#[non_exhaustive]
pub struct RadarChartConfigurationBuilder { /* private fields */ }
Expand description

A builder for RadarChartConfiguration.

Implementations§

source§

impl RadarChartConfigurationBuilder

source

pub fn field_wells(self, input: RadarChartFieldWells) -> Self

The field well configuration of a RadarChartVisual.

source

pub fn set_field_wells(self, input: Option<RadarChartFieldWells>) -> Self

The field well configuration of a RadarChartVisual.

source

pub fn get_field_wells(&self) -> &Option<RadarChartFieldWells>

The field well configuration of a RadarChartVisual.

source

pub fn sort_configuration(self, input: RadarChartSortConfiguration) -> Self

The sort configuration of a RadarChartVisual.

source

pub fn set_sort_configuration( self, input: Option<RadarChartSortConfiguration>, ) -> Self

The sort configuration of a RadarChartVisual.

source

pub fn get_sort_configuration(&self) -> &Option<RadarChartSortConfiguration>

The sort configuration of a RadarChartVisual.

source

pub fn shape(self, input: RadarChartShape) -> Self

The shape of the radar chart.

source

pub fn set_shape(self, input: Option<RadarChartShape>) -> Self

The shape of the radar chart.

source

pub fn get_shape(&self) -> &Option<RadarChartShape>

The shape of the radar chart.

source

pub fn base_series_settings(self, input: RadarChartSeriesSettings) -> Self

The base sreies settings of a radar chart.

source

pub fn set_base_series_settings( self, input: Option<RadarChartSeriesSettings>, ) -> Self

The base sreies settings of a radar chart.

source

pub fn get_base_series_settings(&self) -> &Option<RadarChartSeriesSettings>

The base sreies settings of a radar chart.

source

pub fn start_angle(self, input: f64) -> Self

The start angle of a radar chart's axis.

source

pub fn set_start_angle(self, input: Option<f64>) -> Self

The start angle of a radar chart's axis.

source

pub fn get_start_angle(&self) -> &Option<f64>

The start angle of a radar chart's axis.

source

pub fn visual_palette(self, input: VisualPalette) -> Self

The palette (chart color) display setup of the visual.

source

pub fn set_visual_palette(self, input: Option<VisualPalette>) -> Self

The palette (chart color) display setup of the visual.

source

pub fn get_visual_palette(&self) -> &Option<VisualPalette>

The palette (chart color) display setup of the visual.

source

pub fn alternate_band_colors_visibility(self, input: Visibility) -> Self

Determines the visibility of the colors of alternatign bands in a radar chart.

source

pub fn set_alternate_band_colors_visibility( self, input: Option<Visibility>, ) -> Self

Determines the visibility of the colors of alternatign bands in a radar chart.

source

pub fn get_alternate_band_colors_visibility(&self) -> &Option<Visibility>

Determines the visibility of the colors of alternatign bands in a radar chart.

source

pub fn alternate_band_even_color(self, input: impl Into<String>) -> Self

The color of the even-numbered alternate bands of a radar chart.

source

pub fn set_alternate_band_even_color(self, input: Option<String>) -> Self

The color of the even-numbered alternate bands of a radar chart.

source

pub fn get_alternate_band_even_color(&self) -> &Option<String>

The color of the even-numbered alternate bands of a radar chart.

source

pub fn alternate_band_odd_color(self, input: impl Into<String>) -> Self

The color of the odd-numbered alternate bands of a radar chart.

source

pub fn set_alternate_band_odd_color(self, input: Option<String>) -> Self

The color of the odd-numbered alternate bands of a radar chart.

source

pub fn get_alternate_band_odd_color(&self) -> &Option<String>

The color of the odd-numbered alternate bands of a radar chart.

source

pub fn category_axis(self, input: AxisDisplayOptions) -> Self

The category axis of a radar chart.

source

pub fn set_category_axis(self, input: Option<AxisDisplayOptions>) -> Self

The category axis of a radar chart.

source

pub fn get_category_axis(&self) -> &Option<AxisDisplayOptions>

The category axis of a radar chart.

source

pub fn category_label_options(self, input: ChartAxisLabelOptions) -> Self

The category label options of a radar chart.

source

pub fn set_category_label_options( self, input: Option<ChartAxisLabelOptions>, ) -> Self

The category label options of a radar chart.

source

pub fn get_category_label_options(&self) -> &Option<ChartAxisLabelOptions>

The category label options of a radar chart.

source

pub fn color_axis(self, input: AxisDisplayOptions) -> Self

The color axis of a radar chart.

source

pub fn set_color_axis(self, input: Option<AxisDisplayOptions>) -> Self

The color axis of a radar chart.

source

pub fn get_color_axis(&self) -> &Option<AxisDisplayOptions>

The color axis of a radar chart.

source

pub fn color_label_options(self, input: ChartAxisLabelOptions) -> Self

The color label options of a radar chart.

source

pub fn set_color_label_options( self, input: Option<ChartAxisLabelOptions>, ) -> Self

The color label options of a radar chart.

source

pub fn get_color_label_options(&self) -> &Option<ChartAxisLabelOptions>

The color label options of a radar chart.

source

pub fn legend(self, input: LegendOptions) -> Self

The legend display setup of the visual.

source

pub fn set_legend(self, input: Option<LegendOptions>) -> Self

The legend display setup of the visual.

source

pub fn get_legend(&self) -> &Option<LegendOptions>

The legend display setup of the visual.

source

pub fn axes_range_scale(self, input: RadarChartAxesRangeScale) -> Self

