Widget "Table" is used to display data in table form. Widget "Table" represents the core of the table and must be added first. Columns/Rows can be added to widget "Table" using widgets "TableItem" and "TableItemImageList".
|
Our YouTube channel includes a tutorial on this topic. |
|
For this widget, there are various use cases that explain how the widget can be used. |
|
Our B&R Tutorial Portal includes tutorials on widget "Table" (GER/ENG). (access data) |
The following properties cannot be used in compound widget "Mapping":
zIndex, left, top, height, width
Appearance
|
|
Editor |
Web browser |
Properties
Type |
Description |
Bindable |
Necessary |
Default value |
|
columnWidth |
Defines the width of the column. |
|
|
100 |
|
dataOrientation |
Specifies whether data should be listed by row (horizontally) or column (vertically). |
|
|
vertical |
|
ellipsis |
Defines whether a text that is too long should be indicated by an ellipsis, e.g. "This text is..." instead of "This text is too long". For more information, see here. |
|
|
false |
|
Defines the usability of the widget. A disabled widget (enable=false) does not react to user interaction and does not trigger events. The "disabled..." style is displayed at runtime. The "enable" behavior is inherited from the container widgets to the child widgets. |
|
|
true |
||
multiLine |
Defines whether the text can be shown in multiple lines. If "wordWrap" has value true, a break is added to the text after a word or at an explicitly defined line break (\n) if necessary. For more information, see here.Defines whether the text can be shown in multiple lines. If "wordWrap" has value true, a break is added to the text after a word or at an explicitly defined line break (\n) if necessary. For more information, see here. |
|
|
false |
|
Defines the index of the first visible row. The top row has index 0. |
|
|
0 |
||
Defines the index of the first visible row. The first row has index 0. |
|
|
0 |
||
permissionOperate |
Defines the roles that are permitted to use the widget. For roles without sufficient rights, the widget does not react to user interaction and does not trigger events. |
|
|
|
|
permissionView |
Defines the roles that are permitted to see the widget. For roles without sufficient rights, the widget is hidden. |
|
|
|
|
rowHeight |
Defines the height of a row. |
|
|
30 |
|
Returns the index of the currently selected column. |
|
|
0 |
||
Returns the index of the currently selected row. |
|
|
0 |
||
selection |
Specifies whether a row or column can be selected. (possible to select = true / not possible to select = false) |
|
|
true |
|
showHeader |
Visibility of the header. If true, the header is visible. |
|
|
true |
|
showScrollbars |
This property controls the visibility of the scrollbar. |
|
|
true |
|
Reference to a customizable widget style. |
|
|
default |
||
Defines the filter settings. Can only be modified using the configuration dialog box. A variable that receives the correct settings from the configuration dialog box must be bound. For more information, see here. The filter function is not available for horizontal tables. |
|
|
|
||
Specification of the configuration, visibility and usability of the table / table elements: Example for visibility: '{ "specRows": [ {"index":0,"visible": false}, {"index":2,"visible": false}, {"index":4,"visible": true} ], "specColumns": [ {"index":0, "visible": false}, {"index":1, "visible": true}, {"index":2,"visible": true} ] }' Example for usability: '{ "specRows": [ {"index":0,"disable": false}, {"index":2,"disable": false}, {"index":4,"disable": true} ], "specColumns": [ {"index":0, "disable": false}, {"index":1, "disable": true}, {"index":2,"disable": true} ] }' Example for usability and visibility: '{ "specRows": [ {"index":0,"visible":false,"disable": false}, {"index":2,"visible":true,"disable": false}, {"index":4,"visible":true,"disable": true} ], "specColumns": [ {"index":0, "visible":false,"disable": false}, {"index":1,"visible":false, "disable": true}, {"index":2,"visible":true,"disable": true} ] }' Example for the configuration of entire sections: '{"specRows": [ {"from":0, "to":10, "disable":true}, {"from":12, "to":12, "visible":false}, {"index":14, "visible":false}, {"from":25, "to":30, "visible":false, "disable":true}]}' |
|
|
|
||
Defines the visibility of the widget. The widget can be hidden with visible=false. (visible = true, hidden = false). The "visible" behavior is inherited from the container widget to the child widgets. |
|
|
true |
||
wordWrap |
Defines whether a break will be added to the text after a word if necessary. This option has no effect if "multiLine" is set to value false. For more information, see here.Defines whether a break will be added to the text after a word if necessary. This option has no effect if "multiLine" is set to value false. For more information, see here. |
|
|
false |
|
scrollLinkYRefId |
Defines a reference to another "Table" widget (using its ID), which can be scrolled vertically together with this "Table" widget. |
|
|
|
|
scrollLinkXRefId |
Defines a reference to another "Table" widget (using its ID), which can be scrolled horizontally together with this "Table" widget. |
|
|
|
|
zIndex determines the z-order of the widget. With overlapping widgets, the zIndex determines which widget is on the top and which one is on the bottom. The widget with the larger zIndex is on top, and the one with the smaller zIndex is on the bottom. The zIndex must be unique within a piece of content or a container widget. The zIndex is automatically assigned by the visual editor and can therefore be changed via the toolbar. |
|
|
|
||
left |
Absolute position measured from the left border of the surrounded element (e.g. container widget or content). |
|
|
|
|
top |
Absolute position measured from the top border of the surrounded element (e.g. container widget or content). |
|
|
|
|
height |
Defines the total height of the widget in pixels. A value in % refers to the height of the surrounding element. |
|
|
300 |
|
width |
Defines the total width of the widget in pixels. A value in % refers to the width of the surrounding element. |
|
|
400 |
|
useTableStyling |
Defines whether the various columns in the table can be styled individually using a theme. (Individual style = false / Same style = true) |
|
|
true |
|
maxHeight |
Defines the maximum height of the table. If height is greater than maxHeight, then maxHeight has no effect. |
|
|
0 |
|
tooltip |
Defines the text that should appear as information when the tooltip indicator is pressed. A static text or a text from the text system can be used. For more information, see here. Mode "Tooltip" must be enabled for this. There are two different options for this: •Using action "ShowTooltip" •Using action "Client system" ShowTooltips. |
|
|
|
|
showSortingButton |
Defines whether the icon for sorting is displayed. Sorting cannot be used in conjunction with continuously updating variables. |
|
|
false |
|
headerSize |
Defines the width or height of the header depending on the alignment of the widget. If the value is 0, the size is applied from properties rowHeight and columnWidth. |
|
|
0 |
|
refreshRate |
Defines the rate (in milliseconds) at which the table is continuously updated with data. This value should be adjusted with regard to the number of elements, rows/columns and hardware used. It is recommended to work with a value ≥200. For more information, see here. |
|
|
600 |
|
stopRefreshAtScroll |
Defines whether the values of the table are continuously updated while scrolling. If "stopRefreshAtScroll=true", then table values are not updated while scrolling. Updating will resume after scrolling. This is advantageous if a lot of data is used on a low-end target system. For more information, see here. |
|
|
false |
|
initRefreshRate |
Defines the rate (in milliseconds) at which the table is restored or refreshed. This property becomes active through changes, such as disabling widget TableItem, updating tableConfiguration or initial instantiation. |
|
|
0 |
|
busyIndicatorDelay |
Defines the time (ms) until indicator "Busy" is displayed. It is displayed immediately at 0. At 1000, the indicator is only displayed after 1000 ms if it should still be displayed. If the number is negative, indicator "Busy" is not displayed. |
|
|
0 |
|
tabIndex |
Property tabIndex is used to manage the tab order during keyboard operation. For additional information, see Keyboard operation. ENTER triggers event Click if tabIndex ≥0. It is not possible to operate the widget with the keyboard. |
|
|
-1 |
Styleable properties
Type |
Description |
Default value |
|
activeBackColor |
Defines the background color of the selected table entry. |
#FF8800 |
|
activeBackGroundGradient |
Defines the background color of the selected table entry as a color gradient. |
|
|
activeInputCellTextColor |
Defines the text color in a cell during a write operation. |
#333333 |
|
activeInputCellInnerShadow |
This property can be used as an inner border. Example: "0 0 0 5px #B5B5B5" |
none |
|
activeInputCellBackColor |
Defines the background color for selected input cells. |
#FFFFFF |
|
activeInputCellBackgroundGradient |
Defines the background color of selected input cells as a color gradient. |
|
|
activeTextColor |
Defines the color used to display the text of selected entries. |
#FFFFFF |
|
backColor |
Defines the background color of the widget. |
Transparent |
|
backColorEvenColumn |
Defines the background color for even-numbered table entries in the column direction. |
#EAEAEA |
|
backGroundGradientEvenColumn |
Defines the background color as a color gradient for even-numbered table entries in the column direction. |
|
|
backColorEvenRow |
Defines the background color for even-numbered table entries in the row direction. |
#FFFFFF |
|
backGroundGradientEvenRow |
Defines the background color as a color gradient for even-numbered table entries in the row direction. |
|
|
backColorOddRow |
Defines the background color for odd-numbered table entries in the row direction. |
#FCFCFC |
|
backGroundGradientOddRow |
Defines the background color as a color gradient for odd-numbered table entries in the row direction. |
|
|
backColorOddColumn |
Defines the background color for odd-numbered table entries in the column direction. |
#FCFCFC |
|
backGroundGradientOddColumn |
Defines the background color as a color gradient for odd-numbered table entries in the column direction. |
|
|
backGroundGradient |
Defines the background color of the widget as a color gradient. |
|
|
borderColor |
Defines the color of the border around the widget. |
#C8C8C8 |
|
borderStyle |
Defines the style of the border around the widget. Borders can be unbroken, dashed or dotted. |
none |
|
borderWidth |
Defines the width of the border around the widget. |
0px |
|
cellAlign |
Defines the orientation of the text in a cell. |
center center |
|
cellBorderStyle |
Defines the style of the table frame. |
solid |
|
cellBorderColor |
Defines the border color of a cell. |
#C8C8C8 |
|
cellBorderWidth |
Defines the border thickness of a cell. |
0px 0px 1px 1px |
|
cellPadding |
Defines the spacing between the outer boundary of the table entry and its content. For more information, see here. |
0px |
|
cornerRadius |
Defines the radius of the table's rounded corners. |
0px |
|
disabledActiveTextColor |
Defines the color used to display text in even-numbered table entries in the row direction in the disabled state. |
#FFFFFF |
|
disabledActiveBackColor |
Defines the background color of the selected table entry in the disabled state. |
#C7C7C7 |
|
disabledActiveBackGroundGradient |
Defines the background color of the selected table entry in the disabled state as a color gradient. |
|
|
disabledBackColor |
Defines the background color of the widget in the disabled state. |
Transparent |
|
disabledBackGroundGradient |
Defines the background color of the widget as a color gradient in the disabled state. |
|
|
disabledBackColorEvenRow |
Defines the background color for even-numbered table entries in the row direction in the disabled state. |
#EAEAEA |
|
disabledBackColorEvenColumn |
Defines the background color for even-numbered table entries in the column direction in the disabled state. |
#EAEAEA |
|
disabledBackColorOddRow |
Defines the background color for odd-numbered table entries in the row direction in the disabled state. |
#FFFFFF |
|
disabledBackColorOddColumn |
Defines the background color for odd-numbered table entries in the column direction in the disabled state. |
#FFFFFF |
|
disabledBorderColor |
Defines the color of the border around the widget in the disabled state. |
#C8C8C8 |
|
disabledCellBorderColor |
Border color of an inactive table. |
#C8C8C8 |
|
disabledItemBorderColor |
Border color of an inactive table entry. |
#C8C8C8 |
|
disabledHeaderTextColor |
Defines the color used to display the text in the header in the disabled state. |
#C8C8C8 |
|
disabledHeaderBackColor |
Defines the background color of the header in the disabled state. |
#FCFCFC |
|
disabledHeaderGradient |
Defines the background color of the header as a color gradient in the disabled state. |
|
|
disabledTextColor |
Defines the color of the text in the disabled state. |
#C8C8C8 |
|
fontName |
Defines the font used for the text shown. |
Arial |
|
fontSize |
Defines the size of the font used to display the text. |
14px |
|
inputCellTextColor |
Defines the color used to display the text of the input cells. |
#333333 |
|
inputCellInnerShadow |
This property can be used as an inner border for a cell. Example: "0 0 0 5px #B5B5B5" |
none |
|
inputCellBackColor |
Defines the background color for input cells. |
#FFFFFF |
|
inputCellBackgroundGradient |
Defines the background color of input cells as a color gradient. |
|
|
headerBackColor |
Defines the background color of the header. |
#FCFCFC |
|
headerGradient |
Defines the background color of the header as a color gradient. |
|
|
headerTextColor |
Defines the color used to display the text in the header. |
#333333 |
|
headerFontSize |
Defines the size of the font used to display the text in the header. |
14px |
|
headerCellPadding |
Defines the spacing between the outer boundary of the header entry and its contents. For more information, see here. |
0px |
|
textColor |
Defines the color used to display the text. |
#333333 |
|
bold |
Defines whether the text is shown in bold. |
false |
|
italic |
Defines whether the text is shown in italics. |
false |
|
opacity |
Defines the transparency of the widget. The lower the value, the more transparent the widget. |
1 |
|
shadow |
Defines the shadow of the widget. |
none |
|
sortingButtonColor |
Defines the color used to display the icons for sorting when not applied. |
#ECECEC |
|
sortingButtonActiveColor |
Defines the color used to display the icon for sorting when applied. |
#5F8DD3 |
|
mouseDownBackColor |
Defines the background color of the table row only as long as it is pressed. A selected row is not displayed in color mouseDown but in color backColor instead. If the "selected" properties are set, the mouseDown settings are not applied. |
transparent |
|
mouseDownBackGroundGradient |
Defines the background color of the line as a color gradient only as long as it is pressed. A selected row is not displayed in the mouseDown color but in the backColor color instead. If the "selected" properties are set, the mouseDown settings are not applied.
|
|
|
mouseDownTextColor |
Defines the text color in the table row only as long as it is pressed. A selected row is not displayed in the mouseDown color but in the backColor color instead. If the "selected" properties are set, the mouseDown settings are not applied. |
transparent |