#[non_exhaustive]pub struct LineChartConfiguration {Show 21 fields
pub field_wells: Option<LineChartFieldWells>,
pub sort_configuration: Option<LineChartSortConfiguration>,
pub forecast_configurations: Option<Vec<ForecastConfiguration>>,
pub type: Option<LineChartType>,
pub small_multiples_options: Option<SmallMultiplesOptions>,
pub x_axis_display_options: Option<AxisDisplayOptions>,
pub x_axis_label_options: Option<ChartAxisLabelOptions>,
pub primary_y_axis_display_options: Option<LineSeriesAxisDisplayOptions>,
pub primary_y_axis_label_options: Option<ChartAxisLabelOptions>,
pub secondary_y_axis_display_options: Option<LineSeriesAxisDisplayOptions>,
pub secondary_y_axis_label_options: Option<ChartAxisLabelOptions>,
pub single_axis_options: Option<SingleAxisOptions>,
pub default_series_settings: Option<LineChartDefaultSeriesSettings>,
pub series: Option<Vec<SeriesItem>>,
pub legend: Option<LegendOptions>,
pub data_labels: Option<DataLabelOptions>,
pub reference_lines: Option<Vec<ReferenceLine>>,
pub tooltip: Option<TooltipOptions>,
pub contribution_analysis_defaults: Option<Vec<ContributionAnalysisDefault>>,
pub visual_palette: Option<VisualPalette>,
pub interactions: Option<VisualInteractionOptions>,
}Expand description
The configuration of a line 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<LineChartFieldWells>The field well configuration of a line chart.
sort_configuration: Option<LineChartSortConfiguration>The sort configuration of a line chart.
forecast_configurations: Option<Vec<ForecastConfiguration>>The forecast configuration of a line chart.
type: Option<LineChartType>Determines the type of the line chart.
small_multiples_options: Option<SmallMultiplesOptions>The small multiples setup for the visual.
x_axis_display_options: Option<AxisDisplayOptions>The options that determine the presentation of the x-axis.
x_axis_label_options: Option<ChartAxisLabelOptions>The options that determine the presentation of the x-axis label.
primary_y_axis_display_options: Option<LineSeriesAxisDisplayOptions>The series axis configuration of a line chart.
primary_y_axis_label_options: Option<ChartAxisLabelOptions>The options that determine the presentation of the y-axis label.
secondary_y_axis_display_options: Option<LineSeriesAxisDisplayOptions>The series axis configuration of a line chart.
secondary_y_axis_label_options: Option<ChartAxisLabelOptions>The options that determine the presentation of the secondary y-axis label.
single_axis_options: Option<SingleAxisOptions>The settings of a chart's single axis configuration.
default_series_settings: Option<LineChartDefaultSeriesSettings>The options that determine the default presentation of all line series in LineChartVisual.
series: Option<Vec<SeriesItem>>The series item configuration of a line chart.
legend: Option<LegendOptions>The legend configuration of a line chart.
data_labels: Option<DataLabelOptions>The data label configuration of a line chart.
reference_lines: Option<Vec<ReferenceLine>>The reference lines configuration of a line chart.
tooltip: Option<TooltipOptions>The tooltip configuration of a line chart.
contribution_analysis_defaults: Option<Vec<ContributionAnalysisDefault>>The default configuration of a line chart's contribution analysis.
visual_palette: Option<VisualPalette>The visual palette configuration of a line chart.
interactions: Option<VisualInteractionOptions>The general visual interactions setup for a visual.
Implementations§
Source§impl LineChartConfiguration
impl LineChartConfiguration
Sourcepub fn field_wells(&self) -> Option<&LineChartFieldWells>
pub fn field_wells(&self) -> Option<&LineChartFieldWells>
The field well configuration of a line chart.
Sourcepub fn sort_configuration(&self) -> Option<&LineChartSortConfiguration>
pub fn sort_configuration(&self) -> Option<&LineChartSortConfiguration>
The sort configuration of a line chart.
Sourcepub fn forecast_configurations(&self) -> &[ForecastConfiguration]
pub fn forecast_configurations(&self) -> &[ForecastConfiguration]
The forecast configuration of a line chart.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .forecast_configurations.is_none().
Sourcepub fn type(&self) -> Option<&LineChartType>
pub fn type(&self) -> Option<&LineChartType>
Determines the type of the line 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 x_axis_display_options(&self) -> Option<&AxisDisplayOptions>
pub fn x_axis_display_options(&self) -> Option<&AxisDisplayOptions>
The options that determine the presentation of the x-axis.
Sourcepub fn x_axis_label_options(&self) -> Option<&ChartAxisLabelOptions>
pub fn x_axis_label_options(&self) -> Option<&ChartAxisLabelOptions>
The options that determine the presentation of the x-axis label.
Sourcepub fn primary_y_axis_display_options(
&self,
) -> Option<&LineSeriesAxisDisplayOptions>
pub fn primary_y_axis_display_options( &self, ) -> Option<&LineSeriesAxisDisplayOptions>
The series axis configuration of a line chart.
Sourcepub fn primary_y_axis_label_options(&self) -> Option<&ChartAxisLabelOptions>
pub fn primary_y_axis_label_options(&self) -> Option<&ChartAxisLabelOptions>
The options that determine the presentation of the y-axis label.
Sourcepub fn secondary_y_axis_display_options(
&self,
) -> Option<&LineSeriesAxisDisplayOptions>
pub fn secondary_y_axis_display_options( &self, ) -> Option<&LineSeriesAxisDisplayOptions>
The series axis configuration of a line chart.
Sourcepub fn secondary_y_axis_label_options(&self) -> Option<&ChartAxisLabelOptions>
pub fn secondary_y_axis_label_options(&self) -> Option<&ChartAxisLabelOptions>
The options that determine the presentation of the secondary y-axis label.
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 default_series_settings(&self) -> Option<&LineChartDefaultSeriesSettings>
pub fn default_series_settings(&self) -> Option<&LineChartDefaultSeriesSettings>
The options that determine the default presentation of all line series in LineChartVisual.
Sourcepub fn series(&self) -> &[SeriesItem]
pub fn series(&self) -> &[SeriesItem]
The series item configuration of a line chart.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .series.is_none().
Sourcepub fn legend(&self) -> Option<&LegendOptions>
pub fn legend(&self) -> Option<&LegendOptions>
The legend configuration of a line chart.
Sourcepub fn data_labels(&self) -> Option<&DataLabelOptions>
pub fn data_labels(&self) -> Option<&DataLabelOptions>
The data label configuration of a line chart.
Sourcepub fn reference_lines(&self) -> &[ReferenceLine]
pub fn reference_lines(&self) -> &[ReferenceLine]
The reference lines configuration of a line chart.
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 tooltip(&self) -> Option<&TooltipOptions>
pub fn tooltip(&self) -> Option<&TooltipOptions>
The tooltip configuration of a line chart.
Sourcepub fn contribution_analysis_defaults(&self) -> &[ContributionAnalysisDefault]
pub fn contribution_analysis_defaults(&self) -> &[ContributionAnalysisDefault]
The default configuration of a line chart's contribution analysis.
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 visual_palette(&self) -> Option<&VisualPalette>
pub fn visual_palette(&self) -> Option<&VisualPalette>
The visual palette configuration of a line chart.
Sourcepub fn interactions(&self) -> Option<&VisualInteractionOptions>
pub fn interactions(&self) -> Option<&VisualInteractionOptions>
The general visual interactions setup for a visual.
Source§impl LineChartConfiguration
impl LineChartConfiguration
Sourcepub fn builder() -> LineChartConfigurationBuilder
pub fn builder() -> LineChartConfigurationBuilder
Creates a new builder-style object to manufacture LineChartConfiguration.
Trait Implementations§
Source§impl Clone for LineChartConfiguration
impl Clone for LineChartConfiguration
Source§fn clone(&self) -> LineChartConfiguration
fn clone(&self) -> LineChartConfiguration
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 LineChartConfiguration
impl Debug for LineChartConfiguration
Source§impl PartialEq for LineChartConfiguration
impl PartialEq for LineChartConfiguration
Source§fn eq(&self, other: &LineChartConfiguration) -> bool
fn eq(&self, other: &LineChartConfiguration) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for LineChartConfiguration
Auto Trait Implementations§
impl Freeze for LineChartConfiguration
impl RefUnwindSafe for LineChartConfiguration
impl Send for LineChartConfiguration
impl Sync for LineChartConfiguration
impl Unpin for LineChartConfiguration
impl UnwindSafe for LineChartConfiguration
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);