用户引导

更新时间 2024/12/02 01:54:56

英飞画布功能非常丰富，为了让您更加快速地掌握画布的基础操作，我们提供了用户引导功能。

配置项

operationGuide?: OperationGuideT;

OperationGuideT 对象属性

属性名称

类型

说明

boardGuide

GuideConfigT

画布引导，如画布缩放、拖拽

userGuide

GuideConfigT

用户操作引导，如工具栏操作

GuideConfigT 对象列表

属性名称

类型

说明

show

boolean

是否显示引导

onFinish

() => void

引导结束后的回调

使用示例

初始化获取英飞 Web SDK 实例的时候，在 config 参数的 operationGuide 字段中配置即可：

import InfiWebSdk from '@plaso-infi/whiteboard-sdk';

const initRes = await InfiWebSdk.getSdkInstance({
  containerDom: container,
  operationGuide: {
    boardGuide: {
      show: true;
      onFinish: () => {console.log('画布引导结束了')};
    };
    userGuide: {
      show: true;
      onFinish: () => {console.log('用户引导结束了')};
    };
  };
  // other configs
});