Skip to main content

CandlestickChartTooltip

Configuration of the tooltip for CandlestickCharts.

Properties

Methods

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

Properties​

bgcolorclass-attributeinstance-attribute​

bgcolor: ColorValue = '#FFFFECEF'

Background color applied to the tooltip bubble.

border_radiusclass-attributeinstance-attribute​

border_radius: BorderRadiusValue = field(
    default_factory=lambda: BorderRadius.all(4)
)

Corner radius of the tooltip bubble.

border_sideclass-attributeinstance-attribute​

border_side: BorderSide = field(
    default_factory=lambda: BorderSide.none()
)

The tooltip bubble border.

fit_inside_horizontallyclass-attributeinstance-attribute​

fit_inside_horizontally: bool = False

Forces the tooltip bubble to remain inside the chart horizontally.

fit_inside_verticallyclass-attributeinstance-attribute​

fit_inside_vertically: bool = False

Forces the tooltip bubble to remain inside the chart vertically.

horizontal_alignmentclass-attributeinstance-attribute​

horizontal_alignment: HorizontalAlignment = (
    HorizontalAlignment.CENTER
)

Horizontal alignment of the tooltip relative to the tapped candlestick.

horizontal_offsetclass-attributeinstance-attribute​

horizontal_offset: Number = 0

Horizontal offset applied to the tooltip bubble.

max_widthclass-attributeinstance-attribute​

max_width: Number = 120

Maximum width of the tooltip bubble.

paddingclass-attributeinstance-attribute​

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

Padding inside the tooltip bubble.

rotationclass-attributeinstance-attribute​

rotation: Number = 0.0

Rotation angle (in degrees) applied to the tooltip bubble.

show_on_top_of_chart_box_areaclass-attributeinstance-attribute​

show_on_top_of_chart_box_area: bool = False

When set to True, the tooltip is drawn at the top of the chart box.

Methods​

copy​

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

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