Table objects

Standard tables

Standard tables display tabular data in a straightforward manner. For each row of the data, there is a row of the displayed table; for each column in the data, there is a column in the displayed table, with the exception of those specified as hidden. Hidden columns can still be used in labels and drill-down substitutions.

Tables are particularly useful as a starting point for drill down. By default, tables are configured to set a number of predefined substitution variables when the end user activates drill down.

Use the valueTable property to attach data to a standard table. Use the columnsToHide property to specify columns to be omitted from the display.

Include a new line character (\n) in cell text to display multi-line text.

To copy displayed table data to the system clipboard so that it can be pasted into another application, right click and select Copy Table Values or Copy Cell Value.

This section covers the following table visualizations:

• Table
• Table with Row Labels
• Table without Grid

These visualizations all share the same properties. They differ from one another only with regard to their default values for these properties. When one of these objects is selected in the Builder canvas, the Object Class Name that appears at the top of the Object Properties pane is obj_table02.

See also Rotated tables, which covers a table with a different set of properties.

The Object Properties panel organizes standard table properties into the groups below.

The rule’s action is performed on those cells specified by the first field that bear the specified comparison relation to the specified value, or else for the rows that contain those cells, or for the columns that contain those cells (depending on how the Target field is set; see below).

The third field is populated with values from the table’s data attachment, based on the selected comparison field, along with the options top(5) and bottom(5). Select top(5) to specify the five highest values among the cells specified by the first Condition field. Select bottom(5) to specify the five lowest values among the cells specified by the first Condition field. Once you make a selection, you can edit the number in parentheses.

• Action: Use this field to specify the rule’s action.

In the first drop down menu, select one of the following:

• Set Background Color To: controls the color of cell backgrounds.
• Set Font Color To: controls the color of cell text.
• Hide Rows: controls the visibility of the rows containing the cells specified by the Condition fields.
• Display Image: replaces cell values with an image. Select the name of the image file from the drop down menu, or enter the pathname of the file (a .gif, .jpg, or .png file). The drop down menu contains the names of image files located in the current directory (typically, the dashboards directory of your project directory, under your Apama installation’s work directory), as well as image files located in the first level of subdirectories. If you enter a pathname, use an absolute pathname or a pathname that is relative to the current directory.

In the second drop down menu, choose which color to apply to the background or font, enter or select an image, or enter the name of a dashboard variable to use as the value of this field.

• Target: Use this field to control the cells to which the action is applied. Select one of the following from the drop down list:
  • Rows: applies the action to the rows that contain the cells specified in the Condition fields.
  • Cells: applies the action to the cells specified in the Condition fields.
  • Columns: applies the action to the columns that contain the cells specified in the Condition fields.

You must select Rows if the action is Hide Rows.

In the Filter Properties dialog, double-click on an existing rule to edit it. Click the Remove button to delete a rule. Click Clear to remove all rules. Use the Move Up and Move Down buttons to control the order in which the rules are applied.

This property is in the Alert property group.

Standard table: Alert group

This property group contains filterProperties, which specifies how to modify table appearance at runtime in response to changes in the values of individual cells.

filterProperties

Specifies rules that are applied at runtime in order to set text color, background color, row visibility, and cell images based on the values of individual cells. The rules are applied in the order in which they are listed in the Filter Properties dialog, therefore later rules may override the effects of earlier rules.

In the Object Properties window, double-click on filterProperties in the Property Name field. The Filter Properties dialog appears.

Click the Add button in the Filter Properties dialog to add a rule. The Edit Filter dialog appears.

The dialog has the following fields and buttons:

• Condition: Use these fields to specify the cells for which the rule’s action is to be performed. The first field specifies a group of cells and the second and third fields specify a condition. The action is performed for those cells in the specified group that meet the specified condition, or else for the rows containing those cells, or for the columns contain those cells (depending on how the Target field is set; see below).

In the first field, supply a column name to specify all cells in a column. Supply Column Header to specify all column header cells. Supply Row Name for all implicit row name cells.

In the second field, select a comparison relation.

In the third field, select or enter a value or dashboard variable name.

Standard table: Background group

Properties in this group control the visibility and appearance of the rectangle that serves as the background of the table and the table’s main label (see label).

Background group properties

The group contains the following properties:

• bgBorderColor
• bgBorderFlag
• bgColor
• bgEdgeWidth
• bgGradientColor2
• bgGradientMode
• bgRaisedFlag
• bgRoundness
• bgShadowFlag
• bgStyleFlag
• bgVisFlag
• borderPixels
• tableBgColor

bgBorderColor

Sets the color of the border (see bgBorderFlag) of the background rectangle. Select the … button and choose a color from the palette. Close the Color Chooser window when you are done.

bgBorderFlag

Select to display a border around the background rectangle.

This property is in the Background property group.

bgColor

Sets the background color. Select the … button and choose a color from the palette. Close the Color Chooserwindow when you are done.

This property is in the Background property group.

bgEdgeWidth

Sets the width in pixels of the 3D edge on the background rectangle. This property is only used if bgBorderFlag is selected.

This property is in the Background property group.

bgGradientColor2

Sets the color for the second color in the gradient. The default is white. The bgColor property sets the first color in the gradient.

This property is in the Background property group.

bgGradientMode

Display a gradient in the background rectangle. Select from the following options:

• None: No gradient
• Diagonal Edge: Gradient is drawn at a 45 degree angle from the top left to the bottom right corner of the object.
• Diagonal Center: Gradient is drawn at a 45 degree angle from the center to the top left and the bottom right corners of the object.
• Horizontal Edge: Gradient is drawn horizontally from the top to the bottom of the object.
• Horizontal Center: Gradient is drawn horizontally from the center to the top and bottom of the object.
• Vertical Edge: Gradient is drawn vertically from the left to the right of the object.
• Vertical Center: Gradient is drawn vertically from the center to the left and right of the object.

This property is in the Background property group.

bgRaisedFlag

Reverses the direction of the gradient, as well as that of the 3D edge if the bgStyle selected is 3D Rectangle.

This property is in the Background property group.

bgRoundness

Sets the arc length of the rounded corners. This property is only available if the bgStyle selected is Round Rectangle.

