Skip to main content

BandOptions

Struct BandOptions 

Source
pub struct BandOptions {
    pub fill: Option<Rgba>,
    pub fill_crossed: Option<Rgba>,
}
Expand description

Colors of a band between two series.

§Examples

use ferrochart_core::chart::{BandOptions, SeriesData, SeriesOptions};
use ferrochart_core::data::ValueColumns;
use ferrochart_core::frame::SeriesKind;
use ferrochart_core::geom::Rgba;
use ferrochart_core::{Chart, ChartOptions};

let mut chart = Chart::new(ChartOptions::default());
let pane = chart.main_pane();
let a = chart.add_series(pane, SeriesKind::Line, SeriesOptions::default())?;
let b = chart.add_series(pane, SeriesKind::Line, SeriesOptions::default())?;
let line = |v: Vec<f64>| SeriesData::Value(ValueColumns { time: vec![0, 60_000, 120_000], value: v, color: None });
chart.set_data(a, line(vec![2.0, 3.0, 1.0]))?;
chart.set_data(b, line(vec![1.0, 1.0, 2.0]))?;
// Green where a is above b, red where it is below.
let band = chart.add_band(a, b, BandOptions {
    fill: Some(Rgba::hex(0x0026_A69A).with_alpha(0x40)),
    fill_crossed: Some(Rgba::hex(0x00EF_5350).with_alpha(0x40)),
})?;
assert!(chart.band_options(band).is_some());
chart.remove_band(band)?;

Fields§

§fill: Option<Rgba>

Fill where the upper series is at or above the lower one; None: the upper series’ color at 15% opacity.

§fill_crossed: Option<Rgba>

Fill where the upper series is below the lower one; None: as fill.

Trait Implementations§

Source§

impl Clone for BandOptions

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 BandOptions

Source§

impl Debug for BandOptions

Source§

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

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

impl Default for BandOptions

Source§

fn default() -> Self

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

impl PartialEq for BandOptions

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 BandOptions

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.