Struct ViewFrame

#[non_exhaustive]
pub struct ViewFrame {
    pub start_column_index: i32,
    pub column_range: Option<i32>,
    pub hidden_columns: Option<Vec<String>>,
    pub start_row_index: Option<i32>,
    pub row_range: Option<i32>,
    pub analytics: Option<AnalyticsMode>,
}

Represents the data being transformed during an action.

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.

start_column_index: i32

The starting index for the range of columns to return in the view frame.

column_range: Option<i32>

The number of columns to include in the view frame, beginning with the StartColumnIndex value and ignoring any columns in the HiddenColumns list.

hidden_columns: Option<Vec<String>>

A list of columns to hide in the view frame.

start_row_index: Option<i32>

The starting index for the range of rows to return in the view frame.

row_range: Option<i32>

The number of rows to include in the view frame, beginning with the StartRowIndex value.

analytics: Option<AnalyticsMode>

Controls if analytics computation is enabled or disabled. Enabled by default.

Implementations

impl ViewFrame

pub fn start_column_index(&self) -> i32

The starting index for the range of columns to return in the view frame.

pub fn column_range(&self) -> Option<i32>

The number of columns to include in the view frame, beginning with the StartColumnIndex value and ignoring any columns in the HiddenColumns list.

pub fn hidden_columns(&self) -> &[String]

A list of columns to hide in the view frame.

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

pub fn start_row_index(&self) -> Option<i32>

The starting index for the range of rows to return in the view frame.

pub fn row_range(&self) -> Option<i32>

The number of rows to include in the view frame, beginning with the StartRowIndex value.

pub fn analytics(&self) -> Option<&AnalyticsMode>

Controls if analytics computation is enabled or disabled. Enabled by default.

impl ViewFrame

pub fn builder() -> ViewFrameBuilder

Creates a new builder-style object to manufacture ViewFrame.

Trait Implementations

impl Clone for ViewFrame

fn clone(&self) -> ViewFrame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ViewFrame

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

Formats the value using the given formatter.

impl PartialEq for ViewFrame

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

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

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 ViewFrame