The value of bgRoundness cannot exceed half the value of the objWidth or the objHeight. If bgRoundness does exceed that value, half of objWidth or objHeight (whichever is smaller) will be used instead. For example if objWidth is 100 and objHeight is 50, then the value of bgRoundness cannot exceed 25. If it does, then half the value of objHeight (25) will be used instead. This property is in the Background property group.

bgShadowFlag

Select to display a drop shadow on the background rectangle.

This property is in the Background property group.

bgStyleFlag

Choose one of the following three options from the drop down menu:

• Rectangle: Select to display a background rectangle.
• 3D Rectangle: Select to display a 3D edge on the background rectangle. If selected, use bgEdgeWidth to set the width of the 3D edge.
• Round Rectangle: Select to display a background rectangle with rounded edges. If selected, use bgRoundness to set the arc length of the rounded corners.

This property is in the Background property group.

bgVisFlag

Select to display the background rectangle.

This property is in the Background property group.

borderPixels

Sets the width in pixels of the border between the chart and the edge of the background rectangle.

This property is in the Background property group.

tableBgColor

Sets the color of empty space in the table. Select the … button and choose a color from the palette. Close the Color Chooser window when you are done.

This property is in the Background property group.

Standard table: Cell group

Properties in this group control the appearance of cell text and cell background color.

Cell group properties

The group contains the following properties:

• cellBgColor
• cellBgStripedContrast
• cellBgStripedFlag
• cellTextColor
• cellTextFont
• cellTextSize

cellBgColor

Sets the background color of the cells. Select the … button and choose a color from the palette. Close the Color Chooser window when you are done.

This property is in the Cell property group.

cellBgStripedContrast

Specifies the contrast level for the stripes if cellBgStripedFlag is enabled.

This property is in the Cell property group.

cellBgStripedFlag

Specifies alternating striped rows. Alternate rows have a lighter shade of the color specified in cellBgColor.

This property is in the Cell property group.

cellTextColor

Sets the text color of the cells. Select the … button and choose a color from the palette. Close the Color Chooser window when you are done.

This property is in the Cell property group.

cellTextFont

Sets the font for cell text. Select an item from the drop down menu.

This property is in the Cell property group.

cellTextSize

Sets the point size of the cell text. The default is 11 points. If you enter a negative value, the default is used.

This property is in the Cell property group.

Standard table: Column group

Properties in this group control the visibility, width, and resize behavior of table columns, as well as the format and alignment of cell text within each column.

Column group properties

The group contains the following properties:

• autoResizeFlag
• columnAlignment
• columnFormat
• columnProperties
• columnsToHide
• indexColumns

autoResizeFlag

When this property is enabled, column widths change automatically to accommodate table resizing. When this property is disabled, column width is fixed at the values specified by columnProperties.

This property is in the Column property group.

columnAlignment

Specifies the alignment of text within each column. Select the ellipsis button. The Column Alignment Properties dialog appears.

Select one of the following alignment specifications from the drop down menu in the Alignment column:

• Default
• Left
• Center
• Right

The default setting depends on the type of column.

This property is in the Column property group.

columnFormat

Specifies formats for numerical and date columns. In the Object Properties window, double-click on columnFormat in the Property Name field. The Column Format Properties dialog appears.

The Column Name list is populated based on the table’s data attachment. If you have not yet attached the table to data, this list is empty.

In the Column Format column of the dialog, enter a format or select a format from the drop down menu, and press Enter. Specify numerical formats based on the Java format specification, or with the following shorthand:

• $ for US dollar money values
• $$ for US dollar money values with additional formatting, () for non-money values, formatted similar to money
• # for positive or negative whole values

Specify date formats based on the Java date specification.

The dialog has the following buttons:

• Add Column: Enter the name of the column and click the Add Column button to insert a column into the table.
• Clear: Click the Clear button to clear all cells in the Column Format column of the dialog.

This property is in the Column property group.

columnProperties

Specifies the width of each column. In the Object Properties window, double-click on columnProperties in the Property Name field. The Column Width Properties dialog appears.

The Column Name list is populated based on the table’s data attachment. If you have not yet attached the table to data, this list is empty.

In the Column Width column of the dialog, enter the width in pixels.

The dialog has the following buttons:

• Add Column: Enter the name of the column and click the Add Column button to insert a column into the table.
• Clear: Click the Clear button to clear all cells in the Column Width column of the dialog.

This property is in the Column property group.

columnsToHide

Specifies columns from the data attachment to exclude from being displayed in the table. Columns specified in the columnsToHide property can still be used in the drillDownColumnSubs property.

In the Object Properties window, double-click on columnsToHide in the Property Name field. The Columns To Hide dialog appears.

The Column Name list is populated based on the table’s data attachment. If you have not yet attached the table to data, this list is empty.

In the Hide Column column of the dialog, click the checkbox for each column that you want to hide.

The dialog has the following buttons:

• Add Column: Enter the name of the column and click the Add Column button to insert a column into the table.
• Clear: Click the Clear button to clear all cells in the Column Width column of the dialog.

Dashboard Builder displays a warning message if you attempt to hide the row header column.

This property is in the Column property group.

indexColumns

Use this property in order to maintain the highlight of selected rows after data updates or table sorts are executed. In the Object Properties window, double-click on indexColumns in the Property Name field. The Index Columns dialog appears. Select one or more columns whose values uniquely identify each row.

This property is in the Column property group.

Standard table: Column Header group

Properties in this group control the color, font, and size of column-header text, as well as the column-header background color.

Column Header group properties

The group contains the following properties:

• columnHeaderBgColor
• columnHeaderTextColor
• columnHeaderTextFont
• columnHeaderTextSize

columnHeaderBgColor

Sets the background color of the column headers. Select the … button and choose a color from the palette. Close the Color Chooser window when you are done.

This property is in the Column Header property group.

columnHeaderTextColor

Sets the text color of the column headers. Select the … button and choose a color from the palette. Close the Color Chooserwindow when you are done.

This property is in the Column Header property group.

columnHeaderTextFont

Sets the font for column header text. Select an item from the drop down menu.

This property is in the Column Header property group.

columnHeaderTextSize

Sets the point size of the column header text. The default is 11 points. If you enter a negative value, the default is used.

This property is in the Column Header property group.

Standard table: Data group

Properties in this group determine what data populates the table.

Data group properties

The group contains the following properties:

