#[non_exhaustive]
pub struct LegendOptions { pub visibility: Option<Visibility>, pub title: Option<LabelOptions>, pub position: Option<LegendPosition>, pub width: Option<String>, pub height: Option<String>, }
Expand description

The options for the legend setup of a visual.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§visibility: Option<Visibility>

Determines whether or not the legend is visible.

§title: Option<LabelOptions>

The custom title for the legend.

§position: Option<LegendPosition>

The positions for the legend. Choose one of the following options:

  • AUTO

  • RIGHT

  • BOTTOM

  • LEFT

§width: Option<String>

The width of the legend. If this value is omitted, a default width is used when rendering.

§height: Option<String>

The height of the legend. If this value is omitted, a default height is used when rendering.

Implementations§

source§

impl LegendOptions

source

pub fn visibility(&self) -> Option<&Visibility>

Determines whether or not the legend is visible.

source

pub fn title(&self) -> Option<&LabelOptions>

The custom title for the legend.

source

pub fn position(&self) -> Option<&LegendPosition>

The positions for the legend. Choose one of the following options:

  • AUTO

  • RIGHT

  • BOTTOM

  • LEFT

source

pub fn width(&self) -> Option<&str>

The width of the legend. If this value is omitted, a default width is used when rendering.

source

pub fn height(&self) -> Option<&str>

The height of the legend. If this value is omitted, a default height is used when rendering.

source§

impl LegendOptions

source

pub fn builder() -> LegendOptionsBuilder

Creates a new builder-style object to manufacture LegendOptions.

Trait Implementations§

source§

impl Clone for LegendOptions

source§

fn clone(&self) -> LegendOptions

Returns a copy 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 LegendOptions

source§

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

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

impl PartialEq for LegendOptions

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl StructuralPartialEq for LegendOptions

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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

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

§

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>,

§

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>,

§

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.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more