#[non_exhaustive]pub struct BarChartConfigurationBuilder { /* private fields */ }
Expand description
A builder for BarChartConfiguration
.
Implementations§
Source§impl BarChartConfigurationBuilder
impl BarChartConfigurationBuilder
Sourcepub fn field_wells(self, input: BarChartFieldWells) -> Self
pub fn field_wells(self, input: BarChartFieldWells) -> Self
The field wells of the visual.
Sourcepub fn set_field_wells(self, input: Option<BarChartFieldWells>) -> Self
pub fn set_field_wells(self, input: Option<BarChartFieldWells>) -> Self
The field wells of the visual.
Sourcepub fn get_field_wells(&self) -> &Option<BarChartFieldWells>
pub fn get_field_wells(&self) -> &Option<BarChartFieldWells>
The field wells of the visual.
Sourcepub fn sort_configuration(self, input: BarChartSortConfiguration) -> Self
pub fn sort_configuration(self, input: BarChartSortConfiguration) -> Self
The sort configuration of a BarChartVisual
.
Sourcepub fn set_sort_configuration(
self,
input: Option<BarChartSortConfiguration>,
) -> Self
pub fn set_sort_configuration( self, input: Option<BarChartSortConfiguration>, ) -> Self
The sort configuration of a BarChartVisual
.
Sourcepub fn get_sort_configuration(&self) -> &Option<BarChartSortConfiguration>
pub fn get_sort_configuration(&self) -> &Option<BarChartSortConfiguration>
The sort configuration of a BarChartVisual
.
Sourcepub fn orientation(self, input: BarChartOrientation) -> Self
pub fn orientation(self, input: BarChartOrientation) -> Self
The orientation of the bars in a bar chart visual. There are two valid values in this structure:
-
HORIZONTAL
: Used for charts that have horizontal bars. Visuals that use this value are horizontal bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts. -
VERTICAL
: Used for charts that have vertical bars. Visuals that use this value are vertical bar charts, vertical stacked bar charts, and vertical stacked 100% bar charts.
Sourcepub fn set_orientation(self, input: Option<BarChartOrientation>) -> Self
pub fn set_orientation(self, input: Option<BarChartOrientation>) -> Self
The orientation of the bars in a bar chart visual. There are two valid values in this structure:
-
HORIZONTAL
: Used for charts that have horizontal bars. Visuals that use this value are horizontal bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts. -
VERTICAL
: Used for charts that have vertical bars. Visuals that use this value are vertical bar charts, vertical stacked bar charts, and vertical stacked 100% bar charts.
Sourcepub fn get_orientation(&self) -> &Option<BarChartOrientation>
pub fn get_orientation(&self) -> &Option<BarChartOrientation>
The orientation of the bars in a bar chart visual. There are two valid values in this structure:
-
HORIZONTAL
: Used for charts that have horizontal bars. Visuals that use this value are horizontal bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts. -
VERTICAL
: Used for charts that have vertical bars. Visuals that use this value are vertical bar charts, vertical stacked bar charts, and vertical stacked 100% bar charts.
Sourcepub fn bars_arrangement(self, input: BarsArrangement) -> Self
pub fn bars_arrangement(self, input: BarsArrangement) -> Self
Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.
Sourcepub fn set_bars_arrangement(self, input: Option<BarsArrangement>) -> Self
pub fn set_bars_arrangement(self, input: Option<BarsArrangement>) -> Self
Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.
Sourcepub fn get_bars_arrangement(&self) -> &Option<BarsArrangement>
pub fn get_bars_arrangement(&self) -> &Option<BarsArrangement>
Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.
Sourcepub fn visual_palette(self, input: VisualPalette) -> Self
pub fn visual_palette(self, input: VisualPalette) -> Self
The palette (chart color) display setup of the visual.
Sourcepub fn set_visual_palette(self, input: Option<VisualPalette>) -> Self
pub fn set_visual_palette(self, input: Option<VisualPalette>) -> Self
The palette (chart color) display setup of the visual.
Sourcepub fn get_visual_palette(&self) -> &Option<VisualPalette>
pub fn get_visual_palette(&self) -> &Option<VisualPalette>
The palette (chart color) display setup of the visual.
Sourcepub fn small_multiples_options(self, input: SmallMultiplesOptions) -> Self
pub fn small_multiples_options(self, input: SmallMultiplesOptions) -> Self
The small multiples setup for the visual.
Sourcepub fn set_small_multiples_options(
self,
input: Option<SmallMultiplesOptions>,
) -> Self
pub fn set_small_multiples_options( self, input: Option<SmallMultiplesOptions>, ) -> Self
The small multiples setup for the visual.
Sourcepub fn get_small_multiples_options(&self) -> &Option<SmallMultiplesOptions>
pub fn get_small_multiples_options(&self) -> &Option<SmallMultiplesOptions>
The small multiples setup for the visual.
Sourcepub fn category_axis(self, input: AxisDisplayOptions) -> Self
pub fn category_axis(self, input: AxisDisplayOptions) -> Self
The label display options (grid line, range, scale, axis step) for bar chart category.
Sourcepub fn set_category_axis(self, input: Option<AxisDisplayOptions>) -> Self
pub fn set_category_axis(self, input: Option<AxisDisplayOptions>) -> Self
The label display options (grid line, range, scale, axis step) for bar chart category.
Sourcepub fn get_category_axis(&self) -> &Option<AxisDisplayOptions>
pub fn get_category_axis(&self) -> &Option<AxisDisplayOptions>
The label display options (grid line, range, scale, axis step) for bar chart category.
Sourcepub fn category_label_options(self, input: ChartAxisLabelOptions) -> Self
pub fn category_label_options(self, input: ChartAxisLabelOptions) -> Self
The label options (label text, label visibility and sort icon visibility) for a bar chart.
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 (label text, label visibility and sort icon visibility) for a bar chart.
Sourcepub fn get_category_label_options(&self) -> &Option<ChartAxisLabelOptions>
pub fn get_category_label_options(&self) -> &Option<ChartAxisLabelOptions>
The label options (label text, label visibility and sort icon visibility) for a bar chart.
Sourcepub fn value_axis(self, input: AxisDisplayOptions) -> Self
pub fn value_axis(self, input: AxisDisplayOptions) -> Self
The label display options (grid line, range, scale, axis step) for a bar chart value.
Sourcepub fn set_value_axis(self, input: Option<AxisDisplayOptions>) -> Self
pub fn set_value_axis(self, input: Option<AxisDisplayOptions>) -> Self
The label display options (grid line, range, scale, axis step) for a bar chart value.
Sourcepub fn get_value_axis(&self) -> &Option<AxisDisplayOptions>
pub fn get_value_axis(&self) -> &Option<AxisDisplayOptions>
The label display options (grid line, range, scale, axis step) for a bar chart value.
Sourcepub fn value_label_options(self, input: ChartAxisLabelOptions) -> Self
pub fn value_label_options(self, input: ChartAxisLabelOptions) -> Self
The label options (label text, label visibility and sort icon visibility) for a bar chart value.
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 (label text, label visibility and sort icon visibility) for a bar chart value.
Sourcepub fn get_value_label_options(&self) -> &Option<ChartAxisLabelOptions>
pub fn get_value_label_options(&self) -> &Option<ChartAxisLabelOptions>
The label options (label text, label visibility and sort icon visibility) for a bar chart value.
Sourcepub fn color_label_options(self, input: ChartAxisLabelOptions) -> Self
pub fn color_label_options(self, input: ChartAxisLabelOptions) -> Self
The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.
Sourcepub fn set_color_label_options(
self,
input: Option<ChartAxisLabelOptions>,
) -> Self
pub fn set_color_label_options( self, input: Option<ChartAxisLabelOptions>, ) -> Self
The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.
Sourcepub fn get_color_label_options(&self) -> &Option<ChartAxisLabelOptions>
pub fn get_color_label_options(&self) -> &Option<ChartAxisLabelOptions>
The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.
Sourcepub fn legend(self, input: LegendOptions) -> Self
pub fn legend(self, input: LegendOptions) -> Self
The legend display setup of the visual.
Sourcepub fn set_legend(self, input: Option<LegendOptions>) -> Self
pub fn set_legend(self, input: Option<LegendOptions>) -> Self
The legend display setup of the visual.
Sourcepub fn get_legend(&self) -> &Option<LegendOptions>
pub fn get_legend(&self) -> &Option<LegendOptions>
The legend display setup of the visual.
Sourcepub fn data_labels(self, input: DataLabelOptions) -> Self
pub fn data_labels(self, input: DataLabelOptions) -> Self
The options that determine if visual data labels are displayed.
Sourcepub fn set_data_labels(self, input: Option<DataLabelOptions>) -> Self
pub fn set_data_labels(self, input: Option<DataLabelOptions>) -> Self
The options that determine if visual data labels are displayed.
Sourcepub fn get_data_labels(&self) -> &Option<DataLabelOptions>
pub fn get_data_labels(&self) -> &Option<DataLabelOptions>
The options that determine if visual data labels are displayed.
Sourcepub fn tooltip(self, input: TooltipOptions) -> Self
pub fn tooltip(self, input: TooltipOptions) -> Self
The tooltip display setup of the visual.
Sourcepub fn set_tooltip(self, input: Option<TooltipOptions>) -> Self
pub fn set_tooltip(self, input: Option<TooltipOptions>) -> Self
The tooltip display setup of the visual.
Sourcepub fn get_tooltip(&self) -> &Option<TooltipOptions>
pub fn get_tooltip(&self) -> &Option<TooltipOptions>
The tooltip display setup of the visual.
Sourcepub fn reference_lines(self, input: ReferenceLine) -> Self
pub fn reference_lines(self, input: ReferenceLine) -> Self
Appends an item to reference_lines
.
To override the contents of this collection use set_reference_lines
.
The reference line setup of the visual.
Sourcepub fn set_reference_lines(self, input: Option<Vec<ReferenceLine>>) -> Self
pub fn set_reference_lines(self, input: Option<Vec<ReferenceLine>>) -> Self
The reference line setup of the visual.
Sourcepub fn get_reference_lines(&self) -> &Option<Vec<ReferenceLine>>
pub fn get_reference_lines(&self) -> &Option<Vec<ReferenceLine>>
The reference line setup of the visual.
Sourcepub fn contribution_analysis_defaults(
self,
input: ContributionAnalysisDefault,
) -> Self
pub fn contribution_analysis_defaults( self, input: ContributionAnalysisDefault, ) -> Self
Appends an item to contribution_analysis_defaults
.
To override the contents of this collection use set_contribution_analysis_defaults
.
The contribution analysis (anomaly configuration) setup of the visual.
Sourcepub fn set_contribution_analysis_defaults(
self,
input: Option<Vec<ContributionAnalysisDefault>>,
) -> Self
pub fn set_contribution_analysis_defaults( self, input: Option<Vec<ContributionAnalysisDefault>>, ) -> Self
The contribution analysis (anomaly configuration) setup of the visual.
Sourcepub fn get_contribution_analysis_defaults(
&self,
) -> &Option<Vec<ContributionAnalysisDefault>>
pub fn get_contribution_analysis_defaults( &self, ) -> &Option<Vec<ContributionAnalysisDefault>>
The contribution analysis (anomaly configuration) setup of the 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) -> BarChartConfiguration
pub fn build(self) -> BarChartConfiguration
Consumes the builder and constructs a BarChartConfiguration
.
Trait Implementations§
Source§impl Clone for BarChartConfigurationBuilder
impl Clone for BarChartConfigurationBuilder
Source§fn clone(&self) -> BarChartConfigurationBuilder
fn clone(&self) -> BarChartConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for BarChartConfigurationBuilder
impl Debug for BarChartConfigurationBuilder
Source§impl Default for BarChartConfigurationBuilder
impl Default for BarChartConfigurationBuilder
Source§fn default() -> BarChartConfigurationBuilder
fn default() -> BarChartConfigurationBuilder
Source§impl PartialEq for BarChartConfigurationBuilder
impl PartialEq for BarChartConfigurationBuilder
Source§fn eq(&self, other: &BarChartConfigurationBuilder) -> bool
fn eq(&self, other: &BarChartConfigurationBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for BarChartConfigurationBuilder
Auto Trait Implementations§
impl Freeze for BarChartConfigurationBuilder
impl RefUnwindSafe for BarChartConfigurationBuilder
impl Send for BarChartConfigurationBuilder
impl Sync for BarChartConfigurationBuilder
impl Unpin for BarChartConfigurationBuilder
impl UnwindSafe for BarChartConfigurationBuilder
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);