Struct DensityPlotOptions 

pub struct DensityPlotOptions {
    pub base: BasePlotOptions,
    pub x_axis: AxisOptions,
    pub y_axis: AxisOptions,
    pub colormap: ColorMaps,
    pub plot_type: PlotType,
    pub point_size: f32,
    pub contour_line_thickness: f32,
    pub contour_level_count: u32,
    pub contour_smoothing: f64,
    pub draw_outliers: bool,
    pub gate_colors: Vec<(u8, u8, u8)>,
    pub z_range: Option<(f32, f32)>,
}

Options for density plots

Configuration for creating density plots, including base layout options, axis configurations, and color map selection.

Example

use flow_plots::options::{DensityPlotOptions, BasePlotOptions};
use flow_plots::colormap::ColorMaps;

let options = DensityPlotOptions::new()
    .base(BasePlotOptions::new().width(800u32).height(600u32).build()?)
    .colormap(ColorMaps::Viridis)
    .build()?;

@deprecated The old PlotOptions struct has been removed. Use DensityPlotOptions with builder pattern instead.

Fields

base: BasePlotOptions

Base plot options (layout, dimensions, etc.)

x_axis: AxisOptions

X-axis configuration

y_axis: AxisOptions

Y-axis configuration

colormap: ColorMaps

Color map to use for density visualization

plot_type: PlotType

Plot type (density, scatter, contour, etc.)

point_size: f32

Point size in pixels for scatter and density plots (0.1–4.0). For scatter: radius of each point; values below 0.5 draw single-pixel dots. For density: radius of each point’s contribution to the heatmap.

contour_line_thickness: f32

Contour line thickness in pixels (when plot_type is Contour)

contour_level_count: u32

Number of contour levels (when plot_type is Contour)

contour_smoothing: f64

KDE bandwidth adjustment factor (when plot_type is Contour). Higher values = more smoothing. Default 1.0. Typical range 0.5–2.0.

draw_outliers: bool

Draw scatter points outside contour regions as outliers (when plot_type is Contour)

gate_colors: Vec<(u8, u8, u8)>

Colors for discrete gate overlay (ScatterOverlay, ContourOverlay). gate_ids in data index into this slice. Default palette used if empty.

z_range: Option<(f32, f32)>

Z-axis range for continuous coloring (ScatterColoredContinuous). If None, min/max of z_values is used.

Implementations

impl DensityPlotOptions

pub fn new() -> DensityPlotOptionsBuilder

Create a new builder for DensityPlotOptions

Trait Implementations

impl Clone for DensityPlotOptions

fn clone(&self) -> DensityPlotOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DensityPlotOptions

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

Formats the value using the given formatter.

impl Default for DensityPlotOptions

fn default() -> Self

Returns the “default value” for a type.

impl PlotOptions for DensityPlotOptions

fn base(&self) -> &BasePlotOptions

Get a reference to the base plot options