[ type ] TableColumn

Description:

Table column configuration object used in Table components.

Type: Object

Properties:

Name Type Description

text

string

The text to be displayed in the column header. (Required when creating a new column)

[type]

string

Type of component to display/edit cell data. Possible values:

  • text - Plain text or HTML.
  • password" - Masked password text field.
  • textarea - Multi-line text field.
  • icon - Image loaded from cell value source. Use table.onAction(callback) for click events.
  • button - String of button names separated by "|". Use table.onAction(callback) for click events.
  • checkbox - Boolean check mark selection component.
  • combobox - Drop-down list of values, can be editable.
  • progress - Progress bar showing integer value 0–100.

[sorting]

Table.Sorting

Sorting mode. Table.Sorting.None disables sorting.

[icon_size]

number

For "icon" type, fixed width/height of the icon (largest dimension).

[cache_capacity]

number

For "icon" type, number of images cached in RAM.

[resizable]

boolean

Indicates if the column can be resized by the user.

[auto_resize]

boolean

Indicates if column auto-resizes with table (ignored if table auto resize is Table.AutoResize.None).

[primary]

boolean

Indicates a column with primary data, such as URL, file path, or other data type that should be used to generate a list or content for dragging and dropping.

[width]

number

Initial desired width of the column.

[min_width]

number

Minimum width column can be resized to.

[max_width]

number

Maximum width column can be resized to.

[hidden]

boolean

Whether the column is hidden (width 0).

[character]

string

Mask character for "password" type.

[editable]

boolean

Whether text fields are editable.

[clicksToEdit]

boolean

Number of clicks required to make cell editable (only if editable).

[options]

Array.<string>

List of values for "combobox" type.

Examples:

Creating a simple column object:

let column = {
    text: "New Column",
    header_align: "center"
};

Also See: