Skip to main content

PlotItem

egui_plot

Trait PlotItem 

Source 
pub trait PlotItem {

Show 14 methods    // Required methods
    fn shapes(
        &self,
        ui: &Ui,
        transform: &PlotTransform,
        shapes: &mut Vec<Shape>,
    );
    fn initialize(&mut self, x_range: RangeInclusive<f64>);
    fn color(&self) -> Color32;
    fn geometry(&self) -> PlotGeometry<'_>;
    fn bounds(&self) -> PlotBounds;
    fn base(&self) -> &PlotItemBase;
    fn base_mut(&mut self) -> &mut PlotItemBase;

    // Provided methods
    fn name(&self) -> &str { ... }
    fn highlight(&mut self) { ... }
    fn highlighted(&self) -> bool { ... }
    fn allow_hover(&self) -> bool { ... }
    fn id(&self) -> Id { ... }
    fn find_closest(
        &self,
        point: Pos2,
        transform: &PlotTransform,
    ) -> Option<ClosestElem> { ... }
    fn on_hover(
        &self,
        plot_area_response: &Response,
        elem: ClosestElem,
        shapes: &mut Vec<Shape>,
        cursors: &mut Vec<Cursor>,
        plot: &PlotConfig<'_>,
        label_formatter: &Option<LabelFormatter<'_>>,
    ) { ... }

}
Expand description

Trait shared by things that can be drawn in the plot.

Required Methods§

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.

Provided Methods§

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.

Implementors§