Class default

Saves relevant enhancedTable states so that it can be reset on reload/reopen. A PanelStateManager is linked to a BaseLayer. setters are called each time enhancedTable states are updated, getters are called each time enhancedTable is reloaded/reopened. States to save and reset: - displayed rows (on symbology and layer visibility updates) - column filters - whether table maximized is in maximized or split view

Index

Constructors

constructor

new default(options?: TableStateOptions): default
Parameters
- Optionaloptions: TableStateOptions
Returns default
- Defined in src/fixtures/grid/store/table-state-manager.ts:25

Properties

_applyToMap

_applyToMap: boolean

_columns

_columns: { [field: string]: default }

_controls

_controls: (string | ActionButtonDefinition)[]

_filterByExtent

_filterByExtent: boolean

_filtered

_filtered: boolean

_open

_open: boolean

_search

_search: boolean

_searchFilter

_searchFilter: string

_showFilter

_showFilter: boolean

_title

_title: string

state

state: TableStateOptions

Accessors

applyToMap

get applyToMap(): boolean
Returns whether grid filters should apply to the map.

Returns boolean
Memberof
TableStateManager
- Defined in src/fixtures/grid/store/table-state-manager.ts:248
set applyToMap(val: boolean): void
Sets the grid to enable or disable filtering results on the map.
Parameters
- val: boolean
Returns void
Memberof
TableStateManager
- Defined in src/fixtures/grid/store/table-state-manager.ts:257

colFilter

get colFilter(): boolean
Returns whether column filters are enabled for the table.

Returns boolean
Memberof
TableStateManager
- Defined in src/fixtures/grid/store/table-state-manager.ts:158
set colFilter(val: boolean): void
Sets column filters to on or off.
Parameters
- val: boolean
Returns void
Memberof
TableStateManager
- Defined in src/fixtures/grid/store/table-state-manager.ts:167

columns

get columns(): { [field: string]: default }
Returns an array of column configs.

Returns { [field: string]: default }
Memberof
TableStateManager
- Defined in src/fixtures/grid/store/table-state-manager.ts:266
set columns(val: { [field: string]: default }): void
Sets column configs
Parameters
- val: { [field: string]: default }
Returns void
Memberof
TableStateManager
- Defined in src/fixtures/grid/store/table-state-manager.ts:275

controls

get controls(): (string | ActionButtonDefinition)[]
Returns an array of grid action buttons.

Returns (string | ActionButtonDefinition)[]
Memberof
TableStateManager
- Defined in src/fixtures/grid/store/table-state-manager.ts:284

filterByExtent

get filterByExtent(): boolean
Returns whether the grid is filtering by map extent.

Returns boolean
Memberof
TableStateManager
- Defined in src/fixtures/grid/store/table-state-manager.ts:176
set filterByExtent(val: boolean): void
Sets the extent filter to on or off.
Parameters
- val: boolean
Returns void
Memberof
TableStateManager
- Defined in src/fixtures/grid/store/table-state-manager.ts:185

filtered

get filtered(): boolean
Returns boolean
- Defined in src/fixtures/grid/store/table-state-manager.ts:131

open

get open(): boolean
Returns whether the grid is currently open.

Returns boolean
Memberof
TableStateManager
- Defined in src/fixtures/grid/store/table-state-manager.ts:194
set open(val: boolean): void
Sets the grid status to open or closed.
Parameters
- val: boolean
Returns void
Memberof
TableStateManager
- Defined in src/fixtures/grid/store/table-state-manager.ts:203

search

get search(): boolean
Returns whether the global search is currently enabled.

Returns boolean
Memberof
TableStateManager
- Defined in src/fixtures/grid/store/table-state-manager.ts:212
set search(val: boolean): void
Sets the global search to enabled or disabled.
Parameters
- val: boolean
Returns void
Memberof
TableStateManager
- Defined in src/fixtures/grid/store/table-state-manager.ts:221

get searchFilter(): string
Returns the value of the global search.

Returns string
Memberof
TableStateManager
- Defined in src/fixtures/grid/store/table-state-manager.ts:230
set searchFilter(val: string): void
Sets the value of the global search.
Parameters
- val: string
Returns void
Memberof
TableStateManager
- Defined in src/fixtures/grid/store/table-state-manager.ts:239

title

get title(): string
Returns the title of the datatable.

Returns string
Memberof
TableStateManager
- Defined in src/fixtures/grid/store/table-state-manager.ts:140
set title(val: string): void
Sets the title of the datatable.
Parameters
- val: string
Returns void
Memberof
TableStateManager
- Defined in src/fixtures/grid/store/table-state-manager.ts:149

Methods

_checkFilters

_checkFilters(): void
Returns void
- Defined in src/fixtures/grid/store/table-state-manager.ts:121

clearFilters

clearFilters(): void
Clears all saved filters.

Returns void
Memberof
TableStateManager
- Defined in src/fixtures/grid/store/table-state-manager.ts:109

getColumnFilterValue

getColumnFilterValue(colDefField: string, range?: FilterRange): string | number
Returns the stored filter value for the given column field.
Parameters
- colDefField: string
- Optionalrange: FilterRange
Returns string | number
Memberof
TableStateManager
- Defined in src/fixtures/grid/store/table-state-manager.ts:62

parsecolumns

parsecolumns(): void
Parses any given configurations of columns.

Returns void
Memberof
TableStateManager
- Defined in src/fixtures/grid/store/table-state-manager.ts:46

setColumnFilterValue

setColumnFilterValue(
    colDefField: string,
    filterValue: string | number,
    range?: FilterRange,
): void
Saves the current value of the filter for the given column field.
Parameters
- colDefField: string
- filterValue: string | number
- Optionalrange: FilterRange
Returns void
Memberof
TableStateManager
- Defined in src/fixtures/grid/store/table-state-manager.ts:81

Class default

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns default

Properties

_applyToMap

_columns

_controls

_filterByExtent

_filtered

_open

_search

_searchFilter

_showFilter

_title

state

Accessors

applyToMap

Returns boolean

Memberof

Parameters

Returns void

Memberof

colFilter

Returns boolean

Memberof

Parameters

Returns void

Memberof

columns

Returns { [field: string]: default }

Memberof

Parameters

Returns void

Memberof

controls

Returns (string | ActionButtonDefinition)[]

Memberof

filterByExtent

Returns boolean

Memberof

Parameters

Returns void

Memberof

filtered

Returns boolean

open

Returns boolean

Memberof

Parameters

Returns void

Memberof

search

Returns boolean

Memberof

Parameters

Returns void

Memberof

searchFilter

Returns string

Memberof

Parameters

Returns void

Memberof

title

Returns string

Memberof

Parameters

Returns void

Memberof

Methods

_checkFilters

Returns void

clearFilters