Struct netidx_protocols::view::Table

pub struct Table {

    pub path: Expr,
    pub sort_mode: Expr,
    pub column_filter: Expr,
    pub row_filter: Expr,
    pub column_editable: Expr,
    pub column_widths: Expr,
    pub columns_resizable: Expr,
    pub column_types: Expr,
    pub selection_mode: Expr,
    pub selection: Expr,
    pub show_row_name: Expr,
    pub refresh: Expr,
    pub on_select: Expr,
    pub on_activate: Expr,
    pub on_edit: Expr,
    pub on_header_click: Expr,
}

Fields

path: Expr

expr should resolve to the path of the table you want to display. If the expr updates, the table will display the updated path.

sort_mode: Expr

(null | false | external | <column> | spec)
external: [false, [spec, ...]]
spec: [<column>, ("ascending" | "descending")]

• null: no default sort. Sorting is processed within the browser and is under the control of the user. Click events will also be generated when the user clicks on the header button, see on_header_click.
• false: sorting within the browser is disabled, but click events will still be generated when the user clicks on the header buttons. These events could be used to trigger publisher side sorting, or any other desired action. See, on_header_click.
• external: just like ‘false’, however sort indicators will be shown as specified by the indicator spec. Use this if you implement sorting in the publisher, but want to give the user feedback about what is sorted.
• column: by default sort by in descending order. Sorting is processed within the browser and is under the user’s control. Click events will also be generated when the user clicks on the header button, see on_header_click.
• spec: Same as column, except the sort direction is explicitly specified.

column_filter: Expr

(null | true | false | list | range)
list: [list-mode, (<col> | [<col>, ...])]
range: [range-mode, ([(<n> | "start"), (<m> | "end")])]
list-mode: ("include" | "exclude" | "include_match" | "exclude_match")
range-mode: ("keep" | "drop")

• null: all columns are included
• true: all columns are included
• false: no columns are included
• list: Specify a list of columns or column regexes to include or exclude.
  • “include”: col/cols is a list of columns to show. The order of the columns in the list controls the order of the columns that are displayed.
  • “exclude”: col/cols is a list of columns to hide
  • “include_match”: col/cols is a list of regex patterns of columns to show
  • “exclude_match”: col/cols is a list of regex patterns of columns to hide
• range: Specify columns to keep or drop by numeric ranges. Range patterns apply to the positions of columns in the sorted set.
  • “keep”: keep the columns specified by the range, drop any others. If the range specifies more columns than exist all columns will be kept. Matched items will be >= start and < end.
  • “drop”: drop the columns specified by the range, keeping the rest. If the range specifies more columns than exist all the columns will be dropped. Matched items will be < start or >= end.

row_filter: Expr

see column_filter. This is exactly the same, but applies to the rows instead of the columns.

column_editable: Expr

Exactly the same format as the column_filter and the row_filter.

• null: not editable
• true: every column is editable
• otherwise: exactly the same semantics as the column/row filter except it decides whether the column is editable or not.

column_widths: Expr

(null | widths)
widths: [[<name>, <w>], ...]

• null: initial column widths are automatically determined
• widths: The list of numeric values specify the initial width of the corresponding column.

columns_resizable: Expr

(true | false)

• true: columns may be resized by the user
• false: columns may not be resized by the user

column_types: Expr

