Struct ChartPointer 

#[non_exhaustive]
pub struct ChartPointer {

    pub time: DateTime<Utc>,
    pub price: f64,
    pub series: SeriesId,
    pub index: isize,
    pub pos: Pos2,
    pub pane: usize,
    pub bar: Option<Bar>,
    pub previous_close: Option<f64>,
    pub series_bars: Vec<(SeriesId, Bar)>,
    pub studies: Vec<(SeriesId, StudyValue)>,
    pub target: Option<PointerTarget>,
    pub modifiers: Modifiers,
    pub kind: PointerKind,
}

A chart cursor position with the data a host legend, tooltip or context action reads. Identical whitespace slots compare equal, including their colours and host payloads.

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.

time: DateTime<Utc>

Nearest eligible slot’s timestamp, respecting the time-scale index filters. With both filters off, extrapolated into whitespace as in visible_time_range.

price: f64

Price on the main pane, or the value on the scale of the hovered pane or volume.

series: SeriesId

MAIN, VOLUME, or the first series or study of another hovered pane. An empty pane reports no position.

index: isize

Nearest slot in the rendered series, counting elements on price-based chart types. Negative or past the last bar in whitespace.

pos: Pos2

Pointer position in UI points, the coordinates of the chart’s Response::rect.

pane: usize

Pane counted from the top among the panes drawn, the price pane with its volume band included: 0 unless panes sit above the price pane.

bar: Option<Bar>

Main series bar, or price-based element, at index, with its colours and payload: a whitespace bar in an empty slot, None in the whitespace before the first bar or after the last.

previous_close: Option<f64>

Close of the last bar or element with a value before index, from which legends measure the change.

series_bars: Vec<(SeriesId, Bar)>

Every series added with add_series or add_comparison that has a bar at time, including hidden series and their host payloads.

studies: Vec<(SeriesId, StudyValue)>

Visible study plots at index, as Chart::study_values_at returns them, each with the id of its study.

target: Option<PointerTarget>

The drawing, series or study line under the pointer, in the priority a click selects.

modifiers: Modifiers

Modifier keys held during the event.

kind: PointerKind

Device that produced the event.

Trait Implementations

impl Clone for ChartPointer

fn clone(&self) -> ChartPointer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChartPointer

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

Formats the value using the given formatter.

impl PartialEq for ChartPointer

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

Equality operator ==.

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

Inequality operator !=.