Skip to main content
Version: 4.2 (beta)

Table Column

Details a column in the table object.

Attributes​

Column​

Type​

Defines the column's cell type.

Attribute Values​
ValueDescription
textDefault value. Text content.
buttonButton content.
imageImage content.
htmlHTML content.
checkA check is displayed if there's any value other than "false" or "0".
checkboxA checkbox field.
It can edit the column's boolean value in the datasource without opening the edit popup or inline edit.
switchA switch field.
It can edit the column's boolean value in the datasource without opening the edit popup or inline edit.
indexThe row's index.
progressA progress bar.
selectionDisplays a check if the item is selected. This column is displayed only if the table's "Item Selection" attribute is true.
moveMove the item with drag and drop. Drop above or below a row's midpoint to insert before or after it, including the first and last rows.
Hold the pointer near the table's top or bottom edge to scroll while dragging.

The default value is: text.

note

This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.

Hidden​

Hides the column so it's not displayed in the table. A column can be hidden, but still have an edit field associated

Attribute Values​
ValueDescription
falseDefault value. Visible.
trueHidden.
viewmodeHidden in view mode, visible in edit mode.
editmodeHidden in edit mode, visible in view mode.

Default behavior:

  • When type is "button" and action is "edit", this attribute defaults to viewmode.
  • When type is "button" and action is "duplicate", this attribute defaults to viewmode.
  • When type is "button" and action is "delete", this attribute defaults to viewmode.
note

This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.

Merge​

If true and the previous column is also a visible button or move column in the same frozen region, displays both controls in the same table column. Consecutive merged button and move columns share the first column's header.

Attribute Values​
ValueDescription
falseDefault value. Display in a separate column.
trueMerge with the previous button or move column.

This attribute is available when type is one of "button" or "move".

The default value is: false.

note

This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.

Data​

Tri State​

Enables the values true, false and indeterminate.

A check column displays a check mark for true, nothing for false and a minus for indeterminate. A checkbox column cycles through true, false and indeterminate when clicked, like the standalone checkbox. This option also applies to the column's generated checkbox edit field.

For check columns, footer summaries count indeterminate as unchecked while including it in the total. When Column Filters are enabled, check and checkbox columns offer all three states in their filter.

Attribute Values​
ValueDescription
falseDefault value. Two states: false, true.
trueThree states: false, true, undeterminate.

This attribute is available when type is one of "check" or "checkbox".

The default value is: false.

Data Name​

Specifies the datasource column name to be associated with the table's column. Values starting with _ are treated as custom columns and are not validated against datasource columns. This can be used with custom callbacks.

Attribute Values​
ValueDescriptionExample
<string>A valid datasource column name.address
<string>A custom callback field name. Values starting with _ are not validated against datasource columns._custom

This attribute is available when owner's datamode is "datasource" and type is not "selection" and type is not "index" and action is not "edit" and action is not "delete" and action is not "move".

Data Index​

Specifies the index in the items array.

Attribute Values​
ValueDescriptionExample
autoDefault value. Index based on column's index.
<int>A 0-based index.0
noneIs not associated.

This attribute is available when owner's datamode is not "datasource" and type is not "selection" and type is not "index" and action is not "edit" and action is not "delete" and action is not "move".

When owner's datamode is not "datasource" and type is not "selection" and type is not "index" and action is not "edit" and action is not "delete" and action is not "move", this attribute defaults to auto.

JSON Value​

If true, interprets the cell value as a JSON object. Each key in the JSON object represents a column attribute.

Values specified in the JSON object will extend or override the initial column setup.

Only non-static attributes can be overridden.

E.g. { "type": "button", "action": "command", "buttonlabel": "hi", "style": "blue", "commandname": "hi" }

Attribute Values​
ValueDescription
falseDefault value. Value is not interpreted as JSON.
trueCell value interpreted as JSON.

This attribute is available when type is neither "selection" nor "index".

The default value is: false.

Format​

Specifies the language-sensitive format type to be applied.

Attribute Values​
ValueDescription
numberNumeric value, with optional unit or currency.
dateDate value.
timeTime value.
datetimeDate and time value.
relativetimeDate and time value.
time-intervalTime interval value.
listList value.

This attribute is available when type is one of "text", "button", or "index".

The default value is: text.

Time Data Format​

Specifies the data format, which determines how the value is parsed when received (through a UISet) or sent.

Attribute Values​
ValueDescription
extendedDefault value. HH:mm:ss.SSSS Extended Format.
basicHHmmssSSSS Basic Format.
timestampUnix Timestamp: Seconds since the Unix Epoch (January 1, 1970 00:00:00 GMT).

This attribute is available when format is "time".

The default value is: extended.

Date Data Format​

Specifies the data format, which determines how the value is parsed when received (through a UISet) or sent.

Attribute Values​
ValueDescription
extendedDefault value. YYYY-MM-DD ISO 8601 Extended Format.
basicYYYYMMDD ISO 8601 Basic Format.
timestampUnix Timestamp: Seconds since the Unix Epoch (January 1, 1970 00:00:00 GMT).

This attribute is available when format is "date".

The default value is: extended.

DateTime Data Format​

Specifies the format used to parse and return the complete value.

Attribute Values​
ValueDescription
extendedDefault value. YYYY-MM-DD HH:mm:ss.SSS ISO 8601 Extended Format.
basicYYYYMMDDHHmmssSSS ISO 8601 Basic Format.
timestampUnix timestamp in milliseconds.

This attribute is available when format is "datetime".

When format is "datetime", this attribute defaults to extended.

Number Display Format​

Specifies the field's format.

Attribute Values​
ValueDescriptionExample
<JSON object>Format configuration object.{"format":"number","style":"unit","unit":"celsius","maximumfractiondigits":"1"}

This attribute is available when format is "number".

Time Display Format​

Specifies the field's format.

Attribute Values​
ValueDescriptionExample
<JSON object>Format configuration object.{"format":"time","timestyle":"short","hourcycle":"h23"}

This attribute is available when format is "time".

Date Display Format​

Specifies the field's format.

Attribute Values​
ValueDescriptionExample
<JSON object>Format configuration object.{"format":"date","datestyle":"medium"}

This attribute is available when format is "date".

DateTime Display Format​

Specifies the field's format.

Attribute Values​
ValueDescriptionExample
<JSON object>Format configuration object.{"format":"datetime","datestyle":"medium","timestyle":"short"}

This attribute is available when format is "datetime".

Relative Time Display Format​

Specifies the field's format.

Attribute Values​
ValueDescriptionExample
<JSON object>Format configuration object.{"format":"relativetime","relativetimeunit":"hour","numeric":"auto"}

