PanemuTableService

No documentation has been provided.

Presentation

constructor(
	@Inject() protected locale: string
): PanemuTableService;

Parameters

Build columns for the table. This method handle column initialization. The options argument is by default taken from PanemuTableService.getColumnOptions()

Presentation

buildColumns(columns: (NonGroupColumn<T> | GroupedColumn)[], options?: DefaultColumnOptions | undefined): ColumnDefinition<T>;

Parameters

Returns

ColumnDefinition<T>

Delete table state. If you override it, ensure to also override PanemuTableService.saveTableState() and PanemuTableService.getTableState().

Presentation

deleteTableState(stateKey: string): Observable<null>;

Parameters

Returns

Observable<null>

Unspecified properties in BaseColumn use values returned by this method.

Presentation

getColumnOptions(): Required<DefaultColumnOptions>;

Returns

Required<DefaultColumnOptions>

Get default formatter for ColumnType.DATE. Default is EEE, d MMM yyyy

Presentation

getDateCellFormatter(): CellFormatter;

Returns

CellFormatter

Default ColumnType.DATE filter component used by PanemuQueryComponent.

Presentation

getDateFilterComponent(): Type<FilterEditor>;

Returns

Type<FilterEditor>

Get default formatter for ColumnType.DATETIME. Default is d MMM yyyy H:mm:ss

Presentation

getDateTimeCellFormatter(): CellFormatter;

Returns

CellFormatter

Default ColumnType.DATETIME filter component used by PanemuQueryComponent.

Presentation

getDateTimeFilterComponent(): Type<FilterEditor>;

Returns

Type<FilterEditor>

Get default formatter for ColumnType.DECIMAL

Presentation

getDecimalCellFormatter(): CellFormatter;

Returns

CellFormatter

Get default cell formatter. It does nothing beside changing null or undefined to empty string.

Presentation

getDefaultCellFormatter(): CellFormatter;

Returns

CellFormatter

Override this method to specify default cell renderer globally.

Presentation

getDefaultCellRenderer(): CellRenderer;

Returns

CellRenderer

Default filter component used by PanemuQueryComponent.

Presentation

getDefaultFilterComponent(): Type<FilterEditor>;

Returns

Type<FilterEditor>

Override this method to specify default header renderer globally.

Presentation

getDefaultHeaderRenderer(): HeaderRenderer;

Returns

HeaderRenderer

Get group modifier formatter.

Presentation

getGroupModifierFormatter(modifier: string): CellFormatter;

Parameters

Returns

CellFormatter

Get default formatter for ColumnType.INT

Presentation

getIntCellFormatter(): CellFormatter;

Returns

CellFormatter

Get label translation. Intended for internationalization.

Presentation

getLabelTranslation(): LabelTranslation;

Returns

LabelTranslation

Default ColumnType.MAP filter component used by PanemuQueryComponent.

Presentation

getMapFilterComponent(): Type<FilterEditor>;

Returns

Type<FilterEditor>

Default formatter for MapColumn (ColumnType.MAP)

Presentation

getMapFormatter(map: Signal<{ [key: string]: any; }>): CellFormatter;

Parameters

Returns

CellFormatter

Get default formatter for GroupBy functionality where the column type is ColumnType.DATE or ColumnType.DATETIME and the modifier is 'month'

Presentation

getMonthCellFormatter(): CellFormatter;

Returns

CellFormatter

Get default value for pagination maxRows. Override this method to apply default maxRows app-wide.

Presentation

getPaginationMaxRows(): number;

Returns

number

Limit for pagination maxRows to prevent user entering too big range in pagination input range for example 1-1000. In that case the maxRows is 1000 and it is bigger than the value returned by this method (500 by default). The pagination will fallback to 1-500.

Presentation

getPaginationMaxRowsLimit(): number;

Returns

number

Get default table options.

Presentation

getTableOptions(): Required<TableOptions<T>>;

Returns

Required<TableOptions<T>>

Get table state. The state is by default stored in local storage. This method returns an Observable so it can be overriden with http call in case developer save the state in server side. If you override it, ensure to also override PanemuTableService.saveTableState() and PanemuTableService.deleteTableState().

Presentation

getTableState(stateKey: string): Observable<TableState | null>;

Parameters

Returns

Observable<TableState | null>

Get default formatter for GroupBy functionality where the column type is ColumnType.DATE or ColumnType.DATETIME and the modifier is 'year'

Presentation

getYearCellFormatter(): CellFormatter;

Returns

CellFormatter

Function to handle error globally. Override this method to have your own error handler.

Presentation

handleError(err: any): void;

Parameters

Returns

void

By default TableState is saved to local storage. Override this method if you want to save it in a database server. If you override it, ensure to also override PanemuTableService.getTableState() and PanemuTableService.deleteTableState().

Presentation

saveTableState(stateKey: string, state: TableState): void;

Parameters

Returns

void