API文档

ShanhaiBI

ShanhaiBI 为组件运行环境的内置对象,该对象方法与当前组件绑定。

initSettings

1
2
3
4
5
/**
* 初始化设置项
* @param settings
*/
initSettings(settings: object): Promise<null>

getSetting

1
2
3
4
5
6
/**
* 获取对应选项设置的值
* @param key 选项名
* @param data_idx 第几组数据
*/
getSetting(key: string, data_idx?: number | undefined): Promise<any>

getData

1
2
3
4
/**
* 获取数据
*/
getData(): Promise<[object]>

applyLinkage

1
2
3
4
5
/**
* 应用数据联动
* @param linkage 联动
*/
applyLinkage(linkage: object): Promise<null>

withdrawLinkage

1
2
3
4
5
/**
* 取消数据联动
* @param keys 需要取消联动的字段
*/
withdrawLinkage(keys: [] | null): Promise<null>

registerTransition

1
2
3
4
5
6
7
/**
* 注册自定义动画
* @param name 动画名
* @param choices 动画自定义选项
* @param transition 动画执行中的回调函数
*/
registerTransition(name: string, choices: object, transition: (duration: number, args: object) => any): Promise<null>

registerAppActions

1
2
3
4
5
6
/**
* 注册 APP 端的操作
* @param group 操作名
* @param actions 操作内容
*/
registerAppActions(group: string, actions: [object]): Promise<null>