Struct PivotTotalOptions

#[non_exhaustive]
pub struct PivotTotalOptions {
    pub totals_visibility: Option<Visibility>,
    pub placement: Option<TableTotalsPlacement>,
    pub scroll_status: Option<TableTotalsScrollStatus>,
    pub custom_label: Option<String>,
    pub total_cell_style: Option<TableCellStyle>,
    pub value_cell_style: Option<TableCellStyle>,
    pub metric_header_cell_style: Option<TableCellStyle>,
    pub total_aggregation_options: Option<Vec<TotalAggregationOption>>,
}

The optional configuration of totals cells in a PivotTableVisual.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

totals_visibility: Option<Visibility>

The visibility configuration for the total cells.

placement: Option<TableTotalsPlacement>

The placement (start, end) for the total cells.

scroll_status: Option<TableTotalsScrollStatus>

The scroll status (pinned, scrolled) for the total cells.

custom_label: Option<String>

The custom label string for the total cells.

total_cell_style: Option<TableCellStyle>

The cell styling options for the total cells.

value_cell_style: Option<TableCellStyle>

The cell styling options for the totals of value cells.

metric_header_cell_style: Option<TableCellStyle>

The cell styling options for the total of header cells.

total_aggregation_options: Option<Vec<TotalAggregationOption>>

The total aggregation options for each value field.

Implementations

impl PivotTotalOptions

pub fn totals_visibility(&self) -> Option<&Visibility>

The visibility configuration for the total cells.

pub fn placement(&self) -> Option<&TableTotalsPlacement>

The placement (start, end) for the total cells.

pub fn scroll_status(&self) -> Option<&TableTotalsScrollStatus>

The scroll status (pinned, scrolled) for the total cells.

pub fn custom_label(&self) -> Option<&str>

The custom label string for the total cells.

pub fn total_cell_style(&self) -> Option<&TableCellStyle>

The cell styling options for the total cells.

pub fn value_cell_style(&self) -> Option<&TableCellStyle>

The cell styling options for the totals of value cells.

pub fn metric_header_cell_style(&self) -> Option<&TableCellStyle>

The cell styling options for the total of header cells.

pub fn total_aggregation_options(&self) -> &[TotalAggregationOption]

The total aggregation options for each value field.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .total_aggregation_options.is_none().

impl PivotTotalOptions

pub fn builder() -> PivotTotalOptionsBuilder

Creates a new builder-style object to manufacture PivotTotalOptions.

Trait Implementations

impl Clone for PivotTotalOptions

fn clone(&self) -> PivotTotalOptions

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PivotTotalOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for PivotTotalOptions

fn eq(&self, other: &PivotTotalOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PivotTotalOptions