Developing Apama Applications > Dashboard Property Reference for Graphs, Tables, and Trends > Trend Objects > Sparkline charts > Sparkline chart: Interaction group
Sparkline chart: Interaction group
Properties in this group control various forms of interaction between the end user and the chart, including activating commands, drill downs, and tooltips.
Interaction group properties
The group includes the following properties:
*command
*commandCloseWindowOnSuccess
*commandConfirm
*confirmText
*cursorColor
*cursorFlag
*drillDownTarget
*legendPopupFlag
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. For information on the Define Command dialog, see Building Dashboards in Developing Apama Applications.
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 comand 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.
cursorColor
Sets the color of the cursor. 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.
cursorFlag
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 the trend line 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.
drillDownTarget
To specify a drill down display, double click on drilDownTarget 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.
legendPopupFlag
Controls whether a legend pops up when the user mouses over the trend line.
This property is in the Interaction property group.
Copyright © 2013 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or Terracotta Inc., San Francisco, CA, USA, and/or Software AG (Canada) Inc., Cambridge, Ontario, Canada, and/or, Software AG (UK) Ltd., Derby, United Kingdom, and/or Software A.G. (Israel) Ltd., Or-Yehuda, Israel and/or their licensors.