Skip to main content

Marker

Struct Marker 

Source
pub struct Marker {
    pub time: Timestamp,
    pub position: MarkerPosition,
    pub shape: MarkerShape,
    pub color: Option<Rgba>,
    pub text: String,
}
Expand description

An icon with optional text above or below a bar, e.g. a buy or sell signal. Anchored by time; markers on the same bar and side stack away from it in the order given.

§Examples

use ferrochart_core::chart::{Marker, MarkerPosition, MarkerShape, SeriesOptions};
use ferrochart_core::frame::SeriesKind;
use ferrochart_core::{Chart, ChartOptions};

let mut chart = Chart::new(ChartOptions::default());
let id = chart.add_series(chart.main_pane(), SeriesKind::Candlestick, SeriesOptions::default())?;
chart.set_markers(id, vec![Marker {
    time: 1_700_000_000_000,
    position: MarkerPosition::BelowBar,
    shape: MarkerShape::ArrowUp,
    text: "buy".into(),
    ..Marker::default()
}])?;
assert_eq!(chart.markers(id).map(<[Marker]>::len), Some(1));

Fields§

§time: Timestamp

Time of the bar. A time that is not on the time axis snaps to the next bar (the last one for times after the end).

§position: MarkerPosition

Above or below the bar.

§shape: MarkerShape

Icon.

§color: Option<Rgba>

Icon and text color; None uses the series’ main color.

§text: String

Text next to the icon, on the side away from the bar; empty for none.

Trait Implementations§

Source§

impl Clone for Marker

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 Debug for Marker

Source§

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

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

impl Default for Marker

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for Marker

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 Marker

Auto Trait Implementations§

§

impl Forget for Marker

§

impl Freeze for Marker

§

impl Move for Marker

§

impl RefUnwindSafe for Marker

§

impl Send for Marker

§

impl Sync for Marker

§

impl Unpin for Marker

§

impl UnsafeUnpin for Marker

§

impl UnwindSafe for Marker

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.