Struct ViewFrameBuilder

#[non_exhaustive]
pub struct ViewFrameBuilder { /* private fields */ }

A builder for ViewFrame.

Implementations

impl ViewFrameBuilder

pub fn start_column_index(self, input: i32) -> Self

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

This field is required.

pub fn set_start_column_index(self, input: Option<i32>) -> Self

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

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

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

pub fn column_range(self, input: i32) -> Self

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 set_column_range(self, input: Option<i32>) -> Self

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 get_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, input: impl Into<String>) -> Self

Appends an item to hidden_columns.

To override the contents of this collection use set_hidden_columns.

A list of columns to hide in the view frame.

pub fn set_hidden_columns(self, input: Option<Vec<String>>) -> Self

A list of columns to hide in the view frame.

pub fn get_hidden_columns(&self) -> &Option<Vec<String>>

A list of columns to hide in the view frame.

pub fn start_row_index(self, input: i32) -> Self

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

pub fn set_start_row_index(self, input: Option<i32>) -> Self

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

pub fn get_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, input: i32) -> Self

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

pub fn set_row_range(self, input: Option<i32>) -> Self

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

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

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

pub fn analytics(self, input: AnalyticsMode) -> Self

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

pub fn set_analytics(self, input: Option<AnalyticsMode>) -> Self

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

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

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

pub fn build(self) -> Result<ViewFrame, BuildError>

Consumes the builder and constructs a ViewFrame. This method will fail if any of the following fields are not set:

• start_column_index

Trait Implementations

impl Clone for ViewFrameBuilder

fn clone(&self) -> ViewFrameBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ViewFrameBuilder

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

Formats the value using the given formatter.

impl Default for ViewFrameBuilder

fn default() -> ViewFrameBuilder

Returns the “default value” for a type.

impl PartialEq for ViewFrameBuilder

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