IChartDrilldownDataset
interface
Chart
A named sub-dataset associated with a drilldown level in a cartesian chart. The chart swaps its active series and categories with these values when the user clicks a point carrying a matching IChartDrilldownLink.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- idrequiredstring
- Unique identifier — must match IChartDrilldownLink.id on the parent point.
- namerequiredstring
- Human-readable name shown in the breadcrumb trail.
- seriesrequiredArray<IChartSeries>
- Series rendered when this dataset is active.
- categoriesArray<string>
- X-axis category labels for the sub-dataset. When absent the chart falls back to numeric indices.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Defining a drilldown sub-dataset