Struct Line 

#[non_exhaustive]
pub struct Line<T, Y> {
    pub name: RwSignal<String>,
    pub colour: RwSignal<Option<Colour>>,
    pub gradient: RwSignal<Option<ColourScheme>>,
    pub width: RwSignal<f64>,
    pub interpolation: RwSignal<Interpolation>,
    pub marker: Marker,
    /* private fields */
}

Draws a line on the chart.

Simple example

With no legend names, lines can be a simple closure:

let series = Series::new(|data: &MyData| data.x)
    .line(|data: &MyData| data.y1)
    .line(|data: &MyData| data.y2);

See this in action with the tick labels example.

Example

However, we can also set the name of the line which a legend can show:

let series = Series::new(|data: &MyData| data.x)
    .line(Line::new(|data: &MyData| data.y1).with_name("pears"))
    .line(Line::new(|data: &MyData| data.y2).with_name("apples"));

See this in action with the legend example.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: RwSignal<String>

Name of the line. Used in the legend.

colour: RwSignal<Option<Colour>>

Colour of the line. If not set, the next colour in the series will be used.

gradient: RwSignal<Option<ColourScheme>>

Use a linear gradient (colour scheme) for the line. Default is None with fallback to the line colour.

width: RwSignal<f64>

Width of the line.

interpolation: RwSignal<Interpolation>

Interpolation method of the line, aka line smoothing (or not). Describes how the line is drawn between two points. Default is Interpolation::Monotone.

marker: Marker

Marker at each point on the line.

Implementations

impl<T, Y> Line<T, Y>

pub fn new(get_y: impl Fn(&T) -> Y + Send + Sync + 'static) -> Self

where Y: Tick,

Create a new line. The get_y function is used to extract the Y value from your struct.

See the module documentation for examples.

pub fn with_name(self, name: impl Into<String>) -> Self

Set the name of the line. Used in the legend.

pub fn with_colour(self, colour: impl Into<Option<Colour>>) -> Self

Set the colour of the line. If not set, the next colour in the series will be used.

pub fn with_gradient(self, scheme: impl Into<ColourScheme>) -> Self

Use a colour scheme for the line. Interpolated in SVG by the browser, overrides Colour. Default is None with fallback to the line colour.

Suggested use with LINEAR_GRADIENT or DIVERGING_GRADIENT (for data with a zero value).

pub fn with_width(self, width: impl Into<f64>) -> Self

Set the width of the line.

pub fn with_interpolation(self, interpolation: impl Into<Interpolation>) -> Self

Set the interpolation method of the line.

pub fn with_marker(self, marker: impl Into<Marker>) -> Self

Set the marker at each point on the line.

Trait Implementations

impl<T, Y> Clone for Line<T, Y>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, Y: Tick, F: Fn(&T) -> Y + Send + Sync + 'static> From<F> for Line<T, Y>

fn from(f: F) -> Self

Converts to this type from the input type.