Stock chart: Interaction group

Properties in this group control various forms of interaction between the end user and the chart, including scrolling, zooming, and activating commands, drill downs, and tooltips.

The group includes the following properties:

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, 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.

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.

Sets the color of the cursor, as well as the zoom-area rectangle (see zoomEnabledFlag). Select the ... button and choose a color from the palette. Close the Color Chooser window when you are done.

The default is yellow.

This property is in the Interaction property group.

Select to enable the cursor. When the cursor is enabled, select the chart and point to a location on a trace to see a cursor line at that location and display the time and values of all traces at the cursor line on the legend. Select the legendPopupFlag to display the legend along the cursor.

The cursor is disabled by default.

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.

Select to enable trace element tooltips. When the enabled, hold the mouse over a location to display in a tooltip the time and the open and close values of all traces at the location.

This property is in the Interaction property group.

Sets whether and when the scroll bar appears in the chart. Select one of the following from the drop down menu:

As Needed: Display the scroll bar when necessitated by zooming in the trace area, or when more data is loaded into the chart than is displayed in the time range. For example, if the time range of the data in your data attachment is greater than timeRange, setting scrollbarMode to As Needed will enable a scroll bar, allowing the end user to view all data loaded into the chart.

This property is in the Interaction property group.

Specifies the height of the horizontal scroll bar and the width of the vertical scroll bar, in pixels. The default value is -1, which sets the size to the system default.

This property is in the Interaction property group.

Select to enable zooming within the chart. Click in the chart's trace area and drag the cursor until a desired range is selected. While dragging, a rectangle is drawn to show the zoom area. The rectangle's default color is yellow (this can be changed in the cursorColor property). After the zoom is performed, the chart stores up to four zoom operations in queue. To zoom out, press the shift key and click in the chart's trace area.