IChartRangeSelector

interface
Chart

Configuration for the optional band-style range-selector toolbar rendered above <OrigamChartCartesian>. When enabled, displays a set of buttons that let the user select a visible time window over the full dataset.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

API

Properties

Every property declared by this interface, with its type, optionality and default.

enabled
boolean
Show the range-selector toolbar. Default false.
buttons
Array<IChartRangeSelectorButton>
Buttons to display. Defaults to a standard set when omitted: 1w / 1m / 3m / 6m / 1y / all.
selected
number
Zero-based index of the initially selected button.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Enabling the range selector with custom buttons

vue