Struct ExportRow 

pub struct ExportRow<'a, R: GridRow> { /* private fields */ }

A row of an ExportTable: a row of the application, or a summary row of a grouped view (ExportLine).

Row	Cell of a column	Value
new	Every column	The row’s value
caption	value_column	The group’s key value, also where the column has an aggregate
	An aggregated column	The group’s aggregate
footer	An aggregated column	The group’s aggregate
totals	An aggregated column	The view’s aggregate
	The label’s column without an aggregate	The label

A summary row has no cell in any other column: an empty field. An empty aggregate is a cell with CellValue::Empty.

Marks tell where the row is on screen, for a spreadsheet’s outline and frozen panes: its pinned band (band), whether a collapsed group or tree row hides it (is_hidden), and its children in a tree (branch). A data row may carry the optimistic values of edits still waiting for their answer (with_pending): its cells show them, as the screen does.

Implementations

impl<'a, R: GridRow> ExportRow<'a, R>

pub fn new(row: &'a R) -> Self

A row of the application that exports every column of the table, at depth 0.

pub fn caption(value_column: R::Column, group: GroupInfo<'a>) -> Self

The caption of group: its key value in value_column, its aggregates in their columns, at the group’s depth. The grid passes the group’s own column when it is exported, else the first exported column.

pub fn footer(group: GroupInfo<'a>) -> Self

The footer of group: its aggregates in their columns, at the group’s depth.

pub fn totals( aggregates: AggregateRow<'a>, label: Option<(R::Column, &'a str)>, ) -> Self

The totals row: the aggregates of the whole view in their columns, and label in its column when that column has no aggregate; at depth 0.

pub fn with_number_formats(self, formats: &'a [NumberFormat]) -> Self

Sets how each column shows its numbers, by ColumnIx (GridColumn::with_number_format): a column past the end shows the default. The grid sets its columns’ formats on every row it exports, so a cell is written as the screen shows it.

pub fn with_depth(self, depth: u16) -> Self

Sets the row’s level under group captions or tree parents: a data row of a group is one level below the group’s caption.

pub fn with_columns(self, columns: ColumnSet) -> Self

Exports only columns of this row; its other cells in the table are empty fields. A cell selection copies its bounding rectangle this way.

pub fn with_band(self, edge: PinnedEdge) -> Self

Marks a row of a pinned band, or the totals row in it, with the band’s edge. The top band comes before the other lines and is frozen with the header on screen.

pub fn with_hidden(self, hidden: bool) -> Self

Marks the row hidden on screen: under a collapsed group caption or tree row. Only an ExportScope::Expanded export writes such rows; a spreadsheet may write them hidden under a collapsed outline level.

pub fn with_branch(self, branch: Branch) -> Self

Marks a tree row with shown children: their count and whether it is expanded on screen. A summary row is no tree row: ignored there.

pub fn with_pending(self, pending: &'a [(R::Column, OwnedValue)]) -> Self

Sets the optimistic values of edits to this row that still wait for their answer, by column: they replace the row’s values of their columns, as on screen (ExportCell::is_pending). A summary row has none: ignored there.

pub fn line(&self) -> ExportLine

What the row is.

pub fn row(&self) -> Option<&'a R>

The application row; None for a caption, a footer or the totals.

pub fn band(&self) -> Option<PinnedEdge>

The edge of the pinned band the row is in; None outside the bands.

pub fn is_hidden(&self) -> bool

Returns true if the row is hidden on screen, under a collapsed group caption or tree row.

pub fn branch(&self) -> Option<Branch>

The shown children of a tree row; None for a leaf, outside a tree and for a summary row.

pub fn group(&self) -> Option<GroupInfo<'a>>

The group of a caption or a footer: its path, row count and aggregates.

pub fn depth(&self) -> u16

The row’s level under group captions or tree parents; 0 at the top.

pub fn columns(&self) -> ColumnSet

The columns this row exports.

pub fn cell(&self, column: R::Column) -> Option<ExportCell<'a, R>>

The cell of column, or None if this row does not export it or, in a summary row, has nothing in it.

Trait Implementations

impl<R: GridRow> Clone for ExportRow<'_, 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> Copy for ExportRow<'_, R>