Struct Legend 

pub struct Legend { /* private fields */ }

The names behind the tones of a chart: a patch of colour and the name it stands for.

The n-th name takes the theme’s n-th series tone (Theme::series_color), which is how every chart picks its tones, so a legend beside a chart names the same colours the chart drew. A legend is not decoration: in a stacked bar or a tinted grid the meaning of a tone lives nowhere else, and the theme carries only five series tones, so a sixth series shares the first one’s tone and the name is the only thing that tells them apart.

tones pins each name to a tone of the palette instead of its position, the same index its series was given with Series::tone, so a category keeps its colour however many others are named beside it.

Names lie in a row and wrap onto further rows when the area is too narrow; vertical puts each on its own row. A name that does not fit is cut with …. The swatch is two cells of colour, never a bracketed marker, and it works the same in every glyph mode because it is made of colour rather than characters.

Style keys: legend (fg for the names).

Implementations

impl Legend

pub fn new(names: impl IntoIterator<Item = impl Into<String>>) -> Self

A legend naming the series of a chart, in the order the chart draws them.

pub fn tones(self, tones: impl IntoIterator<Item = usize>) -> Self

The palette index of every name, in the order of the names: the n-th name takes the theme’s tones[n]-th series tone. A name past the end of tones keeps the tone of its position.

pub fn vertical(self) -> Self

Puts every name on its own row, for a legend beside a chart rather than under it.

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 Debug for Legend

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

Formats the value using the given formatter.

impl Eq for Legend

impl PartialEq for Legend

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Legend

impl<Msg: 'static> Widget<Msg> for Legend

fn measure(&self, _cx: &mut MeasureCx<'_>, available: Size) -> Size

The size the widget wants when it may use up to available.

fn paint(&self, cx: &mut PaintCx<'_>, area: Rect)

Draws the widget into area.

fn paint_overlay(&self, _cx: &mut PaintCx<'_>, _anchor: Rect)

Draws the widget’s overlay after the whole view was painted, when it asked for one with PaintCx::request_overlay. anchor is the area the widget was painted in.

fn event(&self, _cx: &mut EventCx<'_, Msg>, _event: &Event) -> bool

Handles input. Returns true when the event was used; unused key and scroll events bubble to the parent widget.

fn focusable(&self) -> bool

Whether the widget can take keyboard focus.

fn children(&self) -> &[Node<Msg>]

Child nodes, for widgets that contain other widgets.

fn children_mut(&mut self) -> &mut [Node<Msg>]

Mutable child nodes, used to assign ids.