Interface UIConfiguration

interface UIConfiguration {
    elements?: UIElements;
    showCompositeFilters?: boolean;
    timeline?: null | UITimeline;
    update: ((selection) => undefined | UIMinimalConfiguration | Promise<undefined | UIMinimalConfiguration>);
}

Hierarchy

UIMinimalConfiguration
- UIConfiguration

Index

Properties

elements? showCompositeFilters? timeline? update

Properties

`Optional` elements

elements?: UIElements

elements defines the configuration of each UI element.

`Optional` `Beta` showCompositeFilters

showCompositeFilters?: boolean

showCompositeFilters flag to show composite filters in the report ui

`Optional` timeline

timeline?: null | UITimeline

timeline defines the timeline UI element.

update

update: ((selection) => undefined | UIMinimalConfiguration | Promise<undefined | UIMinimalConfiguration>)

Type declaration

- (selection): undefined | UIMinimalConfiguration | Promise<undefined | UIMinimalConfiguration>
- update provides a callback to react to changes from the UI elements.
  
  It's called when initializing the report's UI elements and whenever the user interacts with them.
  
  selection is an object that reflects the state of the current selection of the UI elements.
  
  update also allows modifying the ui configuration by returning the target configuration. Use null to destroy any visible elements. When using an undefined value for a specific element, the element remains untouched.
  Parameters
  - selection: UISelection
  Returns undefined | UIMinimalConfiguration | Promise<undefined | UIMinimalConfiguration>

Generated using TypeDoc