Struct PlottersDrawingArea

pub struct PlottersDrawingArea<'a> { /* private fields */ }

An object that can be used as a drawing area by the plotters library.

This is needed because direct 2D needs to wrap the drawing command between a begin_draw and end_draw call but it is impossible to do that within the DrawingBackend trait.

Implementations

impl<'a> PlottersDrawingArea<'a>

pub fn new( inner: &'a Plotters, ) -> Result<PlottersDrawingArea<'a>, PlottersError>

Methods from Deref<Target = DrawingArea<&'a PlottersBackend, Shift>>

pub fn get_base_pixel(&self) -> (i32, i32)

Get the left upper conner of this area in the drawing backend

pub fn strip_coord_spec(&self) -> DrawingArea<DB, Shift>

Strip the applied coordinate specification and returns a shift-based drawing area

pub fn use_screen_coord(&self) -> DrawingArea<DB, Shift>

Strip the applied coordinate specification and returns a drawing area

pub fn dim_in_pixel(&self) -> (u32, u32)

Get the area dimension in pixel

pub fn relative_to_height(&self, p: f64) -> f64

Compute the relative size based on the drawing area’s height

pub fn relative_to_width(&self, p: f64) -> f64

Compute the relative size based on the drawing area’s width

pub fn get_pixel_range(&self) -> (Range<i32>, Range<i32>)

Get the pixel range of this area

pub fn fill<ColorType>( &self, color: &ColorType, ) -> Result<(), DrawingAreaErrorKind<<DB as DrawingBackend>::ErrorType>>

where ColorType: Color,

Fill the entire drawing area with a color

pub fn draw_pixel<ColorType>( &self, pos: <CT as CoordTranslate>::From, color: &ColorType, ) -> Result<(), DrawingAreaErrorKind<<DB as DrawingBackend>::ErrorType>>

where ColorType: Color,

Draw a single pixel

pub fn present( &self, ) -> Result<(), DrawingAreaErrorKind<<DB as DrawingBackend>::ErrorType>>

Present all the pending changes to the backend

pub fn draw<'a, E, B>( &self, element: &'a E, ) -> Result<(), DrawingAreaErrorKind<<DB as DrawingBackend>::ErrorType>>

where B: CoordMapper, &'a E: PointCollection<'a, <CT as CoordTranslate>::From, B>, E: Drawable<DB, B>,

Draw an high-level element

pub fn map_coordinate(&self, coord: &<CT as CoordTranslate>::From) -> (i32, i32)

Map coordinate to the backend coordinate

pub fn estimate_text_size( &self, text: &str, style: &TextStyle<'_>, ) -> Result<(u32, u32), DrawingAreaErrorKind<<DB as DrawingBackend>::ErrorType>>

Estimate the dimension of the text if drawn on this drawing area. We can’t get this directly from the font, since the drawing backend may or may not follows the font configuration. In terminal, the font family will be dropped. So the size of the text is drawing area related.

• text: The text we want to estimate
• font: The font spec in which we want to draw the text
• return: The size of the text if drawn on this area

pub fn apply_coord_spec<CT>(&self, coord_spec: CT) -> DrawingArea<DB, CT>

where CT: CoordTranslate,

Apply a new coord transformation object and returns a new drawing area

pub fn margin<ST, SB, SL, SR>( &self, top: ST, bottom: SB, left: SL, right: SR, ) -> DrawingArea<DB, Shift>

where ST: SizeDesc, SB: SizeDesc, SL: SizeDesc, SR: SizeDesc,

Create a margin for the given drawing area and returns the new drawing area

pub fn split_vertically<S>( &self, y: S, ) -> (DrawingArea<DB, Shift>, DrawingArea<DB, Shift>)

where S: SizeDesc,

Split the drawing area vertically

pub fn split_horizontally<S>( &self, x: S, ) -> (DrawingArea<DB, Shift>, DrawingArea<DB, Shift>)

where S: SizeDesc,

Split the drawing area horizontally

pub fn split_evenly(&self, _: (usize, usize)) -> Vec<DrawingArea<DB, Shift>>

Split the drawing area evenly

pub fn split_by_breakpoints<XSize, YSize, XS, YS>( &self, xs: XS, ys: YS, ) -> Vec<DrawingArea<DB, Shift>>

where XSize: SizeDesc, YSize: SizeDesc, XS: AsRef<[XSize]>, YS: AsRef<[YSize]>,

Split the drawing area into a grid with specified breakpoints on both X axis and Y axis

pub fn titled<'a, S>( &self, text: &str, style: S, ) -> Result<DrawingArea<DB, Shift>, DrawingAreaErrorKind<<DB as DrawingBackend>::ErrorType>>

where S: Into<TextStyle<'a>>,

Draw a title of the drawing area and return the remaining drawing area

pub fn draw_text( &self, text: &str, style: &TextStyle<'_>, pos: (i32, i32), ) -> Result<(), DrawingAreaErrorKind<<DB as DrawingBackend>::ErrorType>>

Draw text on the drawing area

pub fn as_coord_spec(&self) -> &CT

Returns the coordinates by reference

Trait Implementations

impl<'a> Drop for PlottersDrawingArea<'a>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> Deref for PlottersDrawingArea<'a>

type Target = DrawingArea<&'a PlottersBackend, Shift>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.