#[non_exhaustive]pub struct PieChartConfiguration {
pub field_wells: Option<PieChartFieldWells>,
pub sort_configuration: Option<PieChartSortConfiguration>,
pub donut_options: Option<DonutOptions>,
pub small_multiples_options: Option<SmallMultiplesOptions>,
pub category_label_options: Option<ChartAxisLabelOptions>,
pub value_label_options: Option<ChartAxisLabelOptions>,
pub legend: Option<LegendOptions>,
pub data_labels: Option<DataLabelOptions>,
pub tooltip: Option<TooltipOptions>,
pub visual_palette: Option<VisualPalette>,
pub contribution_analysis_defaults: Option<Vec<ContributionAnalysisDefault>>,
pub interactions: Option<VisualInteractionOptions>,
}
Expand description
The configuration of a pie chart.
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<PieChartFieldWells>
The field wells of the visual.
sort_configuration: Option<PieChartSortConfiguration>
The sort configuration of a pie chart.
donut_options: Option<DonutOptions>
The options that determine the shape of the chart. This option determines whether the chart is a pie chart or a donut chart.
small_multiples_options: Option<SmallMultiplesOptions>
The small multiples setup for the visual.
category_label_options: Option<ChartAxisLabelOptions>
The label options of the group/color that is displayed in a pie chart.
value_label_options: Option<ChartAxisLabelOptions>
The label options for the value that is displayed in a pie 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.
visual_palette: Option<VisualPalette>
The palette (chart color) display 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 PieChartConfiguration
impl PieChartConfiguration
Sourcepub fn field_wells(&self) -> Option<&PieChartFieldWells>
pub fn field_wells(&self) -> Option<&PieChartFieldWells>
The field wells of the visual.
Sourcepub fn sort_configuration(&self) -> Option<&PieChartSortConfiguration>
pub fn sort_configuration(&self) -> Option<&PieChartSortConfiguration>
The sort configuration of a pie chart.
Sourcepub fn donut_options(&self) -> Option<&DonutOptions>
pub fn donut_options(&self) -> Option<&DonutOptions>
The options that determine the shape of the chart. This option determines whether the chart is a pie chart or a donut chart.
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_label_options(&self) -> Option<&ChartAxisLabelOptions>
pub fn category_label_options(&self) -> Option<&ChartAxisLabelOptions>
The label options of the group/color that is displayed in a pie chart.
Sourcepub fn value_label_options(&self) -> Option<&ChartAxisLabelOptions>
pub fn value_label_options(&self) -> Option<&ChartAxisLabelOptions>
The label options for the value that is displayed in a pie 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 visual_palette(&self) -> Option<&VisualPalette>
pub fn visual_palette(&self) -> Option<&VisualPalette>
The palette (chart color) display setup of the visual.
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 PieChartConfiguration
impl PieChartConfiguration
Sourcepub fn builder() -> PieChartConfigurationBuilder
pub fn builder() -> PieChartConfigurationBuilder
Creates a new builder-style object to manufacture PieChartConfiguration
.
Trait Implementations§
Source§impl Clone for PieChartConfiguration
impl Clone for PieChartConfiguration
Source§fn clone(&self) -> PieChartConfiguration
fn clone(&self) -> PieChartConfiguration
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 PieChartConfiguration
impl Debug for PieChartConfiguration
Source§impl PartialEq for PieChartConfiguration
impl PartialEq for PieChartConfiguration
impl StructuralPartialEq for PieChartConfiguration
Auto Trait Implementations§
impl Freeze for PieChartConfiguration
impl RefUnwindSafe for PieChartConfiguration
impl Send for PieChartConfiguration
impl Sync for PieChartConfiguration
impl Unpin for PieChartConfiguration
impl UnwindSafe for PieChartConfiguration
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);