Skip to main content

ChartEvent

Enum ChartEvent 

Source
#[non_exhaustive]
pub enum ChartEvent { CrosshairMove { point: Option<CrosshairPoint>, }, Click { pos: PointCss, pane: PaneId, logical_index: f64, time: Option<Timestamp>, price: f64, target: Option<ClickTarget>, }, VisibleRangeChanged { from: LogicalIndex, to: LogicalIndex, }, NeedMoreHistory { bars_before_start: i64, }, DrawingCreated(DrawingId), DrawingModified(DrawingId), DrawingRemoved(DrawingId), DrawingSelected(Option<DrawingId>), Warning(WarningKind), Sync(SyncMessage), DrawingSync, }
Expand description

Events for the host, pulled with Chart::drain_events.

Pending CrosshairMove and VisibleRangeChanged events are coalesced: if the host has not drained the previous one, it is replaced, so the queue does not grow (and does not allocate) while the user interacts.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

CrosshairMove

The crosshair moved; None when it left the plot or is hidden.

Fields

§point: Option<CrosshairPoint>

The new position.

§

Click

A press and release in a plot without moving more than the drag threshold (3 CSS px); not sent while a drawing is being created.

Fields

§pos: PointCss

Where, in CSS pixels from the chart’s top left.

§pane: PaneId

The pane clicked.

§logical_index: f64

Logical index at pos (fractional).

§time: Option<Timestamp>

Time of the bar nearest to logical_index; None beyond the data.

§price: f64

Price at pos, on the pane’s price scale.

§target: Option<ClickTarget>

What was clicked; None for empty space.

§

VisibleRangeChanged

The visible logical range changed.

Fields

§from: LogicalIndex

Left edge.

§to: LogicalIndex

Right edge.

§

NeedMoreHistory

The left edge of the view is within one screen of the first bar: the host should prepend older data. Sent once per first-bar position.

Fields

§bars_before_start: i64

Bars between the first bar and the left edge (negative when the view already shows empty space before the data).

§

DrawingCreated(DrawingId)

A drawing was created (by the user, DrawingManager::add, or an undo/redo that brought it back).

§

DrawingModified(DrawingId)

A drawing was moved or restyled.

§

DrawingRemoved(DrawingId)

A drawing was removed.

§

DrawingSelected(Option<DrawingId>)

The selection changed.

§

Warning(WarningKind)

A non-fatal problem.

§

Sync(SyncMessage)

The chart posted a message to its sync group. Hosts that sync charts across workers forward it with Chart::apply_sync; charts in the same SyncGroup need nothing.

§

DrawingSync

The chart sent drawing sync operations; hosts that forward them to charts in other workers take them with Chart::take_drawing_sync_ops. Reported once until they are taken.

Trait Implementations§

Source§

impl Clone for ChartEvent

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for ChartEvent

Source§

impl Debug for ChartEvent

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for ChartEvent

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ChartEvent

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.