• insertNewRowsAtTopFlag
• insertNewRowsFlag
• maxNumberOfRows
• rowLabelMode
• valueTable

insertNewRowsAtTopFlag

Controls whether new rows are inserted at the top or bottom of the table, if insertNewRowsFlag is enabled.

This property is in the Data property group.

insertNewRowsFlag

Controls whether the table contents are replaced or augmented with new data sent to the dashboard. If this property is enabled, the table contents are augmented through the addition of new rows. If this property is not enabled, new data replaces the table contents.

This property is in the Data property group.

maxNumberOfRows

Sets the maximum number of rows that the table can contain. Enter a value that is less than or equal to 131072.

This property is in the Data property group.

rowLabelMode

Supply a positive value to enable a row-header column consisting of generated row IDs.

This property is in the Data property group.

valueTable

Attach your data to the valueTable property. Right-click on the property name in the Object Properties panel, and select a menu item under Attach to Data.

This property is in the Data property group.

Standard table: Data Label group

This property group contains the property columnDisplayNames, which specifies non-default column-header text.

columnDisplayNames

Sets alternate display names for the columns of the data attached to valueTable.

This property is in the Data Label property group.

Standard table: Grid group

Properties in this group control the visibility of the horizontal and vertical lines that separate table rows and columns.

Grid group properties

The group contains the following properties:

• gridHorizontalVisFlag
• gridVerticalVisFlag

gridHorizontalVisFlag

Controls the visibility of the horizontal lines that separate table rows.

This property is in the Grid property group.

gridVerticalVisFlag

Controls the visibility of the vertical lines that separate table columns.

This property is in the Grid property group.

Standard table: Historian group

Do not use the properties in this group.

historyTableName

Do not use this property.

This property is in the Historian property group.

historyTableRowNameFlag

Do not use this property.

This property is in the Historian property group.

Standard table: Interaction group

Properties in this group control various forms of interaction between the end user and the table, including scrolling, highlighting, selecting rows, and activating commands, drill downs, and tooltips. There is also a property that controls end-user keyboard navigation with the Tab key. See also Standard table: Sort group.

Interaction group properties

The group contains the following properties:

• clearSelection
• columnResizeEnabledFlag
• command
• commandCloseWindowOnSuccess
• commandConfirm
• confirmText
• drillDownColumnSubs
• drillDownSelectMode
• drillDownTarget
• editDataEnabledFlag
• editDataLocalVarName
• multiSelectFlag
• rowHighlightEnabledFlag
• scrollToSelectionFlag
• scrollbarMode
• tabIndex

clearSelection

Use the clearSelection property to clear multiple selected rows in a table. When the property is set to a value of 1, the row selection is cleared. When the property is set to a value of 2, the row selection is cleared and either the table’s action or its drillDownTarget is invoked.

A table’s clearSelection property would be attached to a local variable that is set by a control object on the same display.

For example, to add a Clear Selection button to a display that contains a table that supports multiple row selection:

1. Add a local variable named $clearSelection with an initial value of 0.
2. Create a button object, with these property values:
   • label : “Clear Selection”
   • valueToSet : 1
   • varToSet : <attached to the $clearSelection variable>
3. Set these table object’s properties:
   • clearSelection : <attached to the $clearSelection variable>
4. If the table object has a drilldown command, or a drillDownTarget, add this to its Drill Down Substitutions:
   • $clearSelection : 0

The last step is required to reset the value of the $clearSelection variable to zero when a row is selected in the table.

columnResizeEnabledFlag

If selected, the end user can resize table columns by dragging the vertical separators between the column headers. This property also enables resize by dragging for the Dashboard Builder.

This property is in the Interaction property group.

command

Assign a command or group of commands to this stock chart by right-clicking on the command property name in the Object Properties window. Select Define Command and choose SYSTEM, APAMA, or MULTIPLE. See Using the Define Apama Command dialog.

Once a command or command group has been assigned to this object, you can activate it from a deployed dashboard or from the Dashboard Builder:

• Dashboard Builder: Double click on the object.
• Web-based deployment: Single click on the object or else right click on it and select Execute Command from the popup menu.
• Local deployment: By default, single-click on the object or else right-click on it and select Execute Command from the popup menu. To override the default, select Tools > Options in the Builder (do this before you generate the deployment package), and uncheck Single-Click for Drill Down and Commands in the General tab. This allows the end user to use either a double click or a right click.

When you activate a command, any defined drill down substitutions are performed, and then the command is executed.

If you assign multiple commands, the commands are launched in an arbitrary order, and are executed asynchronously; there is no guarantee that one command will finish before the next one in the sequence starts.

This property is in the Interaction property group.

commandCloseWindowOnSuccess

Select this property to automatically close the window that initiates a SYSTEM command when the command is executed successfully. This applies to SYSTEM commands only, and is not supported at all for thin-client (display server) deployments.

With APAMA commands, the window is closed whether or not the command is executed successfully. For MULTIPLE commands, the window closes when the first command in the command group succeeds.

This property is in the Interaction property group.

commandConfirm

By default, when the end user executes a command (see the command property), the command confirmation dialog is disabled. To control this option for each individual object, use the commandConfirm check box. If confirmation is required for a MULTIPLE command group, a single confirmation dialog is presented; if you confirm the execution, all individual commands in the group are executed with no further confirmation. If the you cancel the execution, none of the commands in the group is executed.

You can also override the confirmation status of individual objects with an application-wide policy. Select Tools > Options and choose from three confirmation values:

• Do not confirm: Indicates that no commands require confirmation (regardless of each object’s confirmation status).
• Confirm all: Indicates that all commands require confirmation (regardless of each object’s confirmation status).
• Use object confirm flag (default): Indicates that the confirmation status of each object will determine whether confirmation is required.

This property is in the Interaction property group.

confirmText

Use this property to write your own text for the confirmation dialog. Otherwise, default text is used. See commandConfirm.

This property is in the Interaction property group.

drillDownColumnSubs

Use this property to direct a dashboard to assign data-table column values to specified dashboard variables when the end user activates a drilldown on this object. In the Object Properties window, double-click on drillDownColumnSubs in the Property Name field to bring up the Drill Down Column Substitutions dialog.

The dialog has the following fields and buttons:

