IChartDrilldownProps

interface
Chart

Chart-level prop that wires up the drilldown feature on <OrigamChartCartesian> or <OrigamChartPolar>. Supplies the bank of sub-datasets and an optional Back button label for the breadcrumb navigation.

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.

datasets
required
Array<IChartDrilldownDataset>
Bank of named sub-datasets. Looked up by IChartDrilldownLink.id on point-click.
backLabel
string
'← Back'
Localized label rendered on the Back button / first breadcrumb segment. Default '← Back'.
navAriaLabel
string

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Enabling drilldown on a cartesian chart

typescript