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 viaseries_graphs(). - Non-series graphs — point-in-time objects like
label.new(),line.new(),box.new(),table.new(), accessed viagraphs().
§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
impl Chart
Sourcepub fn background_color(&self) -> Option<Color>
pub fn background_color(&self) -> Option<Color>
Returns the configured chart background color.
Sourcepub fn series_graphs(
&self,
) -> impl Iterator<Item = (SeriesGraphId, &SeriesGraph)>
pub fn series_graphs( &self, ) -> impl Iterator<Item = (SeriesGraphId, &SeriesGraph)>
Iterates over all per-series graphs.
Sourcepub fn series_graph(&self, id: SeriesGraphId) -> Option<&SeriesGraph>
pub fn series_graph(&self, id: SeriesGraphId) -> Option<&SeriesGraph>
Returns the per-series graph for the given id.
Sourcepub fn graphs(&self) -> impl Iterator<Item = (GraphId, &Graph)>
pub fn graphs(&self) -> impl Iterator<Item = (GraphId, &Graph)>
Iterates over all non-series graphs.
Sourcepub fn series_len(&self) -> usize
pub fn series_len(&self) -> usize
Returns the number of bars in the chart series.
Sourcepub fn bar_colors(&self) -> &BarColors
pub fn bar_colors(&self) -> &BarColors
Returns the bar color overrides for the chart.
Sourcepub fn filled_orders_on_bar(&self, bar_index: usize) -> &[FilledOrder]
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<'de> Deserialize<'de> for Chart
impl<'de> Deserialize<'de> for Chart
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. 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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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
impl<T> Pointable for T
§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
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
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
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
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.