自助仪表盘宏接口文档

Index 目录

Namespaces

Enumerations

Interfaces 接口

Variables

logger

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 类型声明

- (row: IFilterRow, column: IFilterColumn, rowIndex: number, columnIndex: number): HtmlString
- Parameters 参数
  - row: IFilterRow
    
    行对象
  - column: IFilterColumn
    
    列对象
  - rowIndex: number
    
    行序号（序号从0开始）
  - columnIndex: number
    
    列序号（序号从0开始）
  Returns 返回值 HtmlString

IndicatorGridDataHandler

IndicatorGridDataHandler: (row: IndicatorRow, column: IndicatorColumn, rowIndex: number, columnIndex: number) => void

指标看板数据处理

Type declaration 类型声明

(row: IndicatorRow, column: IndicatorColumn, rowIndex: number, columnIndex: number): void

Parameters 参数

row: IndicatorRow

行对象
column: IndicatorColumn

列对象
rowIndex: number

行序号（序号从0开始）

columnIndex: number

列序号（序号从0开始）

示例

portlet.gridDataHandler((row:IndicatorRow, column:IndicatorColumn, rowIndex:number, columnIndex:number) => {
// 获取所有字段
let fields = row.getFields()
// 获取当前行数据
let rowData = row.getRowData()
// 获取当前单元格数据
let columnData = column.getCellData()
})

说明

// 返回值例如，当有1个维度1个度量字段，渲染3列时，
// rowData表示当前的3列数据
// rowData=[columnData, columnData, columnData],
// columnData表示当前单元格数据，值为数组按照字段顺序[维度, ...度量]排列
// columnData=[{id, name, value, displayValue}, {id, name, value, displayValue}]

Returns 返回值 void

MarqueeOptions

MarqueeOptions: { data?: string | string[]; direction?: "left" | "right" | "up" | "down"; speed?: number }

跑马灯配置项

Type declaration 类型声明

Optional data?: string | string[]

跑马灯数据，默认取单元格内容

类型为数组时表示按照数组中的文本顺序一屏一屏的滚动，例如值为[text1, text2, ..., textn]时，先滚动完text1，再滚动text2，... 然后再滚动textn，以此类推
Optional direction?: "left" | "right" | "up" | "down"

跑马灯方向，默认值：left 可选值：left | right | up | down
Optional speed?: number

滚动速度（单位：毫秒），默认值：3000ms

这里的滚动速度是指跑马灯滚动一屏所需要的时间

OpenLinkQuery

OpenLinkQuery: { paramInfo?: Array<ParamInfoItem>; targetInfo: OpenLinkTargetInfo }

打开外部链接参数query

示例代码

let openLinkQuery = {
   targetInfo: {
       url: '自定义链接',
       method: 'GET',
       title: '自定义标题',
       params: [{name: '名称', alias: '别名', value: ['真实值'], displayValue: ['显示值']}]
    },
    paramInfo: []
}

Type declaration 类型声明

Optional paramInfo?: Array<ParamInfoItem>

页面参数信息
targetInfo: OpenLinkTargetInfo

目标窗体信息

OpenLinkTargetInfo

OpenLinkTargetInfo: { method?: string; params?: Array<ParamInfoItem>; title?: string; url: string }

外部链接：打开方式窗口属性

示例代码

let openLinkTargetInfo = {
   url: '自定义链接',
   method: 'GET',
   title: '自定义标题',
   params: [{name: '名称', alias: '别名', value: ['真实值'], displayValue: ['显示值']}]
}

Type declaration 类型声明

Optional method?: string

form表单请求方法（默认值：'GET'）
Optional params?: Array<ParamInfoItem>

链接参数
Optional title?: string

窗口的标题
url: string

自定义打开链接（必填）

OpenResourceQuery

OpenResourceQuery: { paramInfo?: Array<ParamInfoItem>; targetInfo?: OpenResourceTargetInfo }

