Struct DataGrid 

pub struct DataGrid { /* private fields */ }

A grid that renders only the rows its viewport holds.

Implementations

impl DataGrid

pub fn new( ident: impl Into<Ident>, count: usize, render_row: impl Fn(usize, &mut Window, &mut App) -> GridRow + 'static, ) -> Self

count is how many rows the caller has; render_row builds one of them, and is only ever called for a row that is about to be drawn or about to be reported.

pub fn total(self, total: usize) -> Self

How many rows exist on the host, when the grid has been given only some of them. Without it the grid assumes it has everything.

pub fn column(self, column: GridColumn) -> Self

pub fn columns(self, columns: impl IntoIterator<Item = GridColumn>) -> Self

pub fn lines(self, lines: GridLines) -> Self

Draws rules between rows, for a grid dense enough to need them.

pub fn sort(self, sort: Option<(SharedString, SortDirection)>) -> Self

The sort the caller applied, which is the only sort the grid shows.

pub fn sorted_by( self, key: impl Into<SharedString>, direction: SortDirection, ) -> Self

pub fn selection_mode(self, mode: SelectionMode) -> Self

pub fn selected( self, ids: impl IntoIterator<Item = impl Into<SharedString>>, ) -> Self

The rows the caller says are selected. The grid renders these and nothing else, whatever a click reported a moment ago.

pub fn expanded(self, rows: impl IntoIterator<Item = Expanded>) -> Self

The rows the caller has opened, and where each one sits.

pub fn detail_rows(self, rows: usize) -> Self

How many row heights an opened detail region occupies.

pub fn detail( self, render: impl Fn(SharedString, &mut Window, &mut App) -> AnyElement + 'static, ) -> Self

Builds the detail region for an opened row. Called only for rows the caller has opened and the viewport is drawing.

pub fn editing(self, cell: Option<EditingCell>) -> Self

The cell the caller has opened for editing, and the value it holds.

pub fn row_height(self, height: f32) -> Self

pub fn visible_rows(self, rows: usize) -> Self

Bounds the viewport to rows rows, which is what lets the grid skip the rows it does not show.

pub fn loading(self, loading: bool) -> Self

A first load with nothing to show yet. A refresh over rows that already exist is not this; see DataGrid::failure.

pub fn failure(self, failure: impl Into<SharedString>) -> Self

A refresh that failed. Rows the grid already has stay on screen with the failure stated above them; only a failure with nothing behind it takes the surface over.

pub fn empty(self, empty: EmptyState) -> Self

What to show when the query succeeded and returned nothing.

pub fn on_sort( self, handler: impl Fn(SharedString, SortDirection, &mut Window, &mut App) + 'static, ) -> Self

pub fn on_select( self, handler: impl Fn(&SelectionChange, &mut Window, &mut App) + 'static, ) -> Self

pub fn on_resize( self, handler: impl Fn(SharedString, f32, &mut Window, &mut App) + 'static, ) -> Self

Reports the width a drag on a column edge asked for.

pub fn on_fit( self, handler: impl Fn(SharedString, &mut Window, &mut App) + 'static, ) -> Self

Reports that a double click on a column edge asked for a width that fits the content. The grid measures nothing; see the module docs.

pub fn on_reorder( self, handler: impl Fn(&DropIntent, &mut Window, &mut App) + 'static, ) -> Self

Reports where a dragged column should go. The grid does not move it.

pub fn on_expand( self, handler: impl Fn(SharedString, bool, &mut Window, &mut App) + 'static, ) -> Self

Reports the disclosure state a row should take.

pub fn on_edit_request( self, handler: impl Fn(SharedString, SharedString, &mut Window, &mut App) + 'static, ) -> Self

Reports that a cell was asked to become a field.

pub fn on_edit( self, handler: impl Fn(&EditIntent, &mut Window, &mut App) + 'static, ) -> Self

Reports how an edit ended, and what was in the field when it did.

Trait Implementations

impl Debug for DataGrid

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

Formats the value using the given formatter.

impl Disableable for DataGrid

fn disabled(self, disabled: bool) -> Self

impl IntoElement for DataGrid

type Element = ViewElement<DataGrid>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl RenderOnce for DataGrid

fn render(self, window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to Render::render() method which takes a mutable reference.

impl Sizable for DataGrid

fn control_size(self, size: ControlSize) -> Self

fn xs(self) -> Self

fn small(self) -> Self

fn medium(self) -> Self

fn large(self) -> Self