ITablePortlet | 自助仪表盘宏接口文档

表格组件接口对象

Hierarchy 层级

IPortlet
- ITablePortlet

Index 目录

Methods 方法

appendCss

appendCss(selector: CssSelector, style: CssObject | string): void

增加自定义CSS样式（样式只对当前组件生效）
version

9.7.0

since
9.7.0

示例代码1 给标题栏加CSS,改变标题栏颜色
```
portlet.appendCss('.portlet-title-text-default', {
  'color': '#fff',
  'background': 'rgb(0,0,255)',
  'font-size': '16px'
})
```
示例图1

示例代码2 给静态文本组件内容加CSS,改变文本样式(注意只在静态文本组件中生效)
```
portlet.appendCss('.text-object__processedContent', {
   'color': '#f00',
   'background': 'rgb(0,255,0)',
})
```
示例图2
Parameters 参数
- selector: CssSelector
  
  css选择器
- style: CssObject | string
  
  css样式对象
Returns 返回值 void

cancelAsFilter

cancelAsFilter(): void

取消作为筛选器
version

10.5.0

since
10.5.0
- 示例
```
portlet.cancelAsFilter();
```
Returns 返回值 void

doExport

doExport(exportType: ExportType): void

导出组件
version

10.5.0

since
10.5.0
- 示例
```
portlet.doExport(ExportType.EXCEL);
```
Parameters 参数
- exportType: ExportType
Returns 返回值 void

getCellDisplayValue

getCellDisplayValue(rowIndex: number, columnIndex: number): string

获取单元格显示值

version

9.7.0

since

9.7.0

Parameters 参数
- rowIndex: number
  
  行序号（序号从0开始）
- columnIndex: number
  
  列序号（序号从0开始）
Returns 返回值 string

getCellValue

getCellValue(rowIndex: number, columnIndex: number): string

获取单元格真实值

version

9.7.0

since

9.7.0

Parameters 参数
- rowIndex: number
  
  行序号（序号从0开始）
- columnIndex: number
  
  列序号（序号从0开始）
Returns 返回值 string

getId

getId(): string

获取组件id

version

9.7.0

since

9.7.0

Returns 返回值 string

getTitle

getTitle(): string

获取组件标题

version

9.7.0

since

9.7.0

Returns 返回值 string

getToolbar

getToolbar(): IPortletToolbar

获取组件工具栏
version

10.5.0

since
10.5.0
- 示例
```
let toolbar: IPortletToolbar = portlet.getToolbar();
```
Returns 返回值 IPortletToolbar

getType

getType(): string

获取组件类型

version

9.7.0

since

9.7.0

Returns 返回值 string

hide

hide(): void

隐藏组件

version

9.7.0

since

9.7.0

Returns 返回值 void

isAsFilter

isAsFilter(): boolean

当前组件是否作为筛选器
version

10.5.0

since
10.5.0
- 示例
```
let isAsFilter: boolean = portlet.isAsFilter();
```
Returns 返回值 boolean

isMaximized

isMaximized(): boolean

当前组件是否是最大化状态
version

10.5.0

since
10.5.0
- 示例
```
let isMaximized: boolean = portlet.isMaximized();
```
Returns 返回值 boolean

maximize

maximize(): void

最大化组件，目前仅支持图形、表格、web电子表格、tab组件以及URL组件调用
version

10.5.0

since
10.5.0
- 示例
```
portlet.maximize();
```
Returns 返回值 void

removeCss

removeCss(): void

移除自定义CSS

version

9.7.0

since

9.7.0

Returns 返回值 void

resetLinkage

resetLinkage(): void

重置联动
version

10.5.0

since
10.5.0
- 示例
```
portlet.resetLinkage();
```
Returns 返回值 void

restoreDown

restoreDown(): void

还原最大化
version

10.5.0

since
10.5.0
- 示例
```
portlet.restoreDown();
```
Returns 返回值 void

setAsFilter

setAsFilter(): void

设置当前组件作为筛选器
version

10.5.0

since
10.5.0
- 示例
```
portlet.setAsFilter();
```
Returns 返回值 void

setCellStyleHandler

setCellStyleHandler(handler: TableCellStyleHandler): void

单元格样式处理函数（适用于组件渲染前）

可以对单元格添加CSS样式，当需要改变某个单元格样式的时候可以使用该方法。

version

9.7.0

since

9.7.0

示例代码

portlet.setCellStyleHandler(function (row, column, rowIndex, columnIndex) {
   if (columnIndex !== 0) return null
   let value = row.getCellValue(columnIndex)
   if (value > 1000) {
        return {
            background: 'red'
        }
    }
   return null
})

示例图

Parameters 参数

handler: TableCellStyleHandler

单元格样式处理函数

Returns 返回值 void