This attribute is available when format is "relativetime".

List Display Format​

Specifies the field's format.

Attribute Values​
ValueDescriptionExample
<JSON object>Format configuration object.{"format":"list","liststyle":"short","type":"conjunction"}

This attribute is available when format is "list".

Time Interval Display Format​

Specifies the field's format.

Attribute Values​
ValueDescriptionExample
<JSON object>Format configuration object.{"format":"time-interval","minprecision":"day","maxprecision":"hour","intervalunit":"hour"}

This attribute is available when format is "time-interval".

Foreign Key​

If specified, the column value is interpreted as a foreign key for either a linked datasource, the list attribute, or the items attribute.

In datasource mode, cells display the corresponding value from the linked datasource column specified in the "Label Data Name" attribute.

In list mode, cells display the corresponding value from the list of items specified in the "List" attribute.

In items mode, cells display the corresponding value from the items array, where every item is an array with the first element being the key and the second element being the label.

Attribute Values​
ValueDescription
noneDefault value. No foreign key.
datasourceDatasource foreign key.
listList foreign key.
itemsItems foreign key.

This attribute is available when type is neither "button", "selection", nor "index".

The default value is: none.

note

This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.

Datasource ID​

Specifies the ID of the linked datasource.

Attribute Values​
ValueDescriptionExample
<[Datasource ID]>A valid datasource ID.ds_addresses

This attribute is available when type is not "button" and type is not "selection" and type is not "index" and foreignkey is "datasource".

note

This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.

Value List​

If true, treats the value as a comma-separated list of foreign keys. It shows a comma-separated list of labels resolved from the selected foreign key source. In datasource mode, labels are based on the "Label Data Name" attribute. Keys used in value lists must not contain commas.

Attribute Values​
ValueDescription
falseDefault value. Treat the value as a single key.
trueTreat the value as a comma-separated list of keys.

This attribute is available when type is not "button" and type is not "selection" and type is not "index" and foreignkey is one of "datasource", "list", or "items".

The default value is: false.

note

This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.

Label Data Name​

Specifies the linked datasource column name to display instead of the key value. Values starting with _ are treated as custom callback fields and are not validated against datasource columns.

Attribute Values​
ValueDescriptionExample
<[Datasource Column Name]>A valid datasource column name.address
<string>A custom callback field name. Values starting with _ are not validated against datasource columns._custom

This attribute is available when type is not "button" and type is not "selection" and type is not "index" and foreignkey is "datasource".

note

This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.

List​

Sets the items. An item with a label "---" (three hyphen-minus characters) is treated as a separator and its value is ignored.

Attribute Values​
ValueDescriptionExample
<comma-separated list>Items specified as a comma-separated list.item1,item2,item3
<array>Items specified as an array of strings.["item1","item2","item3"]
<array of arrays>Items specified as an array of arrays. Each item has an array of value and label.[[1,"label1"],[2,"label2"],[3,"label3"]]
<array of arrays>Items specified as an array of arrays. Each item has an array of values that can be recalled from the template attribute.[[1,"label1","descr1"],[2,"label2","descr2"],[3,"label3","descr3"]]

This attribute is available when type is not "button" and type is not "selection" and type is not "index" and foreignkey is "list".

note

This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.

Items​

Specifies the items.

Attribute Values​
ValueDescriptionExample
<JSON array>Array of list items.[{"value":"kitchen","label":"Kitchen"}]

This attribute is available when type is not "button" and type is not "selection" and type is not "index" and foreignkey is "items".

note

This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.

Cell Style & Format​

Width​

The column's width.

For button columns, 'auto' (also the default when width is omitted) fits the rendered labels, icons, padding and gaps of the entire merged group, including move handles. A single button column has a minimum width of 50 pixels. These columns stay compact instead of expanding to fill unused space.

Other columns set to 'auto' share the remaining table space after accounting for fixed widths and auto button groups, with a minimum width of 100 pixels. An explicit numeric width applies to the entire merged group.

If the combined width of all columns exceeds the width of the table, the table becomes horizontally scrollable. This ensures that all columns, regardless of their individual or total width, remain accessible to the user.

Attribute Values​
ValueDescriptionExample
<int>The column's width in pixels.200

This attribute is available when merge is not "true" and type is neither "selection" nor "move".

When merge is not "true" and type is neither "selection" nor "move", this attribute defaults to auto.

Fixed Width​

Columns of type selection and move have a fixed width.

This attribute is available when merge is not "true" and type is one of "selection" or "move".

When fieldtype is "switch", this attribute defaults to 60.

note

This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.

Align​

Specifies the cell's content alignment.

Attribute Values​
ValueDescription
leftDefault value. Left.
centerCenter.
rightRight.

This attribute is available when merge is not "true" and type is neither "selection" nor "button".

The default value is: left.

Background​

Specifies the cell's background color.

Attribute Values​
ValueDescriptionExample
<html color>Color in any html accepted format.#ff0000

This attribute is available when merge is not "true".

Column Header​

Label​

The label displayed in the column header.

Attribute Values​
ValueDescription
<string>A label.

This attribute is available when type is not "selection" and merge is not "true".

When type is not "selection" and merge is not "true", this attribute defaults to the dataname attribute, converted to title case.

Icon​

An optional icon to be displayed in the column header, before (or in place of) the label.

Attribute Values​
ValueDescriptionExample
<image>An icon image.icon:mdi#account-multiple

This attribute is available when type is not "selection" and merge is not "true".

Header Tooltip​

The tooltip displayed when the mouse hovers over the column header.

Attribute Values​
ValueDescription
<string>A tooltip.

This attribute is available when type is not "selection" and merge is not "true".

Summary Label​

If true, the footer column will contain a label of the row's content (Total, Average, Minimum or Maximum). If more consecutive columns have summary label set to true, they are merged (can be used to display the whole label if a single column is too narrow)

Attribute Values​
ValueDescription
falseDefault value. False.
trueTrue.

This attribute is available when type is not "move" and type is not "selection" and merge is not "true".

The default value is: false.

Summary​

Specifies the summary to be displayed on the column footer. Can be one or more values. If there's an active filter, the results are calculated using the filtered rows. If there's a selection, Selecting specific rows will calculate the results using only the selected rows

Attribute Values​
ValueDescription
noneDefault value. No summary.
sumShow sum of all the displayed column values.
avgShow the average value of all the displayed column values. If the column has type "check", show checked/total.
minShow the minimum value among the displayed column values.
maxShow the maximum value among the displayed column values.

This attribute is available when type is not "move" and type is not "selection" and merge is not "true" and summarylabel is "false" and type is not "index".

