Struct GraphOptions 

pub struct GraphOptions {
    pub canvas_size: CanvasPoint<u16>,
    pub center: GraphPoint<f64>,
    pub scale: GraphPoint<f64>,
    pub square_scale: bool,
    pub label_canvas_boundaries: bool,
    pub major_grid_spacing: GraphPoint<f64>,
    pub major_grid_divisions: (u8, u8),
    pub major_grid_opacity: f64,
    pub minor_grid_opacity: f64,
}

Options to use when drawing a graph.

Fields

canvas_size: CanvasPoint<u16>

The width and height of the canvas, in pixels.

The default value is (1000, 1000).

center: GraphPoint<f64>

The (x, y) point at which to center the graph.

For example, to place the origin at the center of the output image, set this to (0.0, 0.0).

This field will automatically be computed when calling Graph::center_on_points.

The default value is (0.0, 0.0).

scale: GraphPoint<f64>

The (x, y) scale of the graph.

The scale indicates the distance, in graph units, from the center of the canvas to the edge of the canvas. For example, when the graph is centered at (0.0, 0.0) with a scale of (10.0, 10.0), the visible graph will be from (x, y): (-10.0, -10.0) to (x, y): (10.0, 10.0).

This field will automatically be computed when calling Graph::center_on_points.

The default value is (10.0, 10.0).

square_scale: bool

When calling Graph::center_on_points, determines whether to scale the x- and y-axes together (resulting in a square graph) or independently (resulting in a rectangular graph).

The default value is false.

label_canvas_boundaries: bool

Whether to label the canvas boundaries with their corresponding graph values.

The default value is false.

major_grid_spacing: GraphPoint<f64>

The number of graph units between each major grid line, given as a pair of (x, y) units.

For example, to have a major grid line every 3.0 units on the x-axis and every 2.0 units on the y-axis, set this to (3.0, 2.0).

This field will automatically be computed when calling Graph::center_on_points.

The default value is (2.0, 2.0).

major_grid_divisions: (u8, u8)

The number of spaces to divide each major grid line into, given as a pair of (x, y) units. The number of minor grid lines between each major grid line will then be x - 1 on the x-axis, and y - 1 on the y-axis.

For example, to divide each major grid line into 5 spaces on the x-axis (4 minor grid lines) and 4 spaces on the y-axis (3 minor grid lines), set this to (5, 4).

This field will automatically be computed when calling Graph::center_on_points.

The default value is (4, 4).

major_grid_opacity: f64

The opacity of the major grid lines, given as a value in the range 0.0 to 1.0, where 0.0 is fully transparent and 1.0 is fully opaque. This also affects the opacity of the major grid line numbers.

The default value is 0.8.

minor_grid_opacity: f64

The opacity of the minor grid lines, given as a value in the range 0.0 to 1.0, where 0.0 is fully transparent and 1.0 is fully opaque.

The default value is 0.5.

Implementations

impl GraphOptions

pub fn canvas_size(self, width: u16, height: u16) -> Self

Set the canvas size. Returns an updated GraphOptions for chaining.

pub fn center(self, x: f64, y: f64) -> Self

Set the center of the graph. Returns an updated GraphOptions for chaining.

pub fn scale(self, x: f64, y: f64) -> Self

Set the scale of the graph. Returns an updated GraphOptions for chaining.

pub fn square_scale(self, square_scale: bool) -> Self

Set whether to scale the x- and y-axes together. Returns an updated GraphOptions for chaining.

pub fn label_canvas_boundaries(self, label_canvas_boundaries: bool) -> Self

Set whether to label the canvas boundaries with their corresponding graph values. Returns an updated GraphOptions for chaining.

pub fn major_grid_spacing(self, x: f64, y: f64) -> Self

Set the number of graph units between each major grid line. Returns an updated GraphOptions for chaining.

pub fn major_grid_divisions(self, x: u8, y: u8) -> Self

Set the number of spaces to divide each major grid line into. Returns an updated GraphOptions for chaining.

pub fn major_grid_opacity(self, major_grid_opacity: f64) -> Self

Set the opacity of the major grid lines. Returns an updated GraphOptions for chaining.

pub fn minor_grid_opacity(self, minor_grid_opacity: f64) -> Self

Set the opacity of the minor grid lines. Returns an updated GraphOptions for chaining.

impl GraphOptions

pub fn to_canvas(&self, point: GraphPoint<f64>) -> CanvasPoint<f64>

Converts a point in graph space to canvas space.

pub fn to_graph(&self, point: CanvasPoint<f64>) -> GraphPoint<f64>

Converts a point in canvas space to graph space.

Trait Implementations

impl Clone for GraphOptions

fn clone(&self) -> GraphOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GraphOptions

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

Formats the value using the given formatter.

impl Default for GraphOptions

The default options for a graph. Returns a GraphOptions with the following values:

• canvas_size: (1000, 1000)
• center: (0.0, 0.0)
• scale: (10.0, 10.0)
• square_scale: false
• label_canvas_boundaries: false
• major_grid_spacing: (2.0, 2.0)
• major_grid_divisions: (4, 4)

fn default() -> GraphOptions

Returns the “default value” for a type.

impl Copy for GraphOptions