#[non_exhaustive]pub struct BarChartConfiguration {Show 17 fields
pub field_wells: Option<BarChartFieldWells>,
pub sort_configuration: Option<BarChartSortConfiguration>,
pub orientation: Option<BarChartOrientation>,
pub bars_arrangement: Option<BarsArrangement>,
pub visual_palette: Option<VisualPalette>,
pub small_multiples_options: Option<SmallMultiplesOptions>,
pub category_axis: Option<AxisDisplayOptions>,
pub category_label_options: Option<ChartAxisLabelOptions>,
pub value_axis: Option<AxisDisplayOptions>,
pub value_label_options: Option<ChartAxisLabelOptions>,
pub color_label_options: Option<ChartAxisLabelOptions>,
pub legend: Option<LegendOptions>,
pub data_labels: Option<DataLabelOptions>,
pub tooltip: Option<TooltipOptions>,
pub reference_lines: Option<Vec<ReferenceLine>>,
pub contribution_analysis_defaults: Option<Vec<ContributionAnalysisDefault>>,
pub interactions: Option<VisualInteractionOptions>,
}Expand description
The configuration of a BarChartVisual.
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<BarChartFieldWells>The field wells of the visual.
sort_configuration: Option<BarChartSortConfiguration>The sort configuration of a BarChartVisual.
orientation: 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.
bars_arrangement: 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.
visual_palette: Option<VisualPalette>The palette (chart color) display setup of the visual.
small_multiples_options: Option<SmallMultiplesOptions>The small multiples setup for the visual.
category_axis: Option<AxisDisplayOptions>The label display options (grid line, range, scale, axis step) for bar chart category.
category_label_options: Option<ChartAxisLabelOptions>The label options (label text, label visibility and sort icon visibility) for a bar chart.
value_axis: Option<AxisDisplayOptions>The label display options (grid line, range, scale, axis step) for a bar chart value.
value_label_options: Option<ChartAxisLabelOptions>The label options (label text, label visibility and sort icon visibility) for a bar chart value.
color_label_options: Option<ChartAxisLabelOptions>The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.
legend: Option<LegendOptions>The legend display setup of the visual.
data_labels: Option<DataLabelOptions>The options that determine if visual data labels are displayed.
tooltip: Option<TooltipOptions>The tooltip display setup of the visual.
reference_lines: Option<Vec<ReferenceLine>>The reference line setup of the visual.
contribution_analysis_defaults: Option<Vec<ContributionAnalysisDefault>>The contribution analysis (anomaly configuration) setup of the visual.
interactions: Option<VisualInteractionOptions>The general visual interactions setup for a visual.
Implementations§
Source§impl BarChartConfiguration
impl BarChartConfiguration
Sourcepub fn field_wells(&self) -> Option<&BarChartFieldWells>
pub fn field_wells(&self) -> Option<&BarChartFieldWells>
The field wells of the visual.
Sourcepub fn sort_configuration(&self) -> Option<&BarChartSortConfiguration>
pub fn sort_configuration(&self) -> Option<&BarChartSortConfiguration>
The sort configuration of a BarChartVisual.
Sourcepub fn orientation(&self) -> Option<&BarChartOrientation>
pub fn 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) -> Option<&BarsArrangement>
pub fn 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) -> Option<&VisualPalette>
pub fn visual_palette(&self) -> Option<&VisualPalette>
The palette (chart color) display setup of the visual.
Sourcepub fn small_multiples_options(&self) -> Option<&SmallMultiplesOptions>
pub fn small_multiples_options(&self) -> Option<&SmallMultiplesOptions>
The small multiples setup for the visual.
Sourcepub fn category_axis(&self) -> Option<&AxisDisplayOptions>
pub fn 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) -> Option<&ChartAxisLabelOptions>
pub fn 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) -> Option<&AxisDisplayOptions>
pub fn 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) -> Option<&ChartAxisLabelOptions>
pub fn 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) -> Option<&ChartAxisLabelOptions>
pub fn 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) -> Option<&LegendOptions>
pub fn legend(&self) -> Option<&LegendOptions>
The legend display setup of the visual.
Sourcepub fn data_labels(&self) -> Option<&DataLabelOptions>
pub fn data_labels(&self) -> Option<&DataLabelOptions>
The options that determine if visual data labels are displayed.
Sourcepub fn tooltip(&self) -> Option<&TooltipOptions>
pub fn tooltip(&self) -> Option<&TooltipOptions>
The tooltip display setup of the visual.
Sourcepub fn reference_lines(&self) -> &[ReferenceLine]
pub fn reference_lines(&self) -> &[ReferenceLine]
The reference line setup of the visual.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .reference_lines.is_none().
Sourcepub fn contribution_analysis_defaults(&self) -> &[ContributionAnalysisDefault]
pub fn contribution_analysis_defaults(&self) -> &[ContributionAnalysisDefault]
The contribution analysis (anomaly configuration) setup of the visual.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .contribution_analysis_defaults.is_none().
Sourcepub fn interactions(&self) -> Option<&VisualInteractionOptions>
pub fn interactions(&self) -> Option<&VisualInteractionOptions>
The general visual interactions setup for a visual.
Source§impl BarChartConfiguration
impl BarChartConfiguration
Sourcepub fn builder() -> BarChartConfigurationBuilder
pub fn builder() -> BarChartConfigurationBuilder
Creates a new builder-style object to manufacture BarChartConfiguration.
Trait Implementations§
Source§impl Clone for BarChartConfiguration
impl Clone for BarChartConfiguration
Source§fn clone(&self) -> BarChartConfiguration
fn clone(&self) -> BarChartConfiguration
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 BarChartConfiguration
impl Debug for BarChartConfiguration
Source§impl PartialEq for BarChartConfiguration
impl PartialEq for BarChartConfiguration
impl StructuralPartialEq for BarChartConfiguration
Auto Trait Implementations§
impl Freeze for BarChartConfiguration
impl RefUnwindSafe for BarChartConfiguration
impl Send for BarChartConfiguration
impl Sync for BarChartConfiguration
impl Unpin for BarChartConfiguration
impl UnwindSafe for BarChartConfiguration
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);