When type is not "move" and type is not "selection" and merge is not "true" and summarylabel is "false" and type is not "index", this attribute defaults to none.

Button Action​

Action​

Specifies the action performed when clicked/tapped.

Attribute Values​
ValueDescription
noneDefault value. No action.
editEdits the item.
deleteDeletes the item.
duplicateDuplicates the item.
commandSends a command to the server, with the specified name and parameter.

See the Command API.
datapointToggles a datapoint.
linkChanges page, shows a popup or opens a URL.
downloadCalls userCommand with the configured Command Name and Parameter, then downloads the content returned by the callback.

See Handling a download request.
tabShows a specified container and hides the other of the same group.
cameralinkOpens a page with the specified camera address.
copyCopies the cell's value to the clipboard.

This attribute is available when type is "button".

The default value is: none.

Command Name​

Specifies the command name that is sent to the server.

If the name starts with $, then the server will automatically set a variable with the same name as the command, containing the command's parameter.

Attribute Values​
ValueDescriptionExample
<string>A command name.
$[variable name]A command name that sets a variable.$myvar
$[variable name]!A command name that sets a persistent variable.$myvar!

This attribute is available when type is "button" and action is one of "command" or "download".

When type is "button" and action is one of "command" or "download", this attribute defaults to the id attribute.

Parameter​

If set, specifies the command's parameter value. The default parameter is the key value of the row.

This attribute is available when type is "button" and action is one of "command" or "download".

