Struct Plot 

#[non_exhaustive]
pub struct Plot<G: GraphicsArea> { /* private fields */ }

A complete plot: graphics area, annotations, border, title, and axis labels.

Plot owns its graphics and carries all metadata needed for rendering. Use the free-standing constructors (barplot, lineplot, etc.) to create plots, then call render to write output.

Implementations

impl<G: GraphicsArea> Plot<G>

pub const DEFAULT_MARGIN: u16 = 3

Default left margin (in characters) between the terminal edge and labels.

pub const DEFAULT_PADDING: u16 = 1

Default padding (in characters) between labels and the plot border.

pub fn new(graphics: G) -> Self

Creates a new plot wrapping the given graphics area with default settings.

pub fn annotate_left( &mut self, row: usize, text: impl Into<String>, color: Option<TermColor>, )

Adds or replaces a labeled annotation on the left side of the plot body.

Pass None for color to use the terminal’s default foreground color.

pub fn annotate_right( &mut self, row: usize, text: impl Into<String>, color: Option<TermColor>, )

Adds or replaces a labeled annotation on the right side of the plot body.

Pass None for color to use the terminal’s default foreground color.

pub fn set_decoration( &mut self, position: DecorationPosition, text: impl Into<String>, )

Sets edge decoration text at one of the six border positions.

pub fn next_color(&mut self) -> NamedColor

Returns the next color from the auto-series palette and advances the index.

pub const fn annotations(&self) -> &PlotAnnotations

Returns all annotations attached to this plot.

pub fn graphics(&self) -> &G

Returns a reference to the underlying graphics area.

pub fn graphics_mut(&mut self) -> &mut G

Returns a mutable reference to the underlying graphics area.

pub fn title(&self) -> Option<&str>

The plot title, rendered centered above the border.

pub fn xlabel(&self) -> Option<&str>

The x-axis label, rendered centered below the border.

pub fn ylabel(&self) -> Option<&str>

The y-axis label, rendered vertically along the left margin.

pub const fn border(&self) -> BorderType

The border style for this plot.

pub const fn margin(&self) -> u16

The left margin width in characters.

pub const fn padding(&self) -> u16

The padding between labels and the plot border.

pub const fn show_labels(&self) -> bool

Whether left/right row labels are rendered.

pub const fn auto_color_index(&self) -> u8

The current auto-color palette index (wraps at 6).

pub fn render(&self, writer: &mut impl Write, color: bool) -> IoResult<()>

Render this plot into the provided writer.

Errors

Returns any I/O error produced by writing to writer.

pub fn render_with_mode( &self, writer: &mut impl Write, color_mode: ColorMode, writer_is_terminal: bool, ) -> IoResult<()>

Render this plot using a ColorMode policy.

Errors

Returns any I/O error produced by writing to writer.

pub fn render_with_mode_auto<W: Write + IsTerminal>( &self, writer: &mut W, color_mode: ColorMode, ) -> IoResult<()>

Render this plot using a ColorMode policy and terminal auto-detection.

Errors

Returns any I/O error produced by writing to writer.