IAdHocTable | 透视分析接口文档

透视-交叉表格宏接口

Hierarchy 层级

ICrossTablePortlet
- IAdHocTable

Index 目录

Methods 方法

appendCss

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

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

9.7.0

since
9.7.0
- 示例给标题栏加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

getCellDisplayValue

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

获取单元格显示值

version

11

since

11

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

getCellValue

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

获取单元格真实值

version

11

since

11

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

getColHeader

getColHeader(rowIndex: number, columnIndex: number): ITableColHeader

获取列头对象
version

10.5.12

since
10.5.12
- 示例
```
const colHeader: ITableColHeader = portlet.getColHeader(0);
```
Parameters 参数
- rowIndex: number
  
  行号从0开始
- columnIndex: number
  
  列号，从0开始
Returns 返回值 ITableColHeader

列头对象

getCornerHeader

getCornerHeader(columnIndex: number): ITableCornerHeader

获取角头对象
version

11

since
11
- 示例
```
const cornerHeader: ITableCornerHeader = portlet.getCornerHeader(0);
```
Parameters 参数
- columnIndex: number
  
  列号，从0开始
Returns 返回值 ITableCornerHeader

getId

getId(): string

获取组件id

version

9.7.0

since

9.7.0

Returns 返回值 string

getRow

getRow(rowIndex: number): ITableDataRow

获取行对象
version

10.5.12

since
10.5.12
- 示例
```
const row: ITableDataRow = portlet.getRow(0);
```
Parameters 参数
- rowIndex: number
  
  行号，从0开始
Returns 返回值 ITableDataRow

行对象

getRowHeader

getRowHeader(rowIndex: number, columnIndex: number): ITableRowHeader

获取行头对象
version

11

since
11
- 示例
```
const rowHeader: ITableRowHeader = portlet.getRowHeader(0, 0);
```
Parameters 参数
- rowIndex: number
  
  行号，从0开始
- columnIndex: number
  
  列号，从0开始
Returns 返回值 ITableRowHeader

getRows

getRows(): ITableDataRow[]

获取所有行，onAfterRefresh时可用
version

10.5.12

since
10.5.12
- 示例
```
const rows: ITableRow[] = table.getRows();
```
Returns 返回值 ITableDataRow[]

所有行

getType

getType(): string

获取组件类型

version

9.7.0

since

9.7.0

Returns 返回值 string

removeCss

removeCss(): void

移除自定义CSS

version

9.7.0

since

9.7.0

Returns 返回值 void

resetEventListener

resetEventListener(): void

清空所有自定义事件

Returns 返回值 void

setCursor

setCursor(cursor: Cursor | string): void

设置鼠标指针

version

10.5.12

since

10.5.12

示例

table.setRenderColHeaderHandler((colHeader, rowIndex, columnIndex) => {
  colHeader.addEventListener(TableColHeaderEvent.HOVER, () => {
    table.setCursor(Cursor.POINTER);
  });
  colHeader.addEventListener(TableColHeaderEvent.HOVER_OFF, () => {
    table.setCursor(Cursor.DEFAULT);
  });
});

示例图

Parameters 参数

cursor: Cursor | string

鼠标指针

Returns 返回值 void

setRenderCellHandler

setRenderCellHandler(handler: IRenderCellHandler): void

单元格节点处理函数

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

11

since
11
- 示例
Parameters 参数
- handler: IRenderCellHandler
  
  样式处理函数
Returns 返回值 void

setRenderColHeaderHandler

setRenderColHeaderHandler(handler: IRenderColHeaderHandler): void

设置列头渲染handler

version

10.5.12

since

10.5.12

示例

portlet.setRenderColHeaderHandler((colHeader, rowIndex, columnIndex) => {
    if (columnIndex === 1) {
        const backgroundStyle: ITableCellBackgroundStyle = {
            backgroundColor: 'green',
            backgroundColorOpacity: 0.5
        }
        colHeader.setBackgroundStyle(backgroundStyle)
    }
});

示例图

Parameters 参数

handler: IRenderColHeaderHandler

列头渲染handler，入参为ITableColHeader, rowIndex, columnIndex

Returns 返回值 void

setRenderCornerHeaderHandler

