Interface TableModelIf

The TableModelIf is on one hand a container for the header, body, and footer models (see : #getAreaModel, and #AreaModelIf), and on the other hand the master of the column information (#getColumnCount(), #getColumnWidth(columnIndex: number)).

If getFixedLeftColumnCount() returns a value greater than 0, a fixed west area will be rendered in the header, body, and footer. A value greater than 0 for getFixedLeftColumnCount() will result in the presence of an east area.

 +----------------+-------------------+--------------+
 |  header/west   |  header/center    | header/east  |
 +----------------+-------------------+--------------+
 |  body/west     |  body/center      | body/east    |
 +----------------+-------------------+--------------+
 |  footer/west   |  footer/center    | footer/east  |
 +----------------+-------------------+--------------+

Hierarchy

TableModelIf

Implemented by

Methods

changeColumnOrder

changeColumnOrder(sourceColumnIndex, targetColumnIndex): void
Moves a column from the source column index to the target column index.
Parameters
- sourceColumnIndex: number
  The index of the column to be moved.
- targetColumnIndex: number
  The index where the column will be moved to.
Returns void
- This method does not return anything.
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:40

doSort

doSort(sortItems): boolean
Sorts an array of SortItem objects based on a predetermined sorting algorithm.
Parameters
- sortItems: SortItem[]
  An array of SortItem objects to be sorted.
Returns boolean
- Returns true if the sorting was successful, false otherwise.
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:307

externalFilterChanged

externalFilterChanged<T>(predictFn): void
This is triggered when an external filter has changed.
Type Parameters
- T
  The type of elements being filtered.
Parameters
- predictFn: FilterFunction<T>
  A function that takes an element of type T and returns a boolean indicating whether the element satisfies the filter conditions.
Returns void
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:299

getAreaModel

getAreaModel(rowAreaIdent): AreaModelIf
Retrieves the area model based on the given row area identifier.
Parameters
- rowAreaIdent: AreaIdent
  The identifier of the row area.
Returns AreaModelIf
The area model corresponding to the provided row area identifier.
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:95

getBodyModel

getBodyModel(): AreaModelIf
Retrieves the body model.

Returns AreaModelIf
The body model representing an area.
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:102

getBodyRowByIndex

getBodyRowByIndex(rowIndex): any
Retrieves the body row at the specified index.
Parameters
- rowIndex: number
  The index of the desired body row.
Returns any
- The body row object at the specified index.
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:223

getColumnCount

getColumnCount(): number
Returns the number of columns in a dataset.

Returns number
The number of columns in the dataset.
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:71

getColumnDef

getColumnDef(index): undefined | ColumnDefIf
Retrieves the column definition for the specified index.
Parameters
- index: number
  The index of the column to retrieve the definition for.
Returns undefined | ColumnDefIf
- The column definition for the specified index, or undefined if not found.
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:200

getColumnDefs

getColumnDefs(): undefined | ColumnDefIf[]
Retrieves the column definitions for a table.

Returns undefined | ColumnDefIf[]
An array of column definitions or undefined if there are no column definitions.
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:207

getColumnProperty

getColumnProperty(columnIndex): string
Retrieves the property of a specific column.
Parameters
- columnIndex: number
  The index of the column.
Returns string
The property of the column.
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:215

getColumnWidth

getColumnWidth(columnIndex): number
Retrieves the width (in pixels) of a specific column.
Parameters
- columnIndex: number
  The index of the column to get the width of.
Returns number
The width of the specified column.
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:79
getColumnWidth(columnIndex): number
Retrieves the width of a given column in the table.
Parameters
- columnIndex: number
  The index of the column for which to get the width.
Returns number
The width of the column in pixels.
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:231

getContentHeightInPixel

getContentHeightInPixel(): number
Retrieves the content height in pixels.

Returns number
The height of the content in pixels.
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:280

getContentWidthInPixel

getContentWidthInPixel(): number
Returns the content width in pixels.

Returns number
The width of the content in pixels.
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:287

getFixedLeftColumnCount

getFixedLeftColumnCount(): number
Retrieves the number of fixed left columns.

Returns number
The count of fixed left columns.
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:109

getFixedRightColumnCount

getFixedRightColumnCount(): number
Retrieves the count of fixed right columns.

Returns number
The count of fixed right columns.
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:116

getPadding

getPadding(): Padding
Retrieves the padding value of the element.

Returns Padding
The padding value of the element.
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:273

getRowHeight

getRowHeight(rowAreaIdent, rowIndex): number
Retrieves the height of a specific row in the provided row area.
Parameters
- rowAreaIdent: AreaIdent
  The identifier of the row area.
- rowIndex: number
  The index of the row for which to retrieve the height.
Returns number
The height of the specified row in pixels.
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:192

getSelectionModel

getSelectionModel(): undefined | SelectionModelIf
Retrieves the selection model associated with the component.

Returns undefined | SelectionModelIf
The selection model instance if available, or undefined if none is found.
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:316

getTableScope

getTableScope(): undefined | TableScope
Returns undefined | TableScope
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:319

getXPosByColumnIndex

getXPosByColumnIndex(columnIndex): number
Returns the x position corresponding to the given column index.
Parameters
- columnIndex: number
  The index of the column.
Returns number
- The x position corresponding to the given column index.
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:87

init

init(): void
Triggered by TableScope.firstInit() after the table tag is attached to the dom.

Returns void
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:54

`Optional` isColumnVisible

isColumnVisible(column): boolean
Optional: whether a column is shown. Implemented by TableModel.
Parameters
- column: string | number | ColumnDefIf
  column index, property or column definition
Returns boolean
false for hidden and for unknown columns
Example
```
tableModel.isColumnVisible?.("category");
```
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:176

isFooterVisibe

isFooterVisibe(): boolean
Checks if the footer is visible.

Returns boolean
Returns true if the footer is visible, otherwise returns false.
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:130

isHeaderVisibe

isHeaderVisibe(): boolean
Checks if the header is visible.

Returns boolean
- Returns true if the header is visible, false otherwise.
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:123

isRowCheckboxVisible

isRowCheckboxVisible(): boolean
Determines if the row checkbox is visible.

Returns boolean
True if the row checkbox is visible, false otherwise.
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:183

isSortable

isSortable(colIdx): boolean
Checks if a column at the specified index is sortable.
Parameters
- colIdx: number
  The index of the column to check.
Returns boolean
- true if the column is sortable, false otherwise.
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:48

recalcHeightAndPadding

recalcHeightAndPadding(): void
Recalculates the height and padding of an element.

Returns void
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:266

recalcPadding

recalcPadding(): void
Recalculates the padding of the element based on its content. This method updates the padding of the element to ensure that its content is properly aligned and displayed.

Returns void
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:259

recalcSize

recalcSize(clientWidth): void
Recalculates the size of the element based on the provided client width.
Parameters
- clientWidth: number
  The current client width of the element.
Returns void
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:250

`Optional` setColumnVisible

setColumnVisible(column, visible): boolean
Optional: shows or hides a column (width 0, definition, position and width are kept). Implemented by TableModel; TableApi.setColumnVisible uses it and repaints.
Parameters
- column: string | number | ColumnDefIf
  column index, property or column definition
- visible: boolean
  false hides the column
Returns boolean
false if there is no such column definition
Example
```
tableModel.setColumnVisible?.(3, false);
```
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:165

setColumnWidth

setColumnWidth(columnIndex, width): void
Sets the width of a column in the table.
Parameters
- columnIndex: number
  The index of the column to set the width for.
- width: number
  The width to set for the column, in pixels.
Returns void
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:240

`Optional` setFooterVisible

setFooterVisible(visible): void
Optional: shows or hides the footer (height 0, the rows stay in the model). Implemented by TableModel; TableApi.setFooterVisible uses it and repaints.
Parameters
- visible: boolean
  false hides the footer
Returns void
Example
```
tableModel.setFooterVisible?.(false);
```
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:152

`Optional` setHeaderVisible

setHeaderVisible(visible): void
Optional: shows or hides the header (height 0, the rows stay in the model). Implemented by TableModel; TableApi.setHeaderVisible uses it and repaints.
Parameters
- visible: boolean
  false hides the header
Returns void
Example
```
tableModel.setHeaderVisible?.(false);
```
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:141

setParentWidth

setParentWidth(widthInPixel): void
Recalculates the column widths of the table.
Parameters
- widthInPixel: number
Returns void
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:64

setTableScope

setTableScope(tableScope): void
Parameters
- tableScope: TableScope
Returns void
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:318

sort

sort(compareFn): void
Parameters
- compareFn: ((a, b) => number)
  - - (a, b): number
    - Parameters
      a: any
      b: any
      Returns number
Returns void
- Defined in src/lib/table/data/tablemodel/table-model.if.ts:309

Interface TableModelIf

Hierarchy

Implemented by

Index

Methods

Methods

changeColumnOrder

Parameters

sourceColumnIndex: number

targetColumnIndex: number

Returns void

doSort

Parameters

sortItems: SortItem[]

Returns boolean

externalFilterChanged

Type Parameters

T

Parameters

predictFn: FilterFunction<T>

Returns void

getAreaModel

Parameters

rowAreaIdent: AreaIdent

Returns AreaModelIf

getBodyModel

Returns AreaModelIf

getBodyRowByIndex

Parameters

rowIndex: number

Returns any

getColumnCount

Returns number

getColumnDef

Parameters

index: number

Returns undefined | ColumnDefIf

getColumnDefs

Returns undefined | ColumnDefIf[]

getColumnProperty

Parameters

columnIndex: number

Returns string

getColumnWidth

Parameters

columnIndex: number

Returns number

Parameters

columnIndex: number

Returns number

getContentHeightInPixel

Returns number

getContentWidthInPixel

Returns number

getFixedLeftColumnCount

Returns number

getFixedRightColumnCount

Returns number

getPadding

Returns Padding

getRowHeight

Parameters

rowAreaIdent: AreaIdent

rowIndex: number

Returns number

getSelectionModel

Returns undefined | SelectionModelIf

getTableScope

Returns undefined | TableScope

getXPosByColumnIndex

Parameters

columnIndex: number

Returns number

init

Returns void

Optional isColumnVisible

Parameters

column: string | number | ColumnDefIf

Returns boolean

Example

`Optional` isColumnVisible

`Optional` setColumnVisible

`Optional` setFooterVisible

`Optional` setHeaderVisible