#[non_exhaustive]pub struct FunnelChartConfiguration {
pub field_wells: Option<FunnelChartFieldWells>,
pub sort_configuration: Option<FunnelChartSortConfiguration>,
pub category_label_options: Option<ChartAxisLabelOptions>,
pub value_label_options: Option<ChartAxisLabelOptions>,
pub tooltip: Option<TooltipOptions>,
pub data_label_options: Option<FunnelChartDataLabelOptions>,
pub visual_palette: Option<VisualPalette>,
pub interactions: Option<VisualInteractionOptions>,
}
Expand description
The configuration of a FunnelChartVisual
.
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.field_wells: Option<FunnelChartFieldWells>
The field well configuration of a FunnelChartVisual
.
sort_configuration: Option<FunnelChartSortConfiguration>
The sort configuration of a FunnelChartVisual
.
category_label_options: Option<ChartAxisLabelOptions>
The label options of the categories that are displayed in a FunnelChartVisual
.
value_label_options: Option<ChartAxisLabelOptions>
The label options for the values that are displayed in a FunnelChartVisual
.
tooltip: Option<TooltipOptions>
The tooltip configuration of a FunnelChartVisual
.
data_label_options: Option<FunnelChartDataLabelOptions>
The options that determine the presentation of the data labels.
visual_palette: Option<VisualPalette>
The visual palette configuration of a FunnelChartVisual
.
interactions: Option<VisualInteractionOptions>
The general visual interactions setup for a visual.
Implementations§
Source§impl FunnelChartConfiguration
impl FunnelChartConfiguration
Sourcepub fn field_wells(&self) -> Option<&FunnelChartFieldWells>
pub fn field_wells(&self) -> Option<&FunnelChartFieldWells>
The field well configuration of a FunnelChartVisual
.
Sourcepub fn sort_configuration(&self) -> Option<&FunnelChartSortConfiguration>
pub fn sort_configuration(&self) -> Option<&FunnelChartSortConfiguration>
The sort configuration of a FunnelChartVisual
.
Sourcepub fn category_label_options(&self) -> Option<&ChartAxisLabelOptions>
pub fn category_label_options(&self) -> Option<&ChartAxisLabelOptions>
The label options of the categories that are displayed in a FunnelChartVisual
.
Sourcepub fn value_label_options(&self) -> Option<&ChartAxisLabelOptions>
pub fn value_label_options(&self) -> Option<&ChartAxisLabelOptions>
The label options for the values that are displayed in a FunnelChartVisual
.
Sourcepub fn tooltip(&self) -> Option<&TooltipOptions>
pub fn tooltip(&self) -> Option<&TooltipOptions>
The tooltip configuration of a FunnelChartVisual
.
Sourcepub fn data_label_options(&self) -> Option<&FunnelChartDataLabelOptions>
pub fn data_label_options(&self) -> Option<&FunnelChartDataLabelOptions>
The options that determine the presentation of the data labels.
Sourcepub fn visual_palette(&self) -> Option<&VisualPalette>
pub fn visual_palette(&self) -> Option<&VisualPalette>
The visual palette configuration of a FunnelChartVisual
.
Sourcepub fn interactions(&self) -> Option<&VisualInteractionOptions>
pub fn interactions(&self) -> Option<&VisualInteractionOptions>
The general visual interactions setup for a visual.
Source§impl FunnelChartConfiguration
impl FunnelChartConfiguration
Sourcepub fn builder() -> FunnelChartConfigurationBuilder
pub fn builder() -> FunnelChartConfigurationBuilder
Creates a new builder-style object to manufacture FunnelChartConfiguration
.
Trait Implementations§
Source§impl Clone for FunnelChartConfiguration
impl Clone for FunnelChartConfiguration
Source§fn clone(&self) -> FunnelChartConfiguration
fn clone(&self) -> FunnelChartConfiguration
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 FunnelChartConfiguration
impl Debug for FunnelChartConfiguration
Source§impl PartialEq for FunnelChartConfiguration
impl PartialEq for FunnelChartConfiguration
Source§fn eq(&self, other: &FunnelChartConfiguration) -> bool
fn eq(&self, other: &FunnelChartConfiguration) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for FunnelChartConfiguration
Auto Trait Implementations§
impl Freeze for FunnelChartConfiguration
impl RefUnwindSafe for FunnelChartConfiguration
impl Send for FunnelChartConfiguration
impl Sync for FunnelChartConfiguration
impl Unpin for FunnelChartConfiguration
impl UnwindSafe for FunnelChartConfiguration
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);