Class default

constructor

• new default(options?): default

• Parameters

  • Optionaloptions: TableStateOptions

  Returns default

_applyToMap

_columns

_controls

_filterByExtent

_filtered

_open

_search

_searchFilter

_showFilter

_title

state

applyToMap

• get applyToMap(): boolean

• Returns whether grid filters should apply to the map.

  Returns boolean

  Memberof

  TableStateManager

• set applyToMap(val): void

• Sets the grid to enable or disable filtering results on the map.

  Parameters

  • val: boolean

  Returns void

  Memberof

  TableStateManager

colFilter

• get colFilter(): boolean

• Returns whether column filters are enabled for the table.

  Returns boolean

  Memberof

  TableStateManager

• set colFilter(val): void

• Sets column filters to on or off.

  Parameters

  • val: boolean

  Returns void

  Memberof

  TableStateManager

columns

• get columns(): {
      [field: string]: default;
  }

• Returns an array of column configs.

  Returns {
      [field: string]: default;
  }

  • [field: string]: default

  Memberof

  TableStateManager

• set columns(val): void

• Sets column configs

  Parameters

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

    • [field: string]: default

  Returns void

  Memberof

  TableStateManager

controls

• get controls(): (string | ActionButtonDefinition)[]

• Returns an array of grid action buttons.

  Returns (string | ActionButtonDefinition)[]

  Memberof

  TableStateManager

filterByExtent

• get filterByExtent(): boolean

• Returns whether the grid is filtering by map extent.

  Returns boolean

  Memberof

  TableStateManager

• set filterByExtent(val): void

• Sets the extent filter to on or off.

  Parameters

  • val: boolean

  Returns void

  Memberof

  TableStateManager

filtered

• get filtered(): boolean

• Returns boolean

open

• get open(): boolean

• Returns whether the grid is currently open.

  Returns boolean

  Memberof

  TableStateManager

• set open(val): void

• Sets the grid status to open or closed.

  Parameters

  • val: boolean

  Returns void

  Memberof

  TableStateManager

search

• get search(): boolean

• Returns whether the global search is currently enabled.

  Returns boolean

  Memberof

  TableStateManager

• set search(val): void

• Sets the global search to enabled or disabled.

  Parameters

  • val: boolean

  Returns void

  Memberof

  TableStateManager

searchFilter

• get searchFilter(): string

• Returns the value of the global search.

  Returns string

  Memberof

  TableStateManager

• set searchFilter(val): void

• Sets the value of the global search.

  Parameters

  • val: string

  Returns void

  Memberof

  TableStateManager

title

• get title(): string

• Returns the title of the datatable.

  Returns string

  Memberof

  TableStateManager

• set title(val): void

• Sets the title of the datatable.

  Parameters

  • val: string

  Returns void

  Memberof

  TableStateManager

_checkFilters

• _checkFilters(): void

• Returns void

clearFilters

• clearFilters(): void

• Clears all saved filters.

  Returns void

  Memberof

  TableStateManager

getColumnFilterValue

• getColumnFilterValue(colDefField, range?): string | number

• Returns the stored filter value for the given column field.

  Parameters

  • colDefField: any
  • Optionalrange: string

  Returns string | number

  Memberof

  TableStateManager

parsecolumns

• parsecolumns(): void

• Parses any given configurations of columns.

  Returns void

  Memberof

  TableStateManager

setColumnFilterValue

• setColumnFilterValue(colDefField, filterValue, range?): void

• Saves the current value of the filter for the given column field.

  Parameters

  • colDefField: any
  • filterValue: string | number
  • Optionalrange: string

  Returns void

  Memberof

  TableStateManager