Struct GridColumn 

pub struct GridColumn<C> { /* private fields */ }

A column of the grid schema.

Implementations

impl<C: GridColumns> GridColumn<C>

pub fn new(column: C, title: impl Into<SharedString>) -> Self

A column with a title, 100 px wide.

pub fn with_width(self, width: Pixels) -> Self

Sets the initial width, kept within the column’s limits.

pub fn with_align(self, align: ColumnAlign) -> Self

Sets the alignment.

pub fn with_min_width(self, width: Pixels) -> Self

Sets the smallest width; raised to MIN_COLUMN_WIDTH.

pub fn with_max_width(self, width: Pixels) -> Self

Sets the largest width (default: no limit).

pub fn with_zone(self, zone: ColumnZone) -> Self

Sets the zone (default ColumnZone::Scrolling).

pub fn with_visible(self, visible: bool) -> Self

Shows or hides the column initially (default shown).

pub fn with_resizable(self, resizable: bool) -> Self

Lets the user resize the column with the mouse (default true).

pub fn with_movable(self, movable: bool) -> Self

Lets the user drag the column’s header to reorder it (default true).

pub fn with_sortable(self, sortable: bool) -> Self

Lets a click on the column’s header sort by it (default true). Sorting through LiveGridState::set_sort is always allowed.

pub fn with_groupable(self, groupable: bool) -> Self

Lets the user group by the column (default true): drag its header into the group panel (crate::LiveGrid::group_panel) or use “Group by this column”. Grouping through LiveGridState::set_group_by is always allowed.

pub fn with_content(self, content: CellContent) -> Self

Sets what the cells paint: the value as text (the default), or an element of LiveGridDelegate::render_cell.

pub fn with_icon(self, icon: impl IconNamed) -> Self

Shows icon in the header before the title.

pub fn with_icon_only(self, icon: impl IconNamed) -> Self

Shows only icon in the header. The title stays the column’s name: its tooltip, its accessible name, and its label in the column chooser, the menus and an export’s header.

pub fn with_hideable(self, hideable: bool) -> Self

Sets whether the user may hide the column: “Hide column”, HideColumn and the column chooser. Default true. LiveGridState::set_column_visible and a restored layout hide any column.

pub fn with_internal(self, internal: bool) -> Self

Makes the column internal (default false): a helper the grid sorts, filters, groups and aggregates by, but never shows. It is hidden whatever with_visible, a restored layout or LiveGridState::set_column_visible say, and it is not in the column chooser, “Show all columns”, a copy or an export of the visible columns. An export that names it (ExportRequest::with_columns) writes it.

pub fn with_number_format(self, format: NumberFormat) -> Self

Sets how the column shows its numbers (default NumberFormat::new, two decimals): its cells, its aggregates, a copy and an export’s text and number hint.

pub fn with_image_fit(self, fit: ImageFit) -> Self

Sets how an image (CellValue::Image) fits the room of its cell. Default ImageFit::Contain.

pub fn with_image_corner_radius(self, radius: Pixels) -> Self

Rounds the corners of the images in the cells by radius: half the image’s height draws a round avatar. Default 0.

pub fn column(&self) -> C

The column.

pub fn title(&self) -> &SharedString

The title.

pub fn width(&self) -> Pixels

The initial width.

pub fn min_width(&self) -> Pixels

The smallest width.

pub fn max_width(&self) -> Pixels

The largest width.

pub fn align(&self) -> ColumnAlign

The alignment.

pub fn zone(&self) -> ColumnZone

The initial zone.

pub fn is_visible(&self) -> bool

Returns true if the column is shown initially.

pub fn is_resizable(&self) -> bool

Returns true if the user can resize the column.

pub fn is_movable(&self) -> bool

Returns true if the user can drag the column’s header.

pub fn is_sortable(&self) -> bool

Returns true if a click on the column’s header sorts by it.

pub fn is_groupable(&self) -> bool

Returns true if the user can group by the column.

pub fn content(&self) -> CellContent

What the cells paint.

pub fn header_label(&self) -> &HeaderLabel

What the header shows: the title, an icon and the title, or the icon alone.

pub fn icon(&self) -> Option<&SharedString>

The header’s icon (its asset path), if it shows one.

pub fn is_hideable(&self) -> bool

Returns true if the user may hide the column.

pub fn number_format(&self) -> NumberFormat

How the column shows its numbers.

pub fn is_internal(&self) -> bool

Returns true if the column is internal: never shown.

pub fn image_fit(&self) -> ImageFit

How an image fits the room of its cell.

pub fn image_corner_radius(&self) -> Pixels

The corner radius of the images in the cells.

Trait Implementations

impl<C: Clone> Clone for GridColumn<C>

fn clone(&self) -> GridColumn<C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Debug> Debug for GridColumn<C>

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

Formats the value using the given formatter.