Struct Color 

pub struct Color { /* private fields */ }

Color.

Constructors from color representations

From	Constructor
RGB	Color::rgb
RGBA	Color::rgba
Named Color	Color::named
Hexadecimal Literal	Color::hex_literal
Hexadecimal String	Color::hex_str

Default constructor

Color::default constructs a color with RGB values of 0, 0, 0 (black) and an alpha value of 1.0 (opaque).

Other methods

Method	Description
Color::alpha	Set the opacity/transparency of the color.
Color::to_plotly_rgba	Convert the color to an Rgba from the plotly crate.

Implementations

impl Color

pub fn rgb(r: u8, g: u8, b: u8) -> Color

Construct a color from RGB (red, green, blue) values.

Arguments

• r - Red component.
• g - Green component.
• b - Blue component.

Returns

Color.

pub fn rgba(r: u8, g: u8, b: u8, a: f64) -> Color

Construct a color from RGBA (red, green, blue, alpha) values.

Arguments

• r - Red component.
• g - Green component.
• b - Blue component.
• a - Alpha (opacity) between 0 (transparent) and 1 (opaque). Inputs outside the range [0, 1] are clamped.

Returns

Color.

pub fn named(color: NamedColor) -> Color

Construct a color from a named color.

Arguments

• color - Named color.

Returns.

Color.

Examples found in repository

examples/general_2d_plot.rs (line 8)

fn main() {
    // Define the traces.
    let trace_1 = Trace::new_2d([1.0, 2.0, 3.0], [1.0, 2.0, 3.0])
        .name("y = x")
        .line_color(Color::named(NamedColor::Red))
        .line_width(2.0)
        .line_style(LineStyle::Dash);
    let trace_2 = Trace::new_2d([1.0, 2.0, 3.0], [1.0, 4.0, 9.0])
        .name("y = x^2")
        .line_color(Color::named(NamedColor::Blue))
        .line_width(2.0)
        .line_style(LineStyle::Dot);

    // Figure formatting.
    let format: Format = FormatBuilder::default()
        .title("y vs. x")
        .x_label("x")
        .y_label("y")
        .width(800)
        .height(600)
        .build()
        .unwrap();

    // Create the figure.
    let fig = Figure::new(vec![trace_1, trace_2], format);

    // Save the figure so it can be displayed right below this example.
    fig.save_inline_html(Path::new("book/src/figures/general_2d_plot.html"));

    // Alternatively, you can show the figure in a web browser.
    // fig.show();
}

examples/general_3d_plot.rs (line 8)

fn main() {
    // Define the traces.
    let trace_1 = Trace::new_3d([1.0, 2.0, 5.0], [1.0, 2.0, 3.0], [1.0, 2.0, 4.0])
        .name("Trace 1")
        .line_color(Color::named(NamedColor::Red))
        .line_width(2.0)
        .line_style(LineStyle::Dash);
    let trace_2 = Trace::new_3d([1.0, 2.0, 5.0], [3.0, 2.0, 1.0], [1.0, 2.0, 4.0])
        .name("Trace 2")
        .line_color(Color::named(NamedColor::Blue))
        .line_width(2.0)
        .line_style(LineStyle::Dot);

    // Figure formatting.
    let format: Format = FormatBuilder::default()
        .title("z vs. x and y")
        .x_label("x")
        .y_label("y")
        .z_label("z")
        .width(800)
        .height(600)
        .build()
        .unwrap();

    // Create the figure.
    let fig = Figure::new(vec![trace_1, trace_2], format);

    // Save the figure so it can be displayed right below this example.
    fig.save_inline_html(Path::new("book/src/figures/general_3d_plot.html"));

    // Alternatively, you can show the figure in a web browser.
    // fig.show();
}

pub fn hex_literal(color: u32) -> Color

Construct a color from a hexadecimal literal.

Arguments

• color - Hexadecimal literal representing a color.

Returns

Color.

Note

If color is outside the valid RGB range (e.g. color > 0xFFFFFF), then the default color is returned.

References

• [1] https://stackoverflow.com/questions/25004621/how-to-convert-returned-int-value-from-colordrawables-getcolor-to-rgb/25004682

pub fn hex_str(color: &str) -> Color

Construct a color from a hexadecimal string.

Arguments

• color - Hexadecimal string representing a color.

Returns

Color.

Note

If color is outside the valid RGB range (e.g. `color > “#FFFFFF”), then the default color is returned.

pub fn alpha(self, a: f64) -> Color

Set the opacity/transparency of the color.

Arguments

• a - Alpha (opacity) between 0 (transparent) and 1 (opaque). Inputs outside the range [0, 1] are clamped.

Returns

Color with the opacity set.

pub fn to_plotly_rgba(&self) -> Rgba

Convert the color to an Rgba from the plotly crate.

Returns

This color as an Rgba from the plotly crate.

Trait Implementations

impl Debug for Color

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

Formats the value using the given formatter.

impl Default for Color

fn default() -> Self

Default constructor.

Returns

Default-constructed color (black).

Example

use plotting::{Color, NamedColor};

let color = Color::default();

assert_eq!(color, Color::named(NamedColor::Black))

impl PartialEq for Color

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Color