#[non_exhaustive]pub struct TableConfigurationBuilder { /* private fields */ }
Expand description
A builder for TableConfiguration
.
Implementations§
Source§impl TableConfigurationBuilder
impl TableConfigurationBuilder
Sourcepub fn field_wells(self, input: TableFieldWells) -> Self
pub fn field_wells(self, input: TableFieldWells) -> Self
The field wells of the visual.
Sourcepub fn set_field_wells(self, input: Option<TableFieldWells>) -> Self
pub fn set_field_wells(self, input: Option<TableFieldWells>) -> Self
The field wells of the visual.
Sourcepub fn get_field_wells(&self) -> &Option<TableFieldWells>
pub fn get_field_wells(&self) -> &Option<TableFieldWells>
The field wells of the visual.
Sourcepub fn sort_configuration(self, input: TableSortConfiguration) -> Self
pub fn sort_configuration(self, input: TableSortConfiguration) -> Self
The sort configuration for a TableVisual
.
Sourcepub fn set_sort_configuration(
self,
input: Option<TableSortConfiguration>,
) -> Self
pub fn set_sort_configuration( self, input: Option<TableSortConfiguration>, ) -> Self
The sort configuration for a TableVisual
.
Sourcepub fn get_sort_configuration(&self) -> &Option<TableSortConfiguration>
pub fn get_sort_configuration(&self) -> &Option<TableSortConfiguration>
The sort configuration for a TableVisual
.
Sourcepub fn table_options(self, input: TableOptions) -> Self
pub fn table_options(self, input: TableOptions) -> Self
The table options for a table visual.
Sourcepub fn set_table_options(self, input: Option<TableOptions>) -> Self
pub fn set_table_options(self, input: Option<TableOptions>) -> Self
The table options for a table visual.
Sourcepub fn get_table_options(&self) -> &Option<TableOptions>
pub fn get_table_options(&self) -> &Option<TableOptions>
The table options for a table visual.
Sourcepub fn total_options(self, input: TotalOptions) -> Self
pub fn total_options(self, input: TotalOptions) -> Self
The total options for a table visual.
Sourcepub fn set_total_options(self, input: Option<TotalOptions>) -> Self
pub fn set_total_options(self, input: Option<TotalOptions>) -> Self
The total options for a table visual.
Sourcepub fn get_total_options(&self) -> &Option<TotalOptions>
pub fn get_total_options(&self) -> &Option<TotalOptions>
The total options for a table visual.
Sourcepub fn field_options(self, input: TableFieldOptions) -> Self
pub fn field_options(self, input: TableFieldOptions) -> Self
The field options for a table visual.
Sourcepub fn set_field_options(self, input: Option<TableFieldOptions>) -> Self
pub fn set_field_options(self, input: Option<TableFieldOptions>) -> Self
The field options for a table visual.
Sourcepub fn get_field_options(&self) -> &Option<TableFieldOptions>
pub fn get_field_options(&self) -> &Option<TableFieldOptions>
The field options for a table visual.
Sourcepub fn paginated_report_options(
self,
input: TablePaginatedReportOptions,
) -> Self
pub fn paginated_report_options( self, input: TablePaginatedReportOptions, ) -> Self
The paginated report options for a table visual.
Sourcepub fn set_paginated_report_options(
self,
input: Option<TablePaginatedReportOptions>,
) -> Self
pub fn set_paginated_report_options( self, input: Option<TablePaginatedReportOptions>, ) -> Self
The paginated report options for a table visual.
Sourcepub fn get_paginated_report_options(
&self,
) -> &Option<TablePaginatedReportOptions>
pub fn get_paginated_report_options( &self, ) -> &Option<TablePaginatedReportOptions>
The paginated report options for a table visual.
Sourcepub fn table_inline_visualizations(
self,
input: TableInlineVisualization,
) -> Self
pub fn table_inline_visualizations( self, input: TableInlineVisualization, ) -> Self
Appends an item to table_inline_visualizations
.
To override the contents of this collection use set_table_inline_visualizations
.
A collection of inline visualizations to display within a chart.
Sourcepub fn set_table_inline_visualizations(
self,
input: Option<Vec<TableInlineVisualization>>,
) -> Self
pub fn set_table_inline_visualizations( self, input: Option<Vec<TableInlineVisualization>>, ) -> Self
A collection of inline visualizations to display within a chart.
Sourcepub fn get_table_inline_visualizations(
&self,
) -> &Option<Vec<TableInlineVisualization>>
pub fn get_table_inline_visualizations( &self, ) -> &Option<Vec<TableInlineVisualization>>
A collection of inline visualizations to display within a 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) -> TableConfiguration
pub fn build(self) -> TableConfiguration
Consumes the builder and constructs a TableConfiguration
.
Trait Implementations§
Source§impl Clone for TableConfigurationBuilder
impl Clone for TableConfigurationBuilder
Source§fn clone(&self) -> TableConfigurationBuilder
fn clone(&self) -> TableConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for TableConfigurationBuilder
impl Debug for TableConfigurationBuilder
Source§impl Default for TableConfigurationBuilder
impl Default for TableConfigurationBuilder
Source§fn default() -> TableConfigurationBuilder
fn default() -> TableConfigurationBuilder
impl StructuralPartialEq for TableConfigurationBuilder
Auto Trait Implementations§
impl Freeze for TableConfigurationBuilder
impl RefUnwindSafe for TableConfigurationBuilder
impl Send for TableConfigurationBuilder
impl Sync for TableConfigurationBuilder
impl Unpin for TableConfigurationBuilder
impl UnwindSafe for TableConfigurationBuilder
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);