Struct Canvas

pub struct Canvas { /* private fields */ }

Canvas

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).

Implementations

impl Canvas

pub fn foreground(self, fg: Color) -> Self

pub fn background(self, bg: Color) -> Self

pub fn borders(self, b: Borders) -> Self

pub fn title<S: Into<String>>(self, t: S, a: Alignment) -> Self

pub fn data(self, data: &[Shape]) -> Self

pub fn x_bounds(self, bounds: (f64, f64)) -> Self

From https://github.com/fdehau/tui-rs/issues/286:

Those are used to define the viewport of the canvas. Only the points whose coordinates are within the viewport are displayed. When you render the canvas using Frame::render_widget, you give an area to draw the widget to (a Rect) and the crate translates the floating point coordinates to those used by our internal terminal representation.

pub fn y_bounds(self, bounds: (f64, f64)) -> Self

From https://github.com/fdehau/tui-rs/issues/286:

Those are used to define the viewport of the canvas. Only the points whose coordinates are within the viewport are displayed. When you render the canvas using Frame::render_widget, you give an area to draw the widget to (a Rect) and the crate translates the floating point coordinates to those used by our internal terminal representation.

pub fn marker(self, marker: Marker) -> Self

Set marker to use to draw on canvas

Trait Implementations

impl Default for Canvas

fn default() -> Canvas

Returns the “default value” for a type.

impl MockComponent for Canvas

fn view(&mut self, render: &mut Frame<'_>, area: Rect)

Based on the current properties and states, renders the component in the provided area frame. Render can also mutate the component state if this is required

fn query(&self, attr: Attribute) -> Option<AttrValue>

Query attribute of component properties.

fn attr(&mut self, attr: Attribute, value: AttrValue)

Set attribute to properties. query describes the name, while attr the value it’ll take

fn state(&self) -> State

Get current state from component

fn perform(&mut self, _cmd: Cmd) -> CmdResult

Perform a command on the component. The command will may change the component state. The method returns the result of the command applied (what changed if any)