Skip to main content

Polygon

Struct Polygon 

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

A convex polygon.

Implementations§

Source§

impl<'a> Polygon<'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 custom stroke.

Source

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

Set the stroke width.

Source

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

Fill color. Defaults to the stroke color with added transparency.

Source

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

Set the outline’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 Polygon<'_>

Source§

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

Generate shapes to be drawn in the plot.
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

Returns the color of the plot item.
Source§

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

Returns the geometry of the plot item.
Source§

fn bounds(&self) -> PlotBounds

Returns the bounds of the plot item.
Source§

fn base(&self) -> &PlotItemBase

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

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

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

fn name(&self) -> &str

Returns the name of the plot item.
Source§

fn highlight(&mut self)

Highlight the plot item.
Source§

fn highlighted(&self) -> bool

Returns whether the plot item is highlighted.
Source§

fn allow_hover(&self) -> bool

Can the user hover this item?
Source§

fn id(&self) -> Id

Returns the ID of the plot item.
Source§

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

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

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.

Auto Trait Implementations§

§

impl<'a> Freeze for Polygon<'a>

§

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

§

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

§

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

§

impl<'a> Unpin for Polygon<'a>

§

impl<'a> UnsafeUnpin for Polygon<'a>

§

impl<'a> !UnwindSafe for Polygon<'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, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(value: T, _simd: S) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

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.