#[non_exhaustive]pub struct PivotTableOptions {Show 13 fields
pub metric_placement: Option<PivotTableMetricPlacement>,
pub single_metric_visibility: Option<Visibility>,
pub column_names_visibility: Option<Visibility>,
pub toggle_buttons_visibility: Option<Visibility>,
pub column_header_style: Option<TableCellStyle>,
pub row_header_style: Option<TableCellStyle>,
pub cell_style: Option<TableCellStyle>,
pub row_field_names_style: Option<TableCellStyle>,
pub row_alternate_color_options: Option<RowAlternateColorOptions>,
pub collapsed_row_dimensions_visibility: Option<Visibility>,
pub rows_layout: Option<PivotTableRowsLayout>,
pub rows_label_options: Option<PivotTableRowsLabelOptions>,
pub default_cell_width: Option<String>,
}Expand description
The table options for a pivot table visual.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.metric_placement: Option<PivotTableMetricPlacement>The metric placement (row, column) options.
single_metric_visibility: Option<Visibility>The visibility of the single metric options.
column_names_visibility: Option<Visibility>The visibility of the column names.
Determines the visibility of the pivot table.
column_header_style: Option<TableCellStyle>The table cell style of the column header.
row_header_style: Option<TableCellStyle>The table cell style of the row headers.
cell_style: Option<TableCellStyle>The table cell style of cells.
row_field_names_style: Option<TableCellStyle>The table cell style of row field names.
row_alternate_color_options: Option<RowAlternateColorOptions>The row alternate color options (widget status, row alternate colors).
collapsed_row_dimensions_visibility: 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.
rows_layout: 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.
rows_label_options: 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.
default_cell_width: Option<String>The default cell width of the pivot table.
Implementations§
Source§impl PivotTableOptions
impl PivotTableOptions
Sourcepub fn metric_placement(&self) -> Option<&PivotTableMetricPlacement>
pub fn metric_placement(&self) -> Option<&PivotTableMetricPlacement>
The metric placement (row, column) options.
Sourcepub fn single_metric_visibility(&self) -> Option<&Visibility>
pub fn single_metric_visibility(&self) -> Option<&Visibility>
The visibility of the single metric options.
Sourcepub fn column_names_visibility(&self) -> Option<&Visibility>
pub fn column_names_visibility(&self) -> Option<&Visibility>
The visibility of the column names.
Determines the visibility of the pivot table.
Sourcepub fn column_header_style(&self) -> Option<&TableCellStyle>
pub fn column_header_style(&self) -> Option<&TableCellStyle>
The table cell style of the column header.
Sourcepub fn row_header_style(&self) -> Option<&TableCellStyle>
pub fn row_header_style(&self) -> Option<&TableCellStyle>
The table cell style of the row headers.
Sourcepub fn cell_style(&self) -> Option<&TableCellStyle>
pub fn cell_style(&self) -> Option<&TableCellStyle>
The table cell style of cells.
Sourcepub fn row_field_names_style(&self) -> Option<&TableCellStyle>
pub fn row_field_names_style(&self) -> Option<&TableCellStyle>
The table cell style of row field names.
Sourcepub fn row_alternate_color_options(&self) -> Option<&RowAlternateColorOptions>
pub fn row_alternate_color_options(&self) -> Option<&RowAlternateColorOptions>
The row alternate color options (widget status, row alternate colors).
Sourcepub fn collapsed_row_dimensions_visibility(&self) -> Option<&Visibility>
pub fn 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) -> Option<&PivotTableRowsLayout>
pub fn 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) -> Option<&PivotTableRowsLabelOptions>
pub fn 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) -> Option<&str>
pub fn default_cell_width(&self) -> Option<&str>
The default cell width of the pivot table.
Source§impl PivotTableOptions
impl PivotTableOptions
Sourcepub fn builder() -> PivotTableOptionsBuilder
pub fn builder() -> PivotTableOptionsBuilder
Creates a new builder-style object to manufacture PivotTableOptions.
Trait Implementations§
Source§impl Clone for PivotTableOptions
impl Clone for PivotTableOptions
Source§fn clone(&self) -> PivotTableOptions
fn clone(&self) -> PivotTableOptions
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for PivotTableOptions
impl Debug for PivotTableOptions
Source§impl PartialEq for PivotTableOptions
impl PartialEq for PivotTableOptions
impl StructuralPartialEq for PivotTableOptions
Auto Trait Implementations§
impl Freeze for PivotTableOptions
impl RefUnwindSafe for PivotTableOptions
impl Send for PivotTableOptions
impl Sync for PivotTableOptions
impl Unpin for PivotTableOptions
impl UnwindSafe for PivotTableOptions
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);