Struct PlotStyle 

#[non_exhaustive]
pub struct PlotStyle { /* private fields */ }

Styling options for the plot

Implementations

impl PlotStyle

pub fn with_drawing_area(self, drawing_area: impl Into<(u32, u32)>) -> Self

Set the pixel dimensions of the plot (width, height). Default is 1920x1200.

pub fn with_title(self, title: impl Into<String>) -> Self

Override the title of the plot. By default, the title is derived from the metric name and common labels.

pub fn with_utc_offset(self, offset: FixedOffset) -> Self

Set the timezone offset for timestamp labels. Default is UTC. Supports fractional-hour timezones like UTC+5:30.

pub fn with_line_width(self, width: u32) -> Self

Set the stroke width for data lines in pixels. Default is 1.

pub fn with_skip_labels(self, labels: Vec<String>) -> Self

Set label names to exclude from the legend (e.g., “job”, “instance”).

pub fn with_background(self, color: impl Into<RGBAColor>) -> Self

Set the background color of the plot. Default is white.

pub fn with_grid_color(self, color: impl Into<RGBAColor>) -> Self

Set the color of the grid lines. Default is semi-transparent gray.

pub fn with_axis_color(self, color: impl Into<RGBAColor>) -> Self

Set the color of the axis lines. Default is black.

pub fn with_text_color(self, color: impl Into<RGBAColor>) -> Self

Set the color of axis labels and legend text. Default is black.

pub fn with_text_font(self, font: impl Into<String>) -> Self

Set the font family for text. Default is “sans-serif”.

pub fn with_text_size(self, size: u32) -> Self

Set the font size for axis labels and legend in pixels. Default is 18.

pub fn with_caption_size(self, size: u32) -> Self

Set the font size for the plot title/caption in pixels. Default is 36.

pub fn with_data_colors(self, colors: Vec<RGBAColor>) -> Self

Set the colors to cycle through for data lines. If there are more series than colors, colors will repeat.

pub fn with_threshold_color(self, color: impl Into<RGBAColor>) -> Self

Set the color used to shade the threshold region in alert plots. Default is semi-transparent red.

impl PlotStyle

pub fn dark_mode(self) -> Self

Switch to a dark color scheme: black background with white text and axes.

pub fn plot_timeseries<KV, K, V>( &self, path: impl AsRef<Path>, mts: &[MetricTimeseries<KV>], plot_threshold: Option<PlotThreshold>, ) -> Result<(), Box<dyn Error + Send + Sync>>

where KV: Clone + Debug, K: Display, V: Display, for<'a> &'a KV: IntoIterator<Item = (&'a K, &'a V)>,

Plot a collection of metric timeseries data from prometheus, and possibly a “threshold” defined in an alert. Write the result to a path. The file extension of the path will determine the format, e.g. png, gif, etc.

Trait Implementations

impl Default for PlotStyle

fn default() -> Self

Returns the “default value” for a type.