• Substitution String: Enter the dashboard variable next to the name of the data table column whose value you want assigned to the variable. Press Enter.
• Add Column: Enter the name of a column and click the Add Column button to insert a column into the table.
• Clear: Click the Clear button to remove all variables listed.

The Column Name list is populated based on the table’s data attachment. If you have not yet attached the table to data, this list is empty.

Once you have selected which column values to pass in as substitutions, double-click on any element in your object to open a drill down window that displays corresponding values.

This property is in the Interaction property group.

drillDownSelectMode

Use this property to control how a drill down display is activated. Select one of the following:

• Anywhere to activate a drill down display by double-clicking anywhere on the chart.
• Element Only to enable a drill down display only when you double-click on an element of the chart, such as a bar or candlestick.

This property is in the Interaction property group.

drillDownTarget

To specify a drill down display, double click on drillDownTarget in the Property Name field to bring up the Drill Down Properties dialog. See Drill-down specification.

This property is in the Interaction property group.

editDataEnabledFlag

Do not use this property.

This property is in the Interaction property group.

editDataLocalVarName

Do not use this property.

This property is in the Interaction property group.

multiSelectFlag

Enables the selection of multiple rows. When the user selects multiple rows and drills down, the drill down substitution values contain a semi colon delimited list of values, one value for each row that can be used with most data sources in the Filter fields of the Attach To Datadialogs.

This property is in the Interaction property group.

rowHighlightEnabledFlag

Enables highlighting of an entire row when a cell in the row is selected by the end user.

This property is in the Interaction property group.

scrollToSelectionFlag

When this property is enabled, the selected row is made visible whenever the table is updated or redrawn. If multiple rows are selected, the topmost selected row is made visible.

This property is in the Interaction property group.

scrollbarMode

Select one of the following to set the behavior of the table scroll bars:

• Never: Default setting. Some rows or columns may get clipped.
• As Needed: Display a scroll bar or scroll bars when there is not enough space to display all of the rows or columns.
• Always: Display scroll bars at all times.

This property is in the Interaction property group.

tabIndex

Defines the order in which this table object receives focus (relative to other table objects and control objects) during keyboard navigation using the Tab key. Initial focus is given to the object with the smallest positive tabIndex value. The tabbing order proceeds in ascending order. If multiple objects share the same tabIndex value, initial focus and tabbing order are determined by the alpha-numeric order of the table names. Tables with a tabIndex value of 0 are last in the tabbing order.

This property is in the Interaction property group.

Standard table: Label group

Properties in this group control the table’s main label, including text, alignment, color, font, and size.

Label group properties

The group contains the following properties:

• label
• labelTextAlignX
• labelTextColor
• labelTextFont
• labelTextHeight

label

Specifies the text for the chart label. Click the ellipsis for multi-line text.

The default is Table, Table with Row Labels, or Table without Grid.

This property is in the Label property group.

labelTextAlignX

Sets the alignment of the chart label (see the label property). Select Left, Center, or Right from the drop down list.

This property is in the Label property group.

labelTextColor

Specifies the color of the chart label text (see the label property). Select the … button and choose a color from the palette. Close the Color Chooser window when you are done.

This property is in the Label property group.

labelTextFont

Specifies the font of the chart label text (see the label property). Select an item from drop down list.

This property is in the Label property group.

labelTextHeight

Specifies the point size of the chart label text (see the label property).

This property is in the Label property group.

Standard table: Object group

Properties in this group control the visibility and transparency of the table as a whole. They also control (or reflect) the overall position and dimensions of the table. In addition, a property in this group reflects the generated name of this individual table.

Object group properties

The group contains the following properties:

• anchor
• dock
• objHeight
• objName
• objWidth
• objX
• objY
• visFlag

anchor

Select zero or more of Top, Left, Bottom, and Right in order to control the object’s placement. The anchor property is only applied when the display is resized either by changing the Background Properties on the display or by resizing the window in Layout mode. If an object has the dock property set, the anchor property is ignored. See About resize modes.

dock

Select None (default), Top, Left, Bottom, Right, or Fill in order to control the object’s placement in Layout resize mode. See About resize modes.

objHeight

Set the height of a chart by entering a value for this property or by dragging a handle of the bounding box that appears when the chart is selected. When you drag a handle of the bounding box, the displayed value for this property changes to reflect the real-time height of the chart.

This property is in the Object property group.

objName

An identifier that is generated by the Dashboard Builder. This name can be used by other objects’ properties in order to refer to the named chart.

This property is in the Object property group.

objWidth

Set the width of a chart by entering a value for this property or by dragging a handle of the bounding box that appears when the chart is selected. When you drag a handle of the bounding box, the displayed value for this property changes to reflect the real-time width of the chart.

This property is in the Object property group.

objX

Sets the X coordinate of the center of this visualization object, relative to the lower left corner of the current dashboard. This value is set automatically when you position the object with the mouse.

This property is in the Object property group.

objY

Sets the Y coordinate of the center of this visualization object, relative to the lower left corner of the current dashboard. This value is set automatically when you position the object with the mouse.

This property is in the Object property group.

visFlag

Deselect to make this visualization object invisible in the current dashboard.

This property is in the Object property group.

Standard table: Row Header group

A property in this group specifies whether the cells in the first column are considered to be row headers. If this property is selected, other properties control row-header text color, font, point size, and background color.

Row Header group properties

The group contains the following properties:

• rowHeaderBgColor
• rowHeaderEnabledFlag
• rowHeaderFilterColorsEnabledFlag
• rowHeaderTextColor
• rowHeaderTextFont
• rowHeaderTextSize

rowHeaderBgColor

Sets the background color of row-header cells, provided rowHeaderEnabledFlag is enabled. Select the … button and choose a color from the palette. Close the Color Chooser window when you are done.

This property is in the Row Header property group.

rowHeaderEnabledFlag

Specifies that the cells in the first column are row headers When this property is enabled, you can set the appearance of the row-header column using rowHeaderBgColor, rowHeaderTextColor, rowHeaderTextFont, and rowHeaderTextSize properties.

Dashboard Builder displays a warning message if you attempt to hide the row-header column by using the columnsToHide property.

This property is in the Row Header property group.

rowHeaderFilterColorsEnabledFlag

Disable this property to disable the effect of filterProperties on the background color or text color of cells in the row-header column, provided rowHeaderEnabledFlag is enabled. Note that this does not override the effects of filterProperties on row visibility.

