Struct plotters::drawing::CanvasBackend

pub struct CanvasBackend { /* fields omitted */ }

The backend that is drawing on the HTML canvas TODO: Support double bufferring

Methods

impl CanvasBackend

pub fn new(elem_id: &str) -> Option<Self>

Create a new drawing backend backed with an HTML5 canvas object

• elem_id The element id for the canvas
• Return either some drawing backend has been created, or none in error case

Trait Implementations

impl DrawingBackend for CanvasBackend

type ErrorType = CanvasError

The error type reported by the backend

fn get_size(&self) -> (u32, u32)

Get the dimension of the drawing backend in pixel

fn ensure_prepared(&mut self) -> Result<(), DrawingErrorKind<CanvasError>>

Ensure the backend is ready to draw

fn present(&mut self) -> Result<(), DrawingErrorKind<CanvasError>>

Finialize the drawing step and present all the changes. This is used as the real-time rendering support. The backend may implement in the following way, when ensure_prepared is called it checks if it needs a fresh buffer and present is called rendering all the pending changes on the screen.

fn draw_pixel(
    &mut self,
    point: BackendCoord,
    style: &RGBAColor
) -> Result<(), DrawingErrorKind<CanvasError>>

Draw a pixel on the drawing backend - point: The backend pixel-based coordinate to draw - color: The color of the pixel

fn draw_line<S: BackendStyle>(
    &mut self,
    from: BackendCoord,
    to: BackendCoord,
    style: &S
) -> Result<(), DrawingErrorKind<Self::ErrorType>>

Draw a line on the drawing backend - from: The start point of the line - to: The end point of the line - style: The style of the line

fn draw_rect<S: BackendStyle>(
    &mut self,
    upper_left: BackendCoord,
    bottom_right: BackendCoord,
    style: &S,
    fill: bool
) -> Result<(), DrawingErrorKind<Self::ErrorType>>

Draw a rectangle on the drawing backend - upper_left: The coordinate of the upper-left corner of the rect - bottom_right: The coordinate of the bottom-right corner of the rect - style: The style - fill: If the rectangle should be filled

fn draw_path<S: BackendStyle, I: IntoIterator<Item = BackendCoord>>(
    &mut self,
    path: I,
    style: &S
) -> Result<(), DrawingErrorKind<Self::ErrorType>>

Draw a path on the drawing backend - path: The iterator of key points of the path - style: The style of the path

fn draw_circle<S: BackendStyle>(
    &mut self,
    center: BackendCoord,
    radius: u32,
    style: &S,
    fill: bool
) -> Result<(), DrawingErrorKind<Self::ErrorType>>

Draw a circle on the drawing backend - center: The center coordinate of the circle - radius: The radius of the circle - style: The style of the shape - fill: If the circle should be filled

fn draw_text<'b>(
    &mut self,
    text: &str,
    font: &FontDesc<'b>,
    pos: BackendCoord,
    color: &RGBAColor
) -> Result<(), DrawingErrorKind<Self::ErrorType>>

Draw a text on the drawing backend - text: The text to draw - font: The description of the font - pos : The position backend - color: The color of the text