Struct HLine

pub struct HLine { /* private fields */ }

A horizontal line in a plot, filling the full width

Implementations

impl HLine

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

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

Highlight this line in the plot by scaling up the line.

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

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

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

Add a stroke.

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 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 horizontal line.

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

Multiple plot items may share the same name, in which case they will also share an entry in the legend.

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

Set the line’s id which is used to identify it in the plot’s response.

Trait Implementations

impl Clone for HLine

fn clone(&self) -> HLine

Returns a copy 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>)

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

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

fn name(&self) -> &str

fn color(&self) -> Color32

fn highlight(&mut self)

fn highlighted(&self) -> bool

fn allow_hover(&self) -> bool

Can the user hover this item?

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

fn bounds(&self) -> PlotBounds

fn id(&self) -> Option<Id>

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

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

impl StructuralPartialEq for HLine