Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TimeSliderOptions

A data type that represents the configuration options for a timeline slider component.

Hierarchy

Index

Properties

Optional className

className: string

CSS class name to add to the view's element.

Optional formatters

formatters: { date?: string; dateFull?: string; day?: string; time?: string }

Date and time formatters for dates displayed in the component. Values must be a string format supported by the date-fns library: https://date-fns.org/docs/format

Type declaration

  • Optional date?: string
  • Optional dateFull?: string
  • Optional day?: string
  • Optional time?: string

Optional id

id: string

Unique identifier.

Optional renderer

renderer: Function | string

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.

Optional requiresData

requiresData: boolean

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.

slider

Configuration for the internal time range slider component.

Optional ui

ui: {}

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.

Type declaration

  • [key: string]: string

Generated using TypeDoc