This property is in the Row Header property group.

rowHeaderTextColor

Sets the text color for row-header cells, provided rowHeaderEnabledFlag is enabled. Select the … button and choose a color from the palette. Close the Color Chooser window when you are done.

This property is in the Row Header property group.

rowHeaderTextFont

Sets the font for row-header cells, provided rowHeaderEnabledFlag is enabled. Select an item from the drop down list.

This property is in the Row Header property group.

rowHeaderTextSize

Sets the text point size for row-header cells, provided rowHeaderEnabledFlag is enabled.

This property is in the Row Header property group.

Standard table: Sort group

Properties in this group control the order in which table rows appear, as well as whether the end user can re-sort table rows by clicking on a column header.

Sort group properties

The group contains the following properties:

• showSortIconFlag
• sortAscendingFlag
• sortColumnName

showSortIconFlag

When this property is enabled, the end user can click a column’s header to sort the table rows according to the values in that column. The sortAscendingFlag property determines whether the sort is initially ascending or descending. Clicking a column header again reverses the sort order. In Dashboard Builder, sortAscendingFlag changes in real time to reflect the current sort order, and sortColumnName changes in real time to reflect the current sort column.

In addition, when this property is enabled, a sort icon (an arrow head) appears next to the header of the current sort column (determined initially by sortColumnName). The direction in which the arrow head points indicates whether the current sort order is ascending or descending.

This property is in the Sort property group.

sortAscendingFlag

Determines whether the current sort order is ascending or descending. See sortColumnName and showSortIconFlag.

This property is in the Sort property group.

sortColumnName

Sets the column whose values determine the order in which table rows appear. If sortAscendingFlag is enabled, rows with earlier values (either numerically or alphabetically) appear first. See also showSortIconFlag.

This property is in the Sort property group.

Rotated tables

Rotated tables display tabular data by swapping rows and columns. For each row of the data, there is a column in the displayed table; for each column in the data, there is a row in the displayed table.

Use the valueTable property to attach data to a rotated table.

Include a new line character (\n) in the cell text to display multi-line text.

To copy data to the system clipboard so that it can be pasted into another application, right-click and select Copy Table Values or Copy Cell Value.

When a rotated table is selected in the Builder canvas, the Object Class Name that appears at the top of the Object Properties pane is obj_table03.

The Object Properties panel organizes rotated table properties into the groups below.

Rotated table: Background group

Properties in this group control the visibility and appearance of the rectangle that serves as the background of the table and the table’s main label (see label).

Background group properties

The group contains the following properties:

• bgBorderColor
• bgBorderFlag
• bgColor
• bgEdgeWidth
• bgGradientColor2
• bgGradientMode
• bgRaisedFlag
• bgRoundness
• bgShadowFlag
• bgStyleFlag
• bgVisFlag
• borderPixels

bgBorderColor

Sets the color of the border (see bgBorderFlag) of the background rectangle. Select the … button and choose a color from the palette. Close the Color Chooser window when you are done.

bgBorderFlag

Select to display a border around the background rectangle.

This property is in the Background property group.

bgColor

Sets the background color. Select the … button and choose a color from the palette. Close the Color Chooser window when you are done.

This property is in the Background property group.

bgEdgeWidth

Sets the width in pixels of the 3D edge on the background rectangle. This property is only used if bgBorderFlag is selected.

This property is in the Background property group.

bgGradientColor2

Sets the color for the second color in the gradient. The default is white. The bgColor property sets the first color in the gradient.

This property is in the Background property group.

bgGradientMode

Display a gradient in the background rectangle. Select from the following options:

• None: No gradient
• Diagonal Edge: Gradient is drawn at a 45 degree angle from the top left to the bottom right corner of the object.
• Diagonal Center: Gradient is drawn at a 45 degree angle from the center to the top left and the bottom right corners of the object.
• Horizontal Edge: Gradient is drawn horizontally from the top to the bottom of the object.
• Horizontal Center: Gradient is drawn horizontally from the center to the top and bottom of the object.
• Vertical Edge: Gradient is drawn vertically from the left to the right of the object.
• Vertical Center: Gradient is drawn vertically from the center to the left and right of the object.

This property is in the Background property group.

bgRaisedFlag

Reverses the direction of the gradient, as well as that of the 3D edge if the bgStyle selected is 3D Rectangle.

This property is in the Background property group.

bgRoundness

Sets the arc length of the rounded corners. This property is only available if the bgStyle selected is Round Rectangle.

The value of bgRoundness cannot exceed half the value of the objWidth or the objHeight. If bgRoundness does exceed that value, half of objWidth or objHeight (whichever is smaller) will be used instead. For example if objWidth is 100 and objHeight is 50, then the value of bgRoundness cannot exceed 25. If it does, then half the value of objHeight (25) will be used instead. This property is in the Background property group.

bgShadowFlag

Select to display a drop shadow on the background rectangle.

This property is in the Background property group.

bgStyleFlag

Choose one of the following three options from the drop down menu:

• Rectangle: Select to display a background rectangle.
• 3D Rectangle: Select to display a 3D edge on the background rectangle. If selected, use bgEdgeWidth to set the width of the 3D edge.
• Round Rectangle: Select to display a background rectangle with rounded edges. If selected, use bgRoundness to set the arc length of the rounded corners.

This property is in the Background property group.

bgVisFlag

Select to display the background rectangle.

This property is in the Background property group.

borderPixels

Sets the width in pixels of the border between the chart and the edge of the background rectangle.

This property is in the Background property group.

Rotated table: Cell group

Properties in this group control the appearance of cell text and cell background color.

Cell group properties

The group contains the following properties:

• cellBgColor
• cellBgStripedContrast
• cellBgStripedFlag
• cellTextColor
• cellTextFont
• cellTextSize

cellBgColor

Sets the background color of the cells. Select the … button and choose a color from the palette. Close the Color Chooser window when you are done.

This property is in the Cell property group.

cellBgStripedContrast

Specifies the contrast level for the stripes if cellBgStripedFlag is enabled.

This property is in the Cell property group.

cellBgStripedFlag

Specifies alternating striped rows. Alternate rows have a lighter shade of the color specified in cellBgColor.

This property is in the Cell property group.

cellTextColor