setRenderCornerHeaderHandler(handler: IRenderCornerHeaderHandler): void

设置角头渲染handler

version

since

示例

portlet.setRenderCornerHeaderHandler((cornerHeader, columnIndex) => {
    if (columnIndex === 1) {
        const backgroundStyle: ITableCellBackgroundStyle = {
            backgroundColor: 'green',
            backgroundColorOpacity: 0.5
        }
        cornerHeader.setBackgroundStyle(backgroundStyle)
    }
});

示例图

Parameters 参数

handler: IRenderCornerHeaderHandler

角头渲染handler，入参为ITableCornerHeader, columnIndex

Returns 返回值 void

setRenderRowHeaderHandler

setRenderRowHeaderHandler(handler: IRenderRowHeaderHandler): void

设置行头渲染handler

version

since

示例

portlet.setRenderRowHeaderHandler((rowHeader, rowIndex, columnIndex) => {
    if (rowIndex === 1) {
        const backgroundStyle: ITableCellBackgroundStyle = {
            backgroundColor: 'green',
            backgroundColorOpacity: 0.5
        }
        rowHeader.setBackgroundStyle(backgroundStyle)
    }
});

示例图

Parameters 参数

handler: IRenderRowHeaderHandler

行头渲染handler，入参为ITableRowHeader, rowIndex, columnIndex

Hierarchy 层级

Index 目录

Methods 方法

Methods 方法

appendCss

Parameters 参数

selector: CssSelector css选择器

style: CssObject | string css样式对象

Returns 返回值 void

getCellDisplayValue

Parameters 参数

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

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

Returns 返回值 string

getCellValue

Parameters 参数

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

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

Returns 返回值 string

getColHeader

Parameters 参数

rowIndex: number 行号从0开始

columnIndex: number 列号，从0开始

Returns 返回值 ITableColHeader

getCornerHeader

Parameters 参数

columnIndex: number 列号，从0开始

Returns 返回值 ITableCornerHeader

getId

Returns 返回值 string

getRow

Parameters 参数

rowIndex: number 行号，从0开始

Returns 返回值 ITableDataRow

getRowHeader

Parameters 参数

rowIndex: number 行号，从0开始

columnIndex: number 列号，从0开始

Returns 返回值 ITableRowHeader

getRows

Returns 返回值 ITableDataRow[]

getType

Returns 返回值 string

removeCss

Returns 返回值 void

resetEventListener

Returns 返回值 void

setCursor

Parameters 参数

cursor: Cursor | string 鼠标指针

Returns 返回值 void

setRenderCellHandler

Parameters 参数

handler: IRenderCellHandler 样式处理函数

Returns 返回值 void

setRenderColHeaderHandler

Parameters 参数

handler: IRenderColHeaderHandler 列头渲染handler，入参为ITableColHeader, rowIndex, columnIndex

Returns 返回值 void

setRenderCornerHeaderHandler

Parameters 参数

handler: IRenderCornerHeaderHandler 角头渲染handler，入参为ITableCornerHeader, columnIndex

Returns 返回值 void

setRenderRowHeaderHandler

Parameters 参数

handler: IRenderRowHeaderHandler 行头渲染handler，入参为ITableRowHeader, rowIndex, columnIndex

Returns 返回值 void

selector: CssSelector

css选择器

style: CssObject | string

css样式对象

rowIndex: number

行序号（序号从0开始）

columnIndex: number

列序号（序号从0开始）

rowIndex: number

行序号（序号从0开始）

columnIndex: number

列序号（序号从0开始）

rowIndex: number

行号从0开始

columnIndex: number

列号，从0开始

columnIndex: number

列号，从0开始

rowIndex: number

行号，从0开始

rowIndex: number

行号，从0开始

columnIndex: number

列号，从0开始

cursor: Cursor | string

鼠标指针

handler: IRenderCellHandler

样式处理函数

handler: IRenderColHeaderHandler

列头渲染handler，入参为ITableColHeader, rowIndex, columnIndex

handler: IRenderCornerHeaderHandler

角头渲染handler，入参为ITableCornerHeader, columnIndex

handler: IRenderRowHeaderHandler

行头渲染handler，入参为ITableRowHeader, rowIndex, columnIndex