Struct Canvas 

pub struct Canvas { /* private fields */ }

The Canvas component 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

Note that setting this value has no effect.

If you want to set the border color, use borders. If you want to set some point in the canvas, set it in the data.

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

Set the main background color. This may get overwritten by individual text styles.

pub fn modifiers(self, m: TextModifiers) -> Self

Set the main text modifiers. This may get overwritten by individual text styles.

pub fn style(self, style: Style) -> Self

Set the main style. This may get overwritten by individual text styles.

This option will overwrite any previous foreground, background and modifiers!

pub fn inactive(self, s: Style) -> Self

Set a custom style for the border when the component is unfocused.

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

Add a border to the component.

pub fn title<T: Into<Title>>(self, title: T) -> Self

Add a title to the component.

pub fn data(self, data: impl IntoIterator<Item = Shape>) -> Self

Set the initial data to display on the Canvas.

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

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.

From https://github.com/fdehau/tui-rs/issues/286, also read Canvas::x_bounds.

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

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.

From https://github.com/fdehau/tui-rs/issues/286, also read Canvas::y_bounds.

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

Set which kind of Marker type should be used for a point.

Trait Implementations

impl Component 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<'a>(&'a self, attr: Attribute) -> Option<QueryResult<'a>>

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)

impl Default for Canvas

fn default() -> Canvas

Returns the “default value” for a type.