Struct tui::widgets::canvas::Canvas

pub struct Canvas<'a, F> where
    F: Fn(&mut Context),  { /* fields omitted */ }

The Canvas widget may be used to draw more detailed figures using braille patterns (each cell can have a braille character in 8 different positions).

Examples

Canvas::default()
    .block(Block::default().title("Canvas").borders(Borders::ALL))
    .x_bounds([-180.0, 180.0])
    .y_bounds([-90.0, 90.0])
    .paint(|ctx| {
        ctx.draw(&Map{
            resolution: MapResolution::High,
            color: Color::White
        });
        ctx.layer();
        ctx.draw(&Line{
            x1: 0.0,
            y1: 10.0,
            x2: 10.0,
            y2: 10.0,
            color: Color::White,
        });
        ctx.draw(&Line{
            x1: 10.0,
            y1: 10.0,
            x2: 20.0,
            y2: 20.0,
            color: Color::Red
        });
    });

Methods

impl<'a, F> Canvas<'a, F> where     F: Fn(&mut Context),

pub fn block(self, block: Block<'a>) -> Canvas<'a, F>

pub fn x_bounds(self, bounds: [f64; 2]) -> Canvas<'a, F>

pub fn y_bounds(self, bounds: [f64; 2]) -> Canvas<'a, F>

pub fn paint(self, f: F) -> Canvas<'a, F>

Store the closure that will be used to draw to the Canvas

pub fn background_color(self, color: Color) -> Canvas<'a, F>

Trait Implementations

impl<'a, F> Default for Canvas<'a, F> where     F: Fn(&mut Context),

fn default() -> Canvas<'a, F>

Returns the "default value" for a type.

impl<'a, F> Widget for Canvas<'a, F> where     F: Fn(&mut Context),

fn draw(&mut self, area: Rect, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That the only method required to implement a custom widget.

fn background(&self, area: &Rect, buf: &mut Buffer, color: Color)

Helper method to quickly set the background of all cells inside the specified area.

fn render<B>(&mut self, f: &mut Frame<B>, area: Rect) where     Self: Sized,     B: Backend,

Helper method that can be chained with a widget's builder methods to render it.