PanemuTableController

Observable to listen to after reload event. This is only for table controller. It will not fire for RowGroup expand action because RowGroup has its own controller instance.

Presentation

get afterReloadEvent(): Observable<TableData<T> | null>;

Type

Observable<TableData<T> | null>

This observable fire just before loading a data. This is only for table controller. It will not fire for RowGroup expand action because RowGroup has its own controller instance.

Presentation

get beforeReloadEvent(): Observable<number>;

Type

Observable<number>

Get loading observable. Loading status is true when data is being retrieved from datasource.

Presentation

get loading(): Observable<boolean>;

Type

Observable<boolean>

Get max rows from connected PanemuPaginationComponent.

To change default max rows for all tables across application, create a service extending PanemuTableService and override PanemuTableService.getPaginationMaxRows()

Presentation

get maxRows(): number;

Type

number

Set max rows to display in table. Only usable if there is PanemuPaginationComponent using this controller. Otherwise all data from datasource is displayed at once.

To change default max rows for all tables across application, create a service extending PanemuTableService and override PanemuTableService.getPaginationMaxRows().

The value is limited by PanemuTableService.getPaginationMaxRowsLimit().

Presentation

set maxRows(val: number);

Type

number

Get start index from connected PanemuPaginationComponent. First index is 0.

Presentation

get startIndex(): number;

Type

number

Set start index. Only usable if there is PanemuPaginationComponent using this controller.

Presentation

set startIndex(val: number);

Type

number

Create controller with pagination, sorting, filtering and grouping handled by supplied PanemuTableDataSource.

Presentation

static create(columns: ColumnDefinition<T>, datasource: PanemuTableDataSource<T>, tableOptions?: Partial<TableOptions<T>> | undefined): PanemuTableController<T>;

Parameters

Returns

PanemuTableController<T>

Create controller with pagination, sorting, filtering and grouping handled by custom datasource. It provide a way to specify custom logic for pagination, sorting, filtering and grouping in server side.

Presentation

static createWithCustomDataSource(columns: ColumnDefinition<T>, retrieveDataFunction: RetrieveDataFunction<T>, tableOptions?: Partial<TableOptions<T>> | undefined): PanemuTableController<T>;

Parameters

Returns

PanemuTableController<T>

Clear row selection

Presentation

clearSelection(): void;

Returns

void

Delete table state. By default, it reload the window after it.

Presentation

deleteState(reloadAfterDelete: boolean = true): void;

Parameters

Returns

void

Expand cell. Only works of the column BaseColumn.expansion is defined.

Presentation

expand(row: T, column: BaseColumn<T>, expanded?: WritableSignal<boolean> | undefined): void;

Parameters

Returns

void

Get data being displayed in table including ExpansionRow and RowGroup. If a RowGroup is collapsed, its children are not included because they aren't visible in the table.

Presentation

getAllData(): (T | RowGroup | RowGroupFooter | ExpansionRow<T>)[];

Returns

(T | RowGroup | RowGroupFooter | ExpansionRow<T>)[]

Get data being displayed in table as signal. See also getAllData method.

Presentation

getAllDataAsSignal(): WritableSignal<(T | RowGroup | RowGroupFooter | ExpansionRow<T>)[]>;

Returns

WritableSignal<(T | RowGroup | RowGroupFooter | ExpansionRow<T>)[]>

Get data as comma separated string. By default it includes the header and RowGroups.

Presentation

getCsvData(options?: { includeHeader?: boolean | undefined; includeRowGroup?: boolean | undefined; } | undefined): string;

Parameters

Returns

string

Get data being displayed in table. It only returns regular row data. It excludes RowGroup and ExpansionRow. It doesn't returns all data in datasource.

To get all date from table including of type RowGroup and ExpansionRow see getAllData method.

Presentation

getData(): T[];

Returns

T[]

Get selected row. A row is selected if user click it. RowGroup cannot be selected.

Presentation

getSelectedRow(): T | null;

Returns

T | null

Get selected row as signal. A row is selected if user click it. RowGroup cannot be selected.

Presentation

getSelectedRowSignal(): Signal<T | null>;

Returns

Signal<T | null>

Connect pagination component with the controller. It tells the controller that pagination should be used. If there is no pagination component calling this method, the controller will set its maxRows to 0 which means the datasource should return all data.

The controller will also tell the pagination about pagination information after each reload.

Presentation

initPaginationComponent(refreshAction: RefreshPagination): void;

Parameters

Returns

void

Read state.

Presentation

readState(): Observable<TableState | null>;

Returns

Observable<TableState | null>

Reload data without resetting pagination start index.

Presentation

reloadCurrentPage(): void;

Returns

void

Reload data but reset the pagination start index to 0 before hand.

Presentation

reloadData(): void;

Returns

void

Save table states. The states are:

1. Column visibility, order and stickiness
2. Sorting
3. Pagination
4. Filtering
5. Grouping

Saving state only works if TableOptions.stateKey is defined. It has to be unique app-wide. The state is stored in local storage. To save in db server, override PanemuTableService.saveTableState().

Presentation

saveState(): void;

Returns

void

Select the first data row (not RowGroup nor ExpansionRow). If the table is groupped and none of the group is expanded, this function will always return false because none will be selected.

Presentation

selectFirst(): boolean;

Returns

boolean

Select a row in the table by row index or row object. RowGroup can't be selected.

Presentation

selectRow(rowOrIndex: number | T): boolean;

Parameters

Returns

boolean