Struct Legend 

pub struct Legend {
    pub text_style: TextStyle,
    pub background_alpha: f32,
    pub position: Corner,
    pub title: Option<String>,
    /* private fields */
}

The configuration for a plot legend.

Fields

text_style: TextStyle

background_alpha: f32

position: Corner

title: Option<String>

Implementations

impl Legend

pub fn text_style(self, style: TextStyle) -> Self

Which text style to use for the legend. Default: TextStyle::Body.

pub fn background_alpha(self, alpha: f32) -> Self

The alpha of the legend background. Default: 0.75.

pub fn position(self, corner: Corner) -> Self

In which corner to place the legend. Default: Corner::RightTop.

pub fn title(self, title: &str) -> Self

Set the title of the legend. Default: None.

pub fn hidden_items<I>(self, hidden_items: I) -> Self

where I: IntoIterator<Item = Id>,

Specifies hidden items in the legend configuration to override the existing ones. This allows the legend traces’ visibility to be controlled from the application code.

pub fn follow_insertion_order(self, follow: bool) -> Self

Specifies if the legend item order should be the inserted order. Default: false. If true, the order of the legend items will be the same as the order as they were added. By default it will be sorted alphabetically.

pub fn color_conflict_handling( self, color_conflict_handling: ColorConflictHandling, ) -> Self

Specifies how to handle conflicting colors for an item.

pub fn grouping(self, grouping: LegendGrouping) -> Self

Specifies how legend entries are grouped. Default: LegendGrouping::ByName.

With LegendGrouping::ByName, items sharing the same name are merged into a single legend entry. With LegendGrouping::ById, each item gets its own entry keyed by its unique Id.

Trait Implementations

impl Clone for Legend

fn clone(&self) -> Legend

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Legend

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Legend

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Legend

fn eq(&self, other: &Legend) -> 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 Serialize for Legend

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Legend