Struct Axis

pub struct Axis { /* private fields */ }

Axis

An axis is a reference source for the plot.

Implementations

impl Axis

pub fn new() -> Axis

pub fn from_coord(start: Coord, end: Coord) -> Axis

pub fn set_color(&mut self, color: Rgba)

Set the axis color

pub fn set_color_rgb(&mut self, red: f32, green: f32, blue: f32)

Set the axis color

pub fn set_color_rgba(&mut self, red: f32, green: f32, blue: f32, alpha: f32)

Set the axis color

pub fn set_line_width(&mut self, val: f64)

pub fn set_label(&mut self, content: &str)

pub fn set_label_angle(&mut self, angle: f64)

pub fn set_num_ticks(&mut self, val: usize)

pub fn set_positive_tick_length(&mut self, val: f64)

pub fn set_negative_tick_length(&mut self, val: f64)

pub fn set_tick_font_size(&mut self, val: f64)

pub fn set_tick_label_offset(&mut self, hor: f64, ver: f64)

pub fn set_data_range(&mut self, data_min: f64, data_max: f64)

pub fn set_label_offset(&mut self, hor: f64, ver: f64)

pub fn scale_label_offset(&mut self, factor: f64)

pub fn scale_tick_label_offset(&mut self, factor: f64)

pub fn data_min(&self) -> f64

pub fn data_max(&self) -> f64

pub fn mark_coords(&self) -> Vec<Coord>

pub fn compute_marks(&mut self) -> Result<(), Error>

Compute marks

Marks are used to determine the location of ticks and gridlines.

This method will return a list of evenly spaced marks according to the following method. This assumes that the data range is known, and that know how many marks we want. The latter is determined by a variable, and will be used more of a guide than as the actual number of marks we get in the end.

Method

1. Find the orider of magnitude of the difference in the data range. Call this p. 2a. Let min_point be min(data) rounded down to nearest 10^(p - 2). 2b. Let max_point be max(data) rounded up to nearest 10^(p - 2).
2. mark_distance = (max_point - min_point) / num_labels rounded to nearest 10^(p - 2)
3. Then, let mark_k = min_point + k*mark_distance, for k = 0 until mark_k is greater or equal to max(data).
4. Transform between labels in the data framework (the above) and positions in the drawing framework using the data range and axis frame.

• The user can now set data range, but this function will override it. With this, the output looks nicer, but I assume that when the user puts a data range, the user assumes that this range should be used.

pub fn fit(&mut self, canvas_frame: &Frame)

Fit

This function is called just before draw(), and updates the default w.r.t. user input. and changes above in the hierarchy (canvas -> plot -> figure).

pub fn draw(&self, cr: &Context, fig_rel_height: f64, fig_rel_width: f64)

Draw axis on canvas.

Trait Implementations

impl Clone for Axis

fn clone(&self) -> Axis

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Axis

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

Formats the value using the given formatter.