Struct napchart::Napchart

pub struct Napchart {
    pub title: Option<String>,
    pub description: Option<String>,
    pub shape: ChartShape,
    pub lanes: Vec<ChartLane>,
    pub color_tags: HashMap<String, String>,
    // some fields omitted
}

A napchart, as seen on https://napchart.com/

Fields

title: Option<String>

description: Option<String>

shape: ChartShape

lanes: Vec<ChartLane>

A vector of all the lanes in the chart. In circular and wide charts, lane 0 is the innermost and smallest. In line charts, lane 0 is at the bottom.

color_tags: HashMap<String, String>

Keys are simple html color names, values are the associated tag.

Implementations

impl Napchart

pub fn get_id(&self) -> Option<&String>

Get the napchart.com ID of this chart, if set. This is set by the “get” and “create_new” api functions.
The ID directly gives you the URL to the napchart, as in https://napchart.com/idcode.

pub fn add_lane(&mut self) -> &mut ChartLane

Append a new blank lane to the chart and returns a mutable reference to it.

pub fn get_lane_mut(&mut self, i: usize) -> Option<&mut ChartLane>

Get a mutable reference to the given lane

impl Napchart

Builder functions to create new napcharts.

let chart = Napchart::default()
                .title("Title1")
                .description("Cool Chart")
                .lanes(3);
assert_eq!(chart.title, Some("Title1".to_string()));
assert_eq!(chart.description, Some("Cool Chart".to_string()));
assert_eq!(chart.lanes.len(), 3);

pub fn title<'a, T: Into<&'a str>>(self, title: T) -> Self

Return Napchart with title set

pub fn description<'a, T: Into<&'a str>>(self, description: T) -> Self

Return Napchart with description set

pub fn shape(self, shape: ChartShape) -> Self

Return Napchart with shape set

pub fn lanes(self, count: usize) -> Self

Return Napchart with a given number of empty lanes

Trait Implementations

impl Clone for Napchart

fn clone(&self) -> Napchart

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Napchart

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Napchart

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<Napchart> for Napchart

fn eq(&self, other: &Napchart) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Napchart) -> bool

This method tests for !=.

impl StructuralPartialEq for Napchart