API接口: 入口
1 概述
仪表盘宏需要使用TypeScript进行编写，提供的均为TypeScript接口。TypeScript是JavaScript类型的超集，它可以编译成纯JavaScript。
开发仪表盘宏，就是通过Smartbi开放的TypeScript接口，对仪表盘的页面或组件进行修改，实现定制化的效果。本文将描述仪表盘宏各接口对象的作用，及各宏接口之间的关系。
2 接口对象说明
仪表盘宏的接口对象如下表所示：
| 对象 | 名称解释 | 示例 |
|---|---|---|
| 轮播选项接口 | ||
| 单元格位置信息 | ||
| IEchartPortlet | ECharts组件接口对象 | 根据区间设置柱图中柱子的颜色、根据占比设置柱图中柱子的颜色、图形组件中只显示部分图例、实现点击图形弹出显示值、设置组件背景样式、截取y轴名称、图形组件改变X轴位置、图形组件改变Y轴最小值、延时移除组件样式、自定义地图的提示信息、地图实现提示显示多个指标、地图实现循环高亮效果、堆积图如何显示合计、改变图形组件的图形类型、线图根据区间设置闪烁点 |
| 筛选器列接口 | ||
| IFilterPortlet | 筛选器组件接口对象 | 获取筛选器的值、设置筛选器的值、动态修改筛选器的值、设置筛选器备选项的内容及样式、根据筛选器（列表、下拉）备选值轮播、根据筛选器（日期）备选值轮播、根据筛选器（文本）备选值轮播 |
| 筛选器行接口 | ||
| 服务端日志接口 | ||
| IPage | 仪表盘页面接口对象 | 设置表格样式、指定打开方式来打开目标报表页面 |
| 仪表盘页面服务端接口对象 | ||
| IPageToolBar | 仪表盘工具栏接口对象(浏览状态下) | 移除页面菜单栏上的按钮、隐藏页面菜单栏的按钮、页面菜单栏添加自定义功能按钮 |
| IPortlet | 仪表盘组件接口对象 | |
| 仪表盘组件服务端接口 | ||
| web电子表格单元格接口（客户端） | ||
| web电子表格单元格接口（服务端） | ||
| web电子表格列接口 | ||
| web电子表格自定义元素接口 | ||
web电子表格可编辑的元素接口 （提供修改元素内容的能力） | ||
| web电子表格元素接口 | ||
| web电子表格行接口 | ||
| WEB电子表格sheet接口 | ||
| 常用工具方法 | ||
| 筛选器备选值 | ||
| IStaticTextPortlet | 静态文本组件接口对象 | 点击图标弹出提示、自定义生成富文本内容 |
| 静态Tab页组件接口对象 | ||
| ITablePortlet | 表格组件接口对象 | 表单如何改变单元格样式、表单如何改变单元格元素、表单如何改变行样式、表单如何禁止复制 |
| ITableColumn | 表格列接口 | |
| ITableRow | 表格行接口 | |
| WEB电子表格组件接口对象 | sheet页轮播、加号控制隐藏/显示列、禁止复制、实现跑马灯效果、实现鼠标提示、实现跳转规则、数据过长时，显示省略号、选中行高亮、隐藏指定sheet页 | |
| WEB电子表格服务端组件接口对象 | 根据单元格值设置其他单元格是否显示、列宽自适应、不合并空白单元格、根据条件隐藏整行记录 1、根据条件隐藏整行记录 2 | |
| 提示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/
