Interface LegendCategoricalProps<T>

Type Parameters

  • T

Hierarchy

  • LegendCategoricalProps

Properties

getItemColor getItemLabel items orientation?

Properties

getItemColor

getItemColor: ((item: T, itemIndex: number) => string)

Type declaration

    • (item: T, itemIndex: number): string

    • Function that returns the legend item's color.

      Returns

      The item color.

      Parameters

      • item: T

        The legend item.

      • itemIndex: number

        Index of the legend item.

      Returns string

getItemLabel

getItemLabel: ((item: T, itemIndex: number) => string)

Type declaration

    • (item: T, itemIndex: number): string

    • Function that returns the legend item's label.

      Returns

      The item label.

      Parameters

      • item: T

        The legend item.

      • itemIndex: number

        Index of the legend item.

      Returns string

items

items: T[]

Array of legend items, containing properties about each section of the legend.

Optional orientation

orientation?: "horizontal" | "vertical"

Orientation of the legend.

Default

"horizontal"

Settings

Member Visibility

Theme

Generated using TypeDoc