LegendPosition

Enum LegendPosition 

Source
pub enum LegendPosition {
    Right,
    Left,
    Top,
    Bottom,
}
Expand description

Position of the legend relative to the pie chart.

Controls where the legend appears in relation to the pie chart visualization. The legend can be positioned on any of the four sides: right (default), left, top, or bottom.

§Examples

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

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

// Position legend on the left side
let chart = PieChart::new(slices)
    .legend_position(LegendPosition::Left);

§Layout Impact

The legend position affects how space is allocated:

  • Right/Left: Legend takes a portion of horizontal space
  • Top/Bottom: Legend takes a portion of vertical space

The chart automatically adjusts its size to accommodate the legend.

Variants§

§

Right

Legend on the right side (default)

The legend appears to the right of the pie chart. This is the default position and works well for most use cases.

§

Left

Legend on the left side

The legend appears to the left of the pie chart. Useful when you want the chart to be more prominent on the right side of the display.

§

Top

Legend at the top

The legend appears above the pie chart. Best used with horizontal layout for a more compact display.

§

Bottom

Legend at the bottom

The legend appears below the pie chart. Works well with horizontal layout when vertical space is limited.

Trait Implementations§

Source§

impl Clone for LegendPosition

Source§

fn clone(&self) -> LegendPosition

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LegendPosition

Source§

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

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

impl Default for LegendPosition

Source§

fn default() -> LegendPosition

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

impl PartialEq for LegendPosition

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Copy for LegendPosition

Source§

impl Eq for LegendPosition

Source§

impl StructuralPartialEq for LegendPosition

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.