Interface MultiProgressBarProps<T>

Type Parameters

  • T

Hierarchy

Properties

barColor? bgColor? borderRadius? getItemLabel getItemValue height? items maxValue title? width?

Properties

Optional barColor

barColor?: string

Color of the progress bar charted bars.

Default

"#000000"

Optional bgColor

bgColor?: string

Background color of the progress bar. If undefined, theme.palette.border.default is used.

Optional borderRadius

borderRadius?: number

Border radius of the progress bar.

Default

4

getItemLabel

getItemLabel: ((item: T) => string)

Type declaration

    • (item: T): string

    • Function that returns the progress bar item's label.

      Returns

      The item label.

      Parameters

      • item: T

        The progress bar item.

      Returns string

getItemValue

getItemValue: ((item: T) => number)

Type declaration

    • (item: T): number

    • Function that returns the progress bar item's value.

      Returns

      The item value.

      Parameters

      • item: T

        The progress bar item.

      Returns number

Optional height

height?: number

Height of the progress bar.

Default

16 (DEFAULT_HEIGHT)

items

items: [T, T]

Array of two progress bar items, containing properties about each item rendered in the progress bar.

maxValue

maxValue: number

Maximum value of the progress bar's range.

Optional title

title?: string

A text description of what the progress bar is displaying.

Optional width

width?: number

Width of the progress bar.

Default

100 (DEFAULT_WIDTH)

Settings

Member Visibility

Theme

Generated using TypeDoc