Options
All
  • Public
  • Public/Protected
  • All
Menu

自助仪表盘宏接口文档

Index 目录

Namespaces

Interfaces 接口

Type aliases 类型

Type aliases 类型

CssObject

CssObject: {} | null

css样式对象, 把css样式以js对象方式书写

示例代码

let cssObecjt:CssObject = {
  'color': '#f00',
  'background': 'rgb(0,255,0)',
  'margin': '5px 10px',
  'font-size': '13px'
}

CssSelector

CssSelector: string

css选择器

详细参考菜鸟教程文档 https://www.runoob.com/cssref/css-selectors.html

示例代码

let cssSelector:CssSelector = '.el-table__header'
let cssSelector2:CssSelector = 'div, p'

EChartEvent

EChartEvent: any

EChart事件，如 click mousedown legendselected等等

详细参考EChart官方文档 https://echarts.apache.org/v4/zh/api.html#events

EChartEventParams

EChartEventParams: any

EChart事件回调参数

详细参考EChart官方文档 https://echarts.apache.org/v4/zh/api.html#events

EChartInstance

EChartInstance: any

EChart实例

详细参考EChart官方文档 https://echarts.apache.org/v4/zh/api.html#echartsInstance

EChartOptions

EChartOptions: any

EChart配置项

详细参考EChart官方文档 https://echarts.apache.org/v4/zh/option.html#title

FilterValueChangeHandler

FilterValueChangeHandler: (value: []) => []

筛选器输入值处理函数

Type declaration 类型声明

    • (value: []): []

    • Parameters 参数

      • value: []

        筛选器中输入的值

      Returns 返回值 []

      改变后筛选器的值

HtmlString

HtmlString: string | null

Html格式的字符串, 把html标签按字符串方式书写,可以支持增加行内样式

示例代码

let html: HtmlString = '<ul><li>第一项</li><li>第二项</li></ul>'
let html2: HtmlString = '<div><span style="color: red;">Hello<span style="color: #0f0;">World</span></div>'

IFilterTableHandler

IFilterTableHandler: (row: IFilterRow, column: IFilterColumn, rowIndex: number, columnIndex: number) => HtmlString

过滤器当前备选值 单选和下拉可以直接使用为数组，但是时间和文本需要调整为数组形式取第一个即可

Type declaration 类型声明

PageToolBarButton

PageToolBarButton: { color: string; handler: () => void; icon: string; tooltip: string }

自助仪表盘工具栏按钮

Type declaration 类型声明

  • color: string

    颜色，css格式颜色字符串

    如 #fff #ff0000 rgb(255,255,0) rgba(255,255,255,1)

  • handler: () => void

    点击事件回调

      • (): void

      • Returns 返回值 void

  • icon: string

    字体图标iconfont的class

    如 sx-icon-back icon-16

    iconfont详细介绍查看官方文档 https://www.iconfont.cn/help/index

  • tooltip: string

    提示文本

PortletRendered

PortletRendered: () => void

组件渲染完成

Type declaration 类型声明

    • (): void

    • 渲染完成的回调函数

      Returns 返回值 void

StaticTextContentHandler

StaticTextContentHandler: (rawHtmlContent: HtmlString, processedHtmlContent: HtmlString) => HtmlString

Type declaration 类型声明

    • 文本组件内容处理函数

      Parameters 参数

      • rawHtmlContent: HtmlString

        原始文本，文本中的函数未被处理

      • processedHtmlContent: HtmlString

        处理后文本，原始文本中的函数将会被处理成实际值

      Returns 返回值 HtmlString

      最终显示的文本，不会再进行函数处理

TableCellStyleHandler

TableCellStyleHandler: (row: ITableRow, column: ITableColumn, rowIndex: number, columnIndex: number) => CssObject

单元格样式处理函数

Type declaration 类型声明

TableRenderCellHandler

TableRenderCellHandler: (row: ITableRow, column: ITableColumn, rowIndex: number, columnIndex: number) => HtmlString

单元格元素处理函数

返回null代表该单元格不作处理，使用默认格式

Type declaration 类型声明

TableRowStyleHandler

TableRowStyleHandler: (row: ITableRow, rowIndex: number) => CssObject

表格行样式处理函数

Type declaration 类型声明

TooltipHandler

TooltipHandler: (row: ITooltipRow, column: ITooltipColumn, rowIndex: number, columnIndex: number, fieldIndex: number) => void

单个tooltip的字段信息回调函数

Type declaration 类型声明

    • Parameters 参数

      • row: ITooltipRow

        行对象

      • column: ITooltipColumn

        列对象

      • rowIndex: number

        行序号（序号从0开始）

      • columnIndex: number

        列序号（序号从0开始）

      • fieldIndex: number

        字段序号（序号从0开始）

        • 示例
          将原来的数据转为数据结构tooltipInfos：[[key0, value0, field0], [key1, value1, field1]]
例如，当rowIndex = 0 时，
row=[key0, value0, field0], row表示每个tooltip
column[0]=key0, column[0]表示当前tooltip的key字符串
column[1]=value[0], column[1]表示当前tooltip的数据列表
column[2]=field0, column[2]表示当前toolTip的字段信息列表

      Returns 返回值 void

setActiveTabHandler

setActiveTabHandler: (activeTabName: string) => string

聚焦到指定Tab页签

Type declaration 类型声明

    • (activeTabName: string): string

    • Parameters 参数

      • activeTabName: string

      Returns 返回值 string