Interface MetricLegendThresholdProps

Hierarchy

Properties

borderRadius?: number

Border radius of the thermometer.

Default

6 (vertical orientation)

Default

10 (horizontal orientation)

currentCategory?: Category

Category of the metric's current value.

endLabel?: ReactNode

Label rendered at the end of the thermometer. For vertical orientation, this renders below the thermometer. For horizontal orientation, this renders to the right of the thermometer.

height?: number

Height of the thermometer.

Default

265 (vertical orientation)

Default

20 (horizontal orientation)

metric: string | Metric

Metric represented by the legend.

orientation: "horizontal" | "vertical"

Orientation of the legend.

showLabels?: boolean

Show the labels of each legend item.

Default

true

showOverview?: boolean

Show the metric name and information.

Default

true

startLabel?: ReactNode

Label rendered at the start of the thermometer. For vertical orientation, this renders above the thermometer. For horizontal orientation, this renders to the left of the thermometer.

width?: number

Width of the thermometer.

Default

12 (vertical orientation)

Default

300 (horizontal orientation)

Generated using TypeDoc