#[non_exhaustive]pub struct BoxPlotChartConfigurationBuilder { /* private fields */ }
Expand description
A builder for BoxPlotChartConfiguration
.
Implementations§
Source§impl BoxPlotChartConfigurationBuilder
impl BoxPlotChartConfigurationBuilder
Sourcepub fn field_wells(self, input: BoxPlotFieldWells) -> Self
pub fn field_wells(self, input: BoxPlotFieldWells) -> Self
The field wells of the visual.
Sourcepub fn set_field_wells(self, input: Option<BoxPlotFieldWells>) -> Self
pub fn set_field_wells(self, input: Option<BoxPlotFieldWells>) -> Self
The field wells of the visual.
Sourcepub fn get_field_wells(&self) -> &Option<BoxPlotFieldWells>
pub fn get_field_wells(&self) -> &Option<BoxPlotFieldWells>
The field wells of the visual.
Sourcepub fn sort_configuration(self, input: BoxPlotSortConfiguration) -> Self
pub fn sort_configuration(self, input: BoxPlotSortConfiguration) -> Self
The sort configuration of a BoxPlotVisual
.
Sourcepub fn set_sort_configuration(
self,
input: Option<BoxPlotSortConfiguration>,
) -> Self
pub fn set_sort_configuration( self, input: Option<BoxPlotSortConfiguration>, ) -> Self
The sort configuration of a BoxPlotVisual
.
Sourcepub fn get_sort_configuration(&self) -> &Option<BoxPlotSortConfiguration>
pub fn get_sort_configuration(&self) -> &Option<BoxPlotSortConfiguration>
The sort configuration of a BoxPlotVisual
.
Sourcepub fn box_plot_options(self, input: BoxPlotOptions) -> Self
pub fn box_plot_options(self, input: BoxPlotOptions) -> Self
The box plot chart options for a box plot visual
Sourcepub fn set_box_plot_options(self, input: Option<BoxPlotOptions>) -> Self
pub fn set_box_plot_options(self, input: Option<BoxPlotOptions>) -> Self
The box plot chart options for a box plot visual
Sourcepub fn get_box_plot_options(&self) -> &Option<BoxPlotOptions>
pub fn get_box_plot_options(&self) -> &Option<BoxPlotOptions>
The box plot chart options for a box plot 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) of a box plot 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) of a box plot 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) of a box plot 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) of a box plot category.
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) of a box plot category.
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) of a box plot category.
Sourcepub fn primary_y_axis_display_options(self, input: AxisDisplayOptions) -> Self
pub fn primary_y_axis_display_options(self, input: AxisDisplayOptions) -> Self
The label display options (grid line, range, scale, axis step) of a box plot category.
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 label display options (grid line, range, scale, axis step) of a box plot category.
Sourcepub fn get_primary_y_axis_display_options(&self) -> &Option<AxisDisplayOptions>
pub fn get_primary_y_axis_display_options(&self) -> &Option<AxisDisplayOptions>
The label display options (grid line, range, scale, axis step) of a box plot category.
Sourcepub fn primary_y_axis_label_options(self, input: ChartAxisLabelOptions) -> Self
pub fn primary_y_axis_label_options(self, input: ChartAxisLabelOptions) -> Self
The label options (label text, label visibility and sort icon visibility) of a box plot value.
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 label options (label text, label visibility and sort icon visibility) of a box plot value.
Sourcepub fn get_primary_y_axis_label_options(&self) -> &Option<ChartAxisLabelOptions>
pub fn get_primary_y_axis_label_options(&self) -> &Option<ChartAxisLabelOptions>
The label options (label text, label visibility and sort icon visibility) of a box plot value.
Sourcepub fn legend(self, input: LegendOptions) -> Self
pub fn legend(self, input: LegendOptions) -> Self
The options for the legend setup of a visual.
Sourcepub fn set_legend(self, input: Option<LegendOptions>) -> Self
pub fn set_legend(self, input: Option<LegendOptions>) -> Self
The options for the legend setup of a visual.
Sourcepub fn get_legend(&self) -> &Option<LegendOptions>
pub fn get_legend(&self) -> &Option<LegendOptions>
The options for the legend setup of a visual.
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 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 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) -> BoxPlotChartConfiguration
pub fn build(self) -> BoxPlotChartConfiguration
Consumes the builder and constructs a BoxPlotChartConfiguration
.
Trait Implementations§
Source§impl Clone for BoxPlotChartConfigurationBuilder
impl Clone for BoxPlotChartConfigurationBuilder
Source§fn clone(&self) -> BoxPlotChartConfigurationBuilder
fn clone(&self) -> BoxPlotChartConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for BoxPlotChartConfigurationBuilder
impl Default for BoxPlotChartConfigurationBuilder
Source§fn default() -> BoxPlotChartConfigurationBuilder
fn default() -> BoxPlotChartConfigurationBuilder
Source§impl PartialEq for BoxPlotChartConfigurationBuilder
impl PartialEq for BoxPlotChartConfigurationBuilder
Source§fn eq(&self, other: &BoxPlotChartConfigurationBuilder) -> bool
fn eq(&self, other: &BoxPlotChartConfigurationBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for BoxPlotChartConfigurationBuilder
Auto Trait Implementations§
impl Freeze for BoxPlotChartConfigurationBuilder
impl RefUnwindSafe for BoxPlotChartConfigurationBuilder
impl Send for BoxPlotChartConfigurationBuilder
impl Sync for BoxPlotChartConfigurationBuilder
impl Unpin for BoxPlotChartConfigurationBuilder
impl UnwindSafe for BoxPlotChartConfigurationBuilder
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);