LegendPath
@elastic/charts • Exports
@elastic/charts / LegendPath
Type alias: LegendPath
LegendPath:
LegendPathElement
[]
This is an array that defines a path for chart types characterized by hierarchical breakdown of the data, currently partition charts. With partition charts,
- element index 0 is the
groupBy
breakdown: a panelindex
number, and a stringified categoryvalue
- if the chart is a singleton, ie. there's no trellising, it's
{index: 0, value: NULL_SMALL_MULTIPLES_KEY}
- if the chart is a singleton, ie. there's no trellising, it's
- element index 1 represents the singular root of a specific pie etc. chart
{index: 0, value: HIERARCHY_ROOT_KEY}
- element index 2 represents the primary breakdown categories within a pie/treemap/etc.
- element index 3 the next level breakdown, if any (eg. a ring around the pie, ie. sunburst) etc.
Source
packages/charts/src/state/actions/legend.ts:35
Generated using typedoc-plugin-markdown and TypeDoc