Struct ::exo::dom::Chart

Overview

Chart dom node.

This node is used inside a dom to display a custom chart. Supported fields of this node are:

  • id: The id of this node
  • name: The name to display
  • status: The stati where the node should be shown
  • rights: One of the rights needed to show the node
  • edit: Defines the edit state of the node
  • style: The which should be applied ot the node
  • typ: The chart visualisaton type either bar, pie or doughnut
  • collapsed: Collapse the chart panel, to save space
  • data: The data children containing the single values

Within the layouter this chart can be used like this:

<chart id="chart_123" name="Your Data" typ="doughnut" collapsed>
 <chart-data sql="SELECT count(ident) FROM user;" />
</chart>

Methods

fn new() -> Chart

Creates a new Chart.

Example

let node = exo::dom::Chart::new();
node.name = "Your Data";
node.typ = "doughnut";

Protocols

protocol partial_eq
if value == b { }

Allows for partial equality operations to work.

protocol string_debug
println("{:?}", value)

Allows the value to be debug printed.

protocol string_display
println("{}", value)

Allows the value to be display printed.

protocol get id
let output = value.id

Get the id of the node as String. A node Id should be unique inside the complete dom.

Example

let node = exo::dom::Chart::new();
node.id = "id_123456";
assert_eq!(node.id, "id_123456");
protocol set id
value.id = input

Set the id of the node as String. A node Id should be unique inside the complete dom.

Example

let node = exo::dom::Chart::new();
node.id = "id_123456";
assert_eq!(node.id, "id_123456");
protocol get name
let output = value.name

Get the name of the node as String. The name is used to display a title or main text.

Example

let node = exo::dom::Chart::new();
node.name = "Click Here";
assert_eq!(node.name, "Click Here");
protocol set name
value.name = input

Get the name of the node as String. The name is used to display a title or main text.

Example

let node = exo::dom::Chart::new();
node.name = "Click Here";
assert_eq!(node.name, "Click Here");
protocol get status
let output = value.status

Get the different status of the node as Vec<String>. This node and all it's child will only be displayed, when no status is set or the record has any of the given stati.

Example

let node = exo::dom::Chart::new();
node.status = ["new", "released"];
assert!(node.status.iter().any(|s| s == "new"));
protocol set status
value.status = input

Set the status of the node as Vec<String>. This node and all it's child will only be displayed, when no status is set or the record has any of the given stati.

Example

let node = exo::dom::Chart::new();
node.status = ["new", "released"];
assert!(node.status.iter().any(|s| s == "new"));
protocol get edit
let output = value.edit

Get the edit status of the node as Option<bool>. The edit mode can be set as true or false. When the edit mode is not set, it takes the system edit state.

Example

let node = exo::dom::Chart::new();
node.edit = Some(false);
assert_eq!(node.edit, Some(false));
protocol set edit
value.edit = input

Set the edit status of the node as Option<bool>. The edit mode can be set as true or false. When the edit mode is not set, it takes the system edit state.

Example

let node = exo::dom::Chart::new();
node.edit = Some(false);
assert_eq!(node.edit, Some(false));
protocol get style
let output = value.style

Get the style of the node as String.

Example

let node = exo::dom::Chart::new();
node.style = "color: red;";
assert_eq!(node.style, "color: red;");
protocol set style
value.style = input

Set the style of the node as String.

Example

let node = exo::dom::Chart::new();
node.style = "color: red;";
assert_eq!(node.style, "color: red;");
protocol get rights
let output = value.rights

Get the different rights of the node as Vec<String>. This node and all it's child will only be displayed, when no rights are set or the user has one of the rights.

Example

let node = exo::dom::Chart::new();
node.rights = ["user_right", "can_release"];
assert!(node.rights.iter().any(|s| s == "can_release"));
protocol set rights
value.rights = input

Get the different rights of the node as Vec<String>. This node and all it's child will only be displayed, when no rights are set or the user has one of the rights.

Example

let node = exo::dom::Chart::new();
node.rights = ["user_right", "can_release"];
assert!(node.rights.iter().any(|s| s == "can_release"));
protocol get typ
let output = value.typ

Get the chart typ.

Example

let node = exo::dom::Chart::new();
node.typ = "bar";
assert_eq!(node.typ, "bar");
protocol set typ
value.typ = input

Set the chart typ.

Example

let node = exo::dom::Chart::new();
node.typ = "bar";
assert_eq!(node.typ, "bar");
protocol get collapsed
let output = value.collapsed

Get the collapsed status.

Example

let node = exo::dom::Chart::new();
node.collapsed = true;
assert_eq!(node.collapsed, true);
protocol set collapsed
value.collapsed = input

Set the collapsed status.

Example

let node = exo::dom::Chart::new();
node.collapsed = true;
assert_eq!(node.collapsed, true);
protocol get data
let output = value.data

Get the data entries of the chart.

Example

let node = exo::dom::Chart::new();
node.data = [exo::dom::ChartData::new()];
assert!(node.data.iter().any(|d| d == exo::dom::ChartData::new()));
protocol set data
value.data = input

Set the data entries of the chart.

Example

let node = exo::dom::Chart::new();
node.data = [exo::dom::ChartData::new()];
assert!(node.data.iter().any(|d| d == exo::dom::ChartData::new()));