Skip to main content

BarChartRod

A bar rod in a BarChartGroup.

Inherits: BaseControl

Properties

  • background_gradient - An optional gradient to draw a background with.
  • bg_from_y - An optional starting position of a background behind this rod.
  • bg_to_y - An optional ending position of a background behind this rod.
  • bgcolor - An optional color of a background behind this rod.
  • border_radius - Border radius of a bar rod.
  • border_side - Border to draw around rod.
  • color - Rod color.
  • from_y - Specifies a starting position of this rod on Y axis.
  • gradient - Gradient to draw rod's background.
  • selected - If set to True a tooltip is always shown on top of the bar when BarChart.interactive is set to False.
  • show_tooltip - Whether a tooltip should be shown on top of hovered bar.
  • stack_items - Optional list of BarChartRodStackItem objects to draw a stacked bar.
  • to_y - Specifies an ending position of this rod on Y axis.
  • tooltip - The rod's tooltip configuration for this rod.
  • width - The width of this rod.

Properties​

background_gradientclass-attributeinstance-attribute​

background_gradient: Gradient | None = None

An optional gradient to draw a background with.

bg_from_yclass-attributeinstance-attribute​

bg_from_y: Number | None = None

An optional starting position of a background behind this rod.

bg_to_yclass-attributeinstance-attribute​

bg_to_y: Number | None = None

An optional ending position of a background behind this rod.

bgcolorclass-attributeinstance-attribute​

bgcolor: ColorValue | None = None

An optional color of a background behind this rod.

border_radiusclass-attributeinstance-attribute​

border_radius: BorderRadiusValue | None = None

Border radius of a bar rod.

border_sideclass-attributeinstance-attribute​

border_side: BorderSide | None = None

Border to draw around rod.

colorclass-attributeinstance-attribute​

color: ColorValue | None = None

Rod color.

from_yclass-attributeinstance-attribute​

from_y: Number = 0

Specifies a starting position of this rod on Y axis.

gradientclass-attributeinstance-attribute​

gradient: Gradient | None = None

Gradient to draw rod's background.

selectedclass-attributeinstance-attribute​

selected: bool = False

If set to True a tooltip is always shown on top of the bar when BarChart.interactive is set to False.

show_tooltipclass-attributeinstance-attribute​

show_tooltip: bool = True

Whether a tooltip should be shown on top of hovered bar.

stack_itemsclass-attributeinstance-attribute​

stack_items: list[BarChartRodStackItem] = field(
    default_factory=list
)

Optional list of BarChartRodStackItem objects to draw a stacked bar.

to_yclass-attributeinstance-attribute​

to_y: Number | None = None

Specifies an ending position of this rod on Y axis.

tooltipclass-attributeinstance-attribute​

tooltip: BarChartRodTooltip | str = field(
    default_factory=lambda: BarChartRodTooltip()
)

The rod's tooltip configuration for this rod.

widthclass-attributeinstance-attribute​

width: Number | None = None

The width of this rod.