Skip to main content

BarChartTooltip

Configuration of the tooltip for BarCharts.

Properties

Methods

  • copy - Returns a copy of this object with the specified properties overridden.

Properties

bgcolorclass-attributeinstance-attribute

Background color of tooltips.

border_radiusclass-attributeinstance-attribute

border_radius: BorderRadiusValue | None = None

The border radius of the tooltip.

border_sideclass-attributeinstance-attribute

border_side: BorderSide | None = None

The tooltip border side.

directionclass-attributeinstance-attribute

Defines the direction of this tooltip.

fit_inside_horizontallyclass-attributeinstance-attribute

fit_inside_horizontally: bool = False

Forces the tooltip to shift horizontally inside the chart, if overflow happens.

fit_inside_verticallyclass-attributeinstance-attribute

fit_inside_vertically: bool = False

Forces the tooltip to shift vertically inside the chart, if overflow happens.

horizontal_alignmentclass-attributeinstance-attribute

horizontal_alignment: HorizontalAlignment = (
    HorizontalAlignment.CENTER
)

Defines the horizontal alignment of this tooltip.

horizontal_offsetclass-attributeinstance-attribute

horizontal_offset: Number = 0.0

The horizontal offset of this tooltip.

marginclass-attributeinstance-attribute

margin: Number = 16

Applies a bottom margin for showing tooltip on top of rods.

max_widthclass-attributeinstance-attribute

max_width: Number | None = None

Restricts the tooltip's width.

paddingclass-attributeinstance-attribute

padding: PaddingValue = field(
    default_factory=lambda: Padding.symmetric(
        vertical=8, horizontal=16
    )
)

Applies a padding for showing contents inside the tooltip.

rotationclass-attributeinstance-attribute

rotation: Number = 0.0

The rotation angle of the tooltip.

Methods

copy

copy(
    bgcolor: ColorValue | None = None,
    border_radius: BorderRadiusValue | None = None,
    margin: Number | None = None,
    padding: PaddingValue | None = None,
    max_width: Number | None = None,
    rotation: Number | None = None,
    horizontal_offset: Number | None = None,
    border_side: BorderSide | None = None,
    fit_inside_horizontally: bool | None = None,
    fit_inside_vertically: bool | None = None,
    direction: BarChartTooltipDirection | None = None,
    horizontal_alignment: HorizontalAlignment | None = None,
) -> BarChartTooltip

Returns a copy of this object with the specified properties overridden.