IChartRangeSelectorButton

interface
Chart

A single button in the range-selector toolbar. Exactly one of count or fraction must be provided: count = number of categories from the right edge to show; fraction = fraction of the full category range to show (0..1).

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.

label
required
string
Short label rendered on the button. E.g. "1w", "1m", "all".
count
number
Number of categories from the trailing edge of the data to include in the visible window. Ignored when fraction is set.
fraction
number
Fraction of the total category count to show (0 exclusive, 1 inclusive). fraction: 1 is equivalent to "all". Ignored when count is set.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Defining range selector buttons

typescript