#[non_exhaustive]pub struct TreeMapConfigurationBuilder { /* private fields */ }
Expand description
A builder for TreeMapConfiguration
.
Implementations§
Source§impl TreeMapConfigurationBuilder
impl TreeMapConfigurationBuilder
Sourcepub fn field_wells(self, input: TreeMapFieldWells) -> Self
pub fn field_wells(self, input: TreeMapFieldWells) -> Self
The field wells of the visual.
Sourcepub fn set_field_wells(self, input: Option<TreeMapFieldWells>) -> Self
pub fn set_field_wells(self, input: Option<TreeMapFieldWells>) -> Self
The field wells of the visual.
Sourcepub fn get_field_wells(&self) -> &Option<TreeMapFieldWells>
pub fn get_field_wells(&self) -> &Option<TreeMapFieldWells>
The field wells of the visual.
Sourcepub fn sort_configuration(self, input: TreeMapSortConfiguration) -> Self
pub fn sort_configuration(self, input: TreeMapSortConfiguration) -> Self
The sort configuration of a tree map.
Sourcepub fn set_sort_configuration(
self,
input: Option<TreeMapSortConfiguration>,
) -> Self
pub fn set_sort_configuration( self, input: Option<TreeMapSortConfiguration>, ) -> Self
The sort configuration of a tree map.
Sourcepub fn get_sort_configuration(&self) -> &Option<TreeMapSortConfiguration>
pub fn get_sort_configuration(&self) -> &Option<TreeMapSortConfiguration>
The sort configuration of a tree map.
Sourcepub fn group_label_options(self, input: ChartAxisLabelOptions) -> Self
pub fn group_label_options(self, input: ChartAxisLabelOptions) -> Self
The label options (label text, label visibility) of the groups that are displayed in a tree map.
Sourcepub fn set_group_label_options(
self,
input: Option<ChartAxisLabelOptions>,
) -> Self
pub fn set_group_label_options( self, input: Option<ChartAxisLabelOptions>, ) -> Self
The label options (label text, label visibility) of the groups that are displayed in a tree map.
Sourcepub fn get_group_label_options(&self) -> &Option<ChartAxisLabelOptions>
pub fn get_group_label_options(&self) -> &Option<ChartAxisLabelOptions>
The label options (label text, label visibility) of the groups that are displayed in a tree map.
Sourcepub fn size_label_options(self, input: ChartAxisLabelOptions) -> Self
pub fn size_label_options(self, input: ChartAxisLabelOptions) -> Self
The label options (label text, label visibility) of the sizes that are displayed in a tree map.
Sourcepub fn set_size_label_options(
self,
input: Option<ChartAxisLabelOptions>,
) -> Self
pub fn set_size_label_options( self, input: Option<ChartAxisLabelOptions>, ) -> Self
The label options (label text, label visibility) of the sizes that are displayed in a tree map.
Sourcepub fn get_size_label_options(&self) -> &Option<ChartAxisLabelOptions>
pub fn get_size_label_options(&self) -> &Option<ChartAxisLabelOptions>
The label options (label text, label visibility) of the sizes that are displayed in a tree map.
Sourcepub fn color_label_options(self, input: ChartAxisLabelOptions) -> Self
pub fn color_label_options(self, input: ChartAxisLabelOptions) -> Self
The label options (label text, label visibility) for the colors displayed in a tree map.
Sourcepub fn set_color_label_options(
self,
input: Option<ChartAxisLabelOptions>,
) -> Self
pub fn set_color_label_options( self, input: Option<ChartAxisLabelOptions>, ) -> Self
The label options (label text, label visibility) for the colors displayed in a tree map.
Sourcepub fn get_color_label_options(&self) -> &Option<ChartAxisLabelOptions>
pub fn get_color_label_options(&self) -> &Option<ChartAxisLabelOptions>
The label options (label text, label visibility) for the colors displayed in a tree map.
Sourcepub fn color_scale(self, input: ColorScale) -> Self
pub fn color_scale(self, input: ColorScale) -> Self
The color options (gradient color, point of divergence) of a tree map.
Sourcepub fn set_color_scale(self, input: Option<ColorScale>) -> Self
pub fn set_color_scale(self, input: Option<ColorScale>) -> Self
The color options (gradient color, point of divergence) of a tree map.
Sourcepub fn get_color_scale(&self) -> &Option<ColorScale>
pub fn get_color_scale(&self) -> &Option<ColorScale>
The color options (gradient color, point of divergence) of a tree map.
Sourcepub fn legend(self, input: LegendOptions) -> Self
pub fn legend(self, input: LegendOptions) -> Self
The legend display setup of the visual.
Sourcepub fn set_legend(self, input: Option<LegendOptions>) -> Self
pub fn set_legend(self, input: Option<LegendOptions>) -> Self
The legend display setup of the visual.
Sourcepub fn get_legend(&self) -> &Option<LegendOptions>
pub fn get_legend(&self) -> &Option<LegendOptions>
The legend display setup of the visual.
Sourcepub fn data_labels(self, input: DataLabelOptions) -> Self
pub fn data_labels(self, input: DataLabelOptions) -> Self
The options that determine if visual data labels are displayed.
Sourcepub fn set_data_labels(self, input: Option<DataLabelOptions>) -> Self
pub fn set_data_labels(self, input: Option<DataLabelOptions>) -> Self
The options that determine if visual data labels are displayed.
Sourcepub fn get_data_labels(&self) -> &Option<DataLabelOptions>
pub fn get_data_labels(&self) -> &Option<DataLabelOptions>
The options that determine if visual data labels are displayed.
Sourcepub fn tooltip(self, input: TooltipOptions) -> Self
pub fn tooltip(self, input: TooltipOptions) -> Self
The tooltip display setup of the visual.
Sourcepub fn set_tooltip(self, input: Option<TooltipOptions>) -> Self
pub fn set_tooltip(self, input: Option<TooltipOptions>) -> Self
The tooltip display setup of the visual.
Sourcepub fn get_tooltip(&self) -> &Option<TooltipOptions>
pub fn get_tooltip(&self) -> &Option<TooltipOptions>
The tooltip display setup of the visual.
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) -> TreeMapConfiguration
pub fn build(self) -> TreeMapConfiguration
Consumes the builder and constructs a TreeMapConfiguration
.
Trait Implementations§
Source§impl Clone for TreeMapConfigurationBuilder
impl Clone for TreeMapConfigurationBuilder
Source§fn clone(&self) -> TreeMapConfigurationBuilder
fn clone(&self) -> TreeMapConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for TreeMapConfigurationBuilder
impl Debug for TreeMapConfigurationBuilder
Source§impl Default for TreeMapConfigurationBuilder
impl Default for TreeMapConfigurationBuilder
Source§fn default() -> TreeMapConfigurationBuilder
fn default() -> TreeMapConfigurationBuilder
impl StructuralPartialEq for TreeMapConfigurationBuilder
Auto Trait Implementations§
impl Freeze for TreeMapConfigurationBuilder
impl RefUnwindSafe for TreeMapConfigurationBuilder
impl Send for TreeMapConfigurationBuilder
impl Sync for TreeMapConfigurationBuilder
impl Unpin for TreeMapConfigurationBuilder
impl UnwindSafe for TreeMapConfigurationBuilder
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);