Interface LegendThresholdProps<T>

Type Parameters

  • T

Hierarchy

Properties

borderRadius? getItemColor getItemLabel? getItemShowIndicator? getItemSublabel? height? items orientation showLabels? width?

Properties

Optional borderRadius

borderRadius?: number

Border radius of the thermometer.

Default

6 (vertical orientation)

Default

10 (horizontal orientation)

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

Optional 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

Optional getItemShowIndicator

getItemShowIndicator?: ((item: T, itemIndex: number) => undefined | boolean)

Type declaration

    • (item: T, itemIndex: number): undefined | boolean

    • Function that returns whether or not to show an indicator of the current value.

      Returns

      Whether or not to show the indicator.

      Parameters

      • item: T

        The legend item.

      • itemIndex: number

        Index of the legend item.

      Returns undefined | boolean

Optional getItemSublabel

getItemSublabel?: ((item: T, itemIndex: number) => string)

Type declaration

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

    • Function that returns the legend item's sublabel.

      Returns

      The item sublabel.

      Parameters

      • item: T

        The legend item.

      • itemIndex: number

        Index of the legend item.

      Returns string

Optional height

height?: number

Height of the thermometer.

Default

265 (vertical orientation)

Default

20 (horizontal orientation)

items

items: T[]

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

orientation

orientation: "horizontal" | "vertical"

Orientation of the legend.

Optional showLabels

showLabels?: boolean

Show the labels of each legend item.

Default

true

Optional width

width?: number

Width of the thermometer.

Default

12 (vertical orientation)

Default

300 (horizontal orientation)

Settings

Member Visibility

Theme

Generated using TypeDoc