The axis behavior options of a radar chart.

source

pub fn set_axes_range_scale( self, input: Option<RadarChartAxesRangeScale>, ) -> Self

The axis behavior options of a radar chart.

source

pub fn get_axes_range_scale(&self) -> &Option<RadarChartAxesRangeScale>

The axis behavior options of a radar chart.

source

pub fn interactions(self, input: VisualInteractionOptions) -> Self

The general visual interactions setup for a visual.

source

pub fn set_interactions(self, input: Option<VisualInteractionOptions>) -> Self

The general visual interactions setup for a visual.

source

pub fn get_interactions(&self) -> &Option<VisualInteractionOptions>

The general visual interactions setup for a visual.

source

pub fn build(self) -> RadarChartConfiguration

Consumes the builder and constructs a RadarChartConfiguration.

Trait Implementations§

source§

impl Clone for RadarChartConfigurationBuilder

source§

fn clone(&self) -> RadarChartConfigurationBuilder

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for RadarChartConfigurationBuilder

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Default for RadarChartConfigurationBuilder

source§

fn default() -> RadarChartConfigurationBuilder

Returns the “default value” for a type. Read more
source§

impl PartialEq for RadarChartConfigurationBuilder

source§

fn eq(&self, other: &RadarChartConfigurationBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl StructuralPartialEq for RadarChartConfigurationBuilder

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Paint for T
where T: ?Sized,

source§

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 primary(&self) -> Painted<&T>

Returns self with the fg() set to Color::Primary.

§Example
println!("{}", value.primary());
source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to Color::Fixed.

§Example
println!("{}", value.fixed(color));
source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to Color::Rgb.

§Example
println!("{}", value.rgb(r, g, b));
source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to Color::Black.

§Example
println!("{}", value.black());
source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to Color::Red.

§Example
println!("{}", value.red());
source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to Color::Green.

§Example
println!("{}", value.green());
source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to Color::Yellow.

§Example
println!("{}", value.yellow());
source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to Color::Blue.

§Example
println!("{}", value.blue());
source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to Color::Magenta.

§Example
println!("{}", value.magenta());
source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to Color::Cyan.

§Example
println!("{}", value.cyan());
source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to Color::White.

§Example
println!("{}", value.white());
source§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightBlack.

§Example
println!("{}", value.bright_black());
source§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightRed.

§Example
println!("{}", value.bright_red());
source§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightGreen.

§Example
println!("{}", value.bright_green());
source§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightYellow.

§Example
println!("{}", value.bright_yellow());
source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightBlue.

§Example
println!("{}", value.bright_blue());
source§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightMagenta.

§Example
println!("{}", value.bright_magenta());
source§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightCyan.

§Example
println!("{}", value.bright_cyan());
source§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightWhite.

§Example
println!("{}", value.bright_white());
source§

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>

Returns self with the bg() set to Color::Primary.

§Example
println!("{}", value.on_primary());
source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to Color::Fixed.

§Example
println!("{}", value.on_fixed(color));
source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to Color::Rgb.

§Example
println!("{}", value.on_rgb(r, g, b));
source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to Color::Black.

§Example
println!("{}", value.on_black());
source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to Color::Red.

§Example
println!("{}", value.on_red());
source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to Color::Green.

§Example
println!("{}", value.on_green());
source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to Color::Yellow.

§Example
println!("{}", value.on_yellow());
source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to Color::Blue.

§Example
println!("{}", value.on_blue());
source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to Color::Magenta.

§Example
println!("{}", value.on_magenta());
source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to Color::Cyan.

§Example
println!("{}", value.on_cyan());
source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to Color::White.

§Example
println!("{}", value.on_white());
source§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightBlack.

§Example
println!("{}", value.on_bright_black());
source§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightRed.

§Example
println!("{}", value.on_bright_red());
source§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightGreen.

§Example
println!("{}", value.on_bright_green());
source§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightYellow.

§Example
println!("{}", value.on_bright_yellow());
source§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightBlue.

§Example
println!("{}", value.on_bright_blue());
source§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightMagenta.

§Example
println!("{}", value.on_bright_magenta());
source§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightCyan.

§Example
println!("{}", value.on_bright_cyan());
source§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightWhite.

§Example
println!("{}", value.on_bright_white());
source§

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 bold(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Bold.

§Example
println!("{}", value.bold());
source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Dim.

§Example
println!("{}", value.dim());
source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Italic.

§Example
println!("{}", value.italic());
source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Underline.

§Example
println!("{}", value.underline());

Returns self with the attr() set to Attribute::Blink.

§Example
println!("{}", value.blink());

Returns self with the attr() set to Attribute::RapidBlink.

§Example
println!("{}", value.rapid_blink());
source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Invert.

§Example
println!("{}", value.invert());
source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Conceal.

§Example
println!("{}", value.conceal());
source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Strike.

§Example
println!("{}", value.strike());
source§

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 mask(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Mask.

§Example
println!("{}", value.mask());
source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Wrap.

§Example
println!("{}", value.wrap());
source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Linger.

§Example
println!("{}", value.linger());
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.

Returns self with the quirk() set to Quirk::Clear.

§Example
println!("{}", value.clear());
source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Resetting.

§Example
println!("{}", value.resetting());
source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Bright.

§Example
println!("{}", value.bright());
source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::OnBright.

§Example
println!("{}", value.on_bright());
source§

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);
source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
source§

impl<T> Same for T

source§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more