Class TableApi

Hierarchy

TableApi

Index

Constructors

Properties

Methods

externalFilterChanged isColumnVisible isFooterVisible isHeaderVisible repaint scrollToIndex scrollToPixel setColumnVisible setFooterVisible setHeaderVisible updateCells

Constructors

constructor

new TableApi(tableScope): TableApi
Parameters
- tableScope: TableScope
Returns TableApi
- Defined in lib/table/table-api.ts:8

Properties

`Private` `Readonly` tableScope

tableScope: TableScope

Methods

externalFilterChanged

externalFilterChanged(): void
Notifies that the external filter has changed.

Returns void
- Defined in lib/table/table-api.ts:34

isColumnVisible

isColumnVisible(_column): boolean
Returns whether a column is visible or not.
Parameters
- _column: number | ColumnDefIf
  The column index or the column definition.
Returns boolean
- True if the column is visible, false otherwise.
- Defined in lib/table/table-api.ts:91

isFooterVisible

isFooterVisible(): boolean
Determines if the footer is visible.

Returns boolean
True if the footer is visible, false otherwise.
- Defined in lib/table/table-api.ts:121

isHeaderVisible

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

Returns boolean
- Returns true if the header is visible, otherwise returns false.
- Defined in lib/table/table-api.ts:101

repaint

repaint(): void
Repaints the table.

This method calls the repaint method of the tableScope object to update and redraw the table based on the latest data.

Returns void
- Defined in lib/table/table-api.ts:131

scrollToIndex

scrollToIndex(_indexX?, _indexY?): void
Scrolls to the specified index in both horizontal and vertical directions.
Parameters
- _indexX: number = 0
  The index of the column to scroll to in the horizontal direction. Default is 0.
- _indexY: number = 0
  The index of the row to scroll to in the vertical direction. Default is 0.
Returns void
undefined
- Defined in lib/table/table-api.ts:58

scrollToPixel

scrollToPixel(_px?, _py?): void
Scrolls the table body to the specified pixel coordinates.
Parameters
- _px: number = 0
  The horizontal pixel coordinate to scroll to. Defaults to 0.
- _py: number = 0
  The vertical pixel coordinate to scroll to. Defaults to 0.
Returns void
- Defined in lib/table/table-api.ts:45

setColumnVisible

setColumnVisible(_column, _visible?): void
Sets the visibility of a column in the table.
Parameters
- _column: number | ColumnDefIf
- _visible: boolean = true
Returns void
- There is no return value.
- Defined in lib/table/table-api.ts:81

setFooterVisible

setFooterVisible(_visible?): void
Sets the visibility of the footer.
Parameters
- _visible: boolean = true
  Indicates whether the footer should be visible or not. Default value is true.
Returns void
- This method does not return any value.
- Defined in lib/table/table-api.ts:112

setHeaderVisible

setHeaderVisible(_visible?): void
Sets whether the header is visible or not.
Parameters
- _visible: boolean = true
  A boolean value indicating whether the header should be visible. Default value is true.
Returns void
undefined
- Defined in lib/table/table-api.ts:69

updateCells

updateCells(events, repaintAll?): void
Updates the cells in the table based on the provided events.
Parameters
- events: TableCellUpdateEventIf[]
  The array of events representing the updates to perform on the cells.
- Optional repaintAll: boolean = false
  Optional parameter indicating whether to repaint all cells or not. Default value is false.
Returns void
- This method doesn't return anything.
- Defined in lib/table/table-api.ts:22

Generated using TypeDoc