Struct Chart

Source
pub struct Chart { /* private fields */ }
Expand description

Collection of visuals produced during script execution.

Access via Instance::chart() after executing bars. Contains two categories of visual outputs:

  • Series graphs — per-bar data like plot(), bgcolor(), fill(), accessed via series_graphs().
  • Non-series graphs — point-in-time objects like label.new(), line.new(), box.new(), table.new(), accessed via graphs().

§Examples

let chart = instance.chart();

println!("Background: {:?}", chart.background_color());
println!("Bar count: {}", chart.series_len());

// Series graphs (plots, fills, bgcolor, etc.)
for (id, sg) in chart.series_graphs() {
    if let Some(plot) = sg.as_plot() {
        println!("Plot '{:?}': {} values", plot.title, plot.series.len());
    }
}

// Non-series graphs (labels, lines, boxes, tables, etc.)
for (id, g) in chart.graphs() {
    if let Some(line) = g.as_line() {
        println!(
            "Line from ({},{}) to ({},{})",
            line.x1, line.y1, line.x2, line.y2
        );
    }
}

Implementations§

Source§

impl Chart

Source

pub fn background_color(&self) -> Option<Color>

Returns the configured chart background color.

Source

pub fn series_graphs( &self, ) -> impl Iterator<Item = (SeriesGraphId, &SeriesGraph)>

Iterates over all per-series graphs.

Source

pub fn series_graph(&self, id: SeriesGraphId) -> Option<&SeriesGraph>

Returns the per-series graph for the given id.

Source

pub fn graphs(&self) -> impl Iterator<Item = (GraphId, &Graph)>

Iterates over all non-series graphs.

Source

pub fn graph(&self, id: GraphId) -> Option<&Graph>

Returns the graph for the given id.

Source

pub fn series_len(&self) -> usize

Returns the number of bars in the chart series.

Source

pub fn bar_colors(&self) -> &BarColors

Returns the bar color overrides for the chart.

Source

pub fn filled_orders_on_bar(&self, bar_index: usize) -> &[FilledOrder]

Returns the list of filled orders on the given bar_index.

Each fill includes the signal/order id (e.g. entry or exit name), price, and signed quantity. Returns an empty slice if the bar has no fills.

Trait Implementations§

Source§

impl Clone for Chart

Source§

fn clone(&self) -> Chart

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Chart

Source§

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

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

impl Default for Chart

Source§

fn default() -> Chart

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

impl<'de> Deserialize<'de> for Chart

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Chart

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl Freeze for Chart

§

impl RefUnwindSafe for Chart

§

impl Send for Chart

§

impl Sync for Chart

§

impl Unpin for Chart

§

impl UnwindSafe for Chart

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,