#[non_exhaustive]pub struct FunnelChartConfigurationBuilder { /* private fields */ }
Expand description
A builder for FunnelChartConfiguration
.
Implementations§
Source§impl FunnelChartConfigurationBuilder
impl FunnelChartConfigurationBuilder
Sourcepub fn field_wells(self, input: FunnelChartFieldWells) -> Self
pub fn field_wells(self, input: FunnelChartFieldWells) -> Self
The field well configuration of a FunnelChartVisual
.
Sourcepub fn set_field_wells(self, input: Option<FunnelChartFieldWells>) -> Self
pub fn set_field_wells(self, input: Option<FunnelChartFieldWells>) -> Self
The field well configuration of a FunnelChartVisual
.
Sourcepub fn get_field_wells(&self) -> &Option<FunnelChartFieldWells>
pub fn get_field_wells(&self) -> &Option<FunnelChartFieldWells>
The field well configuration of a FunnelChartVisual
.
Sourcepub fn sort_configuration(self, input: FunnelChartSortConfiguration) -> Self
pub fn sort_configuration(self, input: FunnelChartSortConfiguration) -> Self
The sort configuration of a FunnelChartVisual
.
Sourcepub fn set_sort_configuration(
self,
input: Option<FunnelChartSortConfiguration>,
) -> Self
pub fn set_sort_configuration( self, input: Option<FunnelChartSortConfiguration>, ) -> Self
The sort configuration of a FunnelChartVisual
.
Sourcepub fn get_sort_configuration(&self) -> &Option<FunnelChartSortConfiguration>
pub fn get_sort_configuration(&self) -> &Option<FunnelChartSortConfiguration>
The sort configuration of a FunnelChartVisual
.
Sourcepub fn category_label_options(self, input: ChartAxisLabelOptions) -> Self
pub fn category_label_options(self, input: ChartAxisLabelOptions) -> Self
The label options of the categories that are displayed in a FunnelChartVisual
.
Sourcepub fn set_category_label_options(
self,
input: Option<ChartAxisLabelOptions>,
) -> Self
pub fn set_category_label_options( self, input: Option<ChartAxisLabelOptions>, ) -> Self
The label options of the categories that are displayed in a FunnelChartVisual
.
Sourcepub fn get_category_label_options(&self) -> &Option<ChartAxisLabelOptions>
pub fn get_category_label_options(&self) -> &Option<ChartAxisLabelOptions>
The label options of the categories that are displayed in a FunnelChartVisual
.
Sourcepub fn value_label_options(self, input: ChartAxisLabelOptions) -> Self
pub fn value_label_options(self, input: ChartAxisLabelOptions) -> Self
The label options for the values that are displayed in a FunnelChartVisual
.
Sourcepub fn set_value_label_options(
self,
input: Option<ChartAxisLabelOptions>,
) -> Self
pub fn set_value_label_options( self, input: Option<ChartAxisLabelOptions>, ) -> Self
The label options for the values that are displayed in a FunnelChartVisual
.
Sourcepub fn get_value_label_options(&self) -> &Option<ChartAxisLabelOptions>
pub fn get_value_label_options(&self) -> &Option<ChartAxisLabelOptions>
The label options for the values that are displayed in a FunnelChartVisual
.
Sourcepub fn tooltip(self, input: TooltipOptions) -> Self
pub fn tooltip(self, input: TooltipOptions) -> Self
The tooltip configuration of a FunnelChartVisual
.
Sourcepub fn set_tooltip(self, input: Option<TooltipOptions>) -> Self
pub fn set_tooltip(self, input: Option<TooltipOptions>) -> Self
The tooltip configuration of a FunnelChartVisual
.
Sourcepub fn get_tooltip(&self) -> &Option<TooltipOptions>
pub fn get_tooltip(&self) -> &Option<TooltipOptions>
The tooltip configuration of a FunnelChartVisual
.
Sourcepub fn data_label_options(self, input: FunnelChartDataLabelOptions) -> Self
pub fn data_label_options(self, input: FunnelChartDataLabelOptions) -> Self
The options that determine the presentation of the data labels.
Sourcepub fn set_data_label_options(
self,
input: Option<FunnelChartDataLabelOptions>,
) -> Self
pub fn set_data_label_options( self, input: Option<FunnelChartDataLabelOptions>, ) -> Self
The options that determine the presentation of the data labels.
Sourcepub fn get_data_label_options(&self) -> &Option<FunnelChartDataLabelOptions>
pub fn get_data_label_options(&self) -> &Option<FunnelChartDataLabelOptions>
The options that determine the presentation of the data labels.
Sourcepub fn visual_palette(self, input: VisualPalette) -> Self
pub fn visual_palette(self, input: VisualPalette) -> Self
The visual palette configuration of a FunnelChartVisual
.
Sourcepub fn set_visual_palette(self, input: Option<VisualPalette>) -> Self
pub fn set_visual_palette(self, input: Option<VisualPalette>) -> Self
The visual palette configuration of a FunnelChartVisual
.
Sourcepub fn get_visual_palette(&self) -> &Option<VisualPalette>
pub fn get_visual_palette(&self) -> &Option<VisualPalette>
The visual palette configuration of a FunnelChartVisual
.
Sourcepub fn interactions(self, input: VisualInteractionOptions) -> Self
pub fn interactions(self, input: VisualInteractionOptions) -> Self
The general visual interactions setup for a visual.
Sourcepub fn set_interactions(self, input: Option<VisualInteractionOptions>) -> Self
pub fn set_interactions(self, input: Option<VisualInteractionOptions>) -> Self
The general visual interactions setup for a visual.
Sourcepub fn get_interactions(&self) -> &Option<VisualInteractionOptions>
pub fn get_interactions(&self) -> &Option<VisualInteractionOptions>
The general visual interactions setup for a visual.
Sourcepub fn build(self) -> FunnelChartConfiguration
pub fn build(self) -> FunnelChartConfiguration
Consumes the builder and constructs a FunnelChartConfiguration
.
Trait Implementations§
Source§impl Clone for FunnelChartConfigurationBuilder
impl Clone for FunnelChartConfigurationBuilder
Source§fn clone(&self) -> FunnelChartConfigurationBuilder
fn clone(&self) -> FunnelChartConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for FunnelChartConfigurationBuilder
impl Default for FunnelChartConfigurationBuilder
Source§fn default() -> FunnelChartConfigurationBuilder
fn default() -> FunnelChartConfigurationBuilder
Source§impl PartialEq for FunnelChartConfigurationBuilder
impl PartialEq for FunnelChartConfigurationBuilder
Source§fn eq(&self, other: &FunnelChartConfigurationBuilder) -> bool
fn eq(&self, other: &FunnelChartConfigurationBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for FunnelChartConfigurationBuilder
Auto Trait Implementations§
impl Freeze for FunnelChartConfigurationBuilder
impl RefUnwindSafe for FunnelChartConfigurationBuilder
impl Send for FunnelChartConfigurationBuilder
impl Sync for FunnelChartConfigurationBuilder
impl Unpin for FunnelChartConfigurationBuilder
impl UnwindSafe for FunnelChartConfigurationBuilder
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);