Sets the text color of the cells. Select the … button and choose a color from the palette. Close the Color Chooser window when you are done.

This property is in the Cell property group.

cellTextFont

Sets the font for cell text. Select an item from the drop down menu.

This property is in the Cell property group.

cellTextSize

Sets the point size of the cell text.

This property is in the Cell property group.

Rotated table: Column group

Properties in this group control the width and resize-behavior of table columns.

Column group properties

The group contains the following properties:

• autoResizeFlag
• columnProperties

autoResizeFlag

When this property is enabled, column widths change automatically to accommodate table resizing. When this property is disabled, column width is fixed at the values specified by columnProperties.

This property is in the Column property group.

columnProperties

Specifies the width of each column. In the Object Properties window, double-click on columnProperties in the Property Name field. The Column Width Properties dialog appears.

The Column Name list is populated based on the table’s data attachment. If you have not yet attached the table to data, this list is empty.

In the Column Width column of the dialog, enter the width in pixels.

The dialog has the following buttons:

• Add Column: Enter the name of the column and click the Add Column button to insert a column into the table.
• Clear: Click the Clear button to clear all cells in the Column Width column of the dialog.

This property is in the Column property group.

Rotated table: Data group

The property in this group, valueTable, determines what data populates the table.

valueTable

Attach your data to the valueTable property. Right-click on the property name in the Object Properties panel, and select a menu item under Attach to Data.

This property is in the Data property group.

Rotated table: Grid group

Properties in this group control the visibility of the horizontal and vertical lines that separate table rows and columns.

Grid group properties

The group contains the following properties:

• gridHorizontalVisFlag
• gridVerticalVisFlag

gridHorizontalVisFlag

Controls the visibility of the horizontal line that separate table rows.

This property is in the Grid property group.

gridVerticalVisFlag

Controls the visibility of the vertical line that separate table columns.

This property is in the Grid property group.

Rotated table: Historian group

Do not use the properties in this group.

historyTableName

Do not use this property.

This property is in the Historian property group.

historyTableRowNameFlag

Do not use this property.

This property is in the Historian property group.

Rotated table: Interaction group

Properties in this group control command and drill-down of interaction between the end user and the table.

Interaction group properties

The group contains the following properties:

• command
• commandCloseWindowOnSuccess
• commandConfirm
• confirmText
• drillDownColumnSubs
• drillDownSelectMode
• drillDownTarget

command

Assign a command or group of commands to this stock chart by right-clicking on the command property name in the Object Properties window. Select Define Command and choose SYSTEM, APAMA, or MULTIPLE. See Using the Define Apama Command dialog.

Once a command or command group has been assigned to this object, you can activate it from a deployed dashboard or from the Dashboard Builder:

• Dashboard Builder: Double click on the object.
• Web-based deployment: Single click on the object or else right click on it and select Execute Command from the popup menu.
• Local deployment: By default, single-click on the object or else right-click on it and select Execute Command from the popup menu. To override the default, select Tools > Options in the Builder (do this before you generate the deployment package), and uncheck Single-Click for Drill Down and Commands in the General tab. This allows the end user to use either a double click or a right click.

When you activate a command, any defined drill down substitutions are performed, and then the command is executed.

If you assign multiple commands, the commands are launched in an arbitrary order, and are executed asynchronously; there is no guarantee that one command will finish before the next one in the sequence starts.

This property is in the Interaction property group.

commandCloseWindowOnSuccess

Select this property to automatically close the window that initiates a SYSTEM command when the command is executed successfully. This applies to SYSTEM commands only, and is not supported at all for thin-client, web-page deployments.

With APAMA commands, the window is closed whether or not the command is executed successfully. For MULTIPLE commands, the window closes when the first command in the command group succeeds.

This property is in the Interaction property group.

commandConfirm

By default, when the end user executes a command (see the command property), the command confirmation dialog is disabled. To control this option for each individual object, use the commandConfirm check box. If confirmation is required for a MULTIPLE command group, a single confirmation dialog is presented; if you confirm the execution, all individual commands in the group are executed with no further confirmation. If the you cancel the execution, none of the commands in the group is executed.

You can also override the confirmation status of individual objects with an application-wide policy. Select Tools > Options and choose from three confirmation values:

• Do not confirm: Indicates that no commands require confirmation (regardless of each object’s confirmation status).
• Confirm all: Indicates that all commands require confirmation (regardless of each object’s confirmation status).
• Use object confirm flag (default): Indicates that the confirmation status of each object will determine whether confirmation is required.

This property is in the Interaction property group.

confirmText

Use this property to write your own text for the confirmation dialog. Otherwise, default text is used. See commandConfirm.

This property is in the Interaction property group.

drillDownColumnSubs

Use this property to direct a dashboard to assign data-table column values to specified dashboard variables when the end user activates a drilldown on this object. In the Object Properties window, double-click on drillDownColumnSubs in the Property Name field to bring up the Drill Down Column Substitutions dialog.

The dialog has the following fields and buttons:

• Substitution String: Enter the dashboard variable next to the name of the data table column whose value you want assigned to the variable. Press Enter.
• Add Column: Enter the name of a column and click the Add Column button to insert a column into the table.
• Clear: Click the Clear button to remove all variables listed.

The Column Name list is populated based on the table’s data attachment. If you have not yet attached the table to data, this list is empty.

Once you have selected which column values to pass in as substitutions, double-click on any element in your object to open a drill down window that displays corresponding values.

This property is in the Interaction property group.

drillDownSelectMode

Use this property to control how a drill down display is activated. Select one of the following:

• Anywhere to activate a drill down display by double-clicking anywhere on the chart.
• Element Only to enable a drill down display only when you double-click on an element of the chart, such as a bar or candlestick.

This property is in the Interaction property group.

drillDownTarget

To specify a drill down display, double click on drillDownTarget in the Property Name field to bring up the Drill Down Properties dialog. See Drill-down specification.

This property is in the Interaction property group.

Rotated table: Label group

Properties in this group control the table’s main label, including text, alignment, color, font, and size.

Label group properties

The group contains the following properties:

• label
• labelTextAlignX
• labelTextColor
• labelTextFont
• labelTextHeight

label

Specifies the text for the chart label. Click the ellipsis for multi-line text.

The default is Table.

This property is in the Label property group.

labelTextAlignX

