Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ITableCell

单表格元格对象

Hierarchy 层级

Index 目录

Methods 方法

Methods 方法

addEventListener

  • 添加事件监听器

    version

    10.5.12

    since

    10.5.12

    • 示例
    const cell: ITableCell = portlet.getCell(2, 0);
const handler: ITableCellEventListener = () => {
  alert('clicked');
};
cell.addEventListener(TableCellEvent.CLICK, handler);
    • 示例图

    图例

    Parameters 参数

    Returns 返回值 void

addPrefixIcon

  • 在文字前面添加自定义图标

    version

    10.5.12

    since

    10.5.12

    • 示例
    const cell: ITableCell = portlet.getCell(2, 0);
const icon: string = 'base64内容';
cell.addPrefixIcon(icon);
    • 示例图

    图例

    Parameters 参数

    Returns 返回值 string

    图标id，可用于移除图标

addSuffixIcon

  • 在文字后面添加自定义图标

    version

    10.5.12

    since

    10.5.12

    • 示例
    const cell: ITableCell = portlet.getCell(2, 0);
const icon: string = 'base64内容';
cell.addSuffixIcon(icon);
    • 示例图

    图例

    Parameters 参数

    Returns 返回值 string

    图标id，可用于移除图标

getBackgroundStyle

  • 获取单元格背景样式

    version

    10.5.12

    since

    10.5.12

    Returns 返回值 ITableCellBackgroundStyle

    单元格背景样式

    • 示例
    const cell: ITableCell = portlet.getCell(0, 0);
const backgroudStyle: ITableCellBackgroundStyle = cell.getBackgroundStyle();

getColumnIndex

  • getColumnIndex(): number

  • 获取列号

    version

    10.5.12

    since

    10.5.12

    • 示例
    const cell: ITableCell = portlet.getCell(2, 0);
const columnIndex: number = cell.getColumnIndex();

    Returns 返回值 number

    列号，从0开始

getDisplayValue

  • getDisplayValue(): string

  • 获取显示值

    Returns 返回值 string

getRowIndex

  • getRowIndex(): number

  • 获取行号

    version

    10.5.12

    since

    10.5.12

    • 示例
    const cell: ITableCell = portlet.getCell(2, 0);
const rowIndex: number = cell.getRowIndex();

    Returns 返回值 number

    行号，从0开始

getTextStyle

  • 获取文字样式

    version

    10.5.12

    since

    10.5.12

    Returns 返回值 ITableCellTextStyle

    文字样式

    • 示例
    const cell: ITableCell = portlet.getCell(2, 0);
const textStyle: ITableCellTextStyle = cell.getTextStyle();

getValue

  • getValue(): string

  • 获取真实

    Returns 返回值 string

removeEventListener

  • 移除事件监听器

    version

    10.5.12

    since

    10.5.12

    • 示例
    const cell: ITableCell = portlet.getCell(2, 0);
const handler: ITableCellEventListener = () => {
    alert('clicked');
};
cell.addEventListener(TableCellEvent.CLICK, handler);
cell.removeEventListener(TableCellEvent.CLICK, handler);

    Parameters 参数

    Returns 返回值 void

removeIcon

  • removeIcon(iconId: string): void

  • 移除自定义图标

    version

    10.5.12

    since

    10.5.12

    • 示例
    const cell: ITableCell = portlet.getCell(0, 0);
const icon: string = 'base64内容';
const iconId: string = cell.addSuffixIcon(icon);
cell.removeIcon(iconId);

    Parameters 参数

    • iconId: string

      图标id

    Returns 返回值 void

resetBackgroundStyle

  • resetBackgroundStyle(): void

  • 重置自定义背景样式

    version

    10.5.12

    since

    10.5.12

    • 示例
    const cell: ITableCell = portlet.getCell(2, 0);
cell.resetBackgroundStyle();

    Returns 返回值 void

resetTextStyle

  • resetTextStyle(): void

  • 重置自定义文字样式

    version

    10.5.12

    since

    10.5.12

    • 示例
    const cell: ITableCell = portlet.getCell(2, 0);
cell.resetTextStyle();

    Returns 返回值 void

setBackgroundStyle

  • 设置单元格背景样式

    version

    10.5.12

    since

    10.5.12

    • 示例
    const cell: ITableCell = portlet.getCell(2, 0);
const backgroundStyle: ITableCellBackgroundStyle = {
    backgroundColor: '#ee00ee',
    backgroundColorOpacity: 0.7
}
cell.setBackgroundStyle(backgroundStyle);
    • 示例图

    图例

    Parameters 参数

    Returns 返回值 void

setDisplayValue

  • setDisplayValue(value: string): void

  • 设置显示值

    Parameters 参数

    • value: string

    Returns 返回值 void

setTextStyle

  • 设置文字样式

    version

    10.5.12

    since

    10.5.12

    • 示例
    const cell: ITableCell = portlet.getCell(2, 0);
const textStyle: ITableCellTextStyle = {
    fontSize: 16,
    textAlign: AlignType.CENTER,
    textBaseline: BaselineType.BOTTOM,
    fontFamily: 'Microsoft Yahei',
    fontWeight: FontWeightType.BOLDER,
    fill: '#BE0000',
    opacity: 0.8
}
cell.setTextStyle(textStyle);
    • 示例图

    图例

    Parameters 参数

    Returns 返回值 void

setValue

  • setValue(value: any): void

  • 设置真实值

    Parameters 参数

    • value: any

    Returns 返回值 void