Trend graph: Interaction group

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

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.

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.

By default, when the end user executes a command (see command), 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.

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

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.

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.

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, that is, a trace point.

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.

Trend graphs support drill down from a trace point. If the trend graph has a drillDownTarget specified, clicking on a trace point sets the following predefined substitutions:

$traceNumber: number of the trace (1 to 10) that contains the selected point

$traceLabel: label of selected trace

$pointValue: y value of point

$pointTimestamp: timestamp of point

$pointLabel: data label (if any) of point

$pointIndex: position of point in trace data (0 to maxPointsPerTrace)

If the drillDownSelectMode property is set to Element Only, clicks on the graph that are not near a trace point are ignored. If drillDownSelectMode is set to Anywhere, a click anywhere on the graph triggers a drill down, but if the click is not near a trace point the substitutions listed above are not set.

Thin client (display server) deployments support mouseover text and drill down from data points on traces on the trend graph. If the trend graph's cursorFlag property is checked, this enables mouseover on the trace points. If the mouse is over a trace point, a browser tooltip box appears displaying the legend values that correspond to that point. Following are the limitations on this feature:

If this feature is used on a graph with many trace points, the performance of the browser may be sluggish when the display is loading or refreshing. To avoid this, set the timeRange property so that only a portion of the trace points are visible at a time.

If a thin client display refresh occurs while positioning the mouse over a point, the browser tooltip may not appear or it may appear in the wrong location.

When maxPointsPerTrace is exceeded on a trace (1000 by default), an old trace point is shifted out of the trace for each new point that is added. If this occurs between the time that the thin client display was last refreshed and the time that the user clicks on a point, the drilldown substitutions reflect the new set of data points. For example, if two points are shifted out of the trace, the drilldown substitutions are set as though the selected point were two positions to the right of the point the user actually clicked.

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

Never: Default setting

Always: Display a scroll bar at all times.

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.

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

Select to enable zooming within the chart. Click in the chart's trace area and drag the cursorColorcursor 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 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.