Sets the alignment of the chart label (see the label property). Select Left, Center, or Right from the drop down list.

This property is in the Label property group.

labelTextColor

Specifies the color of the chart label text (see the label property). Select the … button and choose a color from the palette. Close the Color Chooser window when you are done.

This property is in the Label property group.

labelTextFont

Specifies the font of the chart label text (see the label property). Select an item from drop down list.

This property is in the Label property group.

labelTextHeight

Specifies the point size of the chart label text (see the label property).

This property is in the Label property group.

Rotated table: Object group

Properties in this group control the visibility and transparency of the table as a whole. They also control (or reflect) the overall position and dimensions of the table. In addition, a property in this group reflects the generated name of this individual table.

Object group properties

The group contains the following properties:

• anchor
• dock
• objHeight
• objName
• objWidth
• objX
• objY
• visFlag

anchor

Select zero or more of Top, Left, Bottom, and Right in order to control the object’s placement. The anchor property is only applied when the display is resized either by changing the Background Properties on the display or by resizing the window in Layout mode. If an object has the dock property set, the anchor property is ignored. See About resize modes.

dock

Select None (default), Top, Left, Bottom, Right, or Fill in order to control the object’s placement in Layout resize mode. See About resize modes.

objHeight

Set the height of a chart by entering a value for this property or by dragging a handle of the bounding box that appears when the chart is selected. When you drag a handle of the bounding box, the displayed value for this property changes to reflect the real-time height of the chart.

This property is in the Object property group.

objName

An identifier that is generated by the Dashboard Builder. This name can be used by other objects’ properties in order to refer to the named chart.

This property is in the Object property group.

objWidth

Set the width of a chart by entering a value for this property or by dragging a handle of the bounding box that appears when the chart is selected. When you drag a handle of the bounding box, the displayed value for this property changes to reflect the real-time width of the chart.

This property is in the Object property group.

objX

Sets the X coordinate of the center of this visualization object, relative to the lower left corner of the current dashboard. This value is set automatically when you position the object with the mouse.

This property is in the Object property group.

objY

Sets the Y coordinate of the center of this visualization object, relative to the lower left corner of the current dashboard. This value is set automatically when you position the object with the mouse.

This property is in the Object property group.

visFlag

Deselect to make this visualization object invisible in the current dashboard.

This property is in the Object property group.

HTML5 tables

The HTML5 table is an advanced HTML implementation of obj_table02 which provides enhanced filtering. The HTML5 table is available in the Thin Client only.

To display your data in a HTML5 table, select the Table (HTML5) table object instance in the Builder’s Tables tab. One can also select any of the other table objects under Tables tab except the Rotated Table and check the webGridFlag property.

Requirements

HTML5 table appears in the Thin Client in any modern version of a supported browser. No plug-in is required. In older browsers which do not support HTML5, the HTML5 table will be rendered with the classic grid table.

Features

The HTML5 table supports advanced, interactive table features in the Thin Client: sorting on multiple columns, filtering on multiple columns, column resizing, column reordering, and hiding columns. In addition, you can unsort a previously selected sort column and, in a grid with rowHeaderEnabledFlag = true, additional columns can be locked into the row header. You can save all of those column settings permanently so that they are restored when you return to the display later. Many of these features are accessed from the column menu, shown in the screen shot above, opened by clicking on the menu icon in each column’s header.

Also, for improved performance and usability, if a data table contains more than 200 rows, by default the HTML5 table displays it in pages of 200 rows. For more information on paging, see the Paging section.

Column Sorting

Click on a column header to sort the table by that column. On the first click, the column is sorted in ascending order. On the second click the column is sorted in descending order. On the third click, the column is returned to its original unsorted state. A sort on a string column is case-insensitive.

You can select multiple sort columns. In that case, the sorting is performed in the order that the column headers were clicked. Multiple column sorting is a very useful feature, but can also cause confusion if you intend to sort on a single column, but forget to “unsort” any previously selected sort columns first. You should check for the up/down sort icon in other column headers if a sort gives unexpected results.

Column sorting is reflected in an export to HTML and Excel.

Column Visibility

You can hide or show columns in the table by clicking on any column’s menu icon, and choosing Columns from the menu. This opens a submenu with a checkbox for each column that toggles the visibility of the column. All columns in the data table appear in the Columns menu, even those that are initially hidden by the obj_table02 property columnsToHide.

If the grid has the rowHeaderEnabledFlag property checked then the leftmost column (the row header column) cannot be hidden.

Column visibility changes are not reflected in an export to HTML and Excel.

Column Filtering

You can create a filter on any column. If filters are created on multiple columns, only the rows that pass all of the filters are displayed.

The background of a column’s menu icon changes to white to indicate that a filter is defined on that column. This is intended to remind you which columns are filtered.

You can configure a filter on any column by clicking on the column’s menu icon and choosing Filter from the menu. This opens the Column Filter dialog.

Options in the Column Filter dialog vary according to the data type of the selected column:

• String columns: You can enter a filter string such as “abc” and, from the dropdown list, select the operator (equal to, not equal to, starts with, contains, etc) to be used when comparing the filter string to each string in the column. All of the filter comparisons on strings are case-insensitive. You can optionally enter a second filter string (e.g. “xyz”) and specify if an AND or OR combination should be used to combine the first and second filter results on the column.
• Numeric columns: You can enter numeric filter values and select arithmetic comparison operators, (=, !=, >, >=, <, <=). You can optionally enter a second filter value and comparison operator, and specify if an AND or OR combination should be used to combine the first and second filter results.
• Boolean columns: You simply select whether matching items should be true or false.
• Date columns: You can select a date and time, and choose whether matching items should have a timestamp that is same as, before, or after the filter time. The date is selected by clicking the calendar icon and picking a date from the Calendar dialog. The time is selected by clicking the time icon and picking a time from the dropdown list. Alternatively, a date and time can be typed in the edit box.

Data updates to the grid are suspended while the filter menu is opened. The updates are applied when the menu is closed.

Column filtering is reflected in an export to HTML and Excel.

Column Locking

This feature is available only if the obj_table02 instance has the row header feature enabled (rowHeaderEnabledFlag is checked). If so, the leftmost column is “locked” in position, that is it does not scroll horizontally with the other columns in the table. If the row header is enabled, then two items labeled Lock and Unlock appear in the column menu. These can be used to add or remove additional columns from the non-scrolling row header area.