setRenderCellHandler

setRenderCellHandler(handler: TableRenderCellHandler): HtmlString

单元格节点处理函数（适用于组件渲染前）

可以改变单元格的结构，当需要改变单元格结构（如添加图标、自定义格式化等）的时候可以使用该方法。

version

9.7.0

since

9.7.0

示例代码

portlet.setRenderCellHandler(function (row, column, rowIndex, columnIndex) {
    if (columnIndex != 1) return null
    let value = row.getCellValue(columnIndex)
    let displayValue = row.getCellDisplayValue(columnIndex)
    if (value < 500) {
        return '<span style="color: red;"><i class="SmartbixIcons sx-icon-descending"/>' + displayValue + '</span>'
    }
    if (value > 1500) {
        return '<span style="color: blue;"><i class="SmartbixIcons sx-icon-ascending"/>' + displayValue + '</span>'
    }
    return null
})

示例图

Parameters 参数

handler: TableRenderCellHandler

样式处理函数

Returns 返回值 HtmlString

setRenderHeaderHandler

setRenderHeaderHandler(handler: TableRenderHeaderHandler): HtmlString

表头节点处理函数（适用于组件渲染前）

可以改变表头的结构，当需要改变表头结构（如添加图标、自定义格式化等）的时候可以使用该方法。
version

10.1.0

since
10.1.0

示例代码
```
portlet.setRenderHeaderHandler(function (header, rowIndex, columnIndex, value) {
    if (columnIndex % 2 === 0) {
        return '<span style="color: red;">' + value + '</span>'
    } else {
        return '<span style="color: blue;">' + value + '</span>'
    }
})
```
示例图
Parameters 参数
- handler: TableRenderHeaderHandler
  
  表头处理函数
Returns 返回值 HtmlString

setRowStyleHandler

setRowStyleHandler(handler: TableRowStyleHandler): void

表格行样式处理函数（适用于组件渲染前）

可以对表格行添加CSS样式，当需要改变一整行样式的时候可以使用该方法。
version

9.7.0

since
9.7.0

示例代码
```
portlet.setRowStyleHandler(function (row, rowIndex) {
   let value1 = row.getCellValue(1)
   if (value > 1000) {
        return {
            background: 'red'
        }
    }
   return null
})
```
示例图
Parameters 参数
- handler: TableRowStyleHandler
  
  表格行样式处理函数
Returns 返回值 void

setTitle

setTitle(title: string): void

设置组件标题

version

9.7.0

since

9.7.0

Parameters 参数
- title: string
  
  标题
Returns 返回值 void

show

show(): void

显示组件

version

9.7.0

since

9.7.0

Returns 返回值 void

Hierarchy 层级

Index 目录

Methods 方法

Methods 方法

appendCss

Parameters 参数

selector: CssSelector css选择器

style: CssObject | string css样式对象

Returns 返回值 void

cancelAsFilter

Returns 返回值 void

doExport

Parameters 参数

exportType: ExportType

Returns 返回值 void

getCellDisplayValue

Parameters 参数

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

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

Returns 返回值 string

getCellValue

Parameters 参数

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

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

Returns 返回值 string

getId

Returns 返回值 string

getTitle

Returns 返回值 string

getToolbar

Returns 返回值 IPortletToolbar

getType

Returns 返回值 string

hide

Returns 返回值 void

isAsFilter

Returns 返回值 boolean

isMaximized

Returns 返回值 boolean

maximize

Returns 返回值 void

removeCss

Returns 返回值 void

resetLinkage

Returns 返回值 void

restoreDown

Returns 返回值 void

setAsFilter

Returns 返回值 void

setCellStyleHandler

Parameters 参数

handler: TableCellStyleHandler 单元格样式处理函数

Returns 返回值 void

setRenderCellHandler

Parameters 参数

handler: TableRenderCellHandler 样式处理函数

Returns 返回值 HtmlString

setRenderHeaderHandler

Parameters 参数

handler: TableRenderHeaderHandler 表头处理函数

Returns 返回值 HtmlString

setRowStyleHandler

Parameters 参数

handler: TableRowStyleHandler 表格行样式处理函数

Returns 返回值 void

setTitle

Parameters 参数

title: string 标题

Returns 返回值 void

show

Returns 返回值 void

selector: CssSelector

css选择器

style: CssObject | string

css样式对象

rowIndex: number

行序号（序号从0开始）

columnIndex: number

列序号（序号从0开始）

rowIndex: number

行序号（序号从0开始）

columnIndex: number

列序号（序号从0开始）

handler: TableCellStyleHandler

单元格样式处理函数

handler: TableRenderCellHandler

样式处理函数

handler: TableRenderHeaderHandler

表头处理函数

handler: TableRowStyleHandler

表格行样式处理函数

title: string

标题