#[non_exhaustive]pub struct KpiOptions {
pub progress_bar: Option<ProgressBarOptions>,
pub trend_arrows: Option<TrendArrowOptions>,
pub secondary_value: Option<SecondaryValueOptions>,
pub comparison: Option<ComparisonConfiguration>,
pub primary_value_display_type: Option<PrimaryValueDisplayType>,
pub primary_value_font_configuration: Option<FontConfiguration>,
pub secondary_value_font_configuration: Option<FontConfiguration>,
pub sparkline: Option<KpiSparklineOptions>,
pub visual_layout_options: Option<KpiVisualLayoutOptions>,
}
Expand description
The options that determine the presentation of a KPI visual.
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.progress_bar: Option<ProgressBarOptions>
The options that determine the presentation of the progress bar of a KPI visual.
trend_arrows: Option<TrendArrowOptions>
The options that determine the presentation of trend arrows in a KPI visual.
secondary_value: Option<SecondaryValueOptions>
The options that determine the presentation of the secondary value of a KPI visual.
comparison: Option<ComparisonConfiguration>
The comparison configuration of a KPI visual.
primary_value_display_type: Option<PrimaryValueDisplayType>
The options that determine the primary value display type.
primary_value_font_configuration: Option<FontConfiguration>
The options that determine the primary value font configuration.
secondary_value_font_configuration: Option<FontConfiguration>
The options that determine the secondary value font configuration.
sparkline: Option<KpiSparklineOptions>
The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.
visual_layout_options: Option<KpiVisualLayoutOptions>
The options that determine the layout a KPI visual.
Implementations§
Source§impl KpiOptions
impl KpiOptions
Sourcepub fn progress_bar(&self) -> Option<&ProgressBarOptions>
pub fn progress_bar(&self) -> Option<&ProgressBarOptions>
The options that determine the presentation of the progress bar of a KPI visual.
Sourcepub fn trend_arrows(&self) -> Option<&TrendArrowOptions>
pub fn trend_arrows(&self) -> Option<&TrendArrowOptions>
The options that determine the presentation of trend arrows in a KPI visual.
Sourcepub fn secondary_value(&self) -> Option<&SecondaryValueOptions>
pub fn secondary_value(&self) -> Option<&SecondaryValueOptions>
The options that determine the presentation of the secondary value of a KPI visual.
Sourcepub fn comparison(&self) -> Option<&ComparisonConfiguration>
pub fn comparison(&self) -> Option<&ComparisonConfiguration>
The comparison configuration of a KPI visual.
Sourcepub fn primary_value_display_type(&self) -> Option<&PrimaryValueDisplayType>
pub fn primary_value_display_type(&self) -> Option<&PrimaryValueDisplayType>
The options that determine the primary value display type.
Sourcepub fn primary_value_font_configuration(&self) -> Option<&FontConfiguration>
pub fn primary_value_font_configuration(&self) -> Option<&FontConfiguration>
The options that determine the primary value font configuration.
Sourcepub fn secondary_value_font_configuration(&self) -> Option<&FontConfiguration>
pub fn secondary_value_font_configuration(&self) -> Option<&FontConfiguration>
The options that determine the secondary value font configuration.
Sourcepub fn sparkline(&self) -> Option<&KpiSparklineOptions>
pub fn sparkline(&self) -> Option<&KpiSparklineOptions>
The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.
Sourcepub fn visual_layout_options(&self) -> Option<&KpiVisualLayoutOptions>
pub fn visual_layout_options(&self) -> Option<&KpiVisualLayoutOptions>
The options that determine the layout a KPI visual.
Source§impl KpiOptions
impl KpiOptions
Sourcepub fn builder() -> KpiOptionsBuilder
pub fn builder() -> KpiOptionsBuilder
Creates a new builder-style object to manufacture KpiOptions
.
Trait Implementations§
Source§impl Clone for KpiOptions
impl Clone for KpiOptions
Source§fn clone(&self) -> KpiOptions
fn clone(&self) -> KpiOptions
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for KpiOptions
impl Debug for KpiOptions
Source§impl PartialEq for KpiOptions
impl PartialEq for KpiOptions
impl StructuralPartialEq for KpiOptions
Auto Trait Implementations§
impl Freeze for KpiOptions
impl RefUnwindSafe for KpiOptions
impl Send for KpiOptions
impl Sync for KpiOptions
impl Unpin for KpiOptions
impl UnwindSafe for KpiOptions
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);