CandlestickChartTooltip

Configuration of the tooltip for CandlestickCharts.

Properties

• bgcolor - Background color applied to the tooltip bubble.
• border_radius - Corner radius of the tooltip bubble.
• border_side - The tooltip bubble border.
• fit_inside_horizontally - Forces the tooltip bubble to remain inside the chart horizontally.
• fit_inside_vertically - Forces the tooltip bubble to remain inside the chart vertically.
• horizontal_alignment - Horizontal alignment of the tooltip relative to the tapped candlestick.
• horizontal_offset - Horizontal offset applied to the tooltip bubble.
• max_width - Maximum width of the tooltip bubble.
• padding - Padding inside the tooltip bubble.
• rotation - Rotation angle (in degrees) applied to the tooltip bubble.
• show_on_top_of_chart_box_area - 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

buildbgcolorclass-attributeinstance-attribute

bgcolor: ColorValue = '#FFFFECEF'

Background color applied to the tooltip bubble.

buildborder_radiusclass-attributeinstance-attribute

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

Corner radius of the tooltip bubble.

buildborder_sideclass-attributeinstance-attribute

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

The tooltip bubble border.

buildfit_inside_horizontallyclass-attributeinstance-attribute

fit_inside_horizontally: bool = False

Forces the tooltip bubble to remain inside the chart horizontally.

buildfit_inside_verticallyclass-attributeinstance-attribute

fit_inside_vertically: bool = False

Forces the tooltip bubble to remain inside the chart vertically.

buildhorizontal_alignmentclass-attributeinstance-attribute

horizontal_alignment: HorizontalAlignment = HorizontalAlignment.CENTER

Horizontal alignment of the tooltip relative to the tapped candlestick.

buildhorizontal_offsetclass-attributeinstance-attribute

horizontal_offset: Number = 0

Horizontal offset applied to the tooltip bubble.

buildmax_widthclass-attributeinstance-attribute

max_width: Number = 120

Maximum width of the tooltip bubble.

buildpaddingclass-attributeinstance-attribute

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

Padding inside the tooltip bubble.

buildrotationclass-attributeinstance-attribute

rotation: Number = 0.0

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

buildshow_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

deployed_codecopy

copy(bgcolor: Optional[ColorValue] = None, border_radius: Optional[BorderRadiusValue] = None, padding: Optional[PaddingValue] = None, max_width: Optional[Number] = None, rotation: Optional[Number] = None, horizontal_offset: Optional[Number] = None, horizontal_alignment: Optional[HorizontalAlignment] = None, border_side: Optional[BorderSide] = None, fit_inside_horizontally: Optional[bool] = None, fit_inside_vertically: Optional[bool] = None, show_on_top_of_chart_box_area: Optional[bool] = None)

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