Struct Column 

#[non_exhaustive]
pub struct Column { /* private fields */ }

One column of a Grid; build it with a constructor per Kind.

Implementations

impl Column

pub fn related( key: &str, label: &str, table: &str, foreign_key: &str, column: &str, ) -> Self

A value of the row this one belongs to: table’s column where its id is this row’s foreign_key (Column::related("customer", "Customer", "customers", "customer_id", "name")). Shown, sorted, filtered and searched like a text column (.numeric() for a number), in one query per page.

pub fn count_of(key: &str, label: &str, table: &str, foreign_key: &str) -> Self

How many rows of table point at this row through foreign_key (Column::count_of("notes", "Notes", "order_notes", "order_id")).

pub fn sum_of( key: &str, label: &str, table: &str, foreign_key: &str, column: &str, ) -> Self

The total of column over the rows of table that point at this row through foreign_key.

pub fn computed(self, sql: &str) -> Self

The column’s value is sql, a scalar SQL expression over the row, where {T} stands for the model’s table: stock value as Column::money("value", "Value").computed("{T}.\"on_hand\" * (SELECT \"cost\" FROM \"variants\" WHERE \"id\" = {T}.\"variant_id\")"). It is shown, sorted, filtered, searched, summed (Column::summary) and grouped by (Grid::groups) like a related column, with no database view. sql is written by the app, never taken from a request: values go in the model’s columns and subqueries, not in the string.

pub fn numeric(self) -> Self

Shows a related value as a number (filtered with a range).

pub fn image(key: &str, label: &str) -> Self

An image column: the value is the image’s URL (.round() for avatars).

pub fn color(key: &str, label: &str) -> Self

A color column: a swatch of the CSS color in the value, with its code.

pub fn badges(self, tones: &[(&str, &str)]) -> Self

Values as colored badges: (value, tone) pairs, the tone one of success, warning, danger, info or neutral. Values not listed get a neutral badge; .badges(&[]) makes every value one.

pub fn icons(self) -> Self

Yes/no columns as a check and a cross instead of words.

pub fn description(self, key: &str) -> Self

Another of the row’s values, small under this one (an email under a name).

pub fn tooltip(self, key: &str) -> Self

Another of the row’s values, shown when the cell is hovered.

pub fn wrap(self) -> Self

Long text wraps instead of widening the column.

pub fn limit(self, chars: usize) -> Self

Text past chars characters is cut with … (the whole text shows on hover).

pub fn link(self, url: &str) -> Self

The value links to this URL ({id} is the row’s id).

pub fn copyable(self) -> Self

A button next to the value copies it.

pub fn round(self) -> Self

Images round (avatars).

pub fn text(key: &str, label: &str) -> Self

A text column; key is the model’s column.

pub fn number(key: &str, label: &str) -> Self

A number column (.decimals(n) for a fixed number of decimals).

pub fn money(key: &str, label: &str) -> Self

An amount in the smallest unit (cents, fils), shown in whole units of APP_CURRENCY with its usual decimals (129900 cents is 1,299.00 in USD, 400,000 in IDR), as the money template filter takes it. Summaries and exports show whole units too, and range filters take them. An inline edit still sends the stored value (the smallest unit).

pub fn date(key: &str, label: &str) -> Self

A date column.

pub fn datetime(key: &str, label: &str) -> Self

A date and time column (shown in APP_TIMEZONE).

pub fn bool(key: &str, label: &str) -> Self

A yes/no column.

pub fn select<V: Into<String>, L: Into<String>>( key: &str, label: &str, options: impl IntoIterator<Item = (V, L)>, ) -> Self

One of options (stored value, label shown).

pub fn tags<V: Into<String>, L: Into<String>>( key: &str, label: &str, options: impl IntoIterator<Item = (V, L)>, ) -> Self

Several of options, stored as a JSON array of the values.

pub fn custom(key: &str, label: &str) -> Self

A column the page’s template draws ({% call(row, column) grid(…) %}). key needn’t be a database column.

pub fn under<S: Into<String>>(self, groups: impl IntoIterator<Item = S>) -> Self

Puts the column under grouped headings, outermost first: .under(["Amounts"]), .under(["Sales", "Q1"]). Neighbouring columns under the same headings share them.

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

Whether a click on the heading sorts by this column (default: yes, except for tags and custom columns).

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

Whether the heading has a filter (default: yes, except for custom columns).

pub fn mobile(self) -> Self

Shown on small screens until the user picks otherwise. When no column says so, the first three are.

pub fn hidden(self) -> Self

Hidden on wide screens too until the user turns it on.

pub fn frozen(self) -> Self

Frozen at the left edge until the user picks otherwise.

pub fn frozen_right(self) -> Self

Frozen at the right edge (e.g. a column of actions).

pub fn decimals(self, decimals: u8) -> Self

Shows a number with exactly decimals decimals.

pub fn width(self, width: &str) -> Self

A minimum width in CSS units, e.g. "14rem".

pub fn editable(self) -> Self

Cells can be edited in place (double-click, Enter or F2; Enter saves, Escape cancels) and in the row’s edit mode. Saving sends the value to the grid’s Grid::edit_url. Not for custom columns, nor for merged ones.

pub fn merge(self) -> Self

Neighbouring rows with the same value share one cell. Merged columns nest from left to right: a column merges only within the merged groups of the merged columns before it (Region, then City). Merging is off while rows are dragged into order.

pub fn searchable(self) -> Self

The toolbar’s search box looks in this column (as text, ignoring case). The box shows when a column is searchable. Not for custom columns.

When the grid’s model has a full-text index (#[model(search = …)], see renox::db::search), the box searches through it instead: every column of the index counts (also those the grid doesn’t show), words match their other forms and prefixes, and rows come best match first until the user sorts. Searchable columns outside the index are still matched as text.

pub fn summary(self, summary: Summary) -> Self

A figure over every row the filters match, in the grid’s footer and under each group: .summary(Summary::Sum), several in a row (.summary(Summary::Sum).summary(Summary::Average)). Sum, average and range are for number and money columns; count for any.

pub fn key(&self) -> &str

The column’s key.

pub fn kind(&self) -> Kind

The column’s kind.

pub fn label(&self) -> &str

The column’s heading.

pub fn titled(self, label: &str) -> Self

The same column under another heading, e.g. a translation.

pub fn options(&self) -> &[(String, String)]

The (value, label) choices of a select or tags column (empty for the other kinds).

Trait Implementations

impl Clone for Column

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Column

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

Formats the value using the given formatter.