Struct Axis

pub struct Axis<'a> { /* private fields */ }

An X or Y axis for the Chart widget

An axis can have a title which will be displayed at the end of the axis. For an X axis this is the right, for a Y axis, this is the top.

You can also set the bounds and labels on this axis using respectively Axis::bounds and Axis::labels.

See Chart::x_axis and Chart::y_axis to set an axis on a chart.

Example

use ratatui::{
    style::{Style, Stylize},
    widgets::Axis,
};

let axis = Axis::default()
    .title("X Axis")
    .style(Style::default().gray())
    .bounds([0.0, 50.0])
    .labels(["0".bold(), "25".into(), "50".bold()]);

Implementations

impl<'a> Axis<'a>

pub fn title<T>(self, title: T) -> Self

where T: Into<Line<'a>>,

Sets the axis title

It will be displayed at the end of the axis. For an X axis this is the right, for a Y axis, this is the top.

This is a fluent setter method which must be chained or used as it consumes self

pub const fn bounds(self, bounds: [f64; 2]) -> Self

Sets the bounds of this axis

In other words, sets the min and max value on this axis.

This is a fluent setter method which must be chained or used as it consumes self

pub fn labels<Labels>(self, labels: Labels) -> Self

where Labels: IntoIterator, Labels::Item: Into<Line<'a>>,

Sets the axis labels

• For the X axis, the labels are displayed left to right.
• For the Y axis, the labels are displayed bottom to top.

Currently, you need to give at least two labels or the render will panic. Also, giving more than 3 labels is currently broken and the middle labels won’t be in the correct position, see issue 334.

labels is a vector of any type that can be converted into a Line (e.g. &str, String, &Line, Span, …). This allows you to style the labels using the methods provided by Line. Any alignment set on the labels will be ignored as the alignment is determined by the axis.

This is a fluent setter method which must be chained or used as it consumes self

Examples

use ratatui::{style::Stylize, widgets::Axis};

let axis = Axis::default()
    .bounds([0.0, 50.0])
    .labels(["0".bold(), "25".into(), "50".bold()]);

pub fn style<S: Into<Style>>(self, style: S) -> Self

Sets the axis style

This is a fluent setter method which must be chained or used as it consumes self

style accepts any type that is convertible to Style (e.g. Style, Color, or your own type that implements Into<Style>).

Example

Axis also implements Stylize which mean you can style it like so

use ratatui::{style::Stylize, widgets::Axis};

let axis = Axis::default().red();

pub const fn labels_alignment(self, alignment: Alignment) -> Self

Sets the labels alignment of the axis

The alignment behaves differently based on the axis:

• Y axis: The labels are aligned within the area on the left of the axis
• X axis: The first X-axis label is aligned relative to the Y-axis

On the X axis, this parameter only affects the first label.

Trait Implementations

impl<'a> Clone for Axis<'a>

fn clone(&self) -> Axis<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Axis<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Axis<'a>

fn default() -> Axis<'a>

Returns the “default value” for a type.

impl<'a> PartialEq for Axis<'a>

fn eq(&self, other: &Axis<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Styled for Axis<'a>

type Item = Axis<'a>

fn style(&self) -> Style

Returns the style of the object.

fn set_style<S: Into<Style>>(self, style: S) -> Self::Item

Sets the style of the object.

impl<'a> StructuralPartialEq for Axis<'a>