#[non_exhaustive]pub struct AxisDisplayOptionsBuilder { /* private fields */ }
Expand description
A builder for AxisDisplayOptions
.
Implementations§
Source§impl AxisDisplayOptionsBuilder
impl AxisDisplayOptionsBuilder
Sourcepub fn tick_label_options(self, input: AxisTickLabelOptions) -> Self
pub fn tick_label_options(self, input: AxisTickLabelOptions) -> Self
The tick label options of an axis.
Sourcepub fn set_tick_label_options(self, input: Option<AxisTickLabelOptions>) -> Self
pub fn set_tick_label_options(self, input: Option<AxisTickLabelOptions>) -> Self
The tick label options of an axis.
Sourcepub fn get_tick_label_options(&self) -> &Option<AxisTickLabelOptions>
pub fn get_tick_label_options(&self) -> &Option<AxisTickLabelOptions>
The tick label options of an axis.
Sourcepub fn axis_line_visibility(self, input: Visibility) -> Self
pub fn axis_line_visibility(self, input: Visibility) -> Self
Determines whether or not the axis line is visible.
Sourcepub fn set_axis_line_visibility(self, input: Option<Visibility>) -> Self
pub fn set_axis_line_visibility(self, input: Option<Visibility>) -> Self
Determines whether or not the axis line is visible.
Sourcepub fn get_axis_line_visibility(&self) -> &Option<Visibility>
pub fn get_axis_line_visibility(&self) -> &Option<Visibility>
Determines whether or not the axis line is visible.
Sourcepub fn grid_line_visibility(self, input: Visibility) -> Self
pub fn grid_line_visibility(self, input: Visibility) -> Self
Determines whether or not the grid line is visible.
Sourcepub fn set_grid_line_visibility(self, input: Option<Visibility>) -> Self
pub fn set_grid_line_visibility(self, input: Option<Visibility>) -> Self
Determines whether or not the grid line is visible.
Sourcepub fn get_grid_line_visibility(&self) -> &Option<Visibility>
pub fn get_grid_line_visibility(&self) -> &Option<Visibility>
Determines whether or not the grid line is visible.
Sourcepub fn data_options(self, input: AxisDataOptions) -> Self
pub fn data_options(self, input: AxisDataOptions) -> Self
The data options for an axis.
Sourcepub fn set_data_options(self, input: Option<AxisDataOptions>) -> Self
pub fn set_data_options(self, input: Option<AxisDataOptions>) -> Self
The data options for an axis.
Sourcepub fn get_data_options(&self) -> &Option<AxisDataOptions>
pub fn get_data_options(&self) -> &Option<AxisDataOptions>
The data options for an axis.
Sourcepub fn scrollbar_options(self, input: ScrollBarOptions) -> Self
pub fn scrollbar_options(self, input: ScrollBarOptions) -> Self
The scroll bar options for an axis.
Sourcepub fn set_scrollbar_options(self, input: Option<ScrollBarOptions>) -> Self
pub fn set_scrollbar_options(self, input: Option<ScrollBarOptions>) -> Self
The scroll bar options for an axis.
Sourcepub fn get_scrollbar_options(&self) -> &Option<ScrollBarOptions>
pub fn get_scrollbar_options(&self) -> &Option<ScrollBarOptions>
The scroll bar options for an axis.
Sourcepub fn axis_offset(self, input: impl Into<String>) -> Self
pub fn axis_offset(self, input: impl Into<String>) -> Self
The offset value that determines the starting placement of the axis within a visual's bounds.
Sourcepub fn set_axis_offset(self, input: Option<String>) -> Self
pub fn set_axis_offset(self, input: Option<String>) -> Self
The offset value that determines the starting placement of the axis within a visual's bounds.
Sourcepub fn get_axis_offset(&self) -> &Option<String>
pub fn get_axis_offset(&self) -> &Option<String>
The offset value that determines the starting placement of the axis within a visual's bounds.
Sourcepub fn build(self) -> AxisDisplayOptions
pub fn build(self) -> AxisDisplayOptions
Consumes the builder and constructs a AxisDisplayOptions
.
Trait Implementations§
Source§impl Clone for AxisDisplayOptionsBuilder
impl Clone for AxisDisplayOptionsBuilder
Source§fn clone(&self) -> AxisDisplayOptionsBuilder
fn clone(&self) -> AxisDisplayOptionsBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for AxisDisplayOptionsBuilder
impl Debug for AxisDisplayOptionsBuilder
Source§impl Default for AxisDisplayOptionsBuilder
impl Default for AxisDisplayOptionsBuilder
Source§fn default() -> AxisDisplayOptionsBuilder
fn default() -> AxisDisplayOptionsBuilder
impl StructuralPartialEq for AxisDisplayOptionsBuilder
Auto Trait Implementations§
impl Freeze for AxisDisplayOptionsBuilder
impl RefUnwindSafe for AxisDisplayOptionsBuilder
impl Send for AxisDisplayOptionsBuilder
impl Sync for AxisDisplayOptionsBuilder
impl Unpin for AxisDisplayOptionsBuilder
impl UnwindSafe for AxisDisplayOptionsBuilder
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);