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.

The group contains the following properties:

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:

4. If the table object has a drilldown command, or a drillDownTarget, add this to its Drill Down Substitutions:

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

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.

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:

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.

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.

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.

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.

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.

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.

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

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.

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.

Do not use this property.

This property is in the Interaction property group.

Do not use this property.

This property is in the Interaction property group.

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 Data dialogs.

This property is in the Interaction property group.

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.

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.

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

As Needed: Display a scroll bar or scroll bars when there is not enough space to display all of the rows or columns.

This property is in the Interaction property group.

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.

Note:
This property does not apply to thin-client (display server) deployments, or to objects that are disabled, invisible, or have a value of less than 0.