If the row header is enabled, at least one column must remain locked.

Column locking is not reflected in an export to HTML and Excel.

Column Reordering

You can reorder the grid columns by dragging and dropping a column’s header into another position. If the grid has rowHeaderEnabledFlag checked, then dragging a column into or out of the row header area (the leftmost columns) is equivalent to locking or unlocking the column.

Column reordering is not reflected in an export to HTML and Excel.

Paging

If the data table contains more than one page of rows, the page controls are displayed at the bottom of the grid. The default page size is 200 but can be set on each obj_table02 instance via the new property named webGridRowsPerPage. The default value of that property is zero, which indicates that the default size (200) should be used. If the height of the grid is less than 64 pixels, there is insufficient space to display the page controls so only the rows on the first page will be viewable.

Row Mouseover

A new property named webGridHoverColor is available on obj_table02. It is visible only if webGridFlag = true. The default value of webGridHoverColor is checked. If it is set to any other color index value, then that color is used to highlight the row that is under the mouse cursor. But if the obj_table02 filterProperties feature is used to color rows, that color takes precedence, so the webGridHoverColor may not be useful in those cases. Also, if the row header is enabled, the row header column and the other columns are highlighted separately, according to which section of the grid the mouse is over.

Saving Settings

You can permanently save all of the custom settings made to the grid, including filtering, sorting, column size (width), column order, column visibility, and column locking. This is done by opening any column menu, clicking Settings, and then clicking Save All.

The grid’s settings are written as an item in the browser’s local storage. The item’s value is a string containing the grid’s settings. The item uses a unique key comprised of the URL path name, the display name, and the obj_table02 instance’s RTView object name. If the Thin Client’s login feature is enabled, the key will also include the username and role, so different settings can be saved for each user and role for a grid on any given display, in the same browser and host.

If the user saves the grid settings and navigates away from the display or closes the browser, then the next time the user returns to the display in the same browser, the settings are retrieved from the browser’s local storage and applied to the grid. The browser’s local storage items are persistent, so the grid settings are preserved if the browser is closed and reopened or if the host system is restarted.

If the obj_table02 has autoResizeFlag = true, then the column widths are not restored from the saved settings, and the values computed by the auto-resize feature are used instead. This is by design.

You can delete the grid’s item from local storage by clicking Settings -> Clear All in any column menu. This permanently deletes the saved settings for the grid and returns the grid to the state defined in the display file. Note that each browser has its own local storage on each host. The local storage items are not shared between browsers on the same host or on different hosts. So, if a user logs in as Joe with role = admin in Internet Explorer on host H1, and saves grid settings for display X, then those grid settings are restored each time a user logs in as Joe, role admin, on host H1 and opens display X in Internet Explorer. But if all the same is true except that the browser is Chrome, then the settings saved in Internet Explorer are not applied. Or if the user is Joe and role is admin and the browser is Internet Explorer and the display is X, but the host system is H2 not H1, then the grid settings saved on H1 are not applied.

Support for Large Tables

The HTML5 table can support data tables with many rows and columns. However, for best performance the display server’s cellsperpage property should be specified so that the server sends large tables to the client in pages, rather than sending all of the rows. In this server paging mode, large tables are also filtered and sorted in the display server, to improve performance and decrease data traffic. See the RTView documentation for a description of the cellsperpage property, and the related cellsperexport and cellsperreport properties. A typical value for cellsperpage is 20000.

Unsupported obj_table02 Features

The following are existing features of obj_table02 that are not supported by the HTML5 table:

• The rowHeaderEnabledFlag property is supported, but rowHeaderBgColor, rowHeaderTextColor, rowHeaderTextFont, rowHeaderTextSize are ignored. Instead the row header column is rendered like all other columns.
• The columnResizeEnabledFlag is ignored if it is false, the HTML5 table always allows column resizing.
• The editDataEnabledFlag is ignored, the table editing feature using custom commands is currently not supported.

Other limitations, and differences between the new and classic grids:

• Time zones: The strings shown in a date column are formatted by the display server using its time zone. But if a filter is specified on a date column, the date and time for the filter are computed using the client system’s time zone. This can be confusing if the display server and client are in different time zones.
• Selected rows: The grid’s row selection is cleared if the sort is changed or if columns are resized or reordered.
• Scrollbars: In general the grid only displays scrollbars when they are needed. However, the HTML5 table and the classic grid use different algorithms for deciding when to show or hide scrollbars, and do not use identical row heights and column widths. So the HTML5 table may sometimes display scrollbars when the classic grid does not, for a grid instance with a given width and height.
• Keyboard traversal: In the classic grid, selecting a row and then using the up/down arrow keys changes the selection to the previous/next row. In the HTML5 table, the arrow keys moves the keyboard focus to another row, as indicated by a highlight border around the focused table cell, but the user must press the space bar to select the row that contains the highlighted (focused) cell.
• Column widths: On a HTML5 table with no locked columns (rowHeaderEnabledFlag = false), columns expand to fill any unused width in the table, even if autoResizeFlag = false. That is, if the total width of the columns is less than the grid width (ie. the columns don’t use all of the available width) then each column is expanded proportionally to fill the table. In contrast, the classic and Swing (Viewer) grids just leave unused space at the right edge of the grid. If the grid has locked columns (rowHeaderEnabledFlag = true), then the HTML5 table behaves the same as the classic and Swing grids.
• Export: The export to HTML and export to excel features are supported on the HTML5 table, and behave much the same as on the classic grid. The exported table respects the grid’s filter and sort settings but ignores any column reordering, sizing, or hiding changes made by the user.
• Data updates to the grid are suspended while the filter menu is opened. The updates are applied when the menu is closed.

TreeGrid view

You can configure the rows in the HTML5 tables to appear in a tree grid view. The HTML5 table rows can be expanded or collapsed in a hierarchy defined by indexColumns in the table.

To enable the tree grid view

1. Select the webTreeGridFlag property. A new column with tree grid view is added as the first column in the table.
2. Specify the name of the newly added column in the webTreeLabelColumn property.
3. Select the columns that are to be considered for the hierarchical structure in indexColumns.
4. Save the dashboard.
5. Deploy the dashboard using the display server deployment type.