Skip to content

LegendEntry

Defined in: packages/core/src/types.ts:113

One category in a legend, with how its marks are drawn and how many items it holds.

color: string

Defined in: packages/core/src/types.ts:119

The colour a mark of this category gets, or currentColor when this dimension drives no colour.


count: number

Defined in: packages/core/src/types.ts:129

Items in this category, whatever their weight.


optional href?: string

Defined in: packages/core/src/types.ts:125

The category’s link, if it has one.


id: string

Defined in: packages/core/src/types.ts:115

The category id, or UNKNOWN_CATEGORY_ID.


label: string

Defined in: packages/core/src/types.ts:117

The category label, or the dimension’s unknownLabel.


lightness: number | null

Defined in: packages/core/src/types.ts:123

As Mark.lightness, for this category; null when this dimension drives no lightness.


shape: number | null

Defined in: packages/core/src/types.ts:121

As Mark.shape, for this category; 0 when this dimension drives no shape.


unknown: boolean

Defined in: packages/core/src/types.ts:127

True for the unknown category.


weight: number

Defined in: packages/core/src/types.ts:131

The summed weight of those items.