Struct HLine 

pub struct HLine { /* private fields */ }

A horizontal line in a plot, filling the full width

Implementations

impl HLine

pub fn new(name: impl Into<String>, y: impl Into<f64>) -> Self

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

Add a stroke.

pub fn width(self, width: 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 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.

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.

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

Trait Implementations

impl Clone for HLine

fn clone(&self) -> HLine

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HLine

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

Formats the value using the given formatter.

impl PartialEq for HLine

fn eq(&self, other: &HLine) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PlotItem for HLine

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

Generate shapes to be drawn in the plot.

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

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

fn color(&self) -> Color32

Returns the color of the plot item.

fn base(&self) -> &PlotItemBase

Returns a reference to the base data of the plot item.

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

Returns a mutable reference to the base data of the plot item.

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

Returns the geometry of the plot item.

fn bounds(&self) -> PlotBounds

Returns the bounds of the plot item.

fn name(&self) -> &str

Returns the name of the plot item.

fn highlight(&mut self)

Highlight the plot item.

fn highlighted(&self) -> bool

Returns whether the plot item is highlighted.

fn allow_hover(&self) -> bool

Can the user hover this item?

fn id(&self) -> Id

Returns the ID of the plot item.

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

Find the closest element in the plot item to the given point.

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

Handle hover events for the plot item.

impl StructuralPartialEq for HLine