#[non_exhaustive]pub struct DataLabelOptions {
pub visibility: Option<Visibility>,
pub category_label_visibility: Option<Visibility>,
pub measure_label_visibility: Option<Visibility>,
pub data_label_types: Option<Vec<DataLabelType>>,
pub position: Option<DataLabelPosition>,
pub label_content: Option<DataLabelContent>,
pub label_font_configuration: Option<FontConfiguration>,
pub label_color: Option<String>,
pub overlap: Option<DataLabelOverlap>,
pub totals_visibility: Option<Visibility>,
}
Expand description
The options that determine the presentation of the data labels.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.visibility: Option<Visibility>
Determines the visibility of the data labels.
category_label_visibility: Option<Visibility>
Determines the visibility of the category field labels.
measure_label_visibility: Option<Visibility>
Determines the visibility of the measure field labels.
data_label_types: Option<Vec<DataLabelType>>
The option that determines the data label type.
position: Option<DataLabelPosition>
Determines the position of the data labels.
label_content: Option<DataLabelContent>
Determines the content of the data labels.
label_font_configuration: Option<FontConfiguration>
Determines the font configuration of the data labels.
label_color: Option<String>
Determines the color of the data labels.
overlap: Option<DataLabelOverlap>
Determines whether overlap is enabled or disabled for the data labels.
totals_visibility: Option<Visibility>
Determines the visibility of the total.
Implementations§
Source§impl DataLabelOptions
impl DataLabelOptions
Sourcepub fn visibility(&self) -> Option<&Visibility>
pub fn visibility(&self) -> Option<&Visibility>
Determines the visibility of the data labels.
Sourcepub fn category_label_visibility(&self) -> Option<&Visibility>
pub fn category_label_visibility(&self) -> Option<&Visibility>
Determines the visibility of the category field labels.
Sourcepub fn measure_label_visibility(&self) -> Option<&Visibility>
pub fn measure_label_visibility(&self) -> Option<&Visibility>
Determines the visibility of the measure field labels.
Sourcepub fn data_label_types(&self) -> &[DataLabelType]
pub fn data_label_types(&self) -> &[DataLabelType]
The option that determines the data label type.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .data_label_types.is_none()
.
Sourcepub fn position(&self) -> Option<&DataLabelPosition>
pub fn position(&self) -> Option<&DataLabelPosition>
Determines the position of the data labels.
Sourcepub fn label_content(&self) -> Option<&DataLabelContent>
pub fn label_content(&self) -> Option<&DataLabelContent>
Determines the content of the data labels.
Sourcepub fn label_font_configuration(&self) -> Option<&FontConfiguration>
pub fn label_font_configuration(&self) -> Option<&FontConfiguration>
Determines the font configuration of the data labels.
Sourcepub fn label_color(&self) -> Option<&str>
pub fn label_color(&self) -> Option<&str>
Determines the color of the data labels.
Sourcepub fn overlap(&self) -> Option<&DataLabelOverlap>
pub fn overlap(&self) -> Option<&DataLabelOverlap>
Determines whether overlap is enabled or disabled for the data labels.
Sourcepub fn totals_visibility(&self) -> Option<&Visibility>
pub fn totals_visibility(&self) -> Option<&Visibility>
Determines the visibility of the total.
Source§impl DataLabelOptions
impl DataLabelOptions
Sourcepub fn builder() -> DataLabelOptionsBuilder
pub fn builder() -> DataLabelOptionsBuilder
Creates a new builder-style object to manufacture DataLabelOptions
.
Trait Implementations§
Source§impl Clone for DataLabelOptions
impl Clone for DataLabelOptions
Source§fn clone(&self) -> DataLabelOptions
fn clone(&self) -> DataLabelOptions
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for DataLabelOptions
impl Debug for DataLabelOptions
Source§impl PartialEq for DataLabelOptions
impl PartialEq for DataLabelOptions
impl StructuralPartialEq for DataLabelOptions
Auto Trait Implementations§
impl Freeze for DataLabelOptions
impl RefUnwindSafe for DataLabelOptions
impl Send for DataLabelOptions
impl Sync for DataLabelOptions
impl Unpin for DataLabelOptions
impl UnwindSafe for DataLabelOptions
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);