When type is "button" and action is one of "command" or "download", this attribute defaults to [Row's key value].

Repeat​

If enabled, the command will be repeated every second. Instead of a single command on the button press event, multiple commands are sent with the same command name and these suffixes added to the command parameter:

  • <command parameter>/down: on mouse down or touch down events
  • <command parameter>/repeat/<n>: if the button is still pressed, a repeat command is sent every second, where <n> counts the repeats from 1
  • <command parameter>/up: on mouse up or touch up events, for a short press (less than a second, so no repeat commands have been sent yet)
  • <command parameter>/stop: on mouse up or touch up events, for a long press (more than a second, so at least a repeat command has been sent)

With an empty command parameter, the parameter is the suffix alone, such as /down.

Attribute Values​
ValueDescription
falseDefault value. Repeat mode is disabled.
trueRepeat mode is enabled.

This attribute is available when type is "button" and action is "command".

The default value is: false.

If set, specifies the link. The default link is the row's cell value.

This attribute is available when type is "button" and action is "link".

When type is "button" and action is "link", this attribute defaults to [Cell's value].

Specifies where to open the linked URL. Available only for URL links.

Attribute Values​
ValueDescription
_selfDefault value. Opens the linked URL in the same window or tab.
_blankOpens the linked URL in a new window or tab.
<string>Opens the linked URL in a named window or tab. Use this to open multiple links in the same window or tab.

This attribute is available when action is link and link is a valid URL or path.

When action is link and link is a valid URL or path, this attribute defaults to _self.

Datapoint​

Specifies a datapoint, to display and control its status.

Attribute Values​
ValueDescriptionExample
[datapoint address]The datapoint address.dummy.dimmer.1

This attribute is available when type is "button" and action is "datapoint".

When type is "button" and action is "datapoint", this attribute defaults to [Cell's value].

Feedback​

If feedback is enabled, when the action is performed, a loader is displayed until the server responds.

Also the action can't be performed again until the server responds.

Attribute Values​
ValueDescription
falseDefault value. Feedback is disabled.
trueFeedback is enabled.

This attribute is available when type is "button" and action is one of "command", "download", "edit", "delete", or "duplicate".

The default value is: false.

Confirm​

Requires a confirmation before performing the action.

Attribute Values​
ValueDescription
falseDefault value. No confirmation, the action is performed right away.
doubleclickA second click (or touch or enter key) is required to confirm the action.
popupA popup is displayed to ask for confirmation.

This attribute is available when type is "button" and action is not "delete".

The default value is: false.

Confirm Message​

The confirmation message to be displayed if the "confirm" attribute is set to "popup".

Attribute Values​
ValueDescriptionExample
<string>The message to be displayed in the confirm popup.Are you sure?

This attribute is available when type is "button" and action is not "delete".

Confirm​

This attribute is available when type is "button" and action is "delete".

Edit Duplicate​

If true, opens the edit popup to allow changes before adding the item as new.

Attribute Values​
ValueDescription
trueDefault value. Edit the item before adding it as new.
falseDuplicate the item right away.

This attribute is available when type is "button" and action is "duplicate".

When type is "button" and action is "duplicate", this attribute defaults to true.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Edit Popup​

Specifies the ID of a custom edit popup to open when this button is clicked. The popup ID must be defined in the table's "Edit Popups" attribute. This is a client-side way to specify which popup to use for edit buttons in a column. Alternatively, the server can dynamically specify a custom popup via the pre-edit command response.

Attribute Values​
ValueDescription
<string>Popup ID.

This attribute is available when type is "button" and action is "edit".

Text​

Text​

Specifies the text to be displayed in the cell.

Attribute Values​
ValueDescription
<string>A text.

This attribute is available when type is "text".

When type is "text", this attribute defaults to [Cell's value].

Template​

Defines an HTML template. The text parameter is split with pipe character (|) and each part is inserted in the template, replacing the %1;, %2;, $3;, etc. placeholders.

Attribute Values​
ValueDescriptionExample
<string>HTML template.<b>%1;</b> - %2;

This attribute is available when type is "text".

Selectable​

Makes the text selectable.

Attribute Values​
ValueDescription
falseDefault value. False.
trueTrue.

This attribute is available when type is "text".

The default value is: false.

Detects urls, emails and phone numbers and displays them as hyperlinks. Phone numbers can be: E.164 format, [+]XXX XXX XXXX or [+]XXX-XXX-XXXX.

Attribute Values​
ValueDescription
falseDefault value. Disabled.
trueEnabled.

This attribute is available when type is "text".

The default value is: false.

Button​

Copy Text​

Specifies the text to be copied in the clipboard when the button is clicked.

Attribute Values​
ValueDescription
<string>A text.

This attribute is available when type is "button" and and (action=='copy').

When type is "button" and and (action=='copy'), this attribute defaults to [Cell's value].

Button Label​

Specifies the button's label.

Attribute Values​
ValueDescription
<string>Button's label.

This attribute is available when type is "button".

When type is "button" and action is "command", this attribute defaults to [Cell's value].

Button Description​

Specifies a description displayed below the label.

Attribute Values​
ValueDescription
<string>Button's description.

This attribute is available when type is 'button'and (action!='datapoint' or displaystateindescription=='false').

Button Color​

Specifies the button color.

Attribute Values​
ValueDescription
defaultDefault value. Default color.
primaryPrimary color, used to highlight action buttons.
warningWarning color, used to highlight warning buttons.
successSuccess color, used to highlight success buttons.
errorError color, used to highlight error buttons.
lightLight color.
darkDark color.
red,blue,yellow,green,yellow,purple,orange,greenPalette colors.
customCustom color, defined in the "Custom Color" attribute.

This attribute is available when type is "button".

The default value is: default.

Button Look​

Specifies the button's look.

Attribute Values​
ValueDescription
filledDefault value. Filled look, with a solid background.
clearClear look, no background or border.
outlinedOutlined look, with a solid border.
glassGlass look, with a semi-transparent background.

This attribute is available when type is "button".

When type is "button" and buttonicon is not empty and buttonlabel is empty and buttondescription is empty, this attribute defaults to clear.

Button Icon​

Specifies the icon source to display. Its position is set with the "Icon Position" attribute.

The value can be:

  • An icon prefixed with icon:
  • A relative path to an image file, such as lights/lamp.png, resolved from the standard image folders
Attribute Values​
ValueDescriptionExample
<icon>Icon prefixed with icon:.icon:mdi#account-multiple
<image>Relative path to the image file.lights/lamp.png

This attribute is available when type is "button".

Default behavior:

  • When action is "delete", this attribute defaults to icon:sys#delete.
  • When action is "edit", this attribute defaults to icon:sys#edit.
  • When action is "duplicate", this attribute defaults to icon:sys#copy.
  • When action is "download", this attribute defaults to icon:sys#download.
  • When action is "copy", this attribute defaults to icon:sys#copy.

Button Text Align​

Sets the horizontal alignment of the text.

Attribute Values​
ValueDescription
noneDefault value. No alignment.
leftLeft alignment.
rightRight alignment.
centerCenter alignment.
justifyJustified alignment.

This attribute is available when type is "button".

Default behavior:

  • When iconposition is "left", this attribute defaults to left.
  • When iconposition is "top", this attribute defaults to center.

Image​

Image​

Specifies the image source to show.

The value can be:

  • A relative path to an image file, such as lights/lamp.png
  • An icon prefixed with icon:

Relative image paths are resolved against one of the following folders:

  • Common images folder, for images shared among projects (www/img)
  • Project images folder, for project-specific images (www/projects/<project>/img) If an image with the same relative path is found in both folders, the project image is used.
Attribute Values​
ValueDescriptionExample
<image>Relative path to the image file.lights/lamp.png
<icon>Icon prefixed with icon:.icon:mdi#account-multiple
noneNo image is displayed.

This attribute is available when type is "image".

When type is "image", this attribute defaults to [Cell's value].

Icon Color​

Specifies the icon color.

This attribute is available when type is 'image'and (image=='icon:%' or image=='%.svg').

Typography​

Font Family​

Specifies the font family.

This attribute is available when type is one of "text", "index", or "button".

Default behavior:

  • When type is one of "text", "index", or "button", this attribute defaults to default.
  • When mask is not empty, this attribute defaults to Roboto Mono, monospace.

Font Size​

Specifies the font size in pixels or percentage (relative to the project's font size).

Attribute Values​
ValueDescriptionExample
<integer>Font size in pixels.
<percentage>%Relative font size in percentage.90%

This attribute is available when type is one of "text", "index", or "button".

When type is one of "text", "index", or "button", this attribute defaults to 14.

Font Color​

Specifies the text CSS color.

Attribute Values​
ValueDescriptionExample
<html color>Color in any html accepted format.#ff0000

This attribute is available when type is one of "text", "index", or "button".

Font Weight​

Specifies the weight of the font.

Attribute Values​
ValueDescription
normalDefault value. Normal.
boldBold.
bolderBolder.
lighterLighter.

This attribute is available when type is one of "text", "index", or "button".

The default value is: normal.

Italic​

Show the text in italics.

Attribute Values​
ValueDescription
falseDefault value. Normal.
trueItalics.

This attribute is available when type is one of "text", "index", or "button".

The default value is: false.

Small Caps​

Sets the font to small caps.

Attribute Values​
ValueDescription
falseDefault value. Normal.
trueSmall caps.

This attribute is available when type is one of "text", "index", or "button".

The default value is: false.

Decoration​

Specifies the text decoration.

Attribute Values​
ValueDescription
noneDefault value. No decoration.
underlineUnderline.
overlineOverline.
line-throughLine through.

This attribute is available when type is one of "text", "index", or "button".

The default value is: none.

Progress​

Value​

Specifies the current value of the progress bar.

Attribute Values​
ValueDescription
<int>Current value.

This attribute is available when type is "progress".

When type is "progress", this attribute defaults to [Cell's value].

Max Value​

Specifies the maximum value of the progress bar.

Attribute Values​
ValueDescription
<int>Maximum value.

This attribute is available when type is "progress".

When type is "progress", this attribute defaults to 100.

Status​

Specifies the status of the progress bar.

active displays an animation over the progress bar.

success and error display icons in place of the value label.

auto chooses the status depending on the current value:

  • active if the value is less than the maximum value
  • success if the value is equal to the maximum value
  • error if the value is less than 0
Attribute Values​
ValueDescription
autoDefault value. Chooses status depending on the current value.
idleIdle status, no animation.
activeActive status, displays an animation.
successSuccess status, displays a checkmark icon.
errorError status, displays a cross icon.

This attribute is available when type is "progress".

The default value is: auto.

Color​

Specifies the color of the progress bar.

This attribute is available when type is "progress".

When type is "progress", this attribute defaults to auto.

Show Percentage​

Specifies whether the current percentage is shown.

Attribute Values​
ValueDescription
trueDefault value. Current value is shown.
falseCurrent value is not shown.

This attribute is available when type is "progress".

When type is "progress", this attribute defaults to true.

Other​

Import​

Specifies how the imported column values are parsed.

Attribute Values​
ValueDescription
falseImport disabled for this column.
valueDefault value. Import the value.
keyImports the key value, if there's a foreign key source.
formattedAttempts to parse the value when importing (results can vary depending on the input).

This attribute is available when type is neither "selection" nor "move".

Default behavior:

  • When owner's datamode is "datasource" and dataname is empty, this attribute defaults to false.
  • When owner's datamode is not "datasource" and dataindex is "none", this attribute defaults to false.
  • When type is neither "selection" nor "move", this attribute defaults to value.

Export​

Specifies how the column values are exported.

Attribute Values​
ValueDescription
falseExport disabled for this column.
valueDefault value. Exports the value. Can differ from raw if there's a foreign key source or an edit field of type "select" .
keyExports the key value (as received from the datasource or from the items attribute).
formattedExports the formatted value.

This attribute is available when type is neither "selection" nor "move".

Default behavior:

  • When owner's datamode is "datasource" and dataname is empty, this attribute defaults to false.
  • When owner's datamode is not "datasource" and dataindex is "none", this attribute defaults to false.
  • When type is neither "selection" nor "move", this attribute defaults to value.

Filter​

Controls whether the column's value is used when filtering the table.

If set to "formatted", the displayed value is used.

If Column Filters are enabled and this attribute is false, the column filter field is not displayed for this column.

Attribute Values​
ValueDescription
falseThe filter check skips this column.
valueThe filter is applied to the value.
formattedDefault value. The filter is applied to the formatted value.

The default value is: formatted.

Sort​

Specifies sorting behavior for this column. Applies only if table is sortable.

Attribute Values​
ValueDescription
asciiDefault value. Column is sorted using an lexicographical sort algorithm.
naturalColumn is sorted using a natural sort algorithm.
offColumn is not sortable.

This attribute is available when owner's sortable is "true" and type is not "button" and type is not "move" and type is not "selection".

The default value is: ascii.

Tooltip​

Specifies a tooltip to be displayed when the mouse hovers over the cell.

Attribute Values​
ValueDescriptionExample
<string>A tooltip.This is a tooltip

Default behavior:

  • When action is "edit", this attribute defaults to $tablecolumnedit;.
  • When type is "move", this attribute defaults to $tablecolumnmove;.
  • When type is "selection", this attribute defaults to $tablecolumnselect;.
  • When action is "duplicate", this attribute defaults to $tablecolumnduplicate;.
  • When action is "delete", this attribute defaults to $tablecolumndelete;.
  • When action is "copy", this attribute defaults to the copytext attribute.

Edit Field​

Field Type​

Specifies the type of the edit field.

Attribute Values​
ValueDescription
noneNo edit field.
textDefault value. Single line text field.
multilineMulti line text field.
checkboxCheckbox.
switchSwitch.
selectSelect box.
radiogroupRadio group field.
dateDate picker.
timeTime picker.
datetimeDate and time picker.
time-intervalTime interval picker.
keypadKeypad.
hiddenHidden field, not displayed in the edit popup. Useful for sending data to the server.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index').

Default behavior:

  • When type is one of "button", "image", "selection", "move", or "index", this attribute defaults to none.
  • When type is one of "check" or "checkbox", this attribute defaults to checkbox.
  • When type is "switch", this attribute defaults to switch.
  • When type is "text" and format is "date", this attribute defaults to date.
  • When type is "text" and format is "time", this attribute defaults to time.
  • When type is "text" and format is "datetime", this attribute defaults to datetime.
  • When type is "text" and format is "time-interval", this attribute defaults to time-interval.
  • When foreignkey is not "none", this attribute defaults to select.
  • When (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index'), this attribute defaults to text.

Field Name​

Specifies the name of the field, used to send a command to the server, along with the field's value as a parameter.

If the name starts with $, then the server will automatically set a variable with the same name as the command, containing the command's parameter.

Attribute Values​
ValueDescriptionExample
<string>Command name.
$[variable name]A command name that sets a variable.$myvar
$[variable name]!A command name that sets a persistent variable.$myvar!

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is not "none".

Default behavior:

  • When owner's datamode is "datasource", this attribute defaults to the dataname attribute.
  • When (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is not "none", this attribute defaults to the dataindex attribute.

Field Label​

Specifies the label displayed for the field in the add/edit popup.

Attribute Values​
ValueDescription
<string>A label.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is neither "none" nor "hidden".

When fieldtype is neither "checkbox" nor "switch" or checkboxlabel is empty, this attribute defaults to the label attribute.

Placeholder​

Specifies a short hint that describes the expected value of the field (e.g. a sample value or a short description of the expected format).

The short hint is displayed in the input field before the user enters a value.

Attribute Values​
ValueDescription
<string>Placeholder text.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is neither "none", "checkbox", "switch", "radiogroup", nor "hidden".

Field Icon​

Specifies the field's icon image.

Attribute Values​
ValueDescription
<image>Image path or icon id.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is neither "none", "checkbox", "switch", "radiogroup", nor "hidden".

Clear Button​

Show a clear button that clears the field's value.

Attribute Values​
ValueDescription
trueShow the clear button when there's any value set.
falseDefault value. Hide the clear button.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is neither "none", "checkbox", "switch", "radiogroup", nor "hidden".

When fieldtype is "text", this attribute defaults to true.

Prefix​

Specifies a prefix to display before the field's value.

Attribute Values​
ValueDescription
<string>Prefix text.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is neither "none", "checkbox", "switch", "radiogroup", nor "hidden".

Suffix​

Specifies a suffix to display after the field's value.

Attribute Values​
ValueDescription
<string>Suffix text.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is neither "none", "checkbox", "switch", "radiogroup", nor "hidden".

Focus Tooltip​

Specifies a description tooltip to display when focusing the field.

Attribute Values​
ValueDescription
<string>Tooltip text.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is neither "none", "checkbox", "switch", "radiogroup", nor "hidden".

Required​

Specifies if the field is required when adding and editing. If true, an empty/null value is considered not valid. When there are non valid fields, the confirm button focuses the first non valid field instead of sending data to the server, to prompt the user to fill in the required fields.

Attribute Values​
ValueDescription
autoDefault value. If the table is connected to a datasource, this attribute is controlled by the datasource's nullable attribute on the specified column. Otherwise it's set to false.
trueA value is required. Where it applies, null values can't be selected.
falseAn empty/null value is accepted.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is neither "none" nor "hidden".

The default value is: auto.

Add Value​

Specifies the default value in the add popup's edit field. This value is used to initialize the field's value when adding a new item. When duplicating, this value is used as the savevalue="changed" comparison value. It's ignored when editing an existing item.

Attribute Values​
ValueDescription
<string>A default value.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is not "none".

Default Value​

Specifies the field's popup value when the field has no value. This allows a quick selection of a default value by pressing the Enter key or OK button.

For more information on the format of the value, see the specific field type:

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is one of "date", "time", "time-interval", or "keypad".

Edit Field Options​

Checkbox Label​

Specifies a label that is displayed next to the field.

Attribute Values​
ValueDescription
<string>A label.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is one of "checkbox" or "switch".

Keypad Label​

Specifies a label.

Attribute Values​
ValueDescription
<string>Label.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is "keypad".

Min​

Specifies the minimum value allowed.

Attribute Values​
ValueDescription
<string>Minimum value.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is "keypad".

Max​

Specifies the maximum value allowed.

Attribute Values​
ValueDescription
<string>Maximum value.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is "keypad".

Digits​

Specifies the number of digits allowed.

Attribute Values​
ValueDescription
autoAny number of digits.
<int>Maximum number of digits.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is "keypad".

Decimals​

Specifies the number of decimals allowed.

Attribute Values​
ValueDescription
<int>Number of decimals.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is "keypad".

When (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is "keypad", this attribute defaults to 0.

Password​

Hides the typed value, providing a way for the user to securely enter a password.

Attribute Values​
ValueDescription
falseDefault value. Typed value is not hidden.
trueHide the typed value.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is "keypad".

The default value is: false.

Field Data Mode​

Specifies the mode of the data.

Attribute Values​
ValueDescription
itemsDefault value. Data is set with the UI attribute Items.
listData is a list of comma-separated values. Set in the List attribute.
datasourceData is set by a linked datasource.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is one of "select" or "radiogroup".

Default behavior:

  • When foreignkey is "datasource" and fieldtype is "select", this attribute defaults to datasource.
  • When foreignkey is "list" and fieldtype is "select", this attribute defaults to list.

Field Datasource ID​

Specifies the ID of the datasource.

The datasource keys are used as item values.

Attribute Values​
ValueDescription
<string>ID of the datasource.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and (fieldtype is one of "select" or "radiogroup") and fielddatamode is "datasource".

Default behavior:

  • When (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and (fieldtype is one of "select" or "radiogroup") and fielddatamode is "datasource", this attribute defaults to the datasourceid attribute.
  • When foreignkey is "datasource" and fieldtype is "select", this attribute defaults to the datasourceid attribute.

Field Item Data Map​

Specifies how to map datasource columns to the properties displayed by each list item.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and (fieldtype is one of "select" or "radiogroup") and fielddatamode is "datasource".

Field List​

Sets the items. An item with a label "---" (three hyphen-minus characters) is treated as a separator and its value is ignored.

Attribute Values​
ValueDescriptionExample
<comma-separated list>Items specified as a comma-separated list.item1,item2,item3
<array>Items specified as an array of strings.["item1","item2","item3"]
<array of arrays>Items specified as an array of arrays. Each item has an array of value and label.[[1,"label1"],[2,"label2"],[3,"label3"]]
<array of arrays>Items specified as an array of arrays. Each item has an array of values that can be recalled from the template attribute.[[1,"label1","descr1"],[2,"label2","descr2"],[3,"label3","descr3"]]

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and (fieldtype is one of "select" or "radiogroup") and fielddatamode is "list".

When (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and (fieldtype is one of "select" or "radiogroup") and fielddatamode is "list", this attribute defaults to the list attribute.

Field Items​

Specifies the items.

Attribute Values​
ValueDescriptionExample
<JSON array>Array of list items.[{"value":"kitchen","label":"Kitchen"}]

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and (fieldtype is one of "select" or "radiogroup") and fielddatamode is "items".

When (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and (fieldtype is one of "select" or "radiogroup") and fielddatamode is "items", this attribute defaults to the items attribute.

Multi​

Specifies if the field allows selecting multiple items or rows.

Attribute Values​
ValueDescription
falseDefault value. Single selection.
trueMultiple selection.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is "select".

When foreignkey is one of "datasource", "list", or "items" and valuelist is "true", this attribute defaults to true.

Field Template​

Specifies the template for the items.

The template can contain placeholders for the values of the items. The placeholders are specified as %0;, %1;, %2;, etc.

For example, if the template is %0; - %1;, %2; and the item is ["value", "label", "descr"], the result is value - label, descr.

If the template is not specified, the items' labels are displayed.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is "select".

Field Filter​

Displays an input field for filtering the items. After typing a value in the field or setting the Filter Value attribute, any item that does not match the input will be hidden. A match occurs when the filter value is found anywhere within any item's fields ('value', 'label', etc).

Attribute Values​
ValueDescription
trueDisplay the filter field.
falseDefault value. Hides the filter field.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is "select".

The default value is: false.

Specifies the width of the select or table popup.

Attribute Values​
ValueDescription
autoDefault value. Select popup is wide enough to fit the content, while table popup uses its default width.
<int>Width in pixels.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is "select".

When (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is "select", this attribute defaults to auto.

Free Input​

Specifies if the user can input a value that is not in the list.

Attribute Values​
ValueDescription
falseDefault value. Only the items in the list can be selected.
trueThe user can input a value that is not in the list.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is "select".

The default value is: false.

Password​

Hides the typed value, providing a way for the user to securely enter a password.

In toggle mode, a toggle button is displayed that allows the user to show the typed value.

Attribute Values​
ValueDescription
falseDefault value. Typed value is not hidden.
trueHide the typed value.
toggleShow a toggle button that allows the user to show the typed value.
toggle-falseShow the toggle button, but show the typed value by default.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is "text".

The default value is: false.

Sanitize Value​

Specified one or more sanitization options to apply to the field's value before sending it to the server.

Attribute Values​
ValueDescription
trimRemoves leading and trailing whitespaces and line breaks.
carriage-returnRemoves carriage returns.
non-printableRemoves non-printable characters.
lowercaseConverts the value to lowercase.
uppercaseConverts the value to uppercase.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and (fieldtype is "text" or fieldtype is "multiline" or ((fieldtype is "select" and freeinput is "true"))).

Mask​

Specifies an input mask for the field. Supported slots are 0 for digits, a for letters, A for uppercase letters, n for alphanumeric characters, N for uppercase alphanumeric characters, x for hexadecimal digits, X for uppercase hexadecimal digits and * for any character. Use [ and ] to make part of the mask optional. Use \ to escape the next character and treat it as a literal.

When no placeholder is specified, the field shows the mask as underscores with any literal separators. The mask fills only the editable slots, blocks extra characters, and validates only when all slots are filled. The mask defines the structure, while Allowed Characters applies an additional filter to the characters typed into mask slots. A character must satisfy both the mask slot and the Allowed Characters regular expression, if specified. Validate Value is checked on the final formatted value.

E.g. *[***]/*[*]/*[*] with Allowed Characters set to [0-9*] allows values like 2026/3/4 or */3/4. E.g. AA000AA already restricts input by structure, so Allowed Characters is usually only needed for extra restrictions. When no font family is specified, masked fields default to Roboto Mono, monospace.

Attribute Values​
ValueDescription
0000/00/00Four digits for year, two for month and two for day.
00/00/0000Two digits for day, two for month and four for year.
0000/0[0]/0[0]Year always uses four digits, month and day accept one or two digits.
AA000AATwo uppercase letters, three digits and two uppercase letters.
AAAAAA00A00A000ASix uppercase letters, two digits, one uppercase letter, two digits, one uppercase letter, three digits and one uppercase letter.
NNNN-0000Four uppercase alphanumeric characters, a dash and four digits.
#XXXXXXA literal # followed by six uppercase hexadecimal digits.
<string>Any mask pattern.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and (fieldtype is "text" or fieldtype is "multiline" or ((fieldtype is "select" and freeinput is "true"))).

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Allowed Characters​

Specifies a regular expression that defines the characters allowed as input for the custom element. E.g. "[a-z]" will allow only lowercase letters.

It's applied to pasted values as well. When a mask is specified, this regular expression is applied only to the characters typed into the mask slots. Mask literals such as /, - or escaped characters are inserted by the mask and do not need to match the regular expression. This means Allowed Characters is often redundant when the mask already defines the needed character types, and is mainly useful for extra restrictions such as allowing * together with digits in a slot pattern like *[***]/*[*]/*[*]. Might not work on Android devices.

Attribute Values​
ValueDescription
[empty]Default value. No validation, all keys are allowed.
[a-z]Only lowercase letters.
[A-Z]Only uppercase letters.
[0-9]Only numbers.
[0-9a-zA-Z]Only numbers and letters.
[^\s\p{C}]Only printable characters.
<string>Regular expression.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and (fieldtype is "text" or fieldtype is "multiline" or ((fieldtype is "select" and freeinput is "true"))).

Validate Value​

Specifies a regular expression that the field's value must match.

Attribute Values​
ValueDescription
[empty]Default value. No validation, any input is valid.
[a-z]+Only lowercase letters.
[A-Z]+Only uppercase letters.
[a-zA-Z]+Only letters.
[0-9]+Only numbers.
[0-9a-zA-Z]+Only numbers and letters.
<string>Any regular expression.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and (fieldtype is "text" or fieldtype is "multiline" or ((fieldtype is "select" and freeinput is "true"))).

Min Length​

Specifies the minimum number of characters required for the field's validation.

Attribute Values​
ValueDescription
<int>Length in characters.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and (fieldtype is "text" or fieldtype is "multiline" or ((fieldtype is "select" and freeinput is "true"))).

Max Length​

Specifies the maximum number of characters allowed in the field.

Attribute Values​
ValueDescription
<int>Length in characters.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and (fieldtype is "text" or fieldtype is "multiline" or ((fieldtype is "select" and freeinput is "true"))).

Validate Tooltip​

Specifies a custom validation tooltip to display when confirming the field value (on a submit button action or automatically in autosend mode). Displayed only if the current value doesn't match the validation criteria defined by the required, validate value and min length attributes.

Attribute Values​
ValueDescription
<string>Validation tooltip.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and (fieldtype is "text" or fieldtype is "multiline" or ((fieldtype is "select" and freeinput is "true"))).

Field Width​

Width of the edit field in pixels.

Minimum value is 0.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is neither "none" nor "hidden".

Field Height​

Height of the edit field in pixels.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is "multiline".

Field Margin​

Specifies the field margin in the add/edit popup.

Attribute Values​
ValueDescriptionExample
<int>Margin in pixels for all sides.
<top> <right> <bottom> <left>Margin for each side in pixels.0 0 8 0

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is neither "none" nor "hidden".

Step​

Specifies the step of the time picker, referred to the smallest unit of time that can be selected.

E.g. if the smallest unit is minutes and step is set to 15, the time picker will allow to select only times that are multiple of 15 minutes.

Attribute Values​
ValueDescriptionExample
<int>Step of the picker.15

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is one of "time" or "datetime".

Default behavior:

  • When (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is one of "time" or "datetime", this attribute defaults to 1.
  • When (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is "time-interval", this attribute defaults to 1.

Precision​

Specifies the precision of the time picker, the smallest unit of time that can be selected

Attribute Values​
ValueDescription
minuteDefault value. Minute.
secondSecond.
msMs.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is one of "time" or "datetime".

When (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is one of "time" or "datetime", this attribute defaults to minute.

Step​

Specifies the step of the time picker, referred to the smallest unit of time that can be selected.

E.g. if the smallest unit is minutes and step is set to 15, the time picker will allow to select only times that are multiple of 15 minutes.

Attribute Values​
ValueDescriptionExample
<int>Step of the picker.15

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is "time-interval".

Default behavior:

  • When (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is one of "time" or "datetime", this attribute defaults to 1.
  • When (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is "time-interval", this attribute defaults to 1.

Unit​

Specifies the unit of the value.

E.g. Unit: hour, Max Precision: hour, Min Precision: second. 5:30 will be parsed as 5.5. Unit: second, Max Precision: hour, Min Precision: second. 5:30 will be parsed as 330.

Attribute Values​
ValueDescription
yearYear.
dayDay.
hourDefault value. Hour.
minuteMinute.
secondSecond.
msMs.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is "time-interval".

When (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is "time-interval", this attribute defaults to hour.

Min Precision​

Specifies the minimum precision of the time picker, the greatest unit of time that can be selected

Attribute Values​
ValueDescription
yearYear.
dayDay.
hourDefault value. Hour.
minuteMinute.
secondSecond.
msMs.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is "time-interval".

When (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is "time-interval", this attribute defaults to hour.

Max Precision​

Specifies the maximum precision of the time picker, the smallest unit of time that can be selected.

Attribute Values​
ValueDescription
yearYear.
dayDay.
hourHour.
minuteDefault value. Minute.
secondSecond.
msMs.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is "time-interval".

When (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is "time-interval", this attribute defaults to minute.

Min Value​

Specifies the minimum value of the time interval, in the unit specified by Unit.

Attribute Values​
ValueDescriptionExample
<float>Minimum value of the interval.5.5

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is "time-interval".

Max Value​

Specifies the maximum value of the time interval, in the unit specified by Unit.

Attribute Values​
ValueDescriptionExample
<float>Maximum value of the interval.5.5

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is "time-interval".

When type is "progress", this attribute defaults to 100.

Time Value Options​

Specifies additional value options, which appear as buttons.

Attribute Values​
ValueDescriptionExample
<JSON array>Array of JSON options, each with value and label properties.[{"value":"+15m","label":"In 15 min"}]

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is "time".

Default behavior:

  • When interval is "false", this attribute defaults to [{"value":"*", "label":"- -"},{"value":"now", "label":"$now;"}].
  • When interval is "true", this attribute defaults to [{"value":"*", "label":"- -"}].

From Date​

Specifies the earliest selectable date. Dates prior to this will not be selectable.

Uses the same syntax as Value.

Attribute Values​
ValueDescriptionExample
<string>Minimum selectable date.2020-12-31
<string>Minimum selectable date using the same syntax as Value.now-1w

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is one of "date" or "datetime".

Default behavior:

  • When dataformat is "extended", this attribute defaults to 1981-01-01.
  • When dataformat is "basic", this attribute defaults to 19810101.
  • When dataformat is "timestamp", this attribute defaults to 0.
  • When (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is one of "date" or "datetime", this attribute defaults to 1981-01-01.

To Date​

Specifies the latest selectable date. Selection of dates beyond this point is not permitted.

Uses the same syntax as Value.

Attribute Values​
ValueDescriptionExample
<string>Maximum selectable date.2028-12-31
<string>Maximum selectable date using the same syntax as Value.now+1w

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is one of "date" or "datetime".

Default behavior:

  • When dataformat is "extended", this attribute defaults to 2028-12-31.
  • When dataformat is "basic", this attribute defaults to 20281231.
  • When dataformat is "timestamp", this attribute defaults to 4102444800.
  • When (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is one of "date" or "datetime", this attribute defaults to 2028-12-31.

Date Value Options​

Specifies additional value options, which appear as buttons.

Attribute Values​
ValueDescriptionExample
<JSON array>Array of JSON options, each with value and label properties.[{"value":"+1w","label":"Next Week"}]

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is "date".

When (#ownerObjId!='field' or owner:type!='table') and(type!='selection' and type!='move' and type!='index') and fieldtype is "date", this attribute defaults to [{"value":"*", "label":"- -"},{"value":"now", "label":"$today;"}].

Add/Edit Popup​

Edit Popup Column​

Specifies the column index in the add/edit popup. First column has index 1

Minimum value is 1.

Attribute Values​
ValueDescription
<int>Column index starting from 1.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='button' and type!='selection' and type!='move' and type!='index' and fieldtype!='none').

When (#ownerObjId!='field' or owner:type!='table') and(type!='button' and type!='selection' and type!='move' and type!='index' and fieldtype!='none'), this attribute defaults to 1.

Edit Popup Column Span​

Specifies how many popup layout columns the field spans.

Minimum value is 1.

Attribute Values​
ValueDescription
<int>Column span starting from 1.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='button' and type!='selection' and type!='move' and type!='index' and fieldtype!='none').

When (#ownerObjId!='field' or owner:type!='table') and(type!='button' and type!='selection' and type!='move' and type!='index' and fieldtype!='none'), this attribute defaults to 1.

Edit Popup Row​

Specifies the starting row in the add/edit popup layout.

Minimum value is 1.

Attribute Values​
ValueDescription
autoDefault value. Automatic row placement.
<int>Row index starting from 1.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='button' and type!='selection' and type!='move' and type!='index' and fieldtype!='none').

When (#ownerObjId!='field' or owner:type!='table') and(type!='button' and type!='selection' and type!='move' and type!='index' and fieldtype!='none'), this attribute defaults to auto.

Edit Popup Row Span​

Specifies how many popup layout rows the field spans.

Minimum value is 1.

Attribute Values​
ValueDescription
<int>Row span starting from 1.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='button' and type!='selection' and type!='move' and type!='index' and fieldtype!='none').

When (#ownerObjId!='field' or owner:type!='table') and(type!='button' and type!='selection' and type!='move' and type!='index' and fieldtype!='none'), this attribute defaults to 1.

Edit Popup Order​

Specifies the order by which the fields appear in the add/edit popup's layout.

If set to auto, the fields appear in the same order as the table's columns, including hidden columns.

If set to a number, the order is the specified number, starting from 1.

For example: to swap the edit fields of the 3rd and 4th columns, set their Edit Popup Order to 4 and 3 respectively.

Minimum value is 1.

Attribute Values​
ValueDescription
autoDefault value. Follows the column order, starting from 1.
<int>Specifies a new order.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='button' and type!='selection' and type!='move' and type!='index' and fieldtype!='none').

When (#ownerObjId!='field' or owner:type!='table') and(type!='button' and type!='selection' and type!='move' and type!='index' and fieldtype!='none'), this attribute defaults to auto.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Edit Popup Title​

Specifies a title header above the field, used to group multiple fields logically.

Attribute Values​
ValueDescriptionExample
<string>A title.Address

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='button' and type!='selection' and type!='move' and type!='index' and fieldtype!='none').

Edit Popup Description​

Specifies a description label that appears below the field, used to give more information about the fields.

Attribute Values​
ValueDescriptionExample
<string>A description.Insert your full name including the title

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='button' and type!='selection' and type!='move' and type!='index' and fieldtype!='none').

Hide Field​

Hides the field in the add and/or edit popup. Save Value determines whether its value is sent to the server.

Attribute Values​
ValueDescription
falseDefault value. Visible.
addHidden in add popup, visible in edit popup.
editHidden in edit popup, visible in add popup.
bothHidden in both add and edit popup.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='button' and type!='selection' and type!='move' and type!='index' and fieldtype!='none') and fieldtype is not "none".

The default value is: false.

Disable Field​

Disables the field in the add and/or edit popup. Save Value determines whether its value is sent to the server.

Attribute Values​
ValueDescription
autoDefault value. Auto: disabled in datasource mode when the datasource column is read-only.
falseAlways enabled.
addDisabled in add popup, enabled in edit popup.
editDisabled in edit popup, enabled in add popup.
bothDisabled in both add and edit popup.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='button' and type!='selection' and type!='move' and type!='index' and fieldtype!='none') and fieldtype is not "none".

The default value is: auto.

Save Value​

Specifies if the value of this field is sent to the server when confirming an add or edit operation.

This attribute does not affect the pre-add, pre-edit, edit-change commands.

If set to "auto", the value is sent if the field is visible and enabled.

If set to "changed", the value is sent to the server if it is different from the initial value and the field is visible and enabled. When adding or duplicating, values are compared against the Add Value if specified; otherwise against an empty value. When editing, values are compared against the previous value. Fields with Field Type hidden are always sent unless Save Value is false. This is useful when server-side change triggers or logic should run only for fields that were actually changed.

Attribute Values​
ValueDescription
autoDefault value. The value is sent to the server if the field is visible and enabled.
trueThe value is always sent, including invisible or disabled fields.
falseThe value is never sent to the server.
changedThe value is sent to the server if it is different from the initial value and the field is visible and enabled. Fields with Field Type hidden are always sent unless Save Value is false.

This attribute is available when (#ownerObjId!='field' or owner:type!='table') and(type!='button' and type!='selection' and type!='move' and type!='index' and fieldtype!='none').

The default value is: auto.