Reference Canvas

The canvas is a widget that allows custom content. It can load its graphic content from a text file, or it can be set programmatically.

Properties

from_file

File path to a text file from which to load visual context. Empty string means don't load from file. The file content will be merged into your binary, so you do not need to ship the text file with your binary. The file path you use must be relative to the folder specified in your EZ_FOLDER environment variable.

Property type:

String

Possible values:

Any valid file path.

Default value:

Empty string.

Usage examples:

In EzLang files:

- Canvas:
    from_file: ./canvas_content.txt

In code:

use ez_term::*;
let (root_widget, mut state_tree, mut scheduler) = load_ui();
let state = state_tree.get_mut("my_canvas").as_canvas_mut();

state.set_from_file("./canvas_content.txt");

run(root_widget, state_tree, scheduler);

Setting content from code

The alternative to loading content from a text file is setting content from code. You have to manually create the pixels and use them to construct a PixelMap (Vec<Vec>) Here is an example to create a square like this:

S S S
S S S
S S S

The code:

use ez_term::*;
let (root_widget, mut state_tree, mut scheduler) = load_ui();
let state = state_tree.get_mut("my_canvas").as_canvas_mut();

// We create a single pixel
let pixel = Pixel::new("S".to_string(), Color::White, Color::Black);

// We create a row of three pixels
let row = vec!(pixel.clone(); 3);

// We create a pixelmap of three rows (we now have a square)
let content = vec!(row.clone(); 3);

state.set_contents(content);

run(root_widget, state_tree, scheduler);