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

Hierarchy

default

Index

Constructors

constructor

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

Properties

_applyToMap

_applyToMap: boolean

_columns

_columns: {
[field: string]: default;
}

Type declaration

[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: any

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:242
set applyToMap(val): 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:251

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:152
set colFilter(val): 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:161

columns

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

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

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

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:278

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:170
set filterByExtent(val): 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:179

filtered

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

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:188
set open(val): 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:197

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:206
set search(val): 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:215

searchFilter

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

Returns string

Memberof
TableStateManager
- Defined in src/fixtures/grid/store/table-state-manager.ts:224
set searchFilter(val): 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:233

title

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

Returns string

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

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

Methods

_checkFilters

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

clearFilters

clearFilters(): void
Clears all saved filters.

Returns void

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

getColumnFilterValue

getColumnFilterValue(colDefField, range?): string | number
Returns the stored filter value for the given column field.
Parameters
- colDefField: any
- Optional range: string
Returns string | number

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

parsecolumns

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

Returns void

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

setColumnFilterValue

setColumnFilterValue(colDefField, filterValue, range?): void
Saves the current value of the filter for the given column field.
Parameters
- colDefField: any
- filterValue: string | number
- Optional range: string
Returns void

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

Class default

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: TableStateOptions

Returns default

Properties

_applyToMap

_columns

Type declaration

[field: string]: default

_controls

_filterByExtent

_filtered

_open

_search

_searchFilter

_showFilter

_title

state

Accessors

applyToMap

Returns boolean

Memberof

Parameters

val: boolean

Returns void

Memberof

colFilter

Returns boolean

Memberof

Parameters

val: boolean

Returns void

Memberof

columns

Returns { [field: string]: default; }

[field: string]: default

Memberof

Parameters

val: { [field: string]: default; }

[field: string]: default

Returns void

Memberof

controls

Returns (string | ActionButtonDefinition)[]

Memberof

filterByExtent

Returns boolean

Memberof

Parameters

val: boolean

Returns void

Memberof

filtered

Returns boolean

open

Returns boolean

Memberof

Parameters

val: boolean

Returns void

Memberof

search

Returns boolean

Memberof

Parameters

val: boolean

Returns void

Memberof

searchFilter

Returns string

Memberof

Parameters

`Optional` options: TableStateOptions

Returns {
[field: string]: default;
}

val: {
[field: string]: default;
}

`Optional` range: string

`Optional` range: string