#[non_exhaustive]pub struct ComboChartConfiguration {Show 18 fields
pub field_wells: Option<ComboChartFieldWells>,
pub sort_configuration: Option<ComboChartSortConfiguration>,
pub bars_arrangement: Option<BarsArrangement>,
pub category_axis: Option<AxisDisplayOptions>,
pub category_label_options: Option<ChartAxisLabelOptions>,
pub primary_y_axis_display_options: Option<AxisDisplayOptions>,
pub primary_y_axis_label_options: Option<ChartAxisLabelOptions>,
pub secondary_y_axis_display_options: Option<AxisDisplayOptions>,
pub secondary_y_axis_label_options: Option<ChartAxisLabelOptions>,
pub single_axis_options: Option<SingleAxisOptions>,
pub color_label_options: Option<ChartAxisLabelOptions>,
pub legend: Option<LegendOptions>,
pub bar_data_labels: Option<DataLabelOptions>,
pub line_data_labels: Option<DataLabelOptions>,
pub tooltip: Option<TooltipOptions>,
pub reference_lines: Option<Vec<ReferenceLine>>,
pub visual_palette: Option<VisualPalette>,
pub interactions: Option<VisualInteractionOptions>,
}
Expand description
The configuration of a ComboChartVisual
.
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<ComboChartFieldWells>
The field wells of the visual.
sort_configuration: Option<ComboChartSortConfiguration>
The sort configuration of a ComboChartVisual
.
bars_arrangement: Option<BarsArrangement>
Determines the bar arrangement in a combo chart. The following are valid values in this structure:
-
CLUSTERED
: For clustered bar combo charts. -
STACKED
: For stacked bar combo charts. -
STACKED_PERCENT
: Do not use. If you use this value, the operation returns a validation error.
category_axis: Option<AxisDisplayOptions>
The category axis of a combo chart.
category_label_options: Option<ChartAxisLabelOptions>
The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.
primary_y_axis_display_options: Option<AxisDisplayOptions>
The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.
primary_y_axis_label_options: Option<ChartAxisLabelOptions>
The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.
secondary_y_axis_display_options: Option<AxisDisplayOptions>
The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.
secondary_y_axis_label_options: Option<ChartAxisLabelOptions>
The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.
single_axis_options: Option<SingleAxisOptions>
The settings of a chart's single axis configuration.
color_label_options: Option<ChartAxisLabelOptions>
The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.
legend: Option<LegendOptions>
The legend display setup of the visual.
bar_data_labels: Option<DataLabelOptions>
The options that determine if visual data labels are displayed.
The data label options for a bar in a combo chart.
line_data_labels: Option<DataLabelOptions>
The options that determine if visual data labels are displayed.
The data label options for a line in a combo chart.
tooltip: Option<TooltipOptions>
The legend display setup of the visual.
reference_lines: Option<Vec<ReferenceLine>>
The reference line setup of the visual.
visual_palette: Option<VisualPalette>
The palette (chart color) display setup of the visual.
interactions: Option<VisualInteractionOptions>
The general visual interactions setup for a visual.
Implementations§
Source§impl ComboChartConfiguration
impl ComboChartConfiguration
Sourcepub fn field_wells(&self) -> Option<&ComboChartFieldWells>
pub fn field_wells(&self) -> Option<&ComboChartFieldWells>
The field wells of the visual.
Sourcepub fn sort_configuration(&self) -> Option<&ComboChartSortConfiguration>
pub fn sort_configuration(&self) -> Option<&ComboChartSortConfiguration>
The sort configuration of a ComboChartVisual
.
Sourcepub fn bars_arrangement(&self) -> Option<&BarsArrangement>
pub fn bars_arrangement(&self) -> Option<&BarsArrangement>
Determines the bar arrangement in a combo chart. The following are valid values in this structure:
-
CLUSTERED
: For clustered bar combo charts. -
STACKED
: For stacked bar combo charts. -
STACKED_PERCENT
: Do not use. If you use this value, the operation returns a validation error.
Sourcepub fn category_axis(&self) -> Option<&AxisDisplayOptions>
pub fn category_axis(&self) -> Option<&AxisDisplayOptions>
The category axis of a combo chart.
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) of a combo chart category (group/color) field well.
Sourcepub fn primary_y_axis_display_options(&self) -> Option<&AxisDisplayOptions>
pub fn primary_y_axis_display_options(&self) -> Option<&AxisDisplayOptions>
The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.
Sourcepub fn primary_y_axis_label_options(&self) -> Option<&ChartAxisLabelOptions>
pub fn primary_y_axis_label_options(&self) -> Option<&ChartAxisLabelOptions>
The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.
Sourcepub fn secondary_y_axis_display_options(&self) -> Option<&AxisDisplayOptions>
pub fn secondary_y_axis_display_options(&self) -> Option<&AxisDisplayOptions>
The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.
Sourcepub fn secondary_y_axis_label_options(&self) -> Option<&ChartAxisLabelOptions>
pub fn secondary_y_axis_label_options(&self) -> Option<&ChartAxisLabelOptions>
The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.
Sourcepub fn single_axis_options(&self) -> Option<&SingleAxisOptions>
pub fn single_axis_options(&self) -> Option<&SingleAxisOptions>
The settings of a chart's single axis configuration.
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) of a combo chart's color field well.
Sourcepub fn legend(&self) -> Option<&LegendOptions>
pub fn legend(&self) -> Option<&LegendOptions>
The legend display setup of the visual.
Sourcepub fn bar_data_labels(&self) -> Option<&DataLabelOptions>
pub fn bar_data_labels(&self) -> Option<&DataLabelOptions>
The options that determine if visual data labels are displayed.
The data label options for a bar in a combo chart.
Sourcepub fn line_data_labels(&self) -> Option<&DataLabelOptions>
pub fn line_data_labels(&self) -> Option<&DataLabelOptions>
The options that determine if visual data labels are displayed.
The data label options for a line in a combo chart.
Sourcepub fn tooltip(&self) -> Option<&TooltipOptions>
pub fn tooltip(&self) -> Option<&TooltipOptions>
The legend 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 visual_palette(&self) -> Option<&VisualPalette>
pub fn visual_palette(&self) -> Option<&VisualPalette>
The palette (chart color) display setup of the visual.
Sourcepub fn interactions(&self) -> Option<&VisualInteractionOptions>
pub fn interactions(&self) -> Option<&VisualInteractionOptions>
The general visual interactions setup for a visual.
Source§impl ComboChartConfiguration
impl ComboChartConfiguration
Sourcepub fn builder() -> ComboChartConfigurationBuilder
pub fn builder() -> ComboChartConfigurationBuilder
Creates a new builder-style object to manufacture ComboChartConfiguration
.
Trait Implementations§
Source§impl Clone for ComboChartConfiguration
impl Clone for ComboChartConfiguration
Source§fn clone(&self) -> ComboChartConfiguration
fn clone(&self) -> ComboChartConfiguration
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ComboChartConfiguration
impl Debug for ComboChartConfiguration
Source§impl PartialEq for ComboChartConfiguration
impl PartialEq for ComboChartConfiguration
impl StructuralPartialEq for ComboChartConfiguration
Auto Trait Implementations§
impl Freeze for ComboChartConfiguration
impl RefUnwindSafe for ComboChartConfiguration
impl Send for ComboChartConfiguration
impl Sync for ComboChartConfiguration
impl Unpin for ComboChartConfiguration
impl UnwindSafe for ComboChartConfiguration
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);