#[non_exhaustive]pub struct WaterfallChartConfigurationBuilder { /* private fields */ }
Expand description
A builder for WaterfallChartConfiguration
.
Implementations§
Source§impl WaterfallChartConfigurationBuilder
impl WaterfallChartConfigurationBuilder
Sourcepub fn field_wells(self, input: WaterfallChartFieldWells) -> Self
pub fn field_wells(self, input: WaterfallChartFieldWells) -> Self
The field well configuration of a waterfall visual.
Sourcepub fn set_field_wells(self, input: Option<WaterfallChartFieldWells>) -> Self
pub fn set_field_wells(self, input: Option<WaterfallChartFieldWells>) -> Self
The field well configuration of a waterfall visual.
Sourcepub fn get_field_wells(&self) -> &Option<WaterfallChartFieldWells>
pub fn get_field_wells(&self) -> &Option<WaterfallChartFieldWells>
The field well configuration of a waterfall visual.
Sourcepub fn sort_configuration(self, input: WaterfallChartSortConfiguration) -> Self
pub fn sort_configuration(self, input: WaterfallChartSortConfiguration) -> Self
The sort configuration of a waterfall visual.
Sourcepub fn set_sort_configuration(
self,
input: Option<WaterfallChartSortConfiguration>,
) -> Self
pub fn set_sort_configuration( self, input: Option<WaterfallChartSortConfiguration>, ) -> Self
The sort configuration of a waterfall visual.
Sourcepub fn get_sort_configuration(&self) -> &Option<WaterfallChartSortConfiguration>
pub fn get_sort_configuration(&self) -> &Option<WaterfallChartSortConfiguration>
The sort configuration of a waterfall visual.
Sourcepub fn waterfall_chart_options(self, input: WaterfallChartOptions) -> Self
pub fn waterfall_chart_options(self, input: WaterfallChartOptions) -> Self
The options that determine the presentation of a waterfall visual.
Sourcepub fn set_waterfall_chart_options(
self,
input: Option<WaterfallChartOptions>,
) -> Self
pub fn set_waterfall_chart_options( self, input: Option<WaterfallChartOptions>, ) -> Self
The options that determine the presentation of a waterfall visual.
Sourcepub fn get_waterfall_chart_options(&self) -> &Option<WaterfallChartOptions>
pub fn get_waterfall_chart_options(&self) -> &Option<WaterfallChartOptions>
The options that determine the presentation of a waterfall visual.
Sourcepub fn category_axis_label_options(self, input: ChartAxisLabelOptions) -> Self
pub fn category_axis_label_options(self, input: ChartAxisLabelOptions) -> Self
The options that determine the presentation of the category axis label.
Sourcepub fn set_category_axis_label_options(
self,
input: Option<ChartAxisLabelOptions>,
) -> Self
pub fn set_category_axis_label_options( self, input: Option<ChartAxisLabelOptions>, ) -> Self
The options that determine the presentation of the category axis label.
Sourcepub fn get_category_axis_label_options(&self) -> &Option<ChartAxisLabelOptions>
pub fn get_category_axis_label_options(&self) -> &Option<ChartAxisLabelOptions>
The options that determine the presentation of the category axis label.
Sourcepub fn category_axis_display_options(self, input: AxisDisplayOptions) -> Self
pub fn category_axis_display_options(self, input: AxisDisplayOptions) -> Self
The options that determine the presentation of the category axis.
Sourcepub fn set_category_axis_display_options(
self,
input: Option<AxisDisplayOptions>,
) -> Self
pub fn set_category_axis_display_options( self, input: Option<AxisDisplayOptions>, ) -> Self
The options that determine the presentation of the category axis.
Sourcepub fn get_category_axis_display_options(&self) -> &Option<AxisDisplayOptions>
pub fn get_category_axis_display_options(&self) -> &Option<AxisDisplayOptions>
The options that determine the presentation of the category axis.
Sourcepub fn primary_y_axis_label_options(self, input: ChartAxisLabelOptions) -> Self
pub fn primary_y_axis_label_options(self, input: ChartAxisLabelOptions) -> Self
The options that determine the presentation of the y-axis label.
Sourcepub fn set_primary_y_axis_label_options(
self,
input: Option<ChartAxisLabelOptions>,
) -> Self
pub fn set_primary_y_axis_label_options( self, input: Option<ChartAxisLabelOptions>, ) -> Self
The options that determine the presentation of the y-axis label.
Sourcepub fn get_primary_y_axis_label_options(&self) -> &Option<ChartAxisLabelOptions>
pub fn get_primary_y_axis_label_options(&self) -> &Option<ChartAxisLabelOptions>
The options that determine the presentation of the y-axis label.
Sourcepub fn primary_y_axis_display_options(self, input: AxisDisplayOptions) -> Self
pub fn primary_y_axis_display_options(self, input: AxisDisplayOptions) -> Self
The options that determine the presentation of the y-axis.
Sourcepub fn set_primary_y_axis_display_options(
self,
input: Option<AxisDisplayOptions>,
) -> Self
pub fn set_primary_y_axis_display_options( self, input: Option<AxisDisplayOptions>, ) -> Self
The options that determine the presentation of the y-axis.
Sourcepub fn get_primary_y_axis_display_options(&self) -> &Option<AxisDisplayOptions>
pub fn get_primary_y_axis_display_options(&self) -> &Option<AxisDisplayOptions>
The options that determine the presentation of the y-axis.
Sourcepub fn legend(self, input: LegendOptions) -> Self
pub fn legend(self, input: LegendOptions) -> Self
The legend configuration of a waterfall visual.
Sourcepub fn set_legend(self, input: Option<LegendOptions>) -> Self
pub fn set_legend(self, input: Option<LegendOptions>) -> Self
The legend configuration of a waterfall visual.
Sourcepub fn get_legend(&self) -> &Option<LegendOptions>
pub fn get_legend(&self) -> &Option<LegendOptions>
The legend configuration of a waterfall visual.
Sourcepub fn data_labels(self, input: DataLabelOptions) -> Self
pub fn data_labels(self, input: DataLabelOptions) -> Self
The data label configuration of a waterfall visual.
Sourcepub fn set_data_labels(self, input: Option<DataLabelOptions>) -> Self
pub fn set_data_labels(self, input: Option<DataLabelOptions>) -> Self
The data label configuration of a waterfall visual.
Sourcepub fn get_data_labels(&self) -> &Option<DataLabelOptions>
pub fn get_data_labels(&self) -> &Option<DataLabelOptions>
The data label configuration of a waterfall visual.
Sourcepub fn visual_palette(self, input: VisualPalette) -> Self
pub fn visual_palette(self, input: VisualPalette) -> Self
The visual palette configuration of a waterfall visual.
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 waterfall visual.
Sourcepub fn get_visual_palette(&self) -> &Option<VisualPalette>
pub fn get_visual_palette(&self) -> &Option<VisualPalette>
The visual palette configuration of a waterfall visual.
Sourcepub fn color_configuration(
self,
input: WaterfallChartColorConfiguration,
) -> Self
pub fn color_configuration( self, input: WaterfallChartColorConfiguration, ) -> Self
The color configuration of a waterfall visual.
Sourcepub fn set_color_configuration(
self,
input: Option<WaterfallChartColorConfiguration>,
) -> Self
pub fn set_color_configuration( self, input: Option<WaterfallChartColorConfiguration>, ) -> Self
The color configuration of a waterfall visual.
Sourcepub fn get_color_configuration(
&self,
) -> &Option<WaterfallChartColorConfiguration>
pub fn get_color_configuration( &self, ) -> &Option<WaterfallChartColorConfiguration>
The color configuration of a waterfall visual.
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) -> WaterfallChartConfiguration
pub fn build(self) -> WaterfallChartConfiguration
Consumes the builder and constructs a WaterfallChartConfiguration
.
Trait Implementations§
Source§impl Clone for WaterfallChartConfigurationBuilder
impl Clone for WaterfallChartConfigurationBuilder
Source§fn clone(&self) -> WaterfallChartConfigurationBuilder
fn clone(&self) -> WaterfallChartConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for WaterfallChartConfigurationBuilder
impl Default for WaterfallChartConfigurationBuilder
Source§fn default() -> WaterfallChartConfigurationBuilder
fn default() -> WaterfallChartConfigurationBuilder
Source§impl PartialEq for WaterfallChartConfigurationBuilder
impl PartialEq for WaterfallChartConfigurationBuilder
Source§fn eq(&self, other: &WaterfallChartConfigurationBuilder) -> bool
fn eq(&self, other: &WaterfallChartConfigurationBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for WaterfallChartConfigurationBuilder
Auto Trait Implementations§
impl Freeze for WaterfallChartConfigurationBuilder
impl RefUnwindSafe for WaterfallChartConfigurationBuilder
impl Send for WaterfallChartConfigurationBuilder
impl Sync for WaterfallChartConfigurationBuilder
impl Unpin for WaterfallChartConfigurationBuilder
impl UnwindSafe for WaterfallChartConfigurationBuilder
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);