Struct Line

pub struct Line<'a> { /* private fields */ }

A series of values forming a path.

Implementations

impl<'a> Line<'a>

pub fn new(name: impl Into<String>, series: impl Into<PlotPoints<'a>>) -> Self

pub fn stroke(self, stroke: impl Into<Stroke>) -> Self

Add a stroke.

pub fn gradient_color( self, callback: Arc<dyn Fn(PlotPoint) -> Color32 + Send + Sync>, gradient_fill: bool, ) -> Self

Add an optional gradient color to the stroke using a callback. The callback receives a PlotPoint as input with the current X and Y values and should return a Color32 to be used as the stroke color for that point.

Setting the gradient_fill parameter to true will use the gradient color callback for the fill area as well when fill() is set.

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

Stroke width. A high value means the plot thickens.

pub fn color(self, color: impl Into<Color32>) -> Self

Stroke color. Default is Color32::TRANSPARENT which means a color will be auto-assigned.

pub fn fill(self, y_reference: impl Into<f32>) -> Self

Fill the area between this line and a given horizontal reference line.

pub fn fill_alpha(self, alpha: impl Into<f32>) -> Self

Set the fill area’s alpha channel. Default is 0.05.

pub fn style(self, style: LineStyle) -> Self

Set the line’s style. Default is LineStyle::Solid.

pub fn name(self, name: impl ToString) -> Self

Name of this plot item.

This name will show up in the plot legend, if legends are turned on.

pub fn highlight(self, highlight: bool) -> Self

Highlight this plot item, typically by scaling it up.

If false, the item may still be highlighted via user interaction.

pub fn allow_hover(self, hovering: bool) -> Self

Allowed hovering this item in the plot. Default: true.

pub fn id(self, id: impl Into<Id>) -> Self

Sets the id of this plot item.

By default the id is determined from the name, but it can be explicitly set to a different value.

Trait Implementations

impl PlotItem for Line<'_>

fn shapes(&self, _ui: &Ui, transform: &PlotTransform, shapes: &mut Vec<Shape>)

fn initialize(&mut self, x_range: RangeInclusive<f64>)

For plot-items which are generated based on x values (plotting functions).

fn color(&self) -> Color32

fn base(&self) -> &PlotItemBase

fn base_mut(&mut self) -> &mut PlotItemBase

fn geometry(&self) -> PlotGeometry<'_>

fn bounds(&self) -> PlotBounds

fn name(&self) -> &str

fn highlight(&mut self)

fn highlighted(&self) -> bool

fn allow_hover(&self) -> bool

Can the user hover this item?

fn id(&self) -> Id

fn find_closest( &self, point: Pos2, transform: &PlotTransform, ) -> Option<ClosestElem>

fn on_hover( &self, plot_area_response: &Response, elem: ClosestElem, shapes: &mut Vec<Shape>, cursors: &mut Vec<Cursor>, plot: &PlotConfig<'_>, label_formatter: &LabelFormatter<'_>, )