Struct SubtotalOptions

#[non_exhaustive]
pub struct SubtotalOptions {
    pub totals_visibility: Option<Visibility>,
    pub custom_label: Option<String>,
    pub field_level: Option<PivotTableSubtotalLevel>,
    pub field_level_options: Option<Vec<PivotTableFieldSubtotalOptions>>,
    pub total_cell_style: Option<TableCellStyle>,
    pub value_cell_style: Option<TableCellStyle>,
    pub metric_header_cell_style: Option<TableCellStyle>,
    pub style_targets: Option<Vec<TableStyleTarget>>,
}

The subtotal options.

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 subtotal cells.

custom_label: Option<String>

The custom label string for the subtotal cells.

field_level: Option<PivotTableSubtotalLevel>

The field level (all, custom, last) for the subtotal cells.

field_level_options: Option<Vec<PivotTableFieldSubtotalOptions>>

The optional configuration of subtotal cells.

total_cell_style: Option<TableCellStyle>

The cell styling options for the subtotal cells.

value_cell_style: Option<TableCellStyle>

The cell styling options for the subtotals of value cells.

metric_header_cell_style: Option<TableCellStyle>

The cell styling options for the subtotals of header cells.

style_targets: Option<Vec<TableStyleTarget>>

The style targets options for subtotals.

Implementations

impl SubtotalOptions

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

The visibility configuration for the subtotal cells.

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

The custom label string for the subtotal cells.

pub fn field_level(&self) -> Option<&PivotTableSubtotalLevel>

The field level (all, custom, last) for the subtotal cells.

pub fn field_level_options(&self) -> &[PivotTableFieldSubtotalOptions]

The optional configuration of subtotal cells.

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

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

The cell styling options for the subtotal cells.

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

The cell styling options for the subtotals of value cells.

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

The cell styling options for the subtotals of header cells.

pub fn style_targets(&self) -> &[TableStyleTarget]

The style targets options for subtotals.

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

impl SubtotalOptions

pub fn builder() -> SubtotalOptionsBuilder

Creates a new builder-style object to manufacture SubtotalOptions.

Trait Implementations

impl Clone for SubtotalOptions

fn clone(&self) -> SubtotalOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubtotalOptions

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

Formats the value using the given formatter.

impl PartialEq for SubtotalOptions

fn eq(&self, other: &SubtotalOptions) -> 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 SubtotalOptions