CSS class name to add to the view's element.
A Boolean indicating whether the panel is enabled. If false
, then the panel will not be
rendered. Default value is true
.
String formats for the time and day displayed in the panel. Values must be a string format supported by the date-fns library: https://date-fns.org/docs/format
Icon HTML to display in the button when the panel is collapsed. This value can be any valid
HTML, including an <img>
or <svg>
element.
Unique identifier.
Configuration options for the range slider component.
Renderer for the view, which can either be an HTML string or a function that receives the view's data, if any, and returns the final HTML string to render as the view's content.
A Boolean value that indicates whether the view requires valid data to be provided in order
for it to be rendered. When this value is true
and there is no data provided, then the
view will be rendered as empty.
Default value is false
.
Panel title, which is displayed when a toggleable panel is expanded.
A Boolean indicating whether the panel is toggleable. Default value is false
.
An object that defines the CSS selectors for various UI elements in the view and their
reference keys. When a view has been rendered and added to the DOM, you can reference and
access these UI targets using this.ui.#key#
, where #key#
is the key used with this
object.
Generated using TypeDoc
A data type that represents the configuration options for a timeline panel.