Line

Struct Line 

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

A series of values forming a path.

Implementations§

Source§

impl<'a> Line<'a>

Source

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

Source

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

Add a stroke.

Source

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.

Source

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

Stroke width. A high value means the plot thickens.

Source

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

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

Source

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

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

Source

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

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

Source

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

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

Source

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.

Setting the name via this method does not change the item’s id, so you can use it to change the name dynamically between frames without losing the item’s state. You should make sure the name passed to Self::new is unique and stable for each item, or set unique and stable ids explicitly via Self::id.

Source

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.

Source

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

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

Source

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 passed to Self::new, but it can be explicitly set to a different value.

Trait Implementations§

Source§

impl PlotItem for Line<'_>

Source§

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

Source§

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

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

fn color(&self) -> Color32

Source§

fn base(&self) -> &PlotItemBase

Source§

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

Source§

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

Source§

fn bounds(&self) -> PlotBounds

Source§

fn name(&self) -> &str

Source§

fn highlight(&mut self)

Source§

fn highlighted(&self) -> bool

Source§

fn allow_hover(&self) -> bool

Can the user hover this item?
Source§

fn id(&self) -> Id

Source§

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

Source§

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

Auto Trait Implementations§

§

impl<'a> Freeze for Line<'a>

§

impl<'a> !RefUnwindSafe for Line<'a>

§

impl<'a> !Send for Line<'a>

§

impl<'a> !Sync for Line<'a>

§

impl<'a> Unpin for Line<'a>

§

impl<'a> !UnwindSafe for Line<'a>

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