Skip to main content

LegendLayout

Enum LegendLayout 

Source
pub enum LegendLayout {
    Vertical,
    Horizontal,
}
Expand description

Layout mode for the legend.

Controls how legend items are arranged: either stacked vertically in a column (default) or arranged horizontally in a single row.

§Examples

use tui_piechart::{PieChart, PieSlice, LegendLayout, LegendPosition};
use ratatui::style::Color;

let slices = vec![
    PieSlice::new("Rust", 45.0, Color::Red),
    PieSlice::new("Go", 30.0, Color::Blue),
];

// Use horizontal layout with legend at top
let chart = PieChart::new(slices)
    .legend_position(LegendPosition::Top)
    .legend_layout(LegendLayout::Horizontal);

§Layout Considerations

  • Vertical: Each legend item takes one line. Best for detailed legends with longer labels or when vertical space is available.
  • Horizontal: All legend items on one line. Best for compact displays or when used with Top/Bottom positions.

Variants§

§

Vertical

Vertical layout - items stacked vertically (default)

Each legend item appears on its own line, stacked vertically:

● Item 1  45%
● Item 2  30%
● Item 3  25%

This is the default layout and provides clear separation between items.

§

Horizontal

Horizontal layout - items in a single row

All legend items appear in a single horizontal row:

● Item 1  45%  ● Item 2  30%  ● Item 3  25%

This layout is more compact and works well with Top/Bottom positions. The chart automatically calculates required width to prevent item cutoff.

Trait Implementations§

Source§

impl Clone for LegendLayout

Source§

fn clone(&self) -> LegendLayout

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for LegendLayout

Source§

impl Debug for LegendLayout

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for LegendLayout

Source§

fn default() -> LegendLayout

Returns the “default value” for a type. Read more
Source§

impl Eq for LegendLayout

Source§

impl PartialEq for LegendLayout

Source§

fn eq(&self, other: &LegendLayout) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for LegendLayout

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.