CandlestickChartTooltip

Configuration of the tooltip for CandlestickCharts.

Properties

• bgcolor(ColorValue) –

  Background color applied to the tooltip bubble.

• border_radius(BorderRadiusValue) –

  Corner radius of the tooltip bubble.

• border_side(BorderSide) –

  The tooltip bubble border.

• fit_inside_horizontally(bool) –

  Forces the tooltip bubble to remain inside the chart horizontally.

• fit_inside_vertically(bool) –

  Forces the tooltip bubble to remain inside the chart vertically.

• horizontal_alignment(HorizontalAlignment) –

  Horizontal alignment of the tooltip relative to the tapped candlestick.

• horizontal_offset(Number) –

  Horizontal offset applied to the tooltip bubble.

• max_width(Number) –

  Maximum width of the tooltip bubble.

• padding(PaddingValue) –

  Padding inside the tooltip bubble.

• rotation(Number) –

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

• show_on_top_of_chart_box_area(bool) –

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

Methods

• copy –

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

Properties

bgcolor class-attribute instance-attribute

bgcolor: ColorValue = '#FFFFECEF'

Background color applied to the tooltip bubble.

border_radius class-attribute instance-attribute

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

Corner radius of the tooltip bubble.

border_side class-attribute instance-attribute

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

The tooltip bubble border.

fit_inside_horizontally class-attribute instance-attribute

fit_inside_horizontally: bool = False

Forces the tooltip bubble to remain inside the chart horizontally.

fit_inside_vertically class-attribute instance-attribute

fit_inside_vertically: bool = False

Forces the tooltip bubble to remain inside the chart vertically.

horizontal_alignment class-attribute instance-attribute

horizontal_alignment: HorizontalAlignment = CENTER

Horizontal alignment of the tooltip relative to the tapped candlestick.

horizontal_offset class-attribute instance-attribute

horizontal_offset: Number = 0

Horizontal offset applied to the tooltip bubble.

max_width class-attribute instance-attribute

max_width: Number = 120

Maximum width of the tooltip bubble.

padding class-attribute instance-attribute

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

Padding inside the tooltip bubble.

rotation class-attribute instance-attribute

rotation: Number = 0.0

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

show_on_top_of_chart_box_area class-attribute instance-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.