Enum FilterVerb 

pub enum FilterVerb {
    SetBasicFilter {
        sheet: String,
        range: String,
        sort_by: Vec<String>,
        hide_values: Vec<String>,
    },
    ClearBasicFilter {
        sheet: String,
    },
    AddFilterView {
        sheet: String,
        range: String,
        title: Option<String>,
        sort_by: Vec<String>,
        hide_values: Vec<String>,
    },
    UpdateFilterView {
        filter_view_id: i64,
        sheet: Option<String>,
        range: Option<String>,
        title: Option<String>,
        sort_by: Vec<String>,
        hide_values: Vec<String>,
        clear_sort: bool,
        clear_criteria: bool,
    },
    DeleteFilterView {
        filter_view_id: i64,
    },
}

Which mutation to perform.

Variants

SetBasicFilter

Upsert the basic filter on a sheet.

Fields

sheet: String

The sheet to filter.

range: String

The filtered A1 range, optionally carrying its own Sheet! prefix.

sort_by: Vec<String>

<COL>:<asc|desc> sort specs, in priority order.

hide_values: Vec<String>

<COL>:<v1,v2,...> hidden-value criteria, one per column.

ClearBasicFilter

Remove a sheet’s basic filter.

Fields

sheet: String

The sheet to clear the basic filter from.

AddFilterView

Add a named filter view.

Fields

sheet: String

The sheet to filter.

range: String

The filtered A1 range, optionally carrying its own Sheet! prefix.

title: Option<String>

A human-readable name for the view.

sort_by: Vec<String>

<COL>:<asc|desc> sort specs, in priority order.

hide_values: Vec<String>

<COL>:<v1,v2,...> hidden-value criteria, one per column.

UpdateFilterView

Change an existing filter view’s title, range, sort order, or hidden values.

Fields

filter_view_id: i64

Which filter view to change, discovered via list-filter-views.

sheet: Option<String>

A sheet title, supplying a prefix for a bare range, when changing the filtered range.

range: Option<String>

The new filtered A1 range, when changing it.

title: Option<String>

The new title, when changing it.

sort_by: Vec<String>

Sort specs to merge in, replacing any existing entry sharing a column, else appending.

hide_values: Vec<String>

Hidden-value criteria to merge in, replacing any existing entry for the named column.

clear_sort: bool

Reset the sort order to empty before applying sort_by.

clear_criteria: bool

Reset the criteria to empty before applying hide_values.

DeleteFilterView

Remove a filter view.

Fields

filter_view_id: i64

Which filter view to remove, discovered via list-filter-views.

Trait Implementations

impl Clone for FilterVerb

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FilterVerb

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

Formats the value using the given formatter.

impl Eq for FilterVerb

impl PartialEq for FilterVerb

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FilterVerb