IChartDrilldownLink

interface
Chart

Reference attached to a data point that signals a drilldown is available. When the user clicks a point carrying this link, the chart looks up the matching IChartDrilldownDataset by id and re-renders with the sub-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.

id
required
string
Identifier used to look up the matching dataset in IChartDrilldownProps.datasets.
name
string
Display name shown in the breadcrumb trail for this level.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Attaching a drilldown link to a data point

typescript