广州思迈特软件有限公司飞书用户1362
V11【X模块】二次开发扩展接口文档V2.0.0
输入“/”快速插入内容
V11【X模块】二次开发扩展接口文档V2.0.0
V11【X模块】二次开发扩展接口文档V2.0.0
飞书用户1362
飞书用户4145飞书用户3474
飞书用户884飞书用户2784+5
9月9日修改
快速入门文档：
自助仪表盘二次开发快速入门
场景示例文档
仪表盘二开外部资源使用文档
变更说明
仪表盘二开接口变更说明(V11)
BaseDashExtender基类
仪表盘扩展点需继承此类，在自定义的Extender类中可通过this指针调用BaseDashExtender中的方法SAVE_DIALOG_ON_INIT
| 名称 | 参数 | 返回值 | 说明 |
方法 | on | - | 添加接口监听事件 | |
| getDashboard | | 获取仪表盘对象 | |
| getPage | | 获取页面对象 |
install 初始化接口
触发时机：仪表盘创建时。
作用：此时仪表盘刚进行创建，此时开发者可以在此接口中通过on方法添加对仪表盘事件的监听，并进行一些数据准备等初始化操作。
示例代码
代码块
import SmartBIExt from 'smartbi-ext'
let {
DashModule: {
DashEventEmum: {
DASHBOARD_ON_READY,
},
BaseDashExtender
},
Utils: {
ExtensionUtil: { rmi }
}
} = SmartBIExt
class DashExtender extends BaseDashExtenter {
install () {
// 通过RMI获取当前用户信息，供后续使用
let respPromise = rmi('UserService', 'getCurrentUser')
this.on(DASHBOARD_ON_READY, (iDashboard) => {
// 打开组件选择面板
iDashboard.openWidgetPanel()
})
}
}
扩展接口
扩展接口是仪表盘中提供的外部对系统进行修改的接口，这些接口会在对应的生命周期执行。
开发者实现相关接口时，只需在install方法中，通过on方法监听对应的事件，并实现对应的回调方法，以下示例代码均在install方法中编写。
Dashboard 仪表盘接口
DASHBOARD_ON_READY
触发时机：仪表盘准备完成时，此时可以获取到其他接口对象进行操作。
作用：在仪表盘准备完成后进行一些系统操作，如打开弹窗等。