LayoutChangedAction

View as Markdown

Why a LayoutChanged event fired.

Identity of the Layout:

  • LAYOUT_READY — once after startup, for the Layout that is already current. oldLayoutState is absent and changedAreas is omitted.
  • LAYOUT_ADD — a Layout was added. changedAreas is omitted.
  • LAYOUT_EDIT — a Layout was edited.
  • LAYOUT_SAVE — a Layout was saved, including auto-save after grid edits (sort, grouping, columns, and so on). changedAreas lists the facets that actually changed.
  • LAYOUT_DELETE — a Layout was deleted. changedAreas is omitted.
  • LAYOUT_SELECT — a different Layout was selected. changedAreas is omitted.

Column Filters on the current Layout. changedAreas is always ['ColumnFilter']:

  • LAYOUT_COLUMN_FILTER_ADD — a Column Filter was added
  • LAYOUT_COLUMN_FILTER_EDIT — a Column Filter was edited
  • LAYOUT_COLUMN_FILTER_SET — Column Filters were set
  • LAYOUT_COLUMN_FILTER_CLEAR — a Column Filter was cleared
  • LAYOUT_COLUMN_FILTER_CLEAR_ALL — all Column Filters were cleared
  • LAYOUT_COLUMN_FILTER_SUSPEND — a Column Filter was suspended
  • LAYOUT_COLUMN_FILTER_SUSPEND_ALL — all Column Filters were suspended
  • LAYOUT_COLUMN_FILTER_UNSUSPEND — a Column Filter was unsuspended
  • LAYOUT_COLUMN_FILTER_UNSUSPEND_ALL — all Column Filters were unsuspended

Grid Filter on the current Layout. changedAreas is always ['GridFilter']:

  • LAYOUT_GRID_FILTER_SET — the Grid Filter was set
  • LAYOUT_GRID_FILTER_CLEAR — the Grid Filter was cleared
  • LAYOUT_GRID_FILTER_SUSPEND — the Grid Filter was suspended
  • LAYOUT_GRID_FILTER_UNSUSPEND — the Grid Filter was unsuspended
TypeScript
export type LayoutChangedAction = 'LAYOUT_READY' | 'LAYOUT_ADD' | 'LAYOUT_EDIT' | 'LAYOUT_SAVE' | 'LAYOUT_DELETE' | 'LAYOUT_SELECT' | 'LAYOUT_COLUMN_FILTER_ADD' | 'LAYOUT_COLUMN_FILTER_EDIT' | 'LAYOUT_COLUMN_FILTER_SET' | 'LAYOUT_COLUMN_FILTER_CLEAR' | 'LAYOUT_COLUMN_FILTER_CLEAR_ALL' | 'LAYOUT_COLUMN_FILTER_SUSPEND' | 'LAYOUT_COLUMN_FILTER_SUSPEND_ALL' | 'LAYOUT_COLUMN_FILTER_UNSUSPEND' | 'LAYOUT_COLUMN_FILTER_UNSUSPEND_ALL' | 'LAYOUT_GRID_FILTER_SET' | 'LAYOUT_GRID_FILTER_CLEAR' | 'LAYOUT_GRID_FILTER_SUSPEND' | 'LAYOUT_GRID_FILTER_UNSUSPEND';