(null | column_types)
column_types: [[<name>, typename, properties], ...]
typename: ("text" | "toggle" | "image" | "combo" | "spin" | "progress" | "hidden")
properties: match typename
  common:
    ["source", <column-name>],
      optional, the source column that contains the data for
      each row. If not specified the default is this column
      (<name>).
    ["background", <color-string>],
      optional, statically specify the background color of the
      cell. same format as the "foreground" attribute.

    ["background-column", <column-name>],
      optional, the column containing the background color of
      each row in the same format as described in the
      "foreground" attribute.

  "text": [
    common,

    ["foreground", <color-string>],
      optional, statically specify the foreground text
      color. Any string understood by pango_parse_color is
      understood here. That includes css color names, and hex
      strings in various formats.

    ["foreground-column", <column-name>],
      optional, the column containing the foreground color of
      each row, same format as for the "foreground" attribute.
  ]
   
  "toggle": [
    common,

    ["radio", (true | false)],
      optional, whether to render the toggle as a check button
      or a radio button.

      true: the entire column is radio buttons, only one row may
      be selected at any one time

      false: the entire column is check buttons, which may be
      individually toggled.

      <column-name>: the specified boolean column controls
      whether or not the toggle in each row is a radio or a
      check button.

    ["radio-column", <column-name>]
      optional, the column containing the "radio" property for
      each row
  ]

  "image": [
    common,
  ]

  "combo": [
    common,

    ["choices", [<choice>, ...]],
      The available choices globally for the entire
      column. One of choices or choices-column must be
      specified

    ["choices-column", <column-name>]
      The column containing the "choices" attribute
      for each row. One of choices, or choices-column must be
      specified.

    ["has-entry", (true | false)],
      optional. Should the column have an entry in addition to
      the combo box menu? If true the user will be able to
      enter any text they want, even if it isn't a valid
      choice. If false only valid choices may be entered.

    ["has-entry-column", <column-name>]
      optional, the column containing the has-entry attribute for each row.
  ]

  "spin": [
     common,

     ["min", <n>],
       optional, if not specified 0 is assumed.

     ["min-column", <column-name>]
       optional, the column containing the min attribute for each row

     ["max", <n>],
       optional, if not specified 1 is assumed.

     ["max-column", <column-name>]
       optonal, the column containing the max attribute for each row

     ["increment", <n>],
       optional, the amount the value changes with each spin button press

     ["increment-column", <column-name>],
       optional, the column containg the increment property

     ["page-increment", <n>]
       optional, the amount the value changes on a page increment

     ["page-increment-column", <column-name>],
       optional, the column containg the page-increment property

     ["climb-rate", <n>],
       optional. How fast the value should change if the user
       holds the + or - button down.

     ["climb-rate-column", <column-name>]
       optional, the column specifying the climb-rate attribute for each row

     ["digits", <n>],
       optional. The number of decimal places to display.

     ["digits-column", <column-name>]
       optional. The column specifying the digits attribute for each row.
  ]

  "progress": [
    common,
       
    ["activity-mode", (true | false)],
      optional, default false. Operate the progressbar in
      activity mode (see the ProgressBar widget).

    ["activity-mode-column", <column-name>]
      optional, the column specifying the activity mode for each row.

    ["text", <text>],
      optional, display static text near the progress bar

    ["text-column", <column-name>],
      optional, display text from <column-name> near the
      progress bar.

    ["text-xalign", <n>],
      optional, set the horizontal alignment of the displayed
      text. 0 is full left, 1 is full right.

    ["text-xalign-column", <column-name>]
      optional, the column specifying the text-xalign property for each row

    ["text-yalign", <n>],
      optional, set the vertical alignment of the displayed
      text. 0 is top, 1 is bottom.

    ["text-yalign-column", <column-name>]
      optonal, the column specifying the text-yalign property for each row

    ["inverted", (true | false)],
      optional, invert the meaning of the source data

    ["inverted-column", <column-name>]
      optional, the column specifying the inverted property for each row
 ]

 "hidden":
   hidden is a special column type that has no properties. It
   is used to hide data columns that other visible columns
   depend on (so they must appear in the model), but that you
   don't want to show to the user.

 all the properties of progress are optional. If none are set
 the entire properties array may be omitted

• null: a default column type specification is generated that displays all the columns in the filtered model as text.

Notes

The column type specification need not be total, any column not given a type will be assumed to be a text column with no properties assigned.

The column type specification interacts with the column filter, in that a column type specification may name another column as the source of it’s data or of a given property and the column filter may remove that column. If that occurrs the column filter takes precidence. The specified typed column will be displayed, but won’t get any data if it’s underlying column is filtered out.

For properties that can be statically specified and loaded from a column, if both ways are specified then the column will override the static specifiecation. If the column data is missing or invalid for a given row, then the static specification will be used.

selection_mode: Expr

("none" | "single" | "multi")

• “none”: user selection is not allowed. The cursor (text focus) can still be moved, but cells will not be highlighted and no on_select events will be generated in response to user inputs. The selection expression still cause cells to be selected.
• “single”: one cell at a time may be selected.
• “multi”: multi selection is enabled, the user may select multiple cells by shift clicking. on_select will generate an array of selected cells every time the selection changes.

selection: Expr

(null | selection)
selection: [<path>, ...]

• null: The selection is maintained internally under the control of the user, or completely disabled if the selection_mode is “none”.
• selection: A list of selected paths. on_select events are not triggered when this expression updates unless the row or column filters modify the selection by removing selected rows or columns from the table.

show_row_name: Expr

(true | false)
true: show the row name column
false: do not show the row name column

refresh: Expr

when this updates the table structure will be reloaded from netidx

on_select: Expr

event() will yield a list of selected paths when the user changes the selection

on_activate: Expr

event() will yield the row path when the user activates a row, see multi_select

on_edit: Expr

When the user edits a cell event() will yield an array. The first element will be the full path to the source of the cell that was edited. The second element will be the new value of the cell.

on_header_click: Expr

event() will yield the name of the column header that was clicked

Trait Implementations

impl Clone for Table

fn clone(&self) -> Table

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Table

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

Formats the value using the given formatter.

impl Default for Table

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Table

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Table

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.