Struct ViewSpec 

pub struct ViewSpec<R: GridRow> { /* private fields */ }

What the view shows: a filter, a quick filter and a multi-column sort, a grouping or a tree, aggregates and the expansion.

Cloning is cheap: every part is shared or small.

Implementations

impl<R: GridRow> ViewSpec<R>

pub fn with_aggregates( self, aggregates: impl IntoIterator<Item = (R::Column, Aggregate<R>)>, ) -> Self

Aggregates these columns, for group captions, group footers and the totals. A repeated column keeps its last aggregate. The aggregates survive a change of grouping or tree. A view without grouping has totals too.

pub fn aggregates(&self) -> &[(R::Column, Aggregate<R>)]

The aggregates by column.

pub fn aggregate_columns(&self) -> ColumnSet

The columns whose changes change aggregates: the aggregated columns and what custom aggregates depend on.

impl<R: GridRow> ViewSpec<R>

pub fn expansion(&self) -> &Expansion<R::Key>

The expansion the view is laid out for. The grid sets it: groups and tree rows are expanded and collapsed through the grid’s state.

impl<R: GridRow> ViewSpec<R>

pub fn with_group_by(self, levels: impl IntoIterator<Item = GroupBy<R>>) -> Self

Groups the rows by these levels, the first one outermost. Repeated level ids are dropped, the first one stays; an empty list turns grouping off. Replaces a tree, as in AG Grid and DevExpress: the last of with_group_by and Self::with_tree wins.

pub fn group_by(&self) -> &[GroupBy<R>]

The grouping levels, the top one first; empty without grouping.

pub fn with_group_order(self, order: impl GroupOrder<R>) -> Self

Sets the order of sibling groups (default KeyOrder).

pub fn group_order(&self) -> &dyn GroupOrder<R>

The order of sibling groups.

pub fn with_group_footer(self, footer: impl GroupFooter) -> Self

Sets which groups have a footer (default NoGroupFooter).

impl<R: GridRow> ViewSpec<R>

pub fn with_tree(self, tree: TreeSpec<R>) -> Self

Shows the rows as a tree by GridRow::parent_key. Replaces a grouping, as in AG Grid and DevExpress: the last of Self::with_group_by and with_tree wins.

A row whose parent key no row has is an orphan and shows as a root, as does a row that names itself. Rows whose parents form a cycle show as roots too, with a warning in the log. Siblings follow the view’s sort; the filters choose rows by TreeSpec::with_filter.

pub fn tree(&self) -> Option<&TreeSpec<R>>

The tree, if the view is one.

impl<R: GridRow> ViewSpec<R>

pub fn new() -> Self

No filter, insertion order.

pub fn with_sort( self, sort: impl IntoIterator<Item = (R::Column, SortDirection)>, ) -> Self

Sorts by these columns, first one most significant. Ties keep insertion order, so the order is stable.

pub fn with_filter( self, depends_on: ColumnSet, filter: impl Fn(&R) -> bool + Send + Sync + 'static, ) -> Self

Shows only rows for which filter returns true. depends_on lists the columns the filter reads; pass every column when unsure. A rebuild of a large snapshot calls filter from several threads at once.

pub fn with_quick_filter(self, filter: Option<QuickFilter>) -> Self

Shows only rows that also pass the quick text search; None turns it off. A row is shown when it passes both the filter and the quick filter.

pub fn sort(&self) -> &[(R::Column, SortDirection)]

The sort columns.

pub fn quick_filter(&self) -> Option<&QuickFilter>

The quick filter, if it is on.

pub fn dependencies(&self) -> ColumnSet

Columns whose changes can move rows: the sort columns, the columns both filters read and, in a grouped view, the grouping columns, the columns GroupKeys read and those the group order reads (for an order by an aggregate, what that aggregate reads). Inserts and removals always do.

A change of the other aggregated columns (Self::aggregate_columns) changes values alone: the aggregate job (ProjectionEngine::aggregate) refreshes them in the same order.

Trait Implementations

impl<R: GridRow> Clone for ViewSpec<R>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<R: GridRow> Default for ViewSpec<R>

fn default() -> Self

Returns the “default value” for a type.