Struct Span 

pub struct Span { /* private fields */ }

A span covering a range on either axis.

Implementations

impl Span

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

Create a new span covering the provided range on the X axis by default.

pub fn axis(self, axis: Axis) -> Self

Select which axis the span applies to. This also sets the label alignment. If you want a different label alignment, you need to set it by calling label_align after this call.

pub fn range(self, range: impl Into<RangeInclusive<f64>>) -> Self

Set the range.

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

Set the background fill color for the span.

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

Set the stroke used for both span borders.

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

Convenience for updating the span border width.

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

Convenience for updating the span border color.

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

Set the style for the span borders. Defaults to LineStyle::Solid.

pub fn label_align(self, align: Align2) -> Self

Set the label alignment within the span. This should be called after any calls to axis as that would overwrite the label alignment

Trait Implementations

impl Clone for Span

fn clone(&self) -> Span

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Span

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

Formats the value using the given formatter.

impl PartialEq for Span

fn eq(&self, other: &Span) -> 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 Span

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 geometry(&self) -> PlotGeometry<'_>

Returns the geometry of the plot item.

fn bounds(&self) -> PlotBounds

Returns the bounds 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 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 Span