打开内部链接参数query

示例代码

let OpenResourceQuery = {
    paramInfo: [{name: '名称', alias: '别名', value: ['真实值'], displayValue: ['显示值']}],
    targetInfo: {}
}

Type declaration 类型声明

Optional paramInfo?: Array<ParamInfoItem>

页面参数信息
Optional targetInfo?: OpenResourceTargetInfo

目标窗体信息

OpenResourceTargetInfo

OpenResourceTargetInfo: { method?: string; title?: string }

内部资源：打开方式窗口属性

示例代码

let openResourceTargetInfo = {method: 'POST', title: '自定义标题'}

Type declaration 类型声明

Optional method?: string

form表单请求方法（默认值：'POST'）
Optional title?: string

窗口的标题(默认值：资源的别名或者名称)

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

提示文本

ParamInfoItem

ParamInfoItem: { alias?: string; displayValue?: Array<string>; name: string; value: Array<string> }

打开方式传递参数

Type declaration 类型声明

Optional alias?: string
Optional displayValue?: Array<string>
name: string
value: Array<string>

PortletRendered

PortletRendered: () => void

组件渲染完成

Type declaration 类型声明

- (): void
- 渲染完成的回调函数
  
  Returns 返回值 void

SheetEvent

SheetEvent: any

该事件对象主要是对DOM事件对象进行了一层封装，将原先DOM事件中的属性和方法拷贝到该事件对象中，一般情况下，可以把它作为DOM事件看待，只不过该事件对象会去掉能获取到元素的属性和方法（例如：currentTarget, srcElement， target等属性），请不要使用它来获取DOM元素。

详细参考文档 https://developer.mozilla.org/zh-CN/docs/Web/API/Event

SheetEventListener

SheetEventListener: (e: SheetEvent) => void

事件触发时调用的回调函数

Type declaration 类型声明

- (e: SheetEvent): void
- Parameters 参数
  - e: SheetEvent
    
    事件对象
  Returns 返回值 void

StaticTextContentHandler

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

Type declaration 类型声明

- (rawHtmlContent: HtmlString, processedHtmlContent: HtmlString): HtmlString
- 文本组件内容处理函数
  
  Parameters 参数
  - rawHtmlContent: HtmlString
    
    原始文本，文本中的函数未被处理
  - processedHtmlContent: HtmlString
    
    处理后文本，原始文本中的函数将会被处理成实际值
  Returns 返回值 HtmlString
  
  最终显示的文本，不会再进行函数处理

TableCellStyleHandler

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

单元格样式处理函数

Type declaration 类型声明

- (row: ITableRow, column: ITableColumn, rowIndex: number, columnIndex: number): CssObject
- Parameters 参数
  - row: ITableRow
    
    行对象
  - column: ITableColumn
    
    列对象
  - rowIndex: number
    
    行序号（序号从0开始）
  - columnIndex: number
    
    列序号（序号从0开始）
  Returns 返回值 CssObject

TableRenderCellHandler

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

单元格元素处理函数

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

Type declaration 类型声明

- (row: ITableRow, column: ITableColumn, rowIndex: number, columnIndex: number): HtmlString
- Parameters 参数
  - row: ITableRow
    
    行对象
  - column: ITableColumn
    
    列对象
  - rowIndex: number
    
    行序号（序号从0开始）
  - columnIndex: number
    
    列序号（序号从0开始）
  Returns 返回值 HtmlString

TableRenderHeaderHandler

TableRenderHeaderHandler: (header: ITableHeader, rowIndex: number, columnIndex: number, value: string) => HtmlString

表头元素处理函数

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

Type declaration 类型声明

- (header: ITableHeader, rowIndex: number, columnIndex: number, value: string): HtmlString
- Parameters 参数
  - header: ITableHeader
    
    表头对象
  - rowIndex: number
    
    行序号（序号从0开始）
  - columnIndex: number
    
    列序号（序号从0开始）
  - value: string
    
    当前值
  Returns 返回值 HtmlString

TableRowStyleHandler

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

表格行样式处理函数

Type declaration 类型声明

- (row: ITableRow, rowIndex: number): CssObject
- Parameters 参数
  - row: ITableRow
    
    行对象
  - rowIndex: number
    
    行序号（序号从0开始）
  Returns 返回值 CssObject

TooltipHandler

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

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

Type declaration 类型声明

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

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

Variables

logger

logger: ILogger

Index 目录

Namespaces

Enumerations

Interfaces 接口

Type aliases 类型

Variables

Type aliases 类型

CssObject

CssSelector

EChartEvent

EChartEventParams

EChartInstance

EChartOptions

FilterValueChangeHandler

Type declaration 类型声明

Parameters 参数

value: [] 筛选器中输入的值

Returns 返回值 []

HtmlString

IFilterTableHandler

Type declaration 类型声明

Parameters 参数

row: IFilterRow 行对象

column: IFilterColumn 列对象

rowIndex: number 行序号（序号从0开始）

columnIndex: number 列序号（序号从0开始）

Returns 返回值 HtmlString

IndicatorGridDataHandler

Type declaration 类型声明

Parameters 参数

row: IndicatorRow 行对象

column: IndicatorColumn 列对象

rowIndex: number 行序号（序号从0开始）

Returns 返回值 void

MarqueeOptions

Type declaration 类型声明

Optional data?: string | string[]

Optional direction?: "left" | "right" | "up" | "down"

Optional speed?: number

OpenLinkQuery

Type declaration 类型声明

Optional paramInfo?: Array<ParamInfoItem>

targetInfo: OpenLinkTargetInfo

OpenLinkTargetInfo

Type declaration 类型声明

Optional method?: string

Optional params?: Array<ParamInfoItem>

Optional title?: string

url: string

OpenResourceQuery

Type declaration 类型声明

Optional paramInfo?: Array<ParamInfoItem>

Optional targetInfo?: OpenResourceTargetInfo

OpenResourceTargetInfo

Type declaration 类型声明

Optional method?: string

Optional title?: string

PageToolBarButton

Type declaration 类型声明

color: string

handler: () => void

Returns 返回值 void

icon: string

tooltip: string

ParamInfoItem

Type declaration 类型声明

Optional alias?: string

Optional displayValue?: Array<string>

name: string

value: Array<string>

PortletRendered

Type declaration 类型声明

Returns 返回值 void

SheetEvent

SheetEventListener

Type declaration 类型声明

Parameters 参数

e: SheetEvent 事件对象

Returns 返回值 void

StaticTextContentHandler

value: []

筛选器中输入的值

row: IFilterRow

行对象

column: IFilterColumn

列对象

rowIndex: number

行序号（序号从0开始）

columnIndex: number

列序号（序号从0开始）

row: IndicatorRow

行对象

column: IndicatorColumn

列对象

rowIndex: number

行序号（序号从0开始）

e: SheetEvent

事件对象

rawHtmlContent: HtmlString

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

processedHtmlContent: HtmlString

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

row: ITableRow

行对象

column: ITableColumn

列对象

rowIndex: number

行序号（序号从0开始）

columnIndex: number

列序号（序号从0开始）

row: ITableRow

行对象

column: ITableColumn

列对象

rowIndex: number

行序号（序号从0开始）

columnIndex: number

列序号（序号从0开始）

header: ITableHeader

表头对象

rowIndex: number

行序号（序号从0开始）

columnIndex: number

列序号（序号从0开始）

value: string

当前值

row: ITableRow

行对象

rowIndex: number

行序号（序号从0开始）

row: ITooltipRow

行对象

column: ITooltipColumn

列对象

rowIndex: number

行序号（序号从0开始）

columnIndex: number

列序号（序号从0开始）