Struct HeatMap 

pub struct HeatMap {
    pub traces: Vec<Box<dyn Trace + 'static>>,
    pub layout: Layout,
}

A structure representing a heat map.

The HeatMap struct enables the creation of heat map visualizations with options for color scaling, axis customization, legend adjustments, and data value formatting. Users can customize the color scale, adjust the color bar, and set titles for the plot and axes, as well as format ticks and scales for improved data readability.

Arguments

• data - A reference to the DataFrame containing the data to be plotted.
• x - A string slice specifying the column name for x-axis values.
• y - A string slice specifying the column name for y-axis values.
• z - A string slice specifying the column name for z-axis values, which are represented by the color intensity.
• auto_color_scale - An optional boolean for enabling automatic color scaling based on data.
• color_bar - An optional reference to a ColorBar struct for customizing the color bar appearance.
• color_scale - An optional Palette enum for specifying the color scale (e.g., Viridis).
• reverse_scale - An optional boolean to reverse the color scale direction.
• show_scale - An optional boolean to display the color scale on the plot.
• plot_title - An optional Text struct for setting the title of the plot.
• x_title - An optional Text struct for labeling the x-axis.
• y_title - An optional Text struct for labeling the y-axis.
• x_axis - An optional reference to an Axis struct for customizing x-axis appearance.
• y_axis - An optional reference to an Axis struct for customizing y-axis appearance.

Example

use polars::prelude::*;
use plotlars::{ColorBar, HeatMap, Palette, Plot, Text, ValueExponent};

let dataset = LazyCsvReader::new(PlPath::new("data/heatmap.csv"))
    .finish()
    .unwrap()
    .collect()
    .unwrap();

HeatMap::builder()
    .data(&dataset)
    .x("x")
    .y("y")
    .z("z")
    .color_bar(
        &ColorBar::new()
            .length(290)
            .value_exponent(ValueExponent::None)
            .separate_thousands(true)
            .tick_length(5)
            .tick_step(2500.0)
    )
    .plot_title(
        Text::from("Heat Map")
            .font("Arial")
            .size(18)
    )
    .color_scale(Palette::Viridis)
    .build()
    .plot();

Fields

traces: Vec<Box<dyn Trace + 'static>>

layout: Layout

Implementations

impl HeatMap

pub fn builder<'f1, 'f2, 'f3, 'f4, 'f5, 'f6, 'f7>() -> HeatMapBuilder<'f1, 'f2, 'f3, 'f4, 'f5, 'f6, 'f7>

Examples found in repository

examples/heatmap.rs (line 12)

fn main() {
    let dataset = LazyCsvReader::new(PlPath::new("data/heatmap.csv"))
        .finish()
        .unwrap()
        .collect()
        .unwrap();

    HeatMap::builder()
        .data(&dataset)
        .x("x")
        .y("y")
        .z("z")
        .color_bar(
            &ColorBar::new()
                .length(290)
                .value_exponent(ValueExponent::None)
                .separate_thousands(true)
                .tick_length(5)
                .tick_step(2500.0),
        )
        .plot_title(Text::from("Heat Map").font("Arial").size(18))
        .color_scale(Palette::Viridis)
        .build()
        .plot();
}

Trait Implementations

impl Clone for HeatMap

fn clone(&self) -> HeatMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Serialize for HeatMap

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.