#[non_exhaustive]pub struct LineChartConfigurationBuilder { /* private fields */ }
Expand description
A builder for LineChartConfiguration
.
Implementations§
Source§impl LineChartConfigurationBuilder
impl LineChartConfigurationBuilder
Sourcepub fn field_wells(self, input: LineChartFieldWells) -> Self
pub fn field_wells(self, input: LineChartFieldWells) -> Self
The field well configuration of a line chart.
Sourcepub fn set_field_wells(self, input: Option<LineChartFieldWells>) -> Self
pub fn set_field_wells(self, input: Option<LineChartFieldWells>) -> Self
The field well configuration of a line chart.
Sourcepub fn get_field_wells(&self) -> &Option<LineChartFieldWells>
pub fn get_field_wells(&self) -> &Option<LineChartFieldWells>
The field well configuration of a line chart.
Sourcepub fn sort_configuration(self, input: LineChartSortConfiguration) -> Self
pub fn sort_configuration(self, input: LineChartSortConfiguration) -> Self
The sort configuration of a line chart.
Sourcepub fn set_sort_configuration(
self,
input: Option<LineChartSortConfiguration>,
) -> Self
pub fn set_sort_configuration( self, input: Option<LineChartSortConfiguration>, ) -> Self
The sort configuration of a line chart.
Sourcepub fn get_sort_configuration(&self) -> &Option<LineChartSortConfiguration>
pub fn get_sort_configuration(&self) -> &Option<LineChartSortConfiguration>
The sort configuration of a line chart.
Sourcepub fn forecast_configurations(self, input: ForecastConfiguration) -> Self
pub fn forecast_configurations(self, input: ForecastConfiguration) -> Self
Appends an item to forecast_configurations
.
To override the contents of this collection use set_forecast_configurations
.
The forecast configuration of a line chart.
Sourcepub fn set_forecast_configurations(
self,
input: Option<Vec<ForecastConfiguration>>,
) -> Self
pub fn set_forecast_configurations( self, input: Option<Vec<ForecastConfiguration>>, ) -> Self
The forecast configuration of a line chart.
Sourcepub fn get_forecast_configurations(&self) -> &Option<Vec<ForecastConfiguration>>
pub fn get_forecast_configurations(&self) -> &Option<Vec<ForecastConfiguration>>
The forecast configuration of a line chart.
Sourcepub fn type(self, input: LineChartType) -> Self
pub fn type(self, input: LineChartType) -> Self
Determines the type of the line chart.
Sourcepub fn set_type(self, input: Option<LineChartType>) -> Self
pub fn set_type(self, input: Option<LineChartType>) -> Self
Determines the type of the line chart.
Sourcepub fn get_type(&self) -> &Option<LineChartType>
pub fn get_type(&self) -> &Option<LineChartType>
Determines the type of the line chart.
Sourcepub fn small_multiples_options(self, input: SmallMultiplesOptions) -> Self
pub fn small_multiples_options(self, input: SmallMultiplesOptions) -> Self
The small multiples setup for the visual.
Sourcepub fn set_small_multiples_options(
self,
input: Option<SmallMultiplesOptions>,
) -> Self
pub fn set_small_multiples_options( self, input: Option<SmallMultiplesOptions>, ) -> Self
The small multiples setup for the visual.
Sourcepub fn get_small_multiples_options(&self) -> &Option<SmallMultiplesOptions>
pub fn get_small_multiples_options(&self) -> &Option<SmallMultiplesOptions>
The small multiples setup for the visual.
Sourcepub fn x_axis_display_options(self, input: AxisDisplayOptions) -> Self
pub fn x_axis_display_options(self, input: AxisDisplayOptions) -> Self
The options that determine the presentation of the x-axis.
Sourcepub fn set_x_axis_display_options(
self,
input: Option<AxisDisplayOptions>,
) -> Self
pub fn set_x_axis_display_options( self, input: Option<AxisDisplayOptions>, ) -> Self
The options that determine the presentation of the x-axis.
Sourcepub fn get_x_axis_display_options(&self) -> &Option<AxisDisplayOptions>
pub fn get_x_axis_display_options(&self) -> &Option<AxisDisplayOptions>
The options that determine the presentation of the x-axis.
Sourcepub fn x_axis_label_options(self, input: ChartAxisLabelOptions) -> Self
pub fn x_axis_label_options(self, input: ChartAxisLabelOptions) -> Self
The options that determine the presentation of the x-axis label.
Sourcepub fn set_x_axis_label_options(
self,
input: Option<ChartAxisLabelOptions>,
) -> Self
pub fn set_x_axis_label_options( self, input: Option<ChartAxisLabelOptions>, ) -> Self
The options that determine the presentation of the x-axis label.
Sourcepub fn get_x_axis_label_options(&self) -> &Option<ChartAxisLabelOptions>
pub fn get_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,
input: LineSeriesAxisDisplayOptions,
) -> Self
pub fn primary_y_axis_display_options( self, input: LineSeriesAxisDisplayOptions, ) -> Self
The series axis configuration of a line chart.
Sourcepub fn set_primary_y_axis_display_options(
self,
input: Option<LineSeriesAxisDisplayOptions>,
) -> Self
pub fn set_primary_y_axis_display_options( self, input: Option<LineSeriesAxisDisplayOptions>, ) -> Self
The series axis configuration of a line chart.
Sourcepub fn get_primary_y_axis_display_options(
&self,
) -> &Option<LineSeriesAxisDisplayOptions>
pub fn get_primary_y_axis_display_options( &self, ) -> &Option<LineSeriesAxisDisplayOptions>
The series axis configuration of a line chart.
Sourcepub fn primary_y_axis_label_options(self, input: ChartAxisLabelOptions) -> Self
pub fn primary_y_axis_label_options(self, input: ChartAxisLabelOptions) -> Self
The options that determine the presentation of the y-axis label.
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 options that determine the presentation of the y-axis label.
Sourcepub fn get_primary_y_axis_label_options(&self) -> &Option<ChartAxisLabelOptions>
pub fn get_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,
input: LineSeriesAxisDisplayOptions,
) -> Self
pub fn secondary_y_axis_display_options( self, input: LineSeriesAxisDisplayOptions, ) -> Self
The series axis configuration of a line chart.
Sourcepub fn set_secondary_y_axis_display_options(
self,
input: Option<LineSeriesAxisDisplayOptions>,
) -> Self
pub fn set_secondary_y_axis_display_options( self, input: Option<LineSeriesAxisDisplayOptions>, ) -> Self
The series axis configuration of a line chart.
Sourcepub fn get_secondary_y_axis_display_options(
&self,
) -> &Option<LineSeriesAxisDisplayOptions>
pub fn get_secondary_y_axis_display_options( &self, ) -> &Option<LineSeriesAxisDisplayOptions>
The series axis configuration of a line chart.
Sourcepub fn secondary_y_axis_label_options(
self,
input: ChartAxisLabelOptions,
) -> Self
pub fn secondary_y_axis_label_options( self, input: ChartAxisLabelOptions, ) -> Self
The options that determine the presentation of the secondary y-axis label.
Sourcepub fn set_secondary_y_axis_label_options(
self,
input: Option<ChartAxisLabelOptions>,
) -> Self
pub fn set_secondary_y_axis_label_options( self, input: Option<ChartAxisLabelOptions>, ) -> Self
The options that determine the presentation of the secondary y-axis label.
Sourcepub fn get_secondary_y_axis_label_options(
&self,
) -> &Option<ChartAxisLabelOptions>
pub fn get_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, input: SingleAxisOptions) -> Self
pub fn single_axis_options(self, input: SingleAxisOptions) -> Self
The settings of a chart's single axis configuration.
Sourcepub fn set_single_axis_options(self, input: Option<SingleAxisOptions>) -> Self
pub fn set_single_axis_options(self, input: Option<SingleAxisOptions>) -> Self
The settings of a chart's single axis configuration.
Sourcepub fn get_single_axis_options(&self) -> &Option<SingleAxisOptions>
pub fn get_single_axis_options(&self) -> &Option<SingleAxisOptions>
The settings of a chart's single axis configuration.
Sourcepub fn default_series_settings(
self,
input: LineChartDefaultSeriesSettings,
) -> Self
pub fn default_series_settings( self, input: LineChartDefaultSeriesSettings, ) -> Self
The options that determine the default presentation of all line series in LineChartVisual
.
Sourcepub fn set_default_series_settings(
self,
input: Option<LineChartDefaultSeriesSettings>,
) -> Self
pub fn set_default_series_settings( self, input: Option<LineChartDefaultSeriesSettings>, ) -> Self
The options that determine the default presentation of all line series in LineChartVisual
.
Sourcepub fn get_default_series_settings(
&self,
) -> &Option<LineChartDefaultSeriesSettings>
pub fn get_default_series_settings( &self, ) -> &Option<LineChartDefaultSeriesSettings>
The options that determine the default presentation of all line series in LineChartVisual
.
Sourcepub fn series(self, input: SeriesItem) -> Self
pub fn series(self, input: SeriesItem) -> Self
Appends an item to series
.
To override the contents of this collection use set_series
.
The series item configuration of a line chart.
Sourcepub fn set_series(self, input: Option<Vec<SeriesItem>>) -> Self
pub fn set_series(self, input: Option<Vec<SeriesItem>>) -> Self
The series item configuration of a line chart.
Sourcepub fn get_series(&self) -> &Option<Vec<SeriesItem>>
pub fn get_series(&self) -> &Option<Vec<SeriesItem>>
The series item configuration of a line chart.
Sourcepub fn legend(self, input: LegendOptions) -> Self
pub fn legend(self, input: LegendOptions) -> Self
The legend configuration of a line chart.
Sourcepub fn set_legend(self, input: Option<LegendOptions>) -> Self
pub fn set_legend(self, input: Option<LegendOptions>) -> Self
The legend configuration of a line chart.
Sourcepub fn get_legend(&self) -> &Option<LegendOptions>
pub fn get_legend(&self) -> &Option<LegendOptions>
The legend configuration of a line chart.
Sourcepub fn data_labels(self, input: DataLabelOptions) -> Self
pub fn data_labels(self, input: DataLabelOptions) -> Self
The data label configuration of a line chart.
Sourcepub fn set_data_labels(self, input: Option<DataLabelOptions>) -> Self
pub fn set_data_labels(self, input: Option<DataLabelOptions>) -> Self
The data label configuration of a line chart.
Sourcepub fn get_data_labels(&self) -> &Option<DataLabelOptions>
pub fn get_data_labels(&self) -> &Option<DataLabelOptions>
The data label configuration of a line chart.
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 lines configuration of a line chart.
Sourcepub fn set_reference_lines(self, input: Option<Vec<ReferenceLine>>) -> Self
pub fn set_reference_lines(self, input: Option<Vec<ReferenceLine>>) -> Self
The reference lines configuration of a line chart.
Sourcepub fn get_reference_lines(&self) -> &Option<Vec<ReferenceLine>>
pub fn get_reference_lines(&self) -> &Option<Vec<ReferenceLine>>
The reference lines configuration of a line chart.
Sourcepub fn tooltip(self, input: TooltipOptions) -> Self
pub fn tooltip(self, input: TooltipOptions) -> Self
The tooltip configuration of a line chart.
Sourcepub fn set_tooltip(self, input: Option<TooltipOptions>) -> Self
pub fn set_tooltip(self, input: Option<TooltipOptions>) -> Self
The tooltip configuration of a line chart.
Sourcepub fn get_tooltip(&self) -> &Option<TooltipOptions>
pub fn get_tooltip(&self) -> &Option<TooltipOptions>
The tooltip configuration of a line chart.
Sourcepub fn contribution_analysis_defaults(
self,
input: ContributionAnalysisDefault,
) -> Self
pub fn contribution_analysis_defaults( self, input: ContributionAnalysisDefault, ) -> Self
Appends an item to contribution_analysis_defaults
.
To override the contents of this collection use set_contribution_analysis_defaults
.
The default configuration of a line chart's contribution analysis.
Sourcepub fn set_contribution_analysis_defaults(
self,
input: Option<Vec<ContributionAnalysisDefault>>,
) -> Self
pub fn set_contribution_analysis_defaults( self, input: Option<Vec<ContributionAnalysisDefault>>, ) -> Self
The default configuration of a line chart's contribution analysis.
Sourcepub fn get_contribution_analysis_defaults(
&self,
) -> &Option<Vec<ContributionAnalysisDefault>>
pub fn get_contribution_analysis_defaults( &self, ) -> &Option<Vec<ContributionAnalysisDefault>>
The default configuration of a line chart's contribution analysis.
Sourcepub fn visual_palette(self, input: VisualPalette) -> Self
pub fn visual_palette(self, input: VisualPalette) -> Self
The visual palette configuration of a line chart.
Sourcepub fn set_visual_palette(self, input: Option<VisualPalette>) -> Self
pub fn set_visual_palette(self, input: Option<VisualPalette>) -> Self
The visual palette configuration of a line chart.
Sourcepub fn get_visual_palette(&self) -> &Option<VisualPalette>
pub fn get_visual_palette(&self) -> &Option<VisualPalette>
The visual palette configuration of a line chart.
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) -> LineChartConfiguration
pub fn build(self) -> LineChartConfiguration
Consumes the builder and constructs a LineChartConfiguration
.
Trait Implementations§
Source§impl Clone for LineChartConfigurationBuilder
impl Clone for LineChartConfigurationBuilder
Source§fn clone(&self) -> LineChartConfigurationBuilder
fn clone(&self) -> LineChartConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for LineChartConfigurationBuilder
impl Default for LineChartConfigurationBuilder
Source§fn default() -> LineChartConfigurationBuilder
fn default() -> LineChartConfigurationBuilder
Source§impl PartialEq for LineChartConfigurationBuilder
impl PartialEq for LineChartConfigurationBuilder
Source§fn eq(&self, other: &LineChartConfigurationBuilder) -> bool
fn eq(&self, other: &LineChartConfigurationBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for LineChartConfigurationBuilder
Auto Trait Implementations§
impl Freeze for LineChartConfigurationBuilder
impl RefUnwindSafe for LineChartConfigurationBuilder
impl Send for LineChartConfigurationBuilder
impl Sync for LineChartConfigurationBuilder
impl Unpin for LineChartConfigurationBuilder
impl UnwindSafe for LineChartConfigurationBuilder
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);