Struct GridQuery 

pub struct GridQuery {
    pub sort: Vec<(usize, SortDirection)>,
    pub filters: Vec<String>,
    pub search: String,
    pub group_by: Vec<usize>,
    pub collapsed: BTreeSet<String>,
    pub hidden: Vec<bool>,
}

What the user asked the grid to show.

Fields

sort: Vec<(usize, SortDirection)>

Sort columns in priority order.

filters: Vec<String>

Filter-row text per column (index = column): the short syntax of matches_filter, or a ravenrs_criteria expression over columns named by their titles, such as [Seats] > 10 And [Country] = 'Brazil'.

search: String

Text searched in every visible column.

group_by: Vec<usize>

Grouping columns, outermost first.

collapsed: BTreeSet<String>

Keys of collapsed groups (see ViewRow::Group::key).

hidden: Vec<bool>

Hidden columns are ignored by search.

Implementations

impl GridQuery

pub fn filter(&self, column: usize) -> &str

The filter text of column (zero-based), or "".

pub fn set_filter(&mut self, column: usize, text: String)

Sets the filter text of column (zero-based).

pub fn is_hidden(&self, column: usize) -> bool

The column (zero-based) is hidden.

pub fn toggle_sort(&mut self, column: usize, add: bool)

Plain click: sort by this column only, cycling ascending → descending → none. With add, the column is added to (or cycled within) a multi-column sort.

pub fn toggle_group(&mut self, column: usize)

Adds the column to or removes it from the grouping; expands all groups.

pub fn toggle_collapsed(&mut self, key: &str)

Collapses or expands the group with this key.

Trait Implementations

impl Clone for GridQuery

fn clone(&self) -> GridQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GridQuery

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

Formats the value using the given formatter.

impl Default for GridQuery

fn default() -> GridQuery

Returns the “default value” for a type.

impl PartialEq for GridQuery

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for GridQuery