1 概述
自助仪表盘宏需要使用TypeScript进行编写,提供的均为TypeScript接口。TypeScript是JavaScript类型的超集,它可以编译成纯JavaScript。
开发自助仪表盘宏,就是通过Smartbi开放的TypeScript接口,对自助仪表盘的页面或组件进行修改,实现定制化的效果。
API接口: 入口
2 组件接口说明
自助仪表盘宏的接口对象如下表所示:
对象 | 名称解释 | 示例 |
---|---|---|
IPage | 自助仪表盘页面接口对象 | |
IPageToolBar | 自助仪表盘工具栏接口对象(浏览状态下) | 示例1、示例2、示例3 |
IPortlet | 自助仪表盘组件接口对象 | |
IFilterPorlet | 筛选器组件接口对象 | |
筛选器列接口 | ||
筛选器行接口 | ||
IEchartPorlet | ECharts组件接口对象 | 示例1、示例2、示例3 |
IStaticTextPorlet | 静态文本组件接口对象 | |
静态表格组件接口对象 | ||
ITablePorlet | 表格组件接口对象 | 示例1、示例2、示例3 |
ITableColumn | 表格列接口 | |
ITableRow | 表格行接口 | |
常用工具方法 | ||
WEB电子表格组件接口对象 | ||
提示tooltip的列数据 | ||
提示tooltip的行数据 |
在实际的自助仪表盘中,接口对象与实际页面的对应如下图所示:
3 自助仪表盘宏接口关系图
以下是名词解释:
关联: 是指一种拥有的关系,它使一个类知道另一个类的属性和方法;
举例说明:老师与学生,丈夫与妻子关系可以是双向的,也可以是单向的;双向的关联可以有两个箭头或者没有箭头,单向的关联有一个箭头
组合:是指整体与部分的关系,但部分不能离开整体而单独存在。
举例说明:公司和部门是整体和部分的关系,没有公司就不存在部门。
继承: 是指一般与特殊的关系,它指定了子类如何继承父类的素有特征和行为。
举例说明:老虎是动物的一种,即有老虎的特性也有动物的共性。
4 参考文档
- Typescript官方文档 https://www.tslang.cn/docs/home.html
- Typescript菜鸟教程 https://www.runoob.com/typescript/ts-tutorial.html
- Typescript菜鸟工具(TS在线编译) https://c.runoob.com/compile/5577
- EChart官方文档 https://echarts.apache.org/zh/index.html
- iconfont官方文档 https://www.iconfont.cn/