Interface AreaModelIf

areaIdent

rowSelectionModel

changeColumnOrder

• changeColumnOrder(sourceColumnIndex, targetColumnIndex): void

• Method for moving a column from position sourceColumnIndex to targetColumnIndex.

  Parameters

  • sourceColumnIndex: number

  • targetColumnIndex: number

  Returns void

doSort

• doSort(sortItems): boolean

• If the 'restore sort' option is set (see), this method will be triggered automatically by the table,

  Parameters

  • sortItems: SortItem[]

  Returns boolean

externalFilterChanged

• externalFilterChanged<T>(predictFn): void

• Will be called internally, when a filtering is trigger.

  Type Parameters

  • T

  Parameters

  • predictFn: FilterFunction<T>

    Defines, what row are invisible or visible after filtering.

  Returns void

getCellRenderer

• getCellRenderer(rowIndex, columnIndex): undefined | CellRendererIf

• Returns a cell renderer class for the given cell (rowIndex/columnIndex). If the return value is undefined, no renderer is used and the model value will be rendered directly in the cell.

  Parameters

  • rowIndex: number

  • columnIndex: number

  Returns undefined | CellRendererIf

getColspanAt

• getColspanAt(rowIndex, columnIndex): number

• Returns the value of a colspan of the cell at position rowIndex/columnIndex. A value below 2 is ignored.

  Parameters

  • rowIndex: number

  • columnIndex: number

  Returns number

getCustomClassesAt

• getCustomClassesAt(rowIndex, columnIndex): string[]

• This method can be used to return a list of css classes for the given cell

  Parameters

  • rowIndex: number

    row index of the cell

  • columnIndex: number

    column index of the cell

  Returns string[]

getCustomStyleAt

• getCustomStyleAt(rowIndex, columnIndex): undefined | {
      [key: string]: string;
  }

• This method can be used to return an object with css style information for the given cell

  Parameters

  • rowIndex: number

    row index of the cell

  • columnIndex: number

    column index of the cell

  Returns undefined | {
      [key: string]: string;
  }

getMaxColspan

• getMaxColspan(): number

• This return value is internally used to optimize the render performance. Set this value to the lowest possible value. If the model has no colspan, a value of 0 would be good. The dafault is 32. If your model has a colspan cell greater 32, don't forget to increase this value.

  Returns number

getMaxRowspan

• getMaxRowspan(): number

• This return value is internally used to optimize the render performance. Set this value to the lowest possible value. If the model has no rowspan, a value of 0 would be good. The default is 32. If your model has a rowspan cell greater 32, don't forget to increase this value.

  Returns number

getRowByIndex

• getRowByIndex(rowIndex): any

• Returns the row of the model, which correspond to the rowIndex.

  Parameters

  • rowIndex: number

  Returns any

getRowCount

• getRowCount(): number

• Returns the number of rows of the area

  Returns number

getRowHeight

• getRowHeight(rowIndex): number

• Returns the row height in pixel of the given row (rowIndex).

  Parameters

  • rowIndex: number

  Returns number

getRowspanAt

• getRowspanAt(rowIndex, columnIndex): number

• Returns the value of a rowspan of the cell at position rowIndex/columnIndex. A value below 2 is ignored.

  Parameters

  • rowIndex: number

  • columnIndex: number

  Returns number

getTooltipAt

• getTooltipAt(rowIndex, columnIndex): any

• Returns the value of a tooltip of the given cell (rowIndex/columnIndex).

  Parameters

  • rowIndex: number

  • columnIndex: number

  Returns any

getValueAt

• getValueAt(rowIndex, columnIndex): any

• Returns the value of the cell at position rowIndex/columnIndex.

  Parameters

  • rowIndex: number

  • columnIndex: number

  Returns any
• getValueAt(rowIndex, columnIndex): any

• Returns the cell value of the given cell. This value will be rendered directly in the cell or rendered by a cell renderer: see getCellRenderer.

  Parameters

  • rowIndex: number

  • columnIndex: number

  Returns any

getYPosByRowIndex

• getYPosByRowIndex(rowIndex): number

• Return the y-position in pixel of the top of the row on the scrollpane. For big tables it can be a big value (greate than the height of the viewport).

  Parameters

  • rowIndex: number

  Returns number

init

• init(): void

• Internally used by TableModel.

  Returns void

isEditable

• isEditable(rowIndex, columnIndex): boolean

• If this method returns true, the cell can be edited by the user.

  Parameters

  • rowIndex: number

  • columnIndex: number

  Returns boolean

isFilterable

• isFilterable(): boolean

• If true, the table is filterable. Rows can be filtered with help of #externalFilterChanged()

  Returns boolean

isRowCheckable

• isRowCheckable(rowIndex): boolean

• If true, the row is checkable and a checkbox is rendered at the beginning of the row.

  Parameters

  • rowIndex: number

  Returns boolean

isRowChecked

• isRowChecked(rowIndex): undefined | CheckedType

• Returns the checked state of an row.

  Parameters

  • rowIndex: number

  Returns undefined | CheckedType

isSelectable

• isSelectable(rowIndex, columnIndex): boolean

• If true, the cell is selectable.

  Parameters

  • rowIndex: number

  • columnIndex: number

  Returns boolean

setRowChecked

• setRowChecked(rowIndex, checked): void

• Set the checked state of the row (rowIndex) to #checked.

  Parameters

  • rowIndex: number

  • checked: boolean

  Returns void

setValue

• setValue(rowIndex, columnIndex, value): boolean

• Method for changing a cell value.

  Parameters

  • rowIndex: number

  • columnIndex: number

  • value: any

  Returns boolean