• Public
  • Public/Protected
  • All





Optional elements

elements: UIElements

elements defines the configuration of each UI element.

Optional timeline

timeline: UITimeline | null

timeline defines the timeline UI element.


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

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.

Type declaration


  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc