Struct TooltipOptions 

#[non_exhaustive]
pub struct TooltipOptions {

    pub enabled: bool,
    pub on_long_press: bool,
    pub mode: TooltipMode,
    pub show_ohlc: bool,
    pub show_volume: bool,
    pub show_volume_details: bool,
    pub show_change: bool,
    pub show_time: bool,
    pub show_indicators: bool,
    pub magnifier_zoom: f32,
    pub magnifier_size: f32,
    pub background_color: Color32,
    pub text_color: Color32,
    pub border_color_bullish: Color32,
    pub border_color_bearish: Color32,
    pub font_size: f32,
    pub price_precision: usize,
    pub tracking_bar_height: f32,
    pub tracking_bar_background: Color32,
}

Tooltip configuration options

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

enabled: bool

Whether the hover readout is drawn at all.

When false the chart still shows the crosshair but suppresses the OHLC/value readout, matching charting UIs that let users toggle the data tooltip independently of the crosshair.

on_long_press: bool

Show values only while the primary pointer is held. Touch waits for a long press.

mode: TooltipMode

Tooltip display mode

show_ohlc: bool

Show OHLC values (Open, High, Low, Close)

show_volume: bool

Show volume

show_volume_details: bool

Include volume study plot details in held values, in addition to total volume. Other study values and hover readouts retain their existing visibility.

show_change: bool

Show price change (absolute and percentage)

show_time: bool

Show ts

show_indicators: bool

Show indicator values (if indicators are present)

magnifier_zoom: f32

Magnifier zoom level (2.0 = 2x zoom, 3.0 = 3x zoom), drawn within 0.1 to 100 (NaN as 0.1) Only applies when mode is Magnifier

magnifier_size: f32

Magnifier lens diameter in pixels, drawn no larger than the plot’s smaller side Only applies when mode is Magnifier

background_color: Color32

Background color for floating tooltip (Color32::PLACEHOLDER: active theme)

text_color: Color32

Text color for tooltip content (Color32::PLACEHOLDER: active theme)

border_color_bullish: Color32

Border color for the floating tooltip of a rising bar (Color32::PLACEHOLDER: active theme)

border_color_bearish: Color32

Border color for the floating tooltip of a falling bar (Color32::PLACEHOLDER: active theme)

font_size: f32

Font size for tooltip text

price_precision: usize

Most decimals for price values. The floating tooltip shows fewer for prices whose magnitude needs fewer; the tracking bar shows this many, at most 4.

tracking_bar_height: f32

Tracking bar height (for Tracking mode)

tracking_bar_background: Color32

Tracking bar background color (Color32::PLACEHOLDER: active theme)

Implementations

impl TooltipOptions

pub fn floating() -> Self

Create tooltip options with floating mode

pub fn tracking() -> Self

Create tooltip options with tracking mode

pub fn magnifier() -> Self

Create tooltip options with magnifier mode

pub fn magnifier_with_zoom(zoom: f32) -> Self

Create magnifier with custom zoom level

pub fn with_mode(self, mode: TooltipMode) -> Self

Set tooltip mode

pub fn with_enabled(self, enabled: bool) -> Self

Enable or disable the hover readout.

pub fn with_ohlc(self, show: bool) -> Self

Enable/disable OHLC display

pub fn with_volume(self, show: bool) -> Self

Enable/disable volume display

pub fn with_change(self, show: bool) -> Self

Enable/disable change display

pub fn with_magnifier_zoom(self, zoom: f32) -> Self

Set magnifier zoom level

pub fn with_magnifier_size(self, size: f32) -> Self

Set magnifier size

pub fn with_precision(self, precision: usize) -> Self

Set price precision

Trait Implementations

impl Clone for TooltipOptions

fn clone(&self) -> TooltipOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TooltipOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TooltipOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TooltipOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TooltipOptions

fn eq(&self, other: &TooltipOptions) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for TooltipOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TooltipOptions