#[non_exhaustive]pub struct PivotTableOptionsBuilder { /* private fields */ }
Expand description
A builder for PivotTableOptions
.
Implementations§
Source§impl PivotTableOptionsBuilder
impl PivotTableOptionsBuilder
Sourcepub fn metric_placement(self, input: PivotTableMetricPlacement) -> Self
pub fn metric_placement(self, input: PivotTableMetricPlacement) -> Self
The metric placement (row, column) options.
Sourcepub fn set_metric_placement(
self,
input: Option<PivotTableMetricPlacement>,
) -> Self
pub fn set_metric_placement( self, input: Option<PivotTableMetricPlacement>, ) -> Self
The metric placement (row, column) options.
Sourcepub fn get_metric_placement(&self) -> &Option<PivotTableMetricPlacement>
pub fn get_metric_placement(&self) -> &Option<PivotTableMetricPlacement>
The metric placement (row, column) options.
Sourcepub fn single_metric_visibility(self, input: Visibility) -> Self
pub fn single_metric_visibility(self, input: Visibility) -> Self
The visibility of the single metric options.
Sourcepub fn set_single_metric_visibility(self, input: Option<Visibility>) -> Self
pub fn set_single_metric_visibility(self, input: Option<Visibility>) -> Self
The visibility of the single metric options.
Sourcepub fn get_single_metric_visibility(&self) -> &Option<Visibility>
pub fn get_single_metric_visibility(&self) -> &Option<Visibility>
The visibility of the single metric options.
Sourcepub fn column_names_visibility(self, input: Visibility) -> Self
pub fn column_names_visibility(self, input: Visibility) -> Self
The visibility of the column names.
Sourcepub fn set_column_names_visibility(self, input: Option<Visibility>) -> Self
pub fn set_column_names_visibility(self, input: Option<Visibility>) -> Self
The visibility of the column names.
Sourcepub fn get_column_names_visibility(&self) -> &Option<Visibility>
pub fn get_column_names_visibility(&self) -> &Option<Visibility>
The visibility of the column names.
Determines the visibility of the pivot table.
Determines the visibility of the pivot table.
Determines the visibility of the pivot table.
Sourcepub fn column_header_style(self, input: TableCellStyle) -> Self
pub fn column_header_style(self, input: TableCellStyle) -> Self
The table cell style of the column header.
Sourcepub fn set_column_header_style(self, input: Option<TableCellStyle>) -> Self
pub fn set_column_header_style(self, input: Option<TableCellStyle>) -> Self
The table cell style of the column header.
Sourcepub fn get_column_header_style(&self) -> &Option<TableCellStyle>
pub fn get_column_header_style(&self) -> &Option<TableCellStyle>
The table cell style of the column header.
Sourcepub fn row_header_style(self, input: TableCellStyle) -> Self
pub fn row_header_style(self, input: TableCellStyle) -> Self
The table cell style of the row headers.
Sourcepub fn set_row_header_style(self, input: Option<TableCellStyle>) -> Self
pub fn set_row_header_style(self, input: Option<TableCellStyle>) -> Self
The table cell style of the row headers.
Sourcepub fn get_row_header_style(&self) -> &Option<TableCellStyle>
pub fn get_row_header_style(&self) -> &Option<TableCellStyle>
The table cell style of the row headers.
Sourcepub fn cell_style(self, input: TableCellStyle) -> Self
pub fn cell_style(self, input: TableCellStyle) -> Self
The table cell style of cells.
Sourcepub fn set_cell_style(self, input: Option<TableCellStyle>) -> Self
pub fn set_cell_style(self, input: Option<TableCellStyle>) -> Self
The table cell style of cells.
Sourcepub fn get_cell_style(&self) -> &Option<TableCellStyle>
pub fn get_cell_style(&self) -> &Option<TableCellStyle>
The table cell style of cells.
Sourcepub fn row_field_names_style(self, input: TableCellStyle) -> Self
pub fn row_field_names_style(self, input: TableCellStyle) -> Self
The table cell style of row field names.
Sourcepub fn set_row_field_names_style(self, input: Option<TableCellStyle>) -> Self
pub fn set_row_field_names_style(self, input: Option<TableCellStyle>) -> Self
The table cell style of row field names.
Sourcepub fn get_row_field_names_style(&self) -> &Option<TableCellStyle>
pub fn get_row_field_names_style(&self) -> &Option<TableCellStyle>
The table cell style of row field names.
Sourcepub fn row_alternate_color_options(
self,
input: RowAlternateColorOptions,
) -> Self
pub fn row_alternate_color_options( self, input: RowAlternateColorOptions, ) -> Self
The row alternate color options (widget status, row alternate colors).
Sourcepub fn set_row_alternate_color_options(
self,
input: Option<RowAlternateColorOptions>,
) -> Self
pub fn set_row_alternate_color_options( self, input: Option<RowAlternateColorOptions>, ) -> Self
The row alternate color options (widget status, row alternate colors).
Sourcepub fn get_row_alternate_color_options(
&self,
) -> &Option<RowAlternateColorOptions>
pub fn get_row_alternate_color_options( &self, ) -> &Option<RowAlternateColorOptions>
The row alternate color options (widget status, row alternate colors).
Sourcepub fn collapsed_row_dimensions_visibility(self, input: Visibility) -> Self
pub fn collapsed_row_dimensions_visibility(self, input: Visibility) -> Self
The visibility setting of a pivot table's collapsed row dimension fields. If the value of this structure is HIDDEN
, all collapsed columns in a pivot table are automatically hidden. The default value is VISIBLE
.
Sourcepub fn set_collapsed_row_dimensions_visibility(
self,
input: Option<Visibility>,
) -> Self
pub fn set_collapsed_row_dimensions_visibility( self, input: Option<Visibility>, ) -> Self
The visibility setting of a pivot table's collapsed row dimension fields. If the value of this structure is HIDDEN
, all collapsed columns in a pivot table are automatically hidden. The default value is VISIBLE
.
Sourcepub fn get_collapsed_row_dimensions_visibility(&self) -> &Option<Visibility>
pub fn get_collapsed_row_dimensions_visibility(&self) -> &Option<Visibility>
The visibility setting of a pivot table's collapsed row dimension fields. If the value of this structure is HIDDEN
, all collapsed columns in a pivot table are automatically hidden. The default value is VISIBLE
.
Sourcepub fn rows_layout(self, input: PivotTableRowsLayout) -> Self
pub fn rows_layout(self, input: PivotTableRowsLayout) -> Self
The layout for the row dimension headers of a pivot table. Choose one of the following options.
-
TABULAR
: (Default) Each row field is displayed in a separate column. -
HIERARCHY
: All row fields are displayed in a single column. Indentation is used to differentiate row headers of different fields.
Sourcepub fn set_rows_layout(self, input: Option<PivotTableRowsLayout>) -> Self
pub fn set_rows_layout(self, input: Option<PivotTableRowsLayout>) -> Self
The layout for the row dimension headers of a pivot table. Choose one of the following options.
-
TABULAR
: (Default) Each row field is displayed in a separate column. -
HIERARCHY
: All row fields are displayed in a single column. Indentation is used to differentiate row headers of different fields.
Sourcepub fn get_rows_layout(&self) -> &Option<PivotTableRowsLayout>
pub fn get_rows_layout(&self) -> &Option<PivotTableRowsLayout>
The layout for the row dimension headers of a pivot table. Choose one of the following options.
-
TABULAR
: (Default) Each row field is displayed in a separate column. -
HIERARCHY
: All row fields are displayed in a single column. Indentation is used to differentiate row headers of different fields.
Sourcepub fn rows_label_options(self, input: PivotTableRowsLabelOptions) -> Self
pub fn rows_label_options(self, input: PivotTableRowsLabelOptions) -> Self
The options for the label that is located above the row headers. This option is only applicable when RowsLayout
is set to HIERARCHY
.
Sourcepub fn set_rows_label_options(
self,
input: Option<PivotTableRowsLabelOptions>,
) -> Self
pub fn set_rows_label_options( self, input: Option<PivotTableRowsLabelOptions>, ) -> Self
The options for the label that is located above the row headers. This option is only applicable when RowsLayout
is set to HIERARCHY
.
Sourcepub fn get_rows_label_options(&self) -> &Option<PivotTableRowsLabelOptions>
pub fn get_rows_label_options(&self) -> &Option<PivotTableRowsLabelOptions>
The options for the label that is located above the row headers. This option is only applicable when RowsLayout
is set to HIERARCHY
.
Sourcepub fn default_cell_width(self, input: impl Into<String>) -> Self
pub fn default_cell_width(self, input: impl Into<String>) -> Self
The default cell width of the pivot table.
Sourcepub fn set_default_cell_width(self, input: Option<String>) -> Self
pub fn set_default_cell_width(self, input: Option<String>) -> Self
The default cell width of the pivot table.
Sourcepub fn get_default_cell_width(&self) -> &Option<String>
pub fn get_default_cell_width(&self) -> &Option<String>
The default cell width of the pivot table.
Sourcepub fn build(self) -> PivotTableOptions
pub fn build(self) -> PivotTableOptions
Consumes the builder and constructs a PivotTableOptions
.
Trait Implementations§
Source§impl Clone for PivotTableOptionsBuilder
impl Clone for PivotTableOptionsBuilder
Source§fn clone(&self) -> PivotTableOptionsBuilder
fn clone(&self) -> PivotTableOptionsBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for PivotTableOptionsBuilder
impl Debug for PivotTableOptionsBuilder
Source§impl Default for PivotTableOptionsBuilder
impl Default for PivotTableOptionsBuilder
Source§fn default() -> PivotTableOptionsBuilder
fn default() -> PivotTableOptionsBuilder
Source§impl PartialEq for PivotTableOptionsBuilder
impl PartialEq for PivotTableOptionsBuilder
impl StructuralPartialEq for PivotTableOptionsBuilder
Auto Trait Implementations§
impl Freeze for PivotTableOptionsBuilder
impl RefUnwindSafe for PivotTableOptionsBuilder
impl Send for PivotTableOptionsBuilder
impl Sync for PivotTableOptionsBuilder
impl Unpin for PivotTableOptionsBuilder
impl UnwindSafe for PivotTableOptionsBuilder
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);