Struct DerivedColorMap

pub struct DerivedColorMap<ColorType> { /* private fields */ }

This struct is used to dynamically construct colormaps by giving it a slice of colors. It can then be used when being intantiated, but not with associated functions.

use plotters::prelude::{BLACK,BLUE,WHITE,DerivedColorMap,ColorMap};

let derived_colormap = DerivedColorMap::new(
    &[BLACK,
    BLUE,
    WHITE]
);

assert_eq!(derived_colormap.get_color(0.0), BLACK);
assert_eq!(derived_colormap.get_color(0.5), BLUE);
assert_eq!(derived_colormap.get_color(1.0), WHITE);

Implementations

impl<ColorType> DerivedColorMap<ColorType>

where ColorType: Color + Clone,

pub fn new(colors: &[ColorType]) -> DerivedColorMap<ColorType>

This function lets the user define a new colormap by simply specifying colors in the correct order. For calculation of the color values, the colors will be spaced evenly apart.

Trait Implementations

impl<FloatType> ColorMap<HSLColor, FloatType> for DerivedColorMap<HSLColor>

where FloatType: Float + FromPrimitive + ToPrimitive,

fn get_color_normalized( &self, h: FloatType, min: FloatType, max: FloatType, ) -> HSLColor

A slight abstraction over get_color function where lower and upper bound can be specified.

fn get_color(&self, h: FloatType) -> ColorType

Takes a scalar value 0.0 <= h <= 1.0 and returns the corresponding color. Typically color-scales are named according to which color-type they return. To use upper and lower bounds with this function see get_color_normalized.

impl<FloatType> ColorMap<RGBAColor, FloatType> for DerivedColorMap<RGBAColor>

where FloatType: Float + FromPrimitive + ToPrimitive,

fn get_color_normalized( &self, h: FloatType, min: FloatType, max: FloatType, ) -> RGBAColor

A slight abstraction over get_color function where lower and upper bound can be specified.

fn get_color(&self, h: FloatType) -> ColorType

Takes a scalar value 0.0 <= h <= 1.0 and returns the corresponding color. Typically color-scales are named according to which color-type they return. To use upper and lower bounds with this function see get_color_normalized.

impl<FloatType> ColorMap<RGBColor, FloatType> for DerivedColorMap<RGBColor>

where FloatType: Float + FromPrimitive + ToPrimitive,

fn get_color_normalized( &self, h: FloatType, min: FloatType, max: FloatType, ) -> RGBColor

A slight abstraction over get_color function where lower and upper bound can be specified.

fn get_color(&self, h: FloatType) -> ColorType

Takes a scalar value 0.0 <= h <= 1.0 and returns the corresponding color. Typically color-scales are named according to which color-type they return. To use upper and lower bounds with this function see get_color_normalized.