Graph objects

Bar graphs

Bar graphs visualize tabular data that has one or more numerical columns. Typically, the visualized data also has one non-numerical column, whose values are used as graph labels that uniquely identify each row.

A bar graph can visualize data in either of two ways:

• Row series visualization: One group of bars is shown for each numeric column in the data attachment. Within each group, there is a bar for each row in the data attachment.
• Column series visualization: one group of bars is shown for each row in your data attachment. Within each group, there is a bar for each numeric column in the data attachment.

Use the valueTable property to attach data to a bar graph. Use the rowSeriesFlag property to specify row series or column series visualization.

You can attach additional data to a bar graph by using the traceValueTable property. Data attached to this property is visualized with plotted points, or trace markers, rather than bars.

A bar graph can visualize trace data in either of two ways:

• Row series visualization: One group of trace markers is shown for each numeric column in the data attachment. Within each group, there is a marker for each row in the data attachment.
• Column series visualization: one group of trace markers is shown for each row in your data attachment. Within each group, there is a marker for each numeric column in the data attachment

The points within a group are connected to one another by a polyline, or trace line.

The current section covers the following kinds of bar graphs:

• Bar graph
• 3-D Stacked bar graph
• Grouped bar graph with traces

These visualization objects 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_bargraph.

The Object Properties panel organizes bar graph properties into the groups below.

Bar graph: Alert group

Properties in this group allow you to specify changes in the appearance of bars, trace lines, and trace markers in response to changes in the status of plotted data elements. You can either specify threshold values (see valueHighAlarm, valueHighWarning, valueLowAlarm, and valueLowWarning) or attach a data table to traceValueAlarmStatusTable that indicates the status of each element of the table that is attached to traceValueTable.

Alert group properties

This group includes the following properties:

• traceValueAlarmStatusTable
• valueHighAlarm
• valueHighAlarmColor
• valueHighAlarmEnabledFlag
• valueHighAlarmLineVisFlag
• valueHighAlarmMarkColor
• valueHighAlarmMarkStyle
• valueHighWarning
• valueHighWarningColor
• valueHighWarningEnabledFlag
• valueHighWarningLineVisFlag
• valueHighWarningMarkColor
• valueHighWarningMarkStyle
• valueLowAlarm
• valueLowAlarmColor
• valueLowAlarmEnabledFlag
• valueLowAlarmLineVisFlag
• valueLowAlarmMarkColor
• valueLowAlarmMarkStyle
• valueLowWarning
• valueLowWarningColor
• valueLowWarningEnabledFlag
• valueLowWarningLineVisFlag
• valueLowWarningMarkColor
• valueLowWarningMarkStyle

traceValueAlarmStatusTable

Attach an alarm table containing status indexes to this property in order to enable rule based alarm statuses for trace markers. The table attached to traceValueAlarmStatusTable must have the same number of rows and columns as traceValueTable. For each data element in traceValueTable, the status index at the corresponding position in traceValueAlarmStatusTable is used to set the alarm status of the marker that represents the data element.

Following are the valid indexes are:

• 0: Use normal marker color and style. See traceProperties.
• 1: Use low alarm marker color and style. See valueLowAlarmMarkColor and valueLowAlarmMarkStyle.
• 2: Use low warning marker color and style. See valueLowWarningMarkColor and valueLowWarningMarkStyle.
• 3: Use high warning marker color and style. See valueHighWarningMarkColor and valueHighWarningMarkStyle.
• 4: Use high alarm marker color and style. See valueHighAlarmMarkColor and valueHighAlarmMarkStyle.
• -1: Determine marker color and style by comparing the value to the enabled alarm thresholds

If no data is attached to traceValueAlarmStatusTable, the alarm status for a trace marker is determined by comparing the marker’s value to the enabled thresholds. See valueHighAlarm, valueHighWarning, valueLowAlarm, and valueLowWarning.

This property is in the Alert property group.

valueHighAlarm

Specifies the threshold value used by valueHighAlarmLineVisFlag, valueHighAlarmMarkColor, valueHighAlarmMarkStyle, and valueHighAlarmColor.

This property is in the Alert property group.

valueHighAlarmColor

When the value of a bar or trace segment is greater than or equal to valueHighAlarm, its color changes to the valueHighAlarmColor, provided valueHighAlarmEnabledFlag is selected.

This property is in the Alert property group.

valueHighAlarmEnabledFlag

Select to enable the high alarm threshold. See valueHighAlarm.

This property is in the Alert property group.

valueHighAlarmLineVisFlag

Select to display a dashed line at the high alarm threshold. The color of the line is set to valueHighAlarmMarkColor. This line is displayed only if valueHighAlarmEnabledFlag is selected.

This property is in the Alert property group.

valueHighAlarmMarkColor

When a trace marker’s value is greater than or equal to valueHighAlarm, the marker changes to valueHighAlarmMarkColor and valueHighAlarmMarkStyle, provided valueHighAlarmEnabledFlag is selected and no data is attached to traceValueAlarmStatusTable.

If data is attached to traceValueAlarmStatusTable, a marker changes to valueHighAlarmMarkColor and valueHighAlarmMarkStyle when the marker’s corresponding element in the attached alarm status table is 4.

If data is attached to traceValueAlarmStatusTable, and the marker’s corresponding element in the attached alarm status table is -1, marker color and style behave as if no data were attached to traceValueAlarmStatusTable.

This property is in the Alert property group.

valueHighAlarmMarkStyle

When a trace marker’s value is greater than or equal to valueHighAlarm, the marker changes to valueHighAlarmMarkColor and valueHighAlarmMarkStyle, provided valueHighAlarmEnabledFlag is selected and no data is attached to traceValueAlarmStatusTable.

If data is attached to traceValueAlarmStatusTable, a marker changes to valueHighAlarmMarkColor and valueHighAlarmMarkStyle when the marker’s corresponding element in the attached alarm status table is 4.

If data is attached to traceValueAlarmStatusTable, and the marker’s corresponding element in the attached alarm status table is -1, marker color and style behave as of no data were attached to traceValueAlarmStatusTable.

This property is in the Alert property group.

valueHighWarning

Specifies the threshold value used by valueHighWarningLineVisFlag, valueHighWarningMarkColor, valueHighWarningMarkStyle, and valueHighWarningColor.

This property is in the Alert property group.

valueHighWarningColor

When the value of a bar or trace segment is greater than or equal to valueHighWarning but less than valueHighAlarm, its color changes to valueHighWarningColor, provided valueHighWarningEnabledFlag is selected.

This property is in the Alert property group.

valueHighWarningEnabledFlag

Select to enable the high warning threshold. See valueHighWarning.

This property is in the Alert property group.

valueHighWarningLineVisFlag

Select to display a dashed line at the high warning threshold. The color of the line is set to valueHighWarningMarkColor. This line is displayed only if valueHighWarningEnabledFlag is selected.

This property is in the Alert property group.

valueHighWarningMarkColor

When a trace marker’s value is greater than or equal to valueHighWarning but less than valueHighAlarm, the marker changes to valueHighWarningMarkColor and valueHighWarningMarkStyle, provided valueHighWarningEnabledFlag is selected and no data is attached to traceValueAlarmStatusTable.

If data is attached to traceValueAlarmStatusTable, a marker changes to valueHighWarningMarkColor and valueHighWarningMarkStyle when the marker’s corresponding element in the attached alarm status table is 3.

If data is attached to traceValueAlarmStatusTable, and the marker’s corresponding element in the attached alarm status table is -1, marker color and style behave as of no data were attached to traceValueAlarmStatusTable.

This property is in the Alert property group.

valueHighWarningMarkStyle

When a trace marker’s value is greater than or equal to valueHighWarning but less than valueHighAlarm, the marker changes to valueHighWarningMarkColor and valueHighWarningMarkStyle, provided valueHighWarningEnabledFlag is selected and no data is attached to traceValueAlarmStatusTable.

If data is attached to traceValueAlarmStatusTable, a marker changes to valueHighWarningMarkColor and valueHighWarningMarkStyle when the marker’s corresponding element in the attached alarm status table is 3.

If data is attached to traceValueAlarmStatusTable, and the marker’s corresponding element in the attached alarm status table is -1, marker color and style behave as of no data were attached to traceValueAlarmStatusTable.

This property is in the Alert property group.

valueLowAlarm

Specifies the threshold value used by valueLowAlarmLineVisFlag, valueLowAlarmMarkColor, valueLowAlarmMarkStyle, and valueLowAlarmColor.

This property is in the Alert property group.

valueLowAlarmColor

When the value of a bar or trace segment is less than or equal to valueLowAlarm, it’s color changes to valueLowAlarmColor, provided valueLowAlarmEnabledFlag is selected.

This property is in the Alert property group.

valueLowAlarmEnabledFlag

Select to enable the low alarm threshold. See valueLowAlarm.

This property is in the Alert property group.

valueLowAlarmLineVisFlag

Select to display a dashed line at the low alarm threshold. The color of the line is set to valueLowAlarmMarkColor. This line is displayed only if valueLowAlarmEnabledFlag is selected.

This property is in the Alert property group.

valueLowAlarmMarkColor

When a trace marker’s value is less than or equal to valueLowAlarm, the marker changes to valueLowAlarmMarkColor and valueLowAlarmMarkStyle, provided valueLowAlarmEnabledFlag is selected and no data is attached to traceValueAlarmStatusTable.

If data is attached to traceValueAlarmStatusTable, a marker changes to valueLowAlarmMarkColor and valueLowAlarmMarkStyle when the marker’s corresponding element in the attached alarm status table is 1.

If data is attached to traceValueAlarmStatusTable, and the marker’s corresponding element in the attached alarm status table is -1, marker color and style behave as of no data were attached to traceValueAlarmStatusTable.

This property is in the Alert property group.

valueLowAlarmMarkStyle

When a trace marker’s value is less than or equal to valueLowAlarm, the marker changes to valueLowAlarmMarkColor and valueLowAlarmMarkStyle, provided valueLowAlarmEnabledFlag is selected and no data is attached to traceValueAlarmStatusTable.

If data is attached to traceValueAlarmStatusTable, a marker changes to valueLowAlarmMarkColor and valueLowAlarmMarkStyle when the marker’s corresponding element in the attached alarm status table is 1.

If data is attached to traceValueAlarmStatusTable, and the marker’s corresponding element in the attached alarm status table is -1, marker color and style behave as of no data were attached to traceValueAlarmStatusTable.

This property is in the Alert property group.

valueLowWarning

Specifies the threshold value used by valueLowWarningLineVisFlag, valueLowWarningMarkColor, valueLowWarningMarkStyle, and valueLowWarningColor.

This property is in the Alert property group.

valueLowWarningColor

When the value of a bar or trace segment is less than or equal to valueLowWarning but greater than valueLowAlarm, it changes to valueLowWarningColor, provided valueLowWarningEnabledFlag is selected.

This property is in the Alert property group.

valueLowWarningEnabledFlag

Select to enable the low warning threshold. See valueLowWarning.

This property is in the Alert property group.

valueLowWarningLineVisFlag

Select to display a dashed line at the low warning threshold. The color of the line is set to valueLowWarningMarkColor. This line is displayed only if valueLowWarningEnabledFlag is selected.

This property is in the Alert property group.

valueLowWarningMarkColor

When a trace marker’s value is less than or equal to valueLowWarning but greater than valueLowAlarm, the marker changes to valueLowWarningMarkColor and valueLowWarningMarkStyle, provided valueLowWarningEnabledFlag is selected and no data is attached to traceValueAlarmStatusTable.

If data is attached to traceValueAlarmStatusTable, a marker changes to valueLowWarningMarkColor and valueLowWarningMarkStyle when the marker’s corresponding element in the attached alarm status table is 2.

If data is attached to traceValueAlarmStatusTable, and the marker’s corresponding element in the attached alarm status table is -1, marker color and style behave as of no data were attached to traceValueAlarmStatusTable.

This property is in the Alert property group.

valueLowWarningMarkStyle

When a trace marker’s value is less than or equal to valueLowWarning but greater than valueLowAlarm, the marker changes to valueLowWarningMarkColor and valueLowWarningMarkStyle, provided valueLowWarningEnabledFlag is selected and no data is attached to traceValueAlarmStatusTable.

If data is attached to traceValueAlarmStatusTable, a marker changes to valueLowWarningMarkColor and valueLowWarningMarkStyle when the marker’s corresponding element in the attached alarm status table is 2.

If data is attached to traceValueAlarmStatusTable, and the marker’s corresponding element in the attached alarm status table is -1, marker color and style behave as of no data were attached to traceValueAlarmStatusTable.

This property is in the Alert property group.

Bar graph: Background group

Properties in this group control the visibility and appearance of the portion of the graph that serves as the background of both the plot area and legend.

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.

Bar graph: Bar group

Properties in this group control the appearance of the graph’s bars, including gradient style, color, and fill style. The group also includes properties that control the visibility and appearance of the text used to display bar values, including font, color, size, and position. You can also specify an image to be displayed within each bar.

Bar group properties

This group contains the following properties:

• barGradientStyle
• barImage
• barProperties
• barValueTextColor
• barValueTextFont
• barValueTextHeight
• barValueTextPos
• barValueVisFlag

barGradientStyle

Select one of the following in order to set the gradient style of the bars:

• None: Default setting.
• Shaded: Display bars with a flat gradient
• Rounded: Display bars with a rounded gradient

This property is in the Bar property group.

barImage

Specifies an image (.gif, .jpg, or .png file) to display in each bar. Select the name of the image file from the drop down menu, or enter the pathname of the 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.

This property is in the Bar property group.

barProperties

Specifies the color and fill pattern for each bar in the graph. In the Object Properties window, double-click on barProperties in the Property Name field to bring up the Bar Properties dialog. In the Bar Properties dialog you can assign attributes to each bar in a bar graph.

The dialog contains three columns of fields:

• Bar: There is one entry for each bar that is currently displaying data in the bar graph. The Color and Fill Pattern columns list the current settings for each bar.
• Color: Select the ellipsis button in the Color column and choose a color from the palette to set the color of the bar. Close the Color Chooser window.
• Fill Pattern: Select the ellipsis button in the Fill Pattern column and choose a pattern from the palette to set the fill pattern of the bar. Close the Fill Pattern window.

The dialog contains the following buttons:

• Add Bar Property: Click to add a Bar Property entry. This does not add a bar to your graph, it adds a bar entry so that you can set properties for bars that will display data that is not yet available. This is useful if the data attachment is not available when you setup your bar graph, or if the number of rows or columns returned by your data attachment varies.
• Delete Bar Property: Removes the last bar property entry from the Bar Properties dialog.
• OK: Applies values and closes the dialog.
• Apply: Applies values without closing the dialog.
• Reset: Resets all fields to last values applied.
• Clear: Clears all fields. Detaches object from data source (once Apply or OK is selected).
• Cancel: Closes the dialog with last values applied.

This property is in the Bar property group.

barValueTextColor

Sets the color of the text used to display bar values. This property is visible in the Builder’s Object Properties pane only if barValueVisFlag is selected.

To set the 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 Bar property group.

barValueTextFont

Sets the font of the text used to display bar values. This property is visible in the Builder’s Object Properties pane only if barValueVisFlag is selected. To set the font, select an item from the drop down list.

This property is in the Bar property group.

barValueTextHeight

Sets the point size of the text used to display bar values. This property is visible in the Builder’s Object Properties pane only if barValueVisFlag is selected. To set the point size, enter a number in the text field.

This property is in the Bar property group.

barValueTextPos

Sets the position, relative to the bar, of the text used to display bar values. This property is visible in the Builder’s Object Properties pane only if barValueVisFlag is selected. To set the text position, choose an item from the drop down list. By default, digits after a decimal point are not displayed on the labels.

This property is in the Bar property group.

barValueVisFlag

Select to display a value for each bar. Selecting this property causes the following properties to appear in the Object Properties panel:

• barValueTextColor
• barValueTextFont
• barValueTextHeight
• barValueTextPos

This property is in the Bar property group.

Bar graph: Column group

This group contains one property, columnsToHide, which controls which data-attachment columns are used for plotted data or labels.

columnsToHide

Specifies columns from the data attachment to exclude from being used for plotted data or labels. Data from the labelColumnName column will be used for labels even if that column name is also specified in the columnsToHide property. Columns specified in the columnsToHide property can still be used in the drillDownColumnSubs property.

This property is in the Column property group.

Bar graph: Data group

Properties in this group control what data appears in the graph, and whether the data appears in column series or row series form.

Data group properties

The group contains the following properties:

• rowSeriesFlag
• traceValueDivisor
• traceValueTable
• traceYAxisValueMax
• traceYAxisValueMin
• valueDivisor
• valueTable
• yValueMax
• yValueMin

rowSeriesFlag

This property controls how row and column data populate the graph:

• If the rowSeriesFlag checkbox is selected, one group of bars is shown for each numeric column in your data attachment. Within each group, there is a bar for each row in the data attachment.

If xAxisFlag is enabled, each group is labeled with the name of the corresponding numeric column.

By default, each bar within a group has a different color. If rowLabelVisFlag is selected, the legend indicates the mapping between each bar’s color and the label-column value of the bar’s corresponding row (see labelColumnName). If both rowLabelVisFlag and rowNameVisFlag are deselected, the legend indicates the mapping between each bar’s color and an integer identifier for the bar’s corresponding row.

• If the rowSeriesFlag checkbox is not selected, one group of bars is shown for each row in your data attachment. Within each group, there is a bar for each numeric column in the data attachment.

If both rowLabelVisFlag and xAxisFlag are enabled, each group is labeled with the label-column value for the group’s corresponding row (see labelColumnName). If rowLabelVisFlag is disabled and xAxisFlag is enabled, each group is labeled with an integer identifier for the group’s corresponding row.

By default, each bar within a group has a different color. The legend indicates the mapping between each bar’s color and the name of the bar’s corresponding numeric column.

This property is in the Data property group.

traceValueDivisor

Divides trace values by the number entered.

The default is 1.

This property is in the Data property group.

traceValueTable

Attach your data to the traceValueTable property to add one or more traces to your bar graph. Right-click on the property name in the Object Properties panel, and select a menu item under Attach to Data. The attached data table should have one or more numerical columns. Typically, the data attachment has one non-numerical column, whose values uniquely identify each row (that is, no two rows of the table have the same value for the non-numerical column).

The property rowSeriesFlag controls how row and column data populate the graph:

• If the rowSeriesFlag checkbox is selected, one trace line is shown for each row your data attachment. Within each trace line, there is a mark for each numeric column in the data attachment. The height of a given mark in a given trace line is proportional to the value of the mark’s corresponding numerical column for the trace line’s corresponding row.

By default, each trace line has a different color. If rowLabelVisFlag is selected, the legend indicates the mapping between each line’s color and the trace-label-column value of the bar’s corresponding row (see traceLabelColumnName).

• If the rowSeriesFlag checkbox is not selected, one trace line is shown for each numeric column in your data attachment. Within each trace line, there is a mark for each row of the data attachment. The height of a given mark in a given trace line is proportional to the value of the trace line’s corresponding numerical column for the mark’s corresponding row.

By default, each trace line has a different color. The legend indicates the mapping between each trace line’s color and the name of the trace line’s corresponding numeric column.

This property is in the Data property group.

traceYAxisValueMax

When traceYAxisFlag is selected, the traceYAxisValueMin and traceYAxisValueMax properties are used to control the range of the trace y-axis if yAxisAutoScaleMode is set to Off or On-include Min/Max.

This property is in the Data property group.

traceYAxisValueMin

When traceYAxisFlag is selected, the traceYAxisValueMin and traceYAxisValueMax properties are used to control the range of the trace y-axis if yAxisAutoScaleMode is set to Off or On-include Min/Max.

This property is in the Data property group.

valueDivisor

Divides bar and y-axis values by the number entered.

The default is 1.

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. The attached data table should have one or more numerical columns. Typically, the data attachment has one non-numerical column, whose values uniquely identify each row (that is, no two rows of the table have the same value for the non-numerical column).

The property rowSeriesFlag controls how row and column data populate the graph:

• If the rowSeriesFlag checkbox is selected, one group of bars is shown for each numeric column in your data attachment. Within each group, there is a bar for each row in the data attachment. The height of a given bar in a given group is proportional to the value of the group’s corresponding numerical column for the bar’s corresponding row.

If xAxisFlag is enabled, each group is labeled with the name of the corresponding numeric column.

By default, each bar within a group has a different color. If rowLabelVisFlag is selected, the legend indicates the mapping between each bar’s color and the label-column value of the bar’s corresponding row (see labelColumnName). If both rowLabelVisFlag and rowNameVisFlag are deselected, the legend indicates the mapping between each bar’s color and an integer identifier for the bar’s corresponding row.

• If the rowSeriesFlag checkbox is not selected, one group of bars is shown for each row in your data attachment. Within each group, there is a bar for each numeric column in the data attachment. The height of a given bar in a given group is proportional to the value of the bar’s corresponding numerical column for the group’s corresponding row.

If both rowLabelVisFlag and xAxisFlag are enabled, each group is labeled with the label-column value for the group’s corresponding row (see labelColumnName). If rowLabelVisFlag is disabled and xAxisFlag is enabled, each group is labeled with an integer identifier for the group’s corresponding row.

By default, each bar within a group has a different color. The legend indicates the mapping between each bar’s color and the name of the bar’s corresponding numeric column.

This property is in the Data property group.

yValueMax

The yValueMin and yValueMax properties control the range of the y-axis if the yAxisAutoScaleMode is set to Off. In addition, if yAxisAutoScaleMode is set to On - Include Min/Max, the dashboard calculates the smallest y-axis range that includes both yValueMin and yValueMax as well as all plotted points.

This property is in the Data property group.

yValueMin

The yValueMin and yValueMax properties control the range of the y-axis if the yAxisAutoScaleMode is set to Off. In addition, if yAxisAutoScaleMode is set to On - Include Min/Max, the dashboard calculates the smallest y-axis range that includes both yValueMin and yValueMax as well as all plotted points.

This property is in the Data property group.

Bar graph: Data Format group

Properties on this group control the format of displayed bar values as well as numerical and date labels.

Data Format group properties

The group includes the following properties:

• labelColumnFormat
• traceYValueFormat
• yValueFormat

labelColumnFormat

Sets the format of numeric or date labels displayed on the x-axis, in the legend, and in tooltips.

Select or enter the format specification. Use syntax from the Java DecimalFormat class for numeric labels, and syntax from the Java SimpleDateFormat class for date labels.

To enable tooltips, select the mouseOverFlag.

This property is in the Data Format property group.

traceYValueFormat

Sets the numeric format of bar values displayed in the legend and in tooltips.

Select or enter a format. Use syntax from the Java DecimalFormat class. To enable tooltips, select the mouseOverFlag.

This property is in the Data Format property group.

yValueFormat

Sets the numeric format of bar values displayed on bars, in the legend and in tooltips

Select or enter a format. Use syntax from the Java DecimalFormat class. To enable tooltips, select the mouseOverFlag.

This property is in the Data Format property group.

Bar graph: Data Label group

Properties in this group control the labels that are used along the x-axis or in the legend.

Data Label group properties

The group contains the following properties:

• columnDisplayNames
• labelColumnName
• rowLabelVisFlag
• rowNameVisFlag
• traceLabelColumnName

columnDisplayNames

Sets alternate display names for the columns of the data attached to valueTable. Column names are displayed either along the x-axis or in the legend, depending on whether or not the rowSeriesFlag is selected.

This property is in the Data Label property group.

labelColumnName

Sets the label column. By default, the label column is the first non-numeric text column in your data attachment, if there is one. Data from the label column is used to label either the x-axis or the legend, depending on whether rowSeriesFlag is enabled.

If both rowSeriesFlag and rowLabelVisFlag are enabled, data from the label column will be used in the legend.

If rowSeriesFlag is not enabled and both rowLabelVisFlag and xAxisFlag are enabled, data from the label column will appear on the x-axis.

This property is in the Data Label property group.

rowLabelVisFlag

Determines whether or not data from the label column is used in chart labels. (By default, the label column is the first non-numeric column in your data attachment. You can override this default with labelColumnName.)

If both rowSeriesFlag and rowLabelVisFlag are enabled, data from the label column is used in the legend. If rowSeriesFlag is enabled and both rowLabelVisFlag and rowNameVisFlag are disabled, integer row identifiers are used in the legend.

If rowSeriesFlag is not enabled and both rowLabelVisFlag and xAxisFlag are enabled, data from the label column will appear on the x-axis. If rowSeriesFlag, rowLabelVisFlag, and rowNameVisFlag are disabled, and xAxisFlag is enabled, integer row identifiers are used on the x-axis.

This property is in the Data Label property group.

rowNameVisFlag

Determines whether generated row names are used in chart labels. Enable this property if your data attachment has no label column (see labelColumnName). Note that if both rowNameVisFlag and rowLabelVisFlag are enabled, row names and label-column values can appear side-by-side in chart labels.

This property is in the Data Label property group.

traceLabelColumnName

Sets the trace label column. By default, the trace label column is the first non-numeric text column in your data attachment. Data from the label column is used in the legend, if rowSeriesFlag is enabled.

If both rowSeriesFlag and rowLabelVisFlag are enabled, data from the label column will be used in the legend.

This property is in the Data Label property group.

Bar graph: 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.

Bar graph: Interaction group

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

Interaction group properties

The group includes the following properties:

• command
• commandCloseWindowOnSuccess
• commandConfirm
• commandConfirmText
• drillDownColumnSubs
• drillDownSelectMode
• drillDownTarget
• mouseOverFlag
• mouseOverHighlightFlag
• scrollbarMode
• scrollbarSize

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.

commandConfirmText

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.

mouseOverFlag

Select this property to enable tooltips for your bar graph. To display a tooltip, point to a bar or trace marker with your mouse. The tooltip will contain information from your data attachment about that bar or marker.

This property is in the Interaction property group.

mouseOverHighlightFlag

Select this property to enable bar highlighting. To highlight a bar in red, point to the bar.

This property is in the Interaction property group.

scrollbarMode

Select one of the following to set the behavior of the x-axis scroll bar in the graph:

• Never: Default setting. Some bars may get clipped.
• As Needed: Display the scroll bar when there is not enough space to display all of the bars in the plot area. Each bar uses at least minSpacePerBar pixels along the x-axis.
• Always: Display a scroll bar at all times.

This property is in the Interaction property group.

scrollbarSize

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.

This property is in the Interaction property group.

Bar graph: Label group

Properties in this group control the graph’s main label (which defaults to Bar Graph), including text, alignment, color, font, and size.

Label group properties

The group includes 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 Bar Graph.

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.

Bar graph: Layout group

Properties in this group control the layout of bars and axis labels, including alignment and spacing of bars, as well as spacing and rotation of axis labels. You can also specify 3D bars, as well as a horizontal, stacked, or waterfall arrangement for the bars.

Layout group properties

This group contains the following properties:

• barCenterFlag
• barFitFlag
• draw3dDepth
• draw3dFlag
• drawHorizontalFlag
• drawStackedFlag
• drawWaterfallFlag
• horizAxisLabelRotationAngle
• horizAxisMinLabelHeight
• minSpaceBetweenBars
• minSpaceBetweenGroups
• minSpacePerBar

barCenterFlag

Select to center the bars in the plot area. If not selected, the bars will be left or top aligned, depending on drawHorizontalFlag. This property is only used if the barFitFlag is not selected.

This property is in the Layout property group.

barFitFlag

Select to stretch the bars to fit the available space in the plot area. If deselected, the minSpacePerBar property is used to determine the bar width.

This property is in the Layout property group.

draw3dDepth

Sets the depth in pixels of the bars, provided draw3dFlag is enabled.

This property is in the Layout property group.

draw3dFlag

Select to change the display of the bars from 2D to 3D.

This property is in the Layout property group.

drawHorizontalFlag

Select to have the bars in your graph displayed horizontally.

This property is in the Layout property group.

drawStackedFlag

Select to stack each bar group in your graph.

This property is in the Layout property group.

drawWaterfallFlag

Select to stack each bar group in your graph with an offset between bar sections.

This property is in the Layout property group.

horizAxisLabelRotationAngle

Sets the amount of rotation of labels on the horizontal axis. Values range from 0 to 90 degrees. A value of 0 causes the bar graph to automatically pick the optimum angle of rotation (this is the default).

This property is in the Layout property group.

horizAxisMinLabelHeight

Sets the minimum amount of space to reserve for labels on the horizontal axis. If axis labels vary over time, this property can be used to reserve a consistent amount of space to prevent overlapping.

This property is in the Layout property group.

minSpaceBetweenBars

Set the minimum space between bars, in pixels.

This property is in the Layout property group.

minSpaceBetweenGroups

Set the minimum space between bar groups, in pixels.

This property is in the Layout property group.

minSpacePerBar

Sets the minimum width for each bar, in pixels, provided drawHorizontalFlag is disabled.

The default value is 1.

This property is in the Layout property group.

vertAxisMinLabelWidth

Specifies the minimum width in pixels for the vertical axis labels.

This property is in the Layout property group.

waterfallBarConnectFlag

If drawWaterfallFlag is checked, select to connect the bar sections in each bar group.

This property is in the Layout property group.

waterfallTotalBarColor

Specifies the color for the bar that shows the sum of the bar sections in each bar group. See waterfallTotalFlag.

This property is in the Layout property group.

waterfallTotalBarFStyle

Do not use this property.

This property is in the Layout property group.

waterfallTotalBarLabel

Specifies the label for the bar that shows the sum of the bar sections in each bar group. See waterfallTotalFlag.

This property is in the Layout property group.

waterfallTotalFlag

If drawWaterfallFlag is checked, select to display a bar that shows the sum of the bar sections in each bar group.

This property is in the Layout property group.

Bar graph: Legend group

Properties in this group control the visibility, appearance, and content of the graph legend.

Legend group properties

The group contains the following properties:

• legendBgColor
• legendBgGradientFlag
• legendValueVisFlag
• legendVisFlag
• legendWidthPercent

legendBgColor

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

This property is in the Legend property group.

legendBgGradientFlag

Select to display a gradient in the legend background.

This property is in the Legend property group.

legendValueVisFlag

Select to display the numerical values of your data in the legend.

This property is in the Legend property group.

legendVisFlag

Select to display the legend.

This property is in the Legend property group.

legendWidthPercent

Set the percent of the total width of the object used for the legend.

This property is in the Legend property group.

Bar graph: Marker group

Properties in this group control the appearance of trace markers (but see also Bar graph: Trace group).

Marker group properties

The group contains the following properties:

• markDefaultSize
• markScaleMode

markDefaultSize

Sets the size of the markers (see traceProperties) in pixels. Supply an integer value that is between 1 and 18, inclusive.

This property is in the Marker property group.

markScaleMode

Sets the scale mode for trace marks. Select one of the following from the drop down menu:

• No Scale: All marks, across and within traces, are the same size.
• Scale by Trace: Scale marks according to the trace in which they reside, that is, marks in the first trace are the largest, across all traces, and the marks in the last trace are the smallest.
• Scale Within Trace: Scale marks according to the relative order of the data within each trace.

This property is in the Marker property group.

Bar graph: Object group

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

Object group properties

This group contains the following properties:

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

anchor

Select zero or more of Top, Left, Bottom, and Right 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, as with, for example, the graphName property of the Legend visualization object.

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.

transparencyPercent

Sets the transparency of this chart.

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.

Bar graph: Plot Area group

Properties in this group control the appearance of the plot area, the rectangular area that serves as background for the bars (but not for the legend or axis labels; see Bar graph: Background group).

Plot Area group properties

The group includes the following properties:

• gridBgColor
• gridBgGradientFlag
• gridBgImage
• gridColor
• traceFillStyle

gridBgColor

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

This property is in the Plot Area property group.

gridBgGradientFlag

Select to display a gradient in the grid background. Set the color of the grid background with the labelTextAlignX property.

This property is in the Plot Area property group.

gridBgImage

Specify an image (.gif, .jpg, or .png file) to display in the plot area. Select the name of the image file from the drop down menu, or enter the pathname of the 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.

This property is in the Plot Area property group.

gridColor

Sets the color of the horizontal line or lines in the plot area that mark y-axis major divisions. Select the … button and choose a color from the palette. Close the Color Chooser window when you are done.

This property is in the Plot Area property group.

Bar graph: Trace group

Properties in this group control the appearance of trace lines and trace markers (but see also Bar graph: Marker group), including color, style, and line width.

Trace group properties

This group includes the following properties:

• traceFillStyle
• traceProperties
• traceShadowFlag

traceFillStyle

Set traceFillStyle to one of the following fill styles for the area under the trace:

• Solid
• Transparent
• Gradient
• Transparent Gradient
• None

None is the default.

This property is in the Trace property group.

traceProperties

Specify the line color, line style, line width, marker color and marker style of all traces.

In the Object Properties window, double-click on traceProperties in the Property Name field to bring up the Trace Propertiesdialog. In the Trace Properties dialog you can assign attributes to each plotting trace in your graph.

The dialog has six columns of fields:

• Trace: One field for each trace that is currently in the graph. Current settings for each trace are shown.
• Line Color: Select the ellipsis button in the Color column and choose a color from the palette. Close the Color Chooser window.
• Line Style: Select the ellipsis button in the Line Style column and choose a style from the drop down menu. Choose either No Line, Solid, Dotted, Dashed, or Dot Dashed.
• Line Width: Select the ellipsis button in the Line Width column and choose a size from the drop down menu. Choose either Thin, Medium or Thick.
• Marker Color: Select the ellipsis button in the Marker Color column and choose a color from the palette. Close the Color Chooser window.
• Marker Style: Select the ellipsis button in the Marker Style column and choose a style from the drop down menu. Choose either No Marker, Dot, +, *, o, x, Filled Circle, Filled Diamond, Filled Triangle, Filled Square, or Filled Star.

The dialog contains the following buttons:

• Add Trace Property: Click to add a trace property field. The data for the trace does not have to be available yet. You may consider adding and assigning attributes to more traces than your data currently needs for when you have more data to show. It is not necessary to set properties for each trace you currently or subsequently have. This is optional and can be done after additional data is displayed in a subsequent new trace.
• Delete Trace Property: Removes the last trace property field from the Trace Properties dialog.
• OK: Applies values and closes the dialog.
• Apply: Applies values without closing the dialog.
• Reset: Resets all fields to last values applied.
• Clear: Clears all fields. Detaches object from data source (once Apply or OK is selected).
• Cancel: Closes the dialog with last values applied.

This property is in the Trace property group.

traceShadowFlag

Select to enable trace shadows.

This property is in the Trace property group.

Bar graph: X-Axis group

This property group includes a property, xAxisFlag, that controls the visibility of x-axis labels.

xAxisFlag

Select to display x-axis labels.

This property is in the X-Axis property group.

Bar graph: Y-Axis group

Properties in this group control the visibility and range of the y-axis or y-axes, as well as y-axis label formats and y-axis divisions. They also control the visibility of y-axis grid lines (but see also Bar graph: Plot Area group).

Y-Axis group properties

The group includes the following properties:

• traceYAxisFlag
• traceYAxisFormat
• traceYAxisMajorDivisions
• traceYAxisMinorDivisions
• yAxisAutoScaleMode
• yAxisFlag
• yAxisFormat
• yAxisGridMode
• yAxisMajorDivisions
• yAxisMinorDivisions

traceYAxisFlag

Select this property to plot the traces against a y-axis that is separate from the bars. The traceYAxisFlag property is unavailable if the drawHorizontalFlag property is selected. The trace y-axis will be drawn to the right of the plot area.

This property is in the Y-Axis property group.

traceYAxisFormat

Select or enter the numeric format of trace values displayed on the y-axis. Use syntax from the Java DecimalFormat class.

This property is in the Y-Axis property group.

traceYAxisMajorDivisions

Specify the number of major divisions on the trace y-axis. This option only applies if the traceYAxisFlag is on.

This property is in the Y-Axis property group.

traceYAxisMinorDivisions

Specify the number of minor divisions on the trace y-axis. This option only applies if the traceYAxisFlag is on.

This property is in the Y-Axis property group.

yAxisAutoScaleMode

Select one of the following modes to control the y-axis range:

• Off: The yValueMin and yValueMax properties determine the range of the y-axis. This is the default.
• On: The dashboard calculates the y-axis range according to data values being plotted.
• On - Include Min/Max: The dashboard calculates the smallest range (with rounding) that includes yValueMin and yValueMax as well as all plotted points.

This property is in the Y-Axis property group.

yAxisFlag

Select to display the y-axis.

This property is in the Y-Axis property group.

yAxisFormat

Sets the numeric format of values displayed on the y-axis. Select or enter a format. Use syntax from the Java DecimalFormat class.

This property is in the Y-Axis property group.

yAxisGridMode

Controls the alignment of grid lines drawn to the left and right of the bar graph. Select one of the following:

Bar Axis: Align grid lines with the left y-axis. This is the default

Trace Axis: Align with the right y-axis.

Bar and Trace Axis: Draw two sets of grid lines, one aligned with the left y-axis and the other with the right y-axis.

This property is in the Y-Axis property group.

yAxisMajorDivisions

Specify the number of major divisions on the y-axis.

This property is in the Y-Axis property group.

yAxisMinorDivisions

Specify the number of minor divisions on the y-axis.

This property is in the Y-Axis property group.

Google map

The map object displays an embedded Google map in display server clients.

In the Builder, a Google map instance appears as a gray rectangle which you use to set the size and position of the map object, and also configure the latitude, longitude, zoom level and other map object properties through the Builder’s property sheet. The Google map object is rendered only when the display is opened in the display server deployment.

In the Builder and Viewer, the Google map object instance appears as an empty gray rectangle. The Viewer does not support the map object.

Using the map object properties and RTView data attachments, the map object can be populated with marker objects at specific latitude/longitude positions, and also links between the markers. RTView drilldown and command operations can be triggered by clicking on the map object, as well as on its markers and links. Double-click, right-click, and drillDownColumn substitutions are supported as on other table-driven objects. Operations such as zoom, pan and marker selection can be tied to substitutions.

The Thin Client must have internet access to download the Google Maps Javascript API and map data. The Thin Client supports Google Maps in our supported browsers. The Thin Client loads the Google Maps Javascript API to render and manipulate the map. In most cases, a key or license must be obtained from Google for business use of the Google Maps Javascript API. For details, see the Licensing section.

The Object Properties panel organizes Google map object properties into the groups below.

Map graph: Data group

The properties in this group specify how data is displayed in the map object. This group contains the following properties:

• valueTable
• valueTableForLinks

valueTable

To attach data to the map object, right-click Property Value field of the valueTable property and select Attach to Data. The valueTable property can be used to place markers (icons) on the map, at specific locations. The property must be attached to a table that contains one row for each marker. The column names are unimportant, but the column order and type must be as follows.

• column 1 (string): The name
• column 2 (number): The latitude
• column 3 (number): The longitude
• column 4 (string): The icon name/path
• column 5 (integer): The icon height in pixels

The first three columns are required, the others are optional. The marker name must be unique as it is used in drilldowns to indicate the selected (“clicked”) marker, and can also be used to select a marker.

If column 4 (icon name) is omitted or empty, the default Google Maps marker is used. If column 5 (icon height) exists and its value is greater than zero, the value is used to center the icon on the marker’s latitude/longitude position, otherwise the 0,0 pixel of the icon will be placed on the marker’s latitude/longitude position.

valueTableForLinks

Use this property to draw links between markers on the map. The property must be attached to a table that contains one row for each link, with the columns shown below. The column names are unimportant, but the column order and type must be as follows. The first 2 columns are required, the others are optional.

• column 1 (string): The name of marker at start of link
• column 2 (string): The name of marker at end of link
• column 3 (string): The link line color, as a CSS color name or #rrggbb hex value
• column 4 (integer): The link line width
• column 5 (integer): The arrow mode

The first two columns specify the names of the markers at the start and end of the link. These must correspond to the names of markers in the valueTable. If column 3 is omitted, the link color is black. If column 4 is omitted, the link width is 2 pixels. The arrow mode values are 1 (one arrow, pointing to start marker), 2 (one arrow, pointing to end marker) and 3 (two markers, at each end of link). If column 5 is omitted, the default mode of 3 is used.

Map graph: Interaction group

The properties in this group specify interactions in the map object. This group contains the following properties:

• command
• commandCloseWindowOnSuccess
• commandConfirm
• commandConfirmText
• drillDownColumnSubs
• drillDownSelectMode
• drillDownTarget

command

Use the command property to invoke behavior when the user clicks on the map, a marker, or a link.

commandCloseWindowOnSuccess

If selected, the window that initiates a system command will automatically close when the system command is executed successfully. This property only applies to system commands. With data source commands, the window is closed whether or not the command is executed successfully.

For multiple commands, this property is applied to each command individually. Therefore if the first command in the multiple command sequence succeeds, the window closes before the rest of the commands are executed.

commandConfirm

If selected, the command confirmation dialog is enabled. Use the commandConfirmText property to write your own text for the confirmation dialog, otherwise the text from command property will be used.

For multiple commands, if you confirm the execution then all individual commands will be executed in sequence with no further confirmation. If the you cancel the execution, none of the commands in the sequence are executed.

commandConfirmText

Enter command confirmation text directly in the Property Value field. If commandConfirmText is not specified, then the text from command property will be used.

drillDownColumnSubs

The drillDownColumnSubs property is treated the same as for other table-driven objects. If a marker is clicked, the drillDownColumnSubs are set using values from the valueTable row that corresponds to that marker. If a link is clicked, the drillDownColumnSubs are set using values from the valueTableForLinks row that corresponds to that link. In addition, the following predefined substitutions are also set when a drilldown is executed:

• $mapSelLat: The latitude of the map location or marker clicked.
• $mapSelLng: The longitude of the map location or marker clicked.
• $mapLat: The latitude of the map’s current center location.
• $mapLng: The longitude of the map’s current center location.
• $mapZoom: The current zoom level of the map, a value between 0 and 21.

drillDownSelectMode

Control how a drill down display is activated. Select one of the following options:

• Anywhere: A click anywhere on the map triggers the object’s command or drilldown.
• Markers: Only a click on a marker triggers the command or drilldown.
• Links: Only a click on a link triggers the command or drilldown.
• Markers & Links: Only a click on a marker or a link triggers the command or drilldown. (This is the default setting)

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.

Map graph: Map group

The properties in this group specify the position, zoom level and label behavior in the map object. This group contains the following properties:

• labelsZoomThreshold
• latitude
• longitude
• selectedMarker
• zoom

labelsZoomThreshold

If the labelsZoomThreshold property is set to a value greater than zero, a label balloon appears next to each marker when the zoom level is greater than or equal to that value. The label text in the balloon is the name assigned to the marker by the first column in valueTable. A label can be closed by clicking its “x” button. The label reappears if the display is closed and reopened or if the zoom threshold is reached. The default value of labelsZoomThreshold is zero which disables the labels.

latitude

The latitude property specifies the latitude of the point on which the map is to be centered.

longitude

The longitude property specifies the longitude of the point on which the map is to be centered.

selectedMarker

The selectedMarker property specifies the name of the marker to select.

zoom

The zoom property specifies the zoom level of the map, between 0 and 21.

Map graph: Object group

The properties in this group specify the layout in the map object. This group contains the following properties:

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

anchor

Specify where to anchor an object in the display.

The anchor property is applied only when the dimensions of the display are modified, either by editing Background Properties or resizing the window in Layout mode. Select None, or one or more following options:

None	Object not anchored. This is the default.
Top	Anchor top of object at top of display.
Left	Anchor left side of object at left of display.
Bottom	Anchor bottom of object at bottom of display.
Right	Anchor right side of object at right of display.

When a display is resized, the number of pixels between an anchored object and the specified location remain constant. If an object is anchored on opposite sides (that is Top and Bottom or Left and Right), the object will be stretched to fill the available space.

dock

Specify the docking location of an object in the display. Select from the following options:

None	Object is not docked. This is the default.
Top	Dock object at top of display.
Left	Dock object at left of display.
Bottom	Dock object at bottom of display.
Right	Dock object at right of display.
Fill	Dock object in available space remaining in the display after all docked objects are positioned.

If the dimensions of the display are modified, either by editing Background Properties or resizing the window in Layout mode, the properties (objX, objY, objWidth and objHeight) of docked objects will automatically adapt to match the new size of the display.

When multiple objects are docked to the same side of the display, the first object is docked against the side of the display, the next object is docked against the edge of the first object, and so on.

When objects are docked to multiple sides of the display, the order in which objects were added to the display controls docking position. For example, the first object added to the display is docked at the Top and the second object is docked at the Left. Consequently, the first object will fill the entire width of the display and the second object will fill the left side of the display from the bottom of the first object to the bottom of the display.

Objects in a display have the dock property set to Fill, are laid out across a grid in the available space remaining after all docked objects are positioned. By default, the grid has one row and as many columns as there are objects in the display. You can modify the grid in the Background Properties dialog. Once an object is docked, there are some limitations on how that object can be modified.

• Docked objects cannot be dragged or repositioned using objX and objY properties.
• Docked objects cannot be resized using the objWidth or objHeight properties. To resize you must drag on the resize handle.
• Docked objects can only be resized toward the center of the display (for example, if an object is docked at the Top, only its height can be increased by dragging down towards the center of the display).
• Docked objects set to Fill cannot be resized at all.
• Docked objects cannot be moved using Align. Non-docked objects can be aligned against a docked object, but a docked object will not move to align against another object.
• Docked objects are ignored by Distribute.

objHeight

Set height of the object in pixels.

objName

Name given to facilitate object management through the Object List dialog. Select Tools > Object List

objWidth

Set width of the object in pixels.

objX

Set the x-axis position of object.

objY

Set the y-axis position of object.

visFlag

Controls visibility of the object.

Licensing

The Google Maps JavaScript API requires a key or license from Google. For more information, see https://developers.google.com/maps/licensing.

Apama does not provide a key or license for the Google Maps JavaScript API. However, the Thin Client can be configured to download the API using a custom URL that contains specific key or license information obtained from Google.

The custom URL is defined by creating a JavaScript file named apama_extra.js under the APAMA\_WORK\dashboards folder.

The apama_extra.js file contains just one JavaScript statement. For example,

• to specify a URL containing a Google API key, add the following line:

  rtv.customGoogleMapsApiBaseURL = "https://maps.googleapis.com/maps/api/js?key=YOUR_GOOGLE_API_KEY";

• to specify a “Google Maps API for Work” client ID and release version 3.20:

  rtv.customGoogleMapsApiBaseURL = "https://maps.googleapis.com/maps/api/js?client=YOUR_GOOGLE_CLIENT_ID&v=3.20";

The system will try to look for apama_extra.js under the APAMA\_WORK\dashboards folder.

If no apama_extra.js is found, the Thin Client uses the following public URL to download the latest “experimental” version of the API with no key or license information: https://maps.googleapis.com/maps/api/js.

Important:

Please refer to https://developers.google.com/maps/licensing for information about the license key in order to use this Google Map object.

Heat map

Heat maps visualize data by displaying rectangles of various sizes and colors. Complex heat maps display a hierarchy of rectangles, where a rectangle’s level in the hierarchy is represented by its level of geometric nesting within other rectangles.

Heat maps visualize tabular data that contains one or more index columns as well as one or more numerical columns.

You specify the data to be visualized with the valueTable property.

You designate the index columns by specifying a column name or list of column names as the value of the property nodeIndexColumnNames.

If there are two or more non-index numerical columns, the first is the size-data column and the second is the color-data column. If there is only one non-index numerical column, it serves as both the size-data column and the color-data column.

Heat maps with one index column

A heat map with a single index column contains one rectangle for each unique value in the index column.

For a given index value, the area of the corresponding rectangle is proportional to the result of aggregating the values in the size-data column in those rows whose index column contains the index value. You specify the type of aggregation to use (sum, count, average, min, or max) with the sizeValueGroupType property.

In addition, for a given index value, the color of the corresponding rectangle is determined by the result of aggregating the values in the color-data column in those rows whose index column contains the index value (see Mapping from possible aggregation results to colors). You specify the type of aggregation to use (sum, count, average, min, or max) with the colorValueGroupType property.

Important:

Negative aggregated values are treated as 0.

Heat maps with multiple index columns

Heat maps with multiple index columns display a rectangle hierarchy. The number of levels of the hierarchy is the number of columns from the visualized data table that are specified as index columns.

In such a heat map, there is a rectangle at level n for each unique sequence of values from the first n index columns, for every level between 1 and the number of index columns, inclusive.

For a given such sequence of n index values, the area of the corresponding rectangle is proportional to the result of aggregating the values in the size-data column in those rows whose first n index columns contain the values in the sequence. You specify the type of aggregation to use (sum, count, average, min, or max) with the sizeValueGroupType property.

In addition, for a given such sequence of n index values, the color of the corresponding rectangle is determined by the result of aggregating the values in the color-data column in those rows whose first n index columns contain the values in the sequence. You specify the type of aggregation to use (sum, count, average, min, or max) with the colorValueGroupType property.

Important:

Negative aggregated values are treated as 0.

Mapping from possible aggregation results to colors

The possible color-data aggregation results are mapped to colors as follows:

• If colorValueAutoScaleMode is Off
  • The possible aggregation result value specified in colorValueMin is mapped to the color specified by minColor.
  • The possible aggregation result value specified in colorValueMax is mapped to the color specified by maxColor.
• If colorValueAutoScaleMode is On
  • The smallest actual aggregation result for the current display is mapped to the color specified by minColor.
  • The largest actual aggregation result for the current display is mapped to the color specified by maxColor.
• If colorValueAutoScaleMode isOff - Include Min/Max
  • minColor is mapped to the smaller of colorValueMin and the smallest actual aggregation result for the current display.
  • maxColor is larger of colorValueMax and the largest actual aggregation result for the current display.

In all three cases, possible aggregation result values that are in between those mapped to minColor and maxColor are mapped through interpolation, using the colors between minColor and maxColor arranged either in gradient order or color-wheel order (as determined by linearColorMappingFlag).

Drill down displays

Since data in a heat map is aggregated, the value shown in a node might not be the same as the value passed down to a drill down display. For example, suppose your heat map is attached to a table where the index column is Plant and the size column is Units Completed. If you have two rows where the Plant is San Francisco, then the node size is based on the total of the Units Completed values for both rows. However when you drill down, the drill down value for Units Completed will be the value in the first row in the table where the Plant is San Francisco.

Object class name

When a heat map object is selected in the Builder canvas, the Object Class Name that appears at the top of the Object Properties pane is obj_heatmap.

Heat map property groups

The Object Properties panel organizes heat map properties into the following groups:

• Heat map: Background properties
• Heat map: Data group
• Heat map: Data format group
• Heat map: Data Label group
• Heat map: Historian group
• Heat map: Interaction group
• Heat map: Label group
• Heat map: Layout group
• Heat map: Node group
• Heat map: Object group
• Heat map: Quality group

Heat map: Background properties

Properties in this group control the visibility and appearance of the map’s background.

Background properties

The group contains the following properties:

• bgBorderColor
• bgBorderFlag
• bgColor
• bgEdgeWidth
• bgGradientColor2
• bgGradientMode
• bgRaisedFlag
• bgRoundness
• bgShadowFlag
• bgStyle
• 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 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.

bgStyle

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.

Heat map: Data group

Properties in this group control what data appears in the heat map, and how it is mapped to node size and color.

Data group properties

The group contains the following properties:

• colorValueAutoScaleMode
• colorValueDivisor
• colorValueGroupType
• colorValueMax
• colorValueMin
• nodeIndexColumnNames
• sizeValueDivisor
• sizeValueGroupType
• valueTable

colorValueAutoScaleMode

Controls how aggregation results are mapped to colors. See Mapping from possible aggregation results to colors.

This property is in the Data property group.

colorValueDivisor

Divides colorValueMin, colorValueMax, and color-data aggregation results by the specified value.

This property is in the Data property group.

colorValueGroupType

Sets the type of aggregation to use for color data: sum, average, count, min, or max.

This property is in the Data property group.

colorValueMax

Controls how aggregation results are mapped to colors. See Mapping from possible aggregation results to colors.

This property is in the Data property group.

colorValueMin

Controls how aggregation results are mapped to colors. See Mapping from possible aggregation results to colors.

This property is in the Data property group.

nodeIndexColumnNames

Specify a semicolon-delimited list of index column names. If not specified, the first text column in the table attached to valueTable is used as the index column and the first two numeric columns are used as data columns.

This property is in the Data property group.

sizeValueDivisor

sizeValueDivisor Divides size-data aggregation results by the specified value.

.This property is in the Data property group.

sizeValueGroupType

Sets the type of aggregation to use for size data: sum, average, count, min, or max.

This property is in the Data property group.

valueTable

Specifies the data to be visualized. Tabular data attached to the valueTable property must contain one or more index columns and at least one data column. The heat map displays one level of nodes for each index column specified. Use the nodeIndexColumnNames property to specify column names. The first non-index numeric data column is used to control the size of each node. The second non-index numeric data column is used to control the color of the node. If only one data column is specified, it controls both node size and node color.

Data attached to valueTable is aggregated by unique index value.

See Heat map for more information.

This property is in the Data property group.

Heat map: Data format group

Properties in this group control the format of tooltip-displayed data, as well as the mapping from color data to colors.

Data group properties

The group contains the following properties:

• colorValueFormat
• linearColorMappingFlag
• maxColor
• minColor
• sizeValueFormat

colorValueFormat

Sets the numeric format of the color value displayed in tooltips. Use syntax from the Java DecimalFormat class. To enable tooltips, select the mouseOverFlag.

This property is in the Data Format property group.

linearColorMappingFlag

If selected, possible aggregation result values that are in between those mapped to minColor and maxColor are mapped through interpolation, using the colors between minColor and maxColor arranged in gradient order. If deselected, the interpolation uses the colors arranged in color-wheel order.

This property is in the Data Format property group.

maxColor

Sets the maximum color. Possible node colors range from the minColor to maxColor. See Mapping from possible aggregation results to colors.

This property is in the Data Format property group.

minColor

Sets the minimum color. Possible node colors range from the minColor to maxColor. See Mapping from possible aggregation results to colors.

This property is in the Data Format property group.

sizeValueFormat

Sets the numeric format of the size value displayed in tooltips. Use syntax from the Java DecimalFormat class. To enable tooltips, select the mouseOverFlag.

This property is in the Data Format property group.

Heat map: Data Label group

The property in this group, columnDisplayNames, sets alternate display names for column names.

columnDisplayNames

Sets alternate display names for column names in your heat map data. Column names are displayed in tooltips.

This property is in the Data Label property group.

Heat map: 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.

Heat map: Interaction group

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

Interaction group properties

The group includes the following properties:

• command
• commandCloseWindowOnSuccess
• commandConfirm
• commandConfirmText
• drillDownColumnSubs
• drillDownSelectMode
• drillDownTarget
• mouseOverAdditionalColumns
• mouseOverDefaultColumnsFlag
• mouseOverFlag

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

commandConfirmText

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.

mouseOverAdditionalColumns

Select the button to open a dialog to select which columns to include in tooltips and, optionally, specify a date format (or other numeric format) and value divisor (for numeric columns) for each column displayed. In the tool tip, the name and value for each selected column is displayed. If the mouseOverDefaultColumnsFlag is selected, then columns you include are inserted following the default columns in the tooltip. If specified, columnDisplayNames are applied to the columns you selected to include.

This property is in the Interaction property group.

mouseOverDefaultColumnsFlag

Select to include column names and values from valueTable (for index columns and data columns) in tooltips. If columnDisplayNames are specified, they will be applied to all column names.

This property is in the Interaction property group.

mouseOverFlag

Select to enable tooltips for your heat map. To display a tooltip, select the map and point to a node with your mouse. The tooltip will contain information from your data attachment about that node.

This property is in the Interaction property group.

Heat map: Label group

Properties in this group control the graph’s main label (which defaults to Heatmap), including text, alignment, color, font, and size.

Label group properties

The group includes the following properties:

• label
• labelMinTabWidth
• labelTextAlignX
• labelTextAlignY
• labelTextColor
• labelTextFont
• labelTextHeight

label

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

The default is Heatmap.

This property is in the Label property group.

labelMinTabWidth

Sets minimum width of the label tab. This property only applies if labelTextAlignY is set to TabTop.

This property is in the Label property group.

labelTextAlignX

Sets the x-axis 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.

labelTextAlignY

Sets the y-axis position of the chart label (see the label property). Select one of the following from the drop down list:

• Outside Top: Well above the background rectangle
• Top: Just above the background rectangle
• Title Top: Along the top line of the background rectangle
• Tab Top: Just above the background rectangle. Height and width of the tab is dependent on the height and width of the text. Use the labelMinTabWidth property to specify a minimum tab width.
• Inside Top: Inside the top of the background rectangle

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.

Heat map: Layout group

Properties in this group affect the layout of nodes in the heat map.

Layout group properties

This group contains the following properties:

• adjustSizeForLabelFlag
• layoutStyle

adjustSizeForLabelFlag

Select to compress the ratio between the smaller nodes and larger nodes so that the size of smaller nodes is increased to accommodate labels.

This property is in the Layout property group.

layoutStyle

Select from the following layout styles:

• Squarified: Nodes are more square in shape and ordered according to the size of the value from the top-left to the bottom-right.
• Strip: Nodes are more square in shape and ordered according to the order of the rows in the valueTable.
• Slice Horizontal: Nodes are short and wide and ordered according to the order of the rows in the valueTable.
• Slice Vertical: Nodes are tall and narrow and ordered according to the order of the rows in the valueTable.
• Slice Best: Nodes are laid out either like Slice Horizontal or Slice Vertical based on what fits best in the available space.
• Slice Alternate Horizontal: The layout alternates between Slice Horizontal and Slice Vertical based on the node depth. The top level nodes use Slice Horizontal.
• Slice Alternate Vertical: The layout alternates between Slice Horizontal and Slice Vertical based on the node depth. The top level nodes use Slice Vertical.

This property is in the Layout property group.

Heat map: Node group

Properties in this group affect the appearance of nodes in the heat map.

Node group properties

This group contains the following properties:

• nodeBgBorderHighlightFlag
• nodeBgBorderSize
• nodeBgColor
• nodeLabelNestDepth
• nodeLabelTextColor
• nodeLabelTextFont
• nodeLabelTextHeight
• nodeLabelVisFlag

nodeBgBorderHighlightFlag

Select to draw a border highlight around the nodes.

This property is in the Node property group.

nodeBgBorderSize

Specify (in pixels) the size of the border between nodes. If set to -1, the deepest nested level of nodes has a one pixel border and the border increases by two pixels for each level of nesting.

This property is in the Node property group.

nodeBgColor

Select the button and choose from the palette to set the background color for the nodes.

This property is in the Node property group.

nodeLabelNestDepth

Specify the number of nest levels to display node labels. If set to 0, then no labels are displayed.

This property is in the Node property group.

nodeLabelTextColor

Select the button and choose from the palette to set the text color for the node labels.

This property is in the Node property group.

nodeLabelTextFont

Select the font to use for the node labels.

This property is in the Node property group.

nodeLabelTextHeight

Specify the text height for the node labels.

This property is in the Node property group.

nodeLabelVisFlag

Select to display labels on the nodes.

This property is in the Node property group.

Heat map: Object group

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

Object group properties

This group contains the following properties:

• anchor
• dock
• objHeight
• objName
• objWidth
• objX
• objY
• transparencyPercent
• 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, as with, for example, the graphName property of the Legend visualization object.

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.

transparencyPercent

Sets the transparency of this chart.

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.

Heat map: Quality group

Properties in this group allow you to color nodes based on data quality.

Quality group properties

This group contains the following properties:

• valueQuality
• valueQualityColumnName
• valueQualityEnabledFlag
• valueQualityLostData
• valueQualityLostDataColor
• valueQualityNoData
• valueQualityNoDataColor

valueQuality

Specify a value to compare to settings for the valueQualityLostData and valueQualityNoData properties. If the specified valueQuality matches, the selected corresponding valueQuality*Color is applied to all nodes in the heat map.

This property is in the Quality property group.

valueQualityColumnName

Specify a column in the valueTable to compare, per row, to settings for the valueQualityLostData and valueQualityNoData properties. If values in the specified valueQualityColumnName match, the selected corresponding valueQuality*Color is selectively applied to each node in the heat map. If the valueTable contains multiple rows for a single index, the highest data quality value is used.

This property is in the Quality property group.

valueQualityEnabledFlag

If selected, nodes are colored based on data quality.

This property is in the Quality property group.

valueQualityLostData

Enter the lost data value.

This property is in the Quality property group.

valueQualityLostDataColor

Select the button and choose from the palette to set the node color if the value matches the specified valueQualityLostData.

This property is in the Quality property group.

valueQualityNoData

Enter the no data value.

This property is in the Quality property group.

valueQualityNoDataColor

Select the button and choose from the palette to set the node color if the value matches the specified valueQualityNoData.

This property is in the Quality property group.

HTML5 Bar graph

The web bar chart is a pure HTML implementation of an RTView bar chart object. In the RTView thin client, the web bar chart provides an interactive, high performance chart without requiring the Flash player or other browser plug-in.

There is no web bar chart in the Builder palette. Instead, a new property named webChartFlag has been added to the swing (obj_bargraph) bar charts. To enable the web bar chart, you must set the webChartFlag property to true (checked) on a swing bar chart instance. Then, when the display is opened in the thin client in a web compatible browser, the web bar chart appears in place of the swing bar chart. This feature is similar to the webChartFlag property that has been available on the swing trend graph objects in several prior releases.

Properties

The web bar chart supports all of the major properties available in the swing bar charts. However, several minor properties are not supported or have limited support in the web bar chart. See HTML5 bar graph properties.

HTML5 bar graph behavior

• Legend. The legend does not show bar or trace data (y) values. Data values are only shown in the mouseover tooltips (if mouseOverFlag = 1). Labels longer than 200 pixels are wrapped in the legend, and labels longer than 150 pixels are clipped in the tooltip. The width and height of the legend is different between the bar chart implementations. Bar width and spacing differs slightly between the chart implementations.
• Bar values. The web chart automatically selects a text color and shadow to contrast with the corresponding bar, ignoring barValueTextColor.
• Y axis autoscaling. Given the same y data values, the web bar chart may choose a different value range for the y axes in autoscale mode as compared to the older charts. Also the format and number of y axis labels shown on the web chart are determined automatically, unlike the swing bar chart where various yAxis* properties are used.
• X axis label rotation threshold, spacing, and count differ between implementations. Also the web chart may skip labels on some bar groups to avoid crowded or overlapping labels.
• Zooming. You can zoom in on the chart’s X axis (Y axis if drawHorizontalFlag = 1) by dragging across the plot area.
• Reset button. If you change the chart’s visible range, via the scrollbar or by dragging the cursor to perform a zoom, then a button labeled Reset will appear in the upper left corner of the plot area. A click on this button will reset the x axis to its original settings.
• Scrolling. If the mouse is moved below the bottom of the chart while dragging the scrollbar, the scrolling will stop. This is unlike the behavior of other rtview objects, which will continue to scroll until the mouse button is released.
• The perspective in 3D mode differs (above-right perspective in swing chart, center perspective in web chart).
• The waterfall total bar (if visible) is not labeled on the X axis of the web chart.
• The web chart plots each trace point in the center of the corresponding bar group, while the swing chart plots each trace point on the center of each corresponding bar.

HTML5 bar graph issues

• The max zoom-in level is one bar group. For example if there are 2 bars in each bar group, there will usually be at least 2 bars visible regardless of how far you zoom in. But, if the user intentionally zooms in on blank space between bars it is possible to end up with no visible bars.
• After zooming or scrolling, the y axis range (x axis in horizontal mode) may change to reflect the range of values of the visible bars. This is designed behavior.
• If draw3dFlag is set, dragging the scrollbar will also initiate a zoom-in, as though the user dragged in the plot area. This can be avoided by scrolling via clicks on the scrollbar arrows, instead.
• Scrolling performance on a chart with many bars may be sluggish, depending on the vintage of the browser and host.
• The chart’s tooltip may overlap the Reset button making it difficult to click the button. Moving the mouse a bit will correct this problem.
• Performance is affected by the number of bars, traces, trace points, use of trace line shadows, bar/trace fill, and other properties. Performance is also affected by the browser and version, and the CPU speed of the client host system. On a touch interface, a swipe will scroll the chart left or right.
• On a touch interface, a pinch-open gesture in the plot area will zoom the chart’s range *in* to the pinched range. A pinch-close gesture will zoom out to the pinched range. A left/right swipe (or an up/down swipe in horizontal mode) will scroll the chart. The scrollbar (if visible) cannot be dragged reliably on a touch device, but the scrollbar arrow keys can be tapped.

HTML5 bar graph properties

Some chart properties are hidden in the builder if webChartFlag is checked. An “n/a” after the property means the feature is not supported, “auto” means the value is assigned automatically and is not configurable, otherwise the assumed value of the property is shown.

Property	Value
traceValueAlarmStatusTable	n/a (alert coloring & styling of trace markers is not supported, only supported for bars)
valueHighAlarmMarkColor	n/a
valueHighAlarmMarkStyle	n/a
valueHighWarningMarkColor	n/a
valueHighWarningMarkStyle	n/a
valueLowAlarmMarkColor	n/a
valueLowAlarmMarkStyle	n/a
valueLowWarningMarkColor	n/a
valueLowWarningMarkStyle	n/a
bgEdgeWidth	1
bgGradientMode	n/a
bgGradientColor2	n/a
bgRaisedFlag	false
bgShadowFlag	false
bgStyle	Rectangle
borderPixels	n/a
barImage	n/a
barValueTextColor	auto
barValueTextFont	auto
barValueTextHeight	auto
labelColumnFormat	auto
traceYValueFormat	auto
yValueFormat	auto
rowLabelVisFlag	true
rowNameVisFlag	false
mouseOverHighlightFlag	true
scrollbarSize	auto
scrollbarStartAtMaxFlag	true
labelMinTabWidth	n/a
barCenterFlag	true
barFitFlag	true
horizAxisLabelRotationAngle	auto
horizAxisMinLabelHeight	n/a
vertAxisMinLabelWidth	n/a
legendBgGradientMode	n/a
legendBgGradientColor2	None
legendWidthPercent	auto
legendValueVisFlag	false (bar value is shown in tooltip, not legend)
outlineColor	n/a
markDefaultSize	auto
markScaleMode	No scale
transparencyPercent	0
gridBgGradientMode	None
gridBgGradientColor2	n/a
gridBgImage	n/a
traceYAxisFormat	auto
traceYAxisMajorDivisions	auto
traceYAxisMinorDivisions	auto
yAxisFormat	auto
yAxisGridMode	Bar Axis
yAxisMajorDivisions	auto
yAxisMinorDivisions	auto
traceProperties.MarkerColor	n/a (uses trace color)

Legend

The legend visualization object is useful for displaying a legend that is too lengthy for the built-in legends of the graph objects.

You can use a legend visualization object in conjunction with a bar graph, pie graph, radar graph, or XY graph.

The legend displays information from the graph object to which it is connected. Connect a legend to a graph object by setting the legend’s graphName property to the value of the graph’s objName property. Set up all formatting for the legend data in the graph object that it will reflect.

When this visualization object is selected in the Builder canvas, the Object Class Name that appears at the top of the Object Properties pane is obj_legend.

The Object Properties panel organizes legend properties into the groups below.

Legend: Background group

Properties in this group control the visibility and appearance of the legend’s outer rectangle, which serves as the background of both the label (see label) and the legend’s inner rectangle (see Legend: Legend group).

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.

Legend: Data group

The property in this group, graphName, controls what data appears in the graph.

graphName

To attach your legend to a given graph object, set this property to the value objName for the given graph object.

This property is in the Data property group.

Legend: 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.

Legend: Interaction group

Properties in this group configure interaction between the end user and the graph, including commands and drill down interactions.

Interaction group properties

The group includes the following properties:

• command
• commandCloseWindowOnSuccess
• commandConfirm
• confirmText
• 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.

drillDownTarget

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

This property is in the Interaction property group.

Legend: Label group

Properties in this group control the legend’s main label (which defaults to Legend), including text, alignment, color, font, and size.

Label group properties

The group includes 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 Legend.

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.

Legend: Legend group

Properties in this group control the visibility, appearance, and content of the legend.

Legend group properties

The group contains the following properties:

• legendBgColor
• legendBgGradientFlag
• legendVisFlag
• legendTextColor
• legendTextFont
• legendTextHeight
• legendValueMinSpace
• legendValueVisFlag
• legendVisFlag

legendBgColor

Sets the fill color of the legend inner rectangle. The inner rectangle is smaller than and in front of the legend’s background rectangle (see bgColor). The chart label (see label) lies outside of the inner rectangle; the rest of the legend text lies within the inner rectangle.

To set the color, select the … button and choose a color from the palette to set the background color of the legend. Close the Color Chooser window when you are done.

This property is in the Legend property group.

legendBgGradientFlag

Select to display a gradient in the legend inner rectangle (see legendBgColor).

This property is in the Legend property group.

legendVisFlag

Select to display the legend.

This property is in the Legend property group.

legendTextColor

Sets the color of the legend text (other than the chart label; see label and labelTextColor). To set the 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 Legend property group.

legendTextFont

Sets the font of the legend text (other than the chart label: see label and labelTextFont). Select an item from the drop down menu.

This property is in the Legend property group.

legendTextHeight

Specifies the point size of the legend text (other than the chart label; see label and labelTextHeight)

This property is in the Legend property group.

legendValueMinSpace

Specifies the minimum number of pixels between values and labels in the legend. This property applies only if legendValueVisFlag is enabled.

This property is in the Legend property group.

legendValueVisFlag

Select to display the numerical values of your data in the legend.

This property is in the Legend property group.

legendVisFlag

Select to display the legend.

This property is in the Legend property group.

Legend: Object group

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

Object group properties

• anchor
• dock
• objHeight
• objName
• objWidth
• objX
• objY
• transparencyPercent
• 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.

transparencyPercent

Sets the transparency of this chart.

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.

Pie graph

Pie graphs visualize one or more numerical columns from tabular data. A typical attachment has either one row and multiple numeric columns, or multiple rows with one numeric column and one non-numeric column (whose values are used as graph labels that uniquely identify each row).

A pie graph can visualize data in either of two ways:

• Column series: The first numeric column of the visualized data is used to populate the wedges in the pie. Each wedge corresponds to a row and displays that row’s relative value.
• Row series: The first row of the visualized data is used to populate the wedges in the pie. Each wedge corresponds to a numerical column and displays that column’s relative value.

Use the valueTable property to attach data to a pie graph. Use the rowSeriesFlag property to specify row series or column series visualization.

When a pie graph is selected in the Builder canvas, the Object Class Name that appears at the top of the Object Properties pane is obj_pie.

The Object Properties panel organizes pie graph properties into the groups below.

Pie graph: Background group

Properties in this group control the visibility and appearance of the portion of the graph that serves as the background of both the pie and the legend.

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.

Pie graph: Column group

This group contains one property, columnsToHide, which controls which data-attachment columns are excluded from being used for charted data or labels.

columnsToHide

Specify columns from the data attachment to exclude from being used for charted data or labels.

Data from the labelColumnName column will be used for labels even if that column name is also specified in the columnsToHide property.

Columns specified in the columnsToHide property can still be used in the drillDownColumnSubs property.

This property is in the Column property group.

Pie graph: Data group

Properties in this group control what data appears in the graph, and whether the data appears in column series or row series form.

Data group properties

The group contains the following properties:

• rowSeriesFlag
• valueTable

rowSeriesFlag

This property controls whether row or column data populates the graph:

• When the rowSeriesFlag checkbox is not selected, the first numeric column from your data attachment is used to populate the wedges in the pie. Each wedge corresponds to a row in that column and displays that row’s relative value.
• If the rowSeriesFlag checkbox is selected, the first row from your data attachment is used to populate the wedges in the pie. Each wedge corresponds to a numerical column in that row and displays that column’s relative value. Column names are used in the legend.

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. A typical attachment has either multiple rows, one numeric column, and one non-numeric column, or one row and multiple numeric columns.

The rowSeriesFlag property controls how row and column data populates the graph:

• When the rowSeriesFlag checkbox is not selected, the first numeric column from your data attachment is used to populate the wedges in the pie. Each wedge corresponds to a row in that column and displays that row’s relative value.
• If the rowSeriesFlag checkbox is selected, the first row from your data attachment is used to populate the wedges in the pie. Each wedge corresponds to a numerical column in that row and displays that column’s relative value. Column names are used in the legend.

This property is in the Data property group.

Pie graph: Data Format group

Properties on this group control the format of displayed wedge values as well as numerical and date labels.

Data Format group properties

The group includes the following properties:

• labelColumnFormat
• valueFormat

labelColumnFormat

Sets the format of numeric or date labels displayed in the legend, and in tooltips.

Select or enter the format specification. Use syntax from the Java DecimalFormat class for numeric labels, and syntax from the Java SimpleDateFormat class for date labels.

To enable tooltips, select the mouseOverFlag.

This property is in the Data Format property group.

valueFormat

Select or enter the numeric format of wedge values displayed on wedges, in the legend and in tooltips. Use syntax from the Java DecimalFormat class. To enable tooltips, select the mouseOverFlag.

This property is in the Data Format property group.

Pie graph: Data Label group

Properties in this group control the labels that are in the legend and in tooltips.

Data Label properties

The group contains the following properties:

• columnDisplayNames
• labelColumnName
• rowLabelVisFlag
• rowNameVisFlag

columnDisplayNames

Set alternate display names for the columns of the data attached to valueTable. Column names are displayed in the legend, if rowSeriesFlag is selected.

This property is in the Data Label property group.

labelColumnName

Sets the label column. By default, the label column is the first non-numeric text column in your data attachment, if there is one. Note that the column apama.instanceID (contained in all DataView instance tables) is a non-numerical text column.

Data from the label column is used to label the legend, if rowSeriesFlag is disabled. Data from the label column is used in tooltips, if rowSeriesFlag and mouseOverFlag are enabled.

This property is in the Data Label property group.

rowLabelVisFlag

Determines whether or not data from the label column is used in the chart legend, when rowSeriesFlag is disabled. See labelColumnName. If rowLabelVisFlag is disabled, integer row identifiers are used in the legend.

This property is in the Data Label property group.

rowNameVisFlag

If your data attachment has no label column (see labelColumnName), select this property to use generated row names in the legend when the rowSeriesFlag is not selected.

This property is in the Data Label property group.

Pie graph: 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.

Pie graph: Interaction group

Properties in this group control various forms of interaction between the end user and the graph, including configuring command, drill down, and tooltip interactions.

Interaction group properties

The group includes the following properties:

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

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.

mouseOverFlag

Select this property to enable tooltips for your pie graph. To display a tooltip, point to a pie wedge with your mouse. The tooltip will contain information from your data attachment about that pie wedge.

This property is in the Interaction property group.

Pie graph: Label group

Properties in this group control the graph’s main label (which defaults to Pie Graph), including text, alignment, color, font, and size.

Label group properties

The group includes 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 Pie Graph.

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.

Pie graph: Legend group

Properties in this group control the visibility, appearance, and content of the graph legend.

Legend group properties

The group contains the following properties:

• legendBgColor
• legendBgGradientFlag
• legendValueVisFlag
• legendVisFlag
• legendWidthPercent

legendBgColor

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

This property is in the Legend property group.

legendBgGradientFlag

Select to display a gradient in the legend background.

This property is in the Legend property group.

legendValueVisFlag

Select to display the numerical values of your data in the legend.

This property is in the Legend property group.

legendVisFlag

Select to display the legend.

This property is in the Legend property group.

legendWidthPercent

Set the percent of the total width of the object used for the legend.

This property is in the Legend property group.

Pie graph: Object group

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

Object group properties

This group contains the following properties:

• anchor
• dock
• objHeight
• objName
• objWidth
• objX
• objY
• transparencyPercent
• 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.

transparencyPercent

Sets the transparency of this chart.

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.

Pie graph: Wedge group

Properties in this group control the appearance of the pie’s wedges, including thickness, gradient effect, and color.

Wedge group properties

This group contains the following properties:

• pieThickness
• wedgeGradientFlag
• wedgeProperties

pieThickness

Sets the thickness of the wedges in pixels.

This property is in the Wedge property group.

wedgeGradientFlag

Select the box to enable the gradient effect in the wedges.

This property is in the Wedge property group.

wedgeProperties

Use this property to assign a color to each wedge in a pie graph. In the Object Properties window, double-click on wedgeProperties in the Property Name field to bring up the Wedge Properties dialog.

The Wedge Properties dialog has two columns of fields:

• Wedge: Each wedge from the pie graph is listed.
• Color: Select the ellipsis button in the and choose a color from the palette. Close the Color Chooser window.

The dialog has the following buttons:

• Add Wedge Property: Click to add a wedge entry field. The data for the wedge does not have to be available yet. You may consider adding and assigning attributes to more wedges than your data currently needs for when you have more data to show.
• Delete Wedge Property: Removes the last wedge entry field from the Wedge Properties dialog.
• OK: Applies values and closes the dialog.
• Apply: Applies values without closing the dialog.
• Reset: Resets all fields to last values applied.
• Clear: Clears all fields. Detaches object from data source (once Apply or OK is selected).
• Cancel: Closes the dialog with last values applied.

This property is in the Wedge property group.

HTML5 Pie graph

The HTML5 pie chart is an HTML implementation of an swing pie chart object. In the thin client, the HTML5 pie chart provides an interactive, high performance pie chart without requiring the Flash player or other browser plug-ins. A new property named webChartFlag has been added to the swing (obj_pie) pie charts. You can enable the HTML5 pie chart object by selecting the webChartFlag property, which is available on obj_pie object.When the display is opened in the thin client in a web compatible browser, the HTML5 pie chart appears in place of swing pie chart.

HTML5 pie graph behavior

There are some behavioral differences between the swing pie chart and the HTML5 pie chart:

• Stretching. Unlike the swing pie chart (obj_pie), the HTML5 pie chart does not stretch to an oval shape to fill the available space. Instead, the HTML5 pie chart remains round, with its diameter determined by the smaller dimension.
• Slice Order. In the swing pie chart, the bottom edge of the first wedge/slice corresponding to the first row in the valueTable is drawn at 0 degrees (that is, its bottom edge is horizontal). The slices for subsequent rows follow in counter-clockwise order. In the HTML5 pie chart, the first slice is drawn at 90 degrees, so its left edge is vertical. The slices for subsequent rows follow in clockwise order.
• Tooltip. The tooltip on the HTML5 pie chart shows the label and value for a wedge, but does not show its computed percentage.

HTML5 pie graph properties

The HTML5 pie chart supports all of the major properties available in the swing pie charts. However, several minor properties are not supported or have limited support in the HTML5 pie chart. The following properties are not supported by HTML5 pie chart:

• Background group
  • bgEdgeWidth
  • bgGradientColor2
  • borderPixels
• Data Format group
  • labelColumnFormat
• Data Label group
  • rowLabelVisFlag
  • rowNameVisFlag
• Label group
  • labelMinTabWidth
• Legend group
  • legendBgGradientMode
  • legendBgGradientColor2
  • legendWidthPercent
  • legendValueVisFlag
  • legendPercentVisFlag
  • outlineColor
• Object group
  • transparencyPercent

Radar graph

Radar graphs visualize tabular data that has one or more numerical columns. Typically, the visualized data also has one non-numerical column whose values are used as graph labels that uniquely identify each row.

A radar graph can visualize data in either of two ways:

• Row series visualization: The graph displays one radial grid line for each numeric column of the visualized data, and one trace for each row of the data. A given trace intersects a given radial grid line at a distance (from the graph’s center) that is proportional to the value of the grid line’s corresponding column for the trace’s corresponding row. A marker is displayed at the point of intersection.
• Column series visualization: The graph displays one radial grid line for each row of your data attachment, and one trace for each numeric column of your data attachment. A given trace intersects a given radial grid line at a distance (from the graph’s center) that is proportional to the value of the trace’s corresponding column for the grid line’s corresponding row. A marker is displayed at the point of intersection.

Use the valueTable property to attach data to a radar graph. Use the rowSeriesFlag property to specify row series or column series visualization.

When a radar graph is selected in the Builder canvas, the Object Class Name that appears at the top of the Object Properties pane is obj_radar.

The Object Properties panel organizes radar graph properties into the groups below.

Radar graph: Alert group

Properties in this group allow you to specify changes in the appearance of trace lines and markers that signal changes in the status of specified data elements. You can specify threshold values (see valueHighAlarm, valueHighWarning, valueLowAlarm, and valueHighWarning) or attach a data table to valueAlarmStatusTable that indicates the status of each element of the table that is attached to valueTable.

Alert group properties

This group includes the following properties:

• valueAlarmStatusTable
• valueHighAlarm
• valueHighAlarmEnabledFlag
• valueHighAlarmLineVisFlag
• valueHighAlarmMarkColor
• valueHighAlarmMarkStyle
• valueHighWarning
• valueHighWarningEnabledFlag
• valueHighWarningLineVisFlag
• valueHighWarningMarkColor
• valueHighWarningMarkStyle
• valueLowAlarm
• valueLowAlarmEnabledFlag
• valueLowAlarmLineVisFlag
• valueLowAlarmMarkColor
• valueLowAlarmMarkStyle
• valueLowWarning
• valueLowWarningEnabledFlag
• valueLowWarningLineVisFlag
• valueLowWarningMarkColor
• valueLowWarningMarkStyle

valueAlarmStatusTable

Attach an alarm table containing status indexes to this property in order to enable rule based alarm statuses for trace markers. The table attached to valueAlarmStatusTable must have the same number of rows and columns as valueTable. For each data element in valueTable, the status index at the corresponding position in valueAlarmStatusTable is used to set the alarm status of the marker that represents the data element.

Following are the valid indexes are:

• 0: Use normal marker color and style. See traceProperties.
• 1: Use low alarm marker color and style. See valueLowAlarmMarkColor and valueLowAlarmMarkStyle.
• 2: Use low warning marker color and style. See valueLowWarningMarkColor and valueLowWarningMarkStyle.
• 3: Use high warning marker color and style. See valueHighWarningMarkColor and valueHighWarningMarkStyle.
• 4: Use high alarm marker color and style. See valueHighAlarmMarkColor and valueHighAlarmMarkStyle.
• -1: Determine marker color and style by comparing the value to the enabled alarm thresholds. See valueHighAlarm, valueHighWarning, valueLowAlarm, and valueLowWarning.

If no data is attached to valueAlarmStatusTable, the alarm status for a trace marker is determined by comparing the marker’s value to the enabled thresholds. See valueHighAlarm, valueHighWarning, valueLowAlarm, and valueLowWarning.

This property is in the Alert property group.

valueHighAlarm

Specifies the threshold value used by valueHighAlarmLineVisFlag, valueHighAlarmMarkColor, and valueHighAlarmMarkStyle.

This property is in the Alert property group.

valueHighAlarmEnabledFlag

Select to enable the high alarm threshold. See valueHighAlarm.

This property is in the Alert property group.

valueHighAlarmLineVisFlag

Select to display a dashed line at the high alarm threshold. The color of the line is set to valueHighAlarmMarkColor. This line is displayed only if valueHighAlarmEnabledFlag is selected.

This property is in the Alert property group.

valueHighAlarmMarkColor

When a trace marker’s value is greater than or equal to valueHighAlarm, the marker changes to valueHighAlarmMarkColor and valueHighWarningMarkStyle, provided valueHighAlarmEnabledFlag is selected and no data is attached to valueAlarmStatusTable.

If data is attached to valueAlarmStatusTable, a marker changes to valueHighAlarmMarkColor and valueHighAlarmMarkStyle when the marker’s corresponding element in the attached alarm status table is 4.

If data is attached to valueAlarmStatusTable, and the marker’s corresponding element in the attached alarm status table is -1, marker color and style behave as if no data were attached to valueAlarmStatusTable.

This property is in the Alert property group.

valueHighAlarmMarkStyle

When a trace marker’s value is greater than or equal to valueHighAlarm, the marker changes to valueHighAlarmMarkColor and valueHighAlarmMarkStyle, provided valueHighAlarmEnabledFlag is selected and no data is attached to valueAlarmStatusTable.

If data is attached to valueAlarmStatusTable, a marker changes to valueHighAlarmMarkColor and valueHighAlarmMarkStyle when the marker’s corresponding element in the attached alarm status table is 4.

If data is attached to valueAlarmStatusTable, and the marker’s corresponding element in the attached alarm status table is -1, marker color and style behave as if no data were attached to valueAlarmStatusTable.

This property is in the Alert property group.

valueHighWarning

Specifies the threshold value used by valueHighWarningLineVisFlag, valueHighWarningMarkColor, and valueHighWarningMarkStyle.

This property is in the Alert property group.

valueHighWarningEnabledFlag

Select to enable the high warning threshold. See valueHighWarning.

This property is in the Alert property group.

valueHighWarningLineVisFlag

Select to display a dashed line at the high warning threshold. The color of the line is set to valueHighWarningMarkColor. This line is displayed only if valueHighWarningEnabledFlag is selected.

This property is in the Alert property group.

valueHighWarningMarkColor

When a trace marker’s value is greater than or equal to valueHighWarning but less than valueHighAlarm, the marker changes to valueHighWarningMarkColor and valueHighAlarmMarkStyle, provided valueHighAlarmEnabledFlag is selected and no data is attached to valueAlarmStatusTable.

If data is attached to valueAlarmStatusTable, a marker changes to valueHighWarningMarkColor and valueHighWarningMarkStyle when the marker’s corresponding element in the attached alarm status table is 3.

If data is attached to valueAlarmStatusTable, and the marker’s corresponding element in the attached alarm status table is -1, marker color and style behave as of no data were attached to valueAlarmStatusTable.

This property is in the Alert property group.

valueHighWarningMarkStyle

When a trace marker’s value is greater than or equal to valueHighWarning but less than valueHighAlarm, the marker changes to valueHighWarningMarkColor and valueHighWarningMarkStyle, provided valueHighWarningEnabledFlag is selected and no data is attached to valueAlarmStatusTable.

If data is attached to valueAlarmStatusTable, a marker changes to valueHighWarningMarkColor and valueHighWarningMarkStyle when the marker’s corresponding element in the attached alarm status table is 3.

If data is attached to valueAlarmStatusTable, and the marker’s corresponding element in the attached alarm status table is -1, marker color and style behave as of no data were attached to valueAlarmStatusTable.

This property is in the Alert property group.

valueLowAlarm

Specifies the threshold value used by valueLowAlarmLineVisFlag, valueLowAlarmMarkColor, and valueLowWarningMarkStyle.

This property is in the Alert property group.

valueLowAlarmEnabledFlag

Select to enable the low alarm threshold. See valueLowAlarm.

This property is in the Alert property group.

valueLowAlarmLineVisFlag

Select to display a dashed line at the low alarm threshold. The color of the line is set to valueLowAlarmMarkColor. This line is displayed only if valueLowAlarmEnabledFlag is selected.

This property is in the Alert property group.

valueLowAlarmMarkColor

When a trace marker’s value is less than or equal to valueLowAlarm, the marker changes to valueLowAlarmMarkColor and valueLowAlarmMarkStyle, provided valueLowAlarmEnabledFlag is selected and no data is attached to valueAlarmStatusTable.

If data is attached to valueAlarmStatusTable, a marker changes to valueLowAlarmMarkColor and valueLowAlarmMarkStyle when the marker’s corresponding element in the attached alarm status table is 1.

If data is attached to valueAlarmStatusTable, and the marker’s corresponding element in the attached alarm status table is -1, marker color and style behave as of no data were attached to valueAlarmStatusTable.

This property is in the Alert property group.

valueLowAlarmMarkStyle

When a trace marker’s value is less than or equal to valueLowAlarm, the marker changes to valueLowAlarmMarkColor and valueLowAlarmMarkStyle, provided valueLowAlarmEnabledFlag is selected and no data is attached to valueAlarmStatusTable.

If data is attached to valueAlarmStatusTable, a marker changes to valueLowAlarmMarkColor and valueLowAlarmMarkStyle when the marker’s corresponding element in the attached alarm status table is 1.

If data is attached to valueAlarmStatusTable, and the marker’s corresponding element in the attached alarm status table is -1, marker color and style behave as of no data were attached to valueAlarmStatusTable.

This property is in the Alert property group.

valueLowWarning

Specifies the threshold value used by valueLowWarningLineVisFlag, valueLowWarningMarkColor, and valueLowWarningMarkStyle.

This property is in the Alert property group.

valueLowWarningEnabledFlag

Select to enable the low warning threshold. See valueLowWarning.

This property is in the Alert property group.

valueLowWarningLineVisFlag

Select to display a dashed line at the low warning threshold. The color of the line is set to valueLowWarningMarkColor. This line is displayed only if valueLowWarningEnabledFlag is selected.

This property is in the Alert property group.

valueLowWarningMarkColor

When a trace marker’s value is less than or equal to valueLowWarning but greater than valueLowAlarm, the marker changes to valueLowWarningMarkColor and valueLowAlarmMarkStyle, provided valueLowWarningEnabledFlag is selected and no data is attached to valueAlarmStatusTable.

If data is attached to valueAlarmStatusTable, a marker changes to valueLowWarningMarkColor and valueLowWarningMarkStyle when the marker’s corresponding element in the attached alarm status table is 2.

If data is attached to valueAlarmStatusTable, and the marker’s corresponding element in the attached alarm status table is -1, marker color and style behave as of no data were attached to valueAlarmStatusTable.

This property is in the Alert property group.

valueLowWarningMarkStyle

When a trace marker’s value is less than or equal to valueLowWarning but greater than valueLowAlarm, the marker changes to valueLowWarningMarkColor and valueLowWarningMarkStyle, provided valueLowWarningEnabledFlag is selected and no data is attached to valueAlarmStatusTable.

If data is attached to valueAlarmStatusTable, a marker changes to valueLowWarningMarkColor and valueLowWarningMarkStyle when the marker’s corresponding element in the attached alarm status table is 2.

If data is attached to valueAlarmStatusTable, and the marker’s corresponding element in the attached alarm status table is -1, marker color and style behave as of no data were attached to valueAlarmStatusTable.

This property is in the Alert property group.

Radar graph: Background group

Properties in this group control the visibility and appearance of the portion of the graph that serves as the background of both the plot area and legend.

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.

Radar graph: Column group

This group contains one property, columnsToHide, which controls which data-attachment columns are excluded from being used for plotted data or labels.

columnsToHide

Specify columns from the data attachment to exclude from being used for plotted data or labels. Data from the labelColumnName column will be used for labels even if that column name is also specified in the columnsToHide property. Columns specified in the columnsToHide property can still be used in the drillDownColumnSubs property.

This property is in the Column property group.

Radar graph: Data group

Properties in this group control what data appears in the graph, as well as whether the data appears in column series or row series form.

The group contains the following properties:

• rowSeriesFlag
• valueDivisor
• valueDivisor
• valueMax
• valueMin
• valueTable

rowSeriesFlag

The rowSeriesFlag property controls how data populates the graph:

• If the rowSeriesFlag is enabled, the graph displays one radial grid line for each numeric column of your data attachment (see valueTable), and one trace for each row of your data attachment. A given trace intersects a given radial grid line at a distance (from the graph’s center) that is proportional to the value of the grid line’s corresponding column for the trace’s corresponding row. A marker is displayed at the point of intersection.

If the attachment has a label column (see labelColumnName) and rowLabelVisFlag is selected, values from that column are used as legend labels. If radialAxisLabelVisFlag is enabled, the numerical column names appear as labels along the radial axis.

• If the rowSeriesFlag is disabled, the graph displays one radial grid line for each row of your data attachment (see valueTable), and one trace for each numeric column of your data attachment. A given trace intersects a given radial grid line at a distance (from the graph’s center) that is proportional to the value of the trace’s corresponding column for the grid line’s corresponding row. A marker is displayed at the point of intersection.

If the attachment has a label column (see labelColumnName) and both rowLabelVisFlag and radialAxisLabelVisFlag are enabled, values from that column appear as labels along the radial axis. Numerical column names are used as legend labels.

This property is in the Data property group.

valueDivisor

Specifies a value by which to divide data table values in order to arrive at the plotted value for this chart.

The default value is 1. If this property is set to 0, the dashboard uses 1 as the divisor.

This property is in the Data property group.

valueMax

The valueMin and valueMax properties control the range of the value axis if valueAxisAutoScaleMode is set to Off. In this case, the chart origin (the bottom of the value axis) is labeled with valueMin. The intersection of the value axis and the radial axis (the top of the value axis) is labeled with valueMax.

In addition, if valueAxisAutoScaleMode is set to On - Include Min/Max, the dashboard calculates the smallest x-axis range that includes both valueMin and valueMax as well as all plotted points.

This property is in the Data property group.

valueMin

The valueMin and valueMax properties control the range of the value axis if valueAxisAutoScaleMode is set to Off. In this case, the chart origin (the bottom of the value axis) is labeled with valueMin. The intersection of the value axis and the radial axis (the top of the value axis) is labeled with valueMax.

In addition, if valueAxisAutoScaleMode is set to On - Include Min/Max, the dashboard calculates the smallest x-axis range that includes both valueMin and valueMax as well as all plotted points.

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.

The attached data table should have one or more numerical columns. Typically, the data attachment also has one non-numerical column, the label column (see labelColumnName) whose values uniquely identify each row (that is, no two rows of the table have the same value for the label column).

The rowSeriesFlag property controls how data populates the graph:

• If the rowSeriesFlag is enabled, the graph displays one radial grid line for each numeric column of your data attachment, and one trace for each row of your data attachment. A given trace intersects a given radial grid line at a distance (from the graph’s center) that is proportional to the value of the grid line’s corresponding column for the trace’s corresponding row. A marker is displayed at the point of intersection.

If the attachment has a label column and rowLabelVisFlag is selected, values from that column are used in the legend in order to identify each trace. If radialAxisLabelVisFlag is enabled, the numerical column names appear as labels along the radial axis.

• If the rowSeriesFlag is disabled, the graph displays one radial grid line for each row of your data attachment, and one trace for each numeric column of your data attachment. A given trace intersects a given radial grid line at a distance (from the graph’s center) that is proportional to the value of the trace’s corresponding column for the grid line’s corresponding row. A marker is displayed at the point of intersection.

If the attachment has a label column and both rowLabelVisFlag and radialAxisVisFlag are enabled, values from that column appear as labels along the radial axis. Numerical column names are used in the legend in order to identify each trace.

This property is in the Data property group.

Radar graph: Data Format group

Properties on this group control the format of displayed values as well as numerical and date labels.

The group includes the following properties:

• labelColumnFormat
• valueFormat

labelColumnFormat

Sets the format of numeric or date labels displayed in the legend, along the radial axis, and in tooltips.

Select or enter the format specification. Use syntax based on the Java DecimalFormat class for numeric labels, and syntax based on the Java SimpleDateFormat class for date labels.

To enable tooltips, select the mouseOverFlag.

This property is in the Data Format property group.

valueFormat

Sets the numeric format of trace values displayed in tooltips.

Select or enter a format. Use syntax from the Java DecimalFormat class. To enable tooltips, select the mouseOverFlag property.

This property is in the Data Format property group.

Radar graph: Data Label group

Properties in this group control the labels that are used along the radial axis or in the legend.

Data Label group properties

The group contains the following properties:

• columnDisplayNames
• labelColumnName
• rowLabelVisFlag
• rowNameVisFlag

columnDisplayNames

Set alternate display names for the columns of the data attached to valueTable. Column names label the radial axes or are used in the legend, depending on whether or not rowSeriesFlag is selected.

This property is in the Data Label property group.

labelColumnName

Sets the label column. By default, the label column is the first non-numeric text column in your data attachment, if there is one. Data from the label column either appears as labels along the radial axis or else is used in the legend, depending on whether rowSeriesFlag is enabled.

If both rowSeriesFlag and rowLabelVisFlag are enabled, data from the label column is used in the legend.

If rowSeriesFlag is not enabled and both rowLabelVisFlag and radialAxisLabelVisFlag are enabled, data from the label column appears as labels the radial axis.

This property is in the Data Label property group.

rowLabelVisFlag

Determines whether or not data from the label column is used in chart labels. See labelColumnName. If rowLabelVisFlag is disabled, integer row identifiers either appear as labels along the radial axis (if rowSeriesFlag is disabled and radialAxisLabelVisFlag is enabled) or else are used in the legend (if rowSeriesFlag is enabled).

This property is in the Data Label property group.

rowNameVisFlag

If your data attachment has no label column (see labelColumnName), select this property to use generated row names in chart labels.

This property is in the Data Label property group.

Radar graph: 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.

Radar graph: Interaction group

Properties in this group control various forms of interaction between the end user and the graph, including command, drill down, and tooltip interactions.

Interaction group properties

The group includes the following properties:

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

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.

mouseOverFlag

Select this property to enable tooltips for your radar graph. To display a tooltip, point to a trace marker with your mouse. The tooltip will contain information from your data attachment about that marker.

This property is in the Interaction property group.

Radar graph: Label group

Properties in this group control the graph’s main label (which defaults to Radar Graph), including text, alignment, color, font, and size.

Label group properties

The group includes 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 Radar Graph.

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

Radar graph: Legend group

Properties in this group control the visibility and appearance of the graph legend.

Legend group properties

The group contains the following properties:

• legendBgColor
• legendBgGradientFlag
• legendVisFlag
• legendWidthPercent

legendBgColor

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

This property is in the Legend property group.

legendBgGradientFlag

Select to display a gradient in the legend background.

This property is in the Legend property group.

legendVisFlag

Select to display the legend.

This property is in the Legend property group.

legendWidthPercent

Set the percent of the total width of the object used for the legend.

This property is in the Legend property group.

Radar graph: Marker group

Properties in this group control the appearance of trace markers (but see also Radar graph: Trace group).

Marker group properties

The group contains the following properties:

• markDefaultSize
• markScaleMode

markDefaultSize

Sets the size of the trace markers in pixels. Supply an integer value that is between 1 and 18, inclusive.

This property is in the Marker property group.

markScaleMode

Sets the scale mode for trace marks. Select one of the following from the drop down menu:

• No Scale: All marks, across and within traces, are the same size.
• Scale by Trace: Scale marks according to the trace in which they reside, that is, marks in the first trace are the largest, across all traces, and the marks in the last trace are the smallest.
• Scale Within Trace: Scale marks according to the relative order of the data within each trace.

This property is in the Marker property group.

Radar graph: Object group

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

Object group properties

This group contains the following properties:

• anchor
• dock
• objHeight
• objName
• objWidth
• objX
• objY
• transparencyPercent
• 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.

transparencyPercent

Sets the transparency of this chart.

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.

Radar graph: Plot Area group

Properties in this group control the appearance of the plot area, the rectangular area that serves as background for the axes, grid lines, and trace lines (but not for the legend or radial axis labels; see Radar graph: Background group).

Plot Area group properties

The group includes the following properties:

• gridColor
• plotBgColor
• plotBgGradientFlag
• plotBgImage

gridColor

To set the color of the grid lines, select the… button and choose a color from the palette. Close the Color Chooserwindow when you are done.

This property is in the Plot Area property group.

plotBgColor

To set the color of the plot area, select the… button and choose a color from the palette to set the background color. Close the Color Chooserwindow when you are done.

This property is in the Plot Area property group.

plotBgGradientFlag

Select to display a gradient in the plot area background. Set the color of the plot area background with the plotBgColor property.

This property is in the Plot Area property group.

plotBgImage

Specify an image (.gif, .jpg, or .png file) to display in the plot area. Select the name of the image file from the drop down menu, or enter the pathname of the 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.

This property is in the Plot Area property group.

Radar graph: Radial Axis group

Properties in this group control the visibility and appearance of the radial axis, radial axis labels, and radial grid lines.

Radial Axis group

The group includes the following properties:

• radialAxisColor
• radialAxisLabelVisFlag
• radialAxisLineStyle
• radialAxisMinLabelWidth
• radialAxisVisFlag
• radialGridLineStyle
• radialGridVisFlag

radialAxisColor

To set the color of the radial axis and radial axis label, select the … button and choose a color from the palette. Close the Color Chooser window when you are done.

This property is in the Radial Axis property group.

radialAxisLabelVisFlag

Controls the visibility of the labels that appear along the radial axis.

This property is in the Radial Axis property group.

radialAxisLineStyle

Controls the style of the radial axis. Choose either No Line, Solid, Dotted, Dashed, or Dot Dashed.

This property is in the Radial Axis property group.

radialAxisMinLabelWidth

Specifies the minimum width in pixels for the labels that appear along the radial axis.

This property is in the Radial Axis property group.

radialAxisVisFlag

Controls the visibility of the radial axis.

This property is in the Radial Axis property group.

radialGridLineStyle

Controls the style of the radial grid lines. Choose either No Line, Solid, Dotted, Dashed, or Dot Dashed.

This property is in the Radial Axis property group.

radialGridVisFlag

Controls the visibility of the radial grid lines.

This property is in the Radial Axis property group.

Radar graph: Trace group

Properties in this group control the appearance of trace lines and trace markers (but see also Radar graph: Marker group), including color, style, and line width.

Trace group properties

This group includes the following properties:

• traceFillStyle
• traceProperties

traceFillStyle

Set traceFillStyle to one of the following fill styles for the area under the trace:

• Solid
• Transparent
• Gradient
• Transparent Gradient
• None

None is the default.

This property is in the Trace property group.

traceProperties

Specify the line color, line style, line width, marker color and marker style of all traces.

In the Object Properties window, double-click on traceProperties in the Property Name field to bring up the Trace Properties dialog. In the Trace Properties dialog, you can assign attributes to each plotting trace in your graph.

The dialog has six columns of fields:

• Trace: One field for each trace that is currently in the graph. Current settings for each trace are shown.
• Line Color: Select the ellipsis button in the Color column and choose a color from the palette. Close the Color Chooser window.
• Line Style: Select the ellipsis button in the Line Style column and choose a style from the drop down menu. Choose either No Line, Solid, Dotted, Dashed, or Dot Dashed.
• Line Width: Select the ellipsis button in the Line Width column and choose a size from the drop down menu. Choose either Thin, Medium or Thick.
• Marker Color: Select the ellipsis button in the Marker Color column and choose a color from the palette. Close the Color Chooser window.
• Marker Style: Select the ellipsis button in the Marker Style column and choose a style from the drop down menu. Choose either No Marker, Dot, +, *, o, x, Filled Circle, Filled Diamond, Filled Triangle, Filled Square, or Filled Star.

The dialog contains the following buttons:

• Add Trace Property: Click to add a trace property field. The data for the trace does not have to be available yet. You may consider adding and assigning attributes to more traces than your data currently needs for when you have more data to show. It is not necessary to set properties for each trace you currently or subsequently have. This is optional and can be done after additional data is displayed in a subsequent new trace.
• Delete Trace Property: Removes the last trace property field from the Trace Properties dialog.
• OK: Applies values and closes the dialog.
• Apply: Applies values without closing the dialog.
• Reset: Resets all fields to last values applied. Specify the line color, line style, line width, marker color and marker style of all traces.

This property is in the Trace property group.

Radar graph: Value Axis group

Properties in this group control the visibility and range of the value axis, as well as value-axis label formats and value-axis divisions. They also control the visibility of value-axis grid lines.

Value Axis group properties

The group includes the following properties:

• valueAxisAutoScaleMode
• valueAxisColor
• valueAxisFlag
• valueAxisFormat
• valueAxisLineStyle
• valueAxisMajorDivisions
• valueAxisMinorDivisions
• valueGridLineStyle
• valueGridVisFlag

valueAxisAutoScaleMode

Select one of the following modes to control the y-axis range:

• Off: The valueMin and valueMax properties determine the range of the value axis. This is the default. The chart origin (the bottom of the value axis) is labeled with valueMin. The intersection of the value axis and the radial axis (the top of the value axis) is labeled with valueMax.
• On: The dashboard calculates the value axis range according to data values being plotted.
• On - Include Min/Max: The dashboard calculates the smallest range that includes both valueMin and valueMax as well as all plotted points.

This property is in the Value Axis property group.

valueAxisColor

To set the color of the value axis and value axis labels, select the … button and choose a color from the palette. Close the Color Chooser window when you are done.

This property is in the Value Axis property group.

valueAxisFlag

Controls the visibility of the value axis.

This property is in the Value Axis property group.

valueAxisFormat

Sets the format of the numerical labels that appear along the value axis. Select or enter the format specification. Use syntax based on the Java DecimalFormat class.

This property is in the Value Axis property group.

valueAxisLineStyle

Controls the style of the value axis. Choose either No Line, Solid, Dotted, Dashed, or Dot Dashed.

This property is in the Value Axis property group.

valueAxisMajorDivisions

Specifies the number of major divisions on the value axis. Each major division is separated by a value grid line. A numeric label appears along the value axis at the intersections with the grid lines (as well as at the origin and at the intersection with the radial axis).

This property is in the Value Axis property group.

valueAxisMinorDivisions

Specifies the number of minor divisions on the value axis. Each minor division is separated by a horizontal tick mark.

This property is in the Value Axis property group.

valueGridLineStyle

Controls the style of the value grid lines. Choose either No Line, Solid, Dotted, Dashed, or Dot Dashed.

This property is in the Value Axis property group.

valueGridVisFlag

Controls the visibility of the value grid lines.

This property is in the Value Axis property group.

XY graph

XY graphs visualize tabular data that has at least two rows with two or more numeric columns. An XY graph can visualize data in either of two ways:

• Row series visualization: The graph has one trace for each non-first row of the visualized data. (The first row is used for the x components of the plotted points, as described below.) Within each trace, there is a plotted point for each column of the data.

  For a given point in a given trace, the x component is the value of the point’s corresponding column for the first row of the visualized data, and the y component is the value of that column for the trace’s corresponding row.

• Column series visualization: The graph has one trace for each numeric column of the visualized data, except for the first numeric column. (The first numeric column is used for the x components of the plotted points, as described below.) Within each trace, there is a plotted point for each row of the data.

  For a given point in a given trace, the x component is the value of the first numeric column for the point’s corresponding row, and the y component is the value of the trace’s corresponding column for the point’s corresponding row.

Use the valueTable property to attach data to an XY graph. Use the rowSeriesFlag property to specify row series or column series visualization.

When an XY graph is selected in the Builder canvas, the Object Class Name that appears at the top of the Object Properties pane is obj_xygraph.

The Object Properties panel organizes XY graph properties into the groups below.

XY graph: Alert group

Properties in this group allow you to specify changes in the appearance of trace lines and markers that signal changes in the status of specified data elements. You can specify threshold values (see valueHighAlarm, valueHighWarning, valueLowAlarm, and valueLowWarning) or attach a data table to valueAlarmStatusTable that indicates the status of each element of the table that is attached to valueTable.

Alert group propeties

This group includes the following properties:

• valueAlarmStatusTable
• valueHighAlarm
• valueHighAlarmEnabledFlag
• valueHighAlarmLineVisFlag
• valueHighAlarmMarkColor
• valueHighAlarmMarkStyle
• valueHighAlarmTraceColor
• valueHighAlarmTraceStyle
• valueHighWarning
• valueHighWarningEnabledFlag
• valueHighWarningLineVisFlag
• valueHighWarningMarkColor
• valueHighWarningMarkStyle
• valueHighWarningTraceColor
• valueHighWarningTraceStyle
• valueLowAlarm
• valueLowAlarmEnabledFlag
• valueLowAlarmLineVisFlag
• valueLowAlarmMarkColor
• valueLowAlarmMarkStyle
• valueLowAlarmTraceColor
• valueLowAlarmTraceStyle
• valueLowWarning
• valueLowWarningEnabledFlag
• valueLowWarningLineVisFlag
• valueLowWarningMarkColor
• valueLowWarningMarkStyle
• valueLowWarningTraceColor
• valueLowWarningTraceStyle

valueAlarmStatusTable

Attach an alarm table containing status indexes to this property in order to enable rule based alarm statuses for trace markers. The table attached to valueAlarmStatusTable must have the same number of rows and columns as valueTable. For each data element in valueTable, the status index at the corresponding position in valueAlarmStatusTable is used to set the alarm status of the marker that represents the data element.

Following are the valid indexes are:

• 0: Use normal marker color and style. See traceProperties.
• 1: Use low alarm marker color and style valueLowAlarmMarkColor and valueLowAlarmMarkStyle.
• 2: Use low warning marker color and style. See valueLowWarningMarkColor and valueLowWarningMarkStyle.
• 3: Use high warning marker color and style. See valueHighWarningMarkColor and valueHighWarningMarkStyle.
• 4: Use high alarm marker color and style. See valueHighAlarmMarkColor and valueHighAlarmMarkStyle.
• -1: Determine marker color and style by comparing the value to the enabled alarm thresholds. See valueHighAlarm, valueHighWarning, valueLowAlarm, and valueLowWarning.

If no data is attached to valueAlarmStatusTable, the alarm status for a trace marker is determined by comparing the marker’s value to the enabled thresholds. See valueHighAlarm, valueHighWarning, valueLowAlarm, and valueLowWarning.

This property is in the Alert property group.

valueHighAlarm

Specifies the threshold value used by valueHighAlarmLineVisFlag, valueHighAlarmMarkColor, valueHighAlarmMarkStyle, valueHighAlarmTraceColor, and valueHighAlarmTraceStyle.

This property is in the Alert property group.

valueHighAlarmEnabledFlag

Select to enable the high alarm threshold. See valueHighAlarm.

This property is in the Alert property group.

valueHighAlarmLineVisFlag

Select to display a dotted line at the high alarm threshold. The color of the line is set to valueHighAlarmMarkColor. This line is displayed only if valueHighAlarmEnabledFlag is selected.

This property is in the Alert property group.

valueHighAlarmMarkColor

When a trace marker’s value is greater than or equal to valueHighAlarm, the marker changes to valueHighAlarmMarkColor and valueHighAlarmMarkStyle, provided valueHighAlarmEnabledFlag is selected and no data is attached to valueAlarmStatusTable.

If data is attached to valueAlarmStatusTable, a marker changes to valueHighAlarmMarkColor and valueHighAlarmMarkStyle when the marker’s corresponding element in the attached alarm status table is 4.

If data is attached to valueAlarmStatusTable, and the marker’s corresponding element in the attached alarm status table is -1, marker color and style behave as if no data were attached to valueAlarmStatusTable.

This property is in the Alert property group.

valueHighAlarmMarkStyle

When a trace marker’s value is greater than or equal to valueHighAlarm, the marker changes to valueHighAlarmMarkColor and valueHighAlarmMarkStyle, provided valueHighAlarmEnabledFlag is selected and no data is attached to valueAlarmStatusTable.

If data is attached to valueAlarmStatusTable, a marker changes to valueHighAlarmMarkColor and valueHighAlarmMarkStyle when the marker’s corresponding element in the attached alarm status table is 4.

If data is attached to valueAlarmStatusTable, and the marker’s corresponding element in the attached alarm status table is -1, marker color and style behave as if no data were attached to valueAlarmStatusTable.

This property is in the Alert property group.

valueHighAlarmTraceColor

When the value of any segment of a trace line is greater than or equal to valueHighAlarm, that segment of the trace line changes to valueHighAlarmTraceColor and valueHighAlarmTraceStyle, provided valueHighAlarmEnabledFlag is selected.

This property is in the Alert property group.

valueHighAlarmTraceStyle

When the value of any segment of a trace line is greater than or equal to valueHighAlarm, that segment of the trace line changes to valueHighAlarmTraceColor and valueHighAlarmTraceStyle, provided valueHighAlarmEnabledFlag is selected.

This property is in the Alert property group.

valueHighWarning

Specifies the threshold value used by valueHighWarningLineVisFlag, valueHighWarningMarkColor, valueHighWarningMarkStyle, valueHighWarningTraceColor, and valueHighWarningTraceStyle.

This property is in the Alert property group.

valueHighWarningEnabledFlag

Select to enable the high warning threshold. See valueHighWarning.

This property is in the Alert property group.

valueHighWarningLineVisFlag

Select to display a dotted line at the high warning threshold. The color of the line is set to valueHighWarningMarkColor. This line is displayed only if valueHighWarningEnabledFlag is selected.

This property is in the Alert property group.

valueHighWarningMarkColor

When a trace marker’s value is greater than or equal to valueHighWarning but less than valueHighAlarm, the marker changes to valueHighWarningMarkColor and valueHighWarningMarkStyle, provided valueHighWarningEnabledFlag is selected and no data is attached to valueAlarmStatusTable.

If data is attached to valueAlarmStatusTable, a marker changes to valueHighWarningMarkColor and valueHighWarningMarkStyle when the marker’s corresponding element in the attached alarm status table is 3.

If data is attached to valueAlarmStatusTable, and the marker’s corresponding element in the attached alarm status table is -1, marker color and style behave as of no data were attached to valueAlarmStatusTable.

This property is in the Alert property group.

valueHighWarningMarkStyle

When a trace marker’s value is greater than or equal to valueHighWarning but less than valueHighAlarm, the marker changes to valueHighWarningMarkColor and valueHighWarningMarkStyle, provided valueHighWarningEnabledFlag is selected and no data is attached to valueAlarmStatusTable.

If data is attached to valueAlarmStatusTable, a marker changes to valueHighWarningMarkColor and valueHighWarningMarkStyle when the marker’s corresponding element in the attached alarm status table is 3.

If data is attached to valueAlarmStatusTable, and the marker’s corresponding element in the attached alarm status table is -1, marker color and style behave as of no data were attached to valueAlarmStatusTable.

This property is in the Alert property group.

valueHighWarningTraceColor

When the value of any segment of a trace line is greater than or equal to valueHighWarning property but less than valueHighAlarm, that segment of the trace line changes to valueHighWarningTraceColor and valueHighWarningTraceStyle, provided valueHighWarningEnabledFlag is selected.

This property is in the Alert property group.

valueHighWarningTraceStyle

When the value of any segment of a trace line is greater than or equal to valueHighWarning property but less than valueHighAlarm, that segment of the trace line changes to valueHighWarningTraceColor and valueHighWarningTraceStyle, provided valueHighWarningEnabledFlag is selected.

This property is in the Alert property group.

valueLowAlarm

Specifies the threshold value used by valueLowAlarmLineVisFlag, valueLowAlarmMarkColor, valueLowAlarmMarkStyle, valueLowAlarmTraceColor, and valueLowAlarmTraceStyle.

This property is in the Alert property group.

valueLowAlarmEnabledFlag

Select to enable the low alarm threshold. See valueLowAlarm.

This property is in the Alert property group.

valueLowAlarmLineVisFlag

Select to display a dotted line at the low alarm threshold. The color of the line is set to valueLowAlarmMarkColor. This line is displayed only if valueLowAlarmEnabledFlag is selected.

This property is in the Alert property group.

valueLowAlarmMarkColor

When a trace marker’s value is less than or equal to valueLowAlarm, the marker changes to valueLowAlarmMarkColor and valueLowAlarmMarkStyle, provided valueLowAlarmEnabledFlag is selected and no data is attached to valueAlarmStatusTable.

If data is attached to valueAlarmStatusTable, a marker changes to valueLowAlarmMarkColor and valueLowAlarmMarkStyle when the marker’s corresponding element in the attached alarm status table is 1.

If data is attached to valueAlarmStatusTable, and the marker’s corresponding element in the attached alarm status table is -1, marker color and style behave as of no data were attached to valueAlarmStatusTable.

This property is in the Alert property group.

valueLowAlarmMarkStyle

When a trace marker’s value is less than or equal to valueLowAlarm, the marker changes to valueLowAlarmMarkColor and valueLowAlarmMarkStyle, provided valueLowAlarmEnabledFlag is selected and no data is attached to valueAlarmStatusTable.

If data is attached to valueAlarmStatusTable, a marker changes to valueLowAlarmMarkColor and valueLowAlarmMarkStyle when the marker’s corresponding element in the attached alarm status table is 1.

If data is attached to valueAlarmStatusTable, and the marker’s corresponding element in the attached alarm status table is -1, marker color and style behave as of no data were attached to valueAlarmStatusTable.

This property is in the Alert property group.

valueLowAlarmTraceColor

When the value of any segment of a trace line is less than or equal to valueLowAlarm, that segment of the trace line changes to valueLowAlarmTraceColor and valueLowAlarmTraceStyle, provided valueLowAlarmEnabledFlag is selected.

This property is in the Alert property group.

valueLowAlarmTraceStyle

When the value of any segment of a trace line is less than or equal to valueLowAlarm, that segment of the trace line changes to valueLowAlarmTraceColor and valueLowAlarmTraceStyle, provided valueLowAlarmEnabledFlag is selected.

This property is in the Alert property group.

valueLowWarning

Specifies the threshold value used by valueLowWarningLineVisFlag, valueLowAlarmMarkColor, valueLowWarningMarkStyle, valueLowWarningTraceColor, and valueLowWarningTraceStyle.

This property is in the Alert property group.

valueLowWarningEnabledFlag

Select to enable the low warning threshold. See valueLowWarning.

This property is in the Alert property group.

valueLowWarningLineVisFlag

Select to display a dotted line at the low warning threshold. The color of the line is set to valueLowWarningMarkColor. This line is displayed only if valueLowWarningEnabledFlag is selected.

This property is in the Alert property group.

valueLowWarningMarkColor

When a trace marker’s value is less than or equal to valueLowWarning but greater than valueLowAlarm, the marker changes to valueLowWarningMarkColor and valueLowWarningMarkStyle, provided valueLowWarningEnabledFlag is selected and no data is attached to valueAlarmStatusTable.

If data is attached to valueAlarmStatusTable, a marker changes to valueLowWarningMarkColor and valueLowWarningMarkStyle when the marker’s corresponding element in the attached alarm status table is 2.

If data is attached to valueAlarmStatusTable, and the marker’s corresponding element in the attached alarm status table is -1, marker color and style behave as of no data were attached to valueAlarmStatusTable.

This property is in the Alert property group.

valueLowWarningMarkStyle

When a trace marker’s value is less than or equal to valueLowWarning but greater than valueLowAlarm, the marker changes to valueLowWarningMarkColor and valueLowWarningMarkStyle, provided valueLowWarningEnabledFlag is selected and no data is attached to valueAlarmStatusTable.

If data is attached to valueAlarmStatusTable, a marker changes to valueLowWarningMarkColor and valueLowWarningMarkStyle when the marker’s corresponding element in the attached alarm status table is 2.

If data is attached to valueAlarmStatusTable, and the marker’s corresponding element in the attached alarm status table is -1, marker color and style behave as of no data were attached to valueAlarmStatusTable.

This property is in the Alert property group.

valueLowWarningTraceColor

When the value of any segment of a trace line is less than or equal to valueLowWarning but greater than valueLowAlarm, that segment of the trace line changes to valueLowWarningTraceColor and valueLowWarningTraceStyle, provided valueLowWarningEnabledFlag is selected.

This property is in the Alert property group.

valueLowWarningTraceStyle

When the value of any segment of a trace line is less than or equal to valueLowWarning property but greater than valueLowAlarm, that segment of the trace line changes to valueLowWarningTraceColor and valueLowWarningTraceStyle, provided valueLowWarningEnabledFlag is selected.

This property is in the Alert property group.

XY graph: Background group

Properties in this group control the visibility and appearance of the portion of the graph that serves as the background of both the plot area and legend.

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.

XY graph: Column group

This group contains one property, columnsToHide, which controls which data-attachment columns are excluded from being used for plotted data or labels.

columnsToHide

Specifies columns from the data attachment to exclude from being used for plotted data or labels. Data from the labelColumnName column are used for labels even if that column name is also specified in the columnsToHide property. Columns specified in the columnsToHide property can still be used in the drillDownColumnSubs property.

This property is in the Column property group.

XY graph: Data group

Properties in this group control what data appears in the graph, as well as whether the data appears in column series or row series form.

Data group properties

The group contains the following properties:

• rowSeriesFlag
• valueTable
• xValueDivisor
• xValueMax
• xValueMin
• yValueDivisor
• yValueMax
• yValueMin

rowSeriesFlag

Controls how x and y data populate the graph:

• If the rowSeriesFlag checkbox is selected, the graph has one trace for each non-first row of your data attachment. (The first row is used for the x components of the plotted points, as described below.) Within each trace, there is a plotted point for each column of your attachment.

  For a given point in a given trace, the x component is the value of the point’s corresponding column for the first row of your attachment, and the y component is the value of that column for the trace’s corresponding row. Values from the label column (see labelColumnName) or generated row identifiers are used as labels in the legend.

• If the rowSeriesFlag checkbox is not selected, there is a trace for each numeric column of your data attachment, except for the first numeric column. (The first numeric column is used for the x components of the plotted points, as described below.) Within each trace, there is a plotted point for each row of your attachment.

  For a given point in a given trace, the x component is the value of the first numeric column for the point’s corresponding row, and the y component is the value of the trace’s corresponding column for the point’s corresponding row. Column names appear in the legend.

This property is in the Data property group.

valueTable

Attach your data to the valueTable property. Your data attachment must contain at least two rows and at least two numeric columns. The property rowSeriesFlag controls how x and y data populate the graph:

• If the rowSeriesFlag checkbox is selected, the graph has one trace for each non-first row of your data attachment. (The first row is used for the x components of the plotted points, as described below.) Within each trace, there is a plotted point for each column of your attachment.

  For a given point in a given trace, the x component is the value of the point’s corresponding column for the first row of your attachment, and the y component is the value of that column for the trace’s corresponding row. Values from the label column (see labelColumnName) or generated row identifiers are used as labels in the legend.

• If the rowSeriesFlag checkbox is not selected, there is a trace for each numeric column of your data attachment, except for the first numeric column. (The first numeric column is used for the x components of the plotted points, as described below.) Within each trace, there is a plotted point for each row of your attachment.

  For a given point in a given trace, the x component is the value of the first numeric column for the point’s corresponding row, and the y component is the value of the trace’s corresponding column for the point’s corresponding row. Column names appear in the legend.

This property is in the Data property group.

xValueDivisor

The x values are divided by the value entered into the xValueDivisor. The default is 1.

This property is in the Data property group.

xValueMax

The xValueMin and xValueMax properties control the range of the x-axis if xAxisAutoScaleMode is set to Off. In addition, if xAxisAutoScaleMode is set to On - Include Min/Max, the dashboard calculates the smallest x-axis range that includes both xValueMin and xValueMax as well as all plotted points.

This property is in the Data property group.

xValueMin

The xValueMin and xValueMax properties control the range of the x-axis if xAxisAutoScaleMode is set to Off. In addition, if xAxisAutoScaleMode is set to On - Include Min/Max, the dashboard calculates the smallest x-axis range that includes both xValueMin and xValueMax as well as all plotted points.

This property is in the Data property group.

yValueDivisor

The y values are divided by the value entered into the yValueDivisor. The default is 1.

This property is in the Data property group.

yValueMax

The yValueMin and yValueMax properties control the range of the y-axis if the yAxisAutoScaleMode is set to Off. In addition, if yAxisAutoScaleMode is set to On - Include Min/Max, the dashboard calculates the smallest y-axis range that includes both yValueMin and yValueMax as well as all plotted points.

This property is in the Data property group.

yValueMin

The yValueMin and yValueMax properties control the range of the y-axis if the yAxisAutoScaleMode is set to Off. In addition, if yAxisAutoScaleMode is set to On - Include Min/Max, the dashboard calculates the smallest y-axis range that includes both yValueMin and yValueMax as well as all plotted points.

This property is in the Data property group.

XY graph: Data Format group

Properties on this group control the format of displayed values as well as numerical and date labels.

Data Format group properties

The group includes the following properties:

• labelColumnFormat
• xValueFormat
• yValueFormat

labelColumnFormat

Select or enter the format of numeric or date labels displayed in the legend and popup legend (see legendPopupFlag).

For numeric labels, use syntax from the Java DecimalFormat class.

For date labels, use from the Java SimpleDateFormat class.

This property is in the Data Format property group.

xValueFormat

Sets the numeric format of trace values displayed in the legend and popup legend.

Select or enter a format. Use syntax from the Java DecimalFormat class.

This property is in the Data Format property group.

yValueFormat

Sets the numeric format of trace values displayed in the legend and popup legend.

Select or enter a format. Use syntax from the Java DecimalFormat class.

This property is in the Data Format property group.

XY graph: Data Label group

Properties in this group control the labels that are used in the legend.

Data Label group properties

The group contains the following properties:

• columnDisplayNames
• labelColumnName
• rowLabelVisFlag
• rowNameVisFlag

columnDisplayNames

Sets alternate display names for column names in your XY graph’s data. Column names are displayed in the legend when rowSeriesFlag is not selected.

This property is in the Data Label property group.

labelColumnName

Sets the label column. By default, the label column is the first non-numeric text column in your data attachment, if there is one (for Apama data tables, apama.instanceID is used if there is no other non-numeric column).

Data from the label column is used to label the legend, if both rowLabelVisFlag and rowSeriesFlag are enabled.

This property is in the Data Label property group.

rowLabelVisFlag

Determines whether data from the label column (see labelColumnName) is used for legend labels. Data from the label column is used to label the legend if both rowLabelVisFlag and rowSeriesFlag are enabled.

This property is in the Data Label property group.

rowNameVisFlag

If your data attachment has no label column (see labelColumnName), select this property to use generated row names in the legend when the rowSeriesFlag is not selected.

This property is in the Data Label property group.

XY graph: 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.

XY graph: Interaction group

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

Interaction group properties

The group includes the following properties:

• command
• commandCloseWindowOnSuccess
• commandConfirm
• confirmText
• cursorColor
• cursorFlag
• drillDownColumnSubs
• drillDownSelectMode
• drillDownTarget
• scrollbarMode
• scrollbarSize
• mouseOverFlag
• zoomEnabledFlag

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.

cursorColor

To set the color of the cursor (see cursorFlag), select the … button and choose a color from the palette. Close the Color Chooser window when you are done.

This property is in the Interaction property group.

cursorFlag

Select to enable the cursor. When the cursor is enabled, 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. Hold down the control key to snap the cursor to the closest data point. Select the legendPopupFlag to display the legend along the cursor.

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 theDrill Down Properties dialog. See Drill-down specification.

This property is in the Interaction property group.

scrollbarMode

Select one of the following from the scrollbarMode property to set the behavior of the scroll bar in the table:

• 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 you have X or Y values that are outside of the min/max range.

This property is in the Interaction property group.

scrollbarSize

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.

mouseOverFlag

Select to enable tooltips for your graph. To display a tooltip, point to a trace marker with your mouse. The tooltip contains information from your data attachment about that trace marker. This property applies only if legendPopupFlag is disabled.

This property is in the Interaction property group.

zoomEnabledFlag

Select to enable zooming within the graph. Click in the graph’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 graph stores up to four zoom operations in queue. To zoom out, press the Shift key and click in the graph’s trace area.

This property is in the Interaction property group.

XY graph: Label group

Properties in this group control the graph’s main label (which defaults to XY Graph), including text, alignment, color, font, and size.

Label group properties

The group includes 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 XY Graph.

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.

XY graph: Legend group

Properties in this group control the visibility and appearance of the graph legend.

Legend group properties

The group contains the following properties:

• legendBgColor
• legendBgGradientFlag
• legendPopupFlag
• legendValueMinSpace
• legendValueVisFlag
• legendVisFlag
• legendWidthPercent

legendBgColor

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

This property is in the Legend property group.

legendBgGradientFlag

Select to display a gradient in the legend background.

This property is in the Legend property group.

legendPopupFlag

Select to display the legend along the cursor.

This property is in the Legend property group.

legendValueMinSpace

Specifies the minimum number of pixels between values and labels in the legend. This property applies only if legendValueVisFlag is enabled.

This property is in the Legend property group.

legendValueVisFlag

Select to display the numerical values of your data in the legend.

This property is in the Legend property group.

legendVisFlag

Select to display the legend.

This property is in the Legend property group.

legendWidthPercent

Set the percent of the total width of the object used for the legend.

This property is in the Legend property group.

XY graph: Marker group

Properties in this group control the appearance of trace markers (but see also XY graph: Trace group).

Marker group properties

The group contains the following properties:

• markDefaultSize
• markScaleMode

markDefaultSize

Sets the size of the markers in pixels. Supply an integer value that is between 1 and 18, inclusive.

This property is in the Marker property group.

markScaleMode

Sets the scale mode for trace marks. Select one of the following from the drop down menu:

• No Scale: All marks, across and within traces, are the same size.
• Scale by Trace: Scale marks according to the trace in which they reside, that is, marks in the first trace are the largest, across all traces, and the marks in the last trace are the smallest.
• Scale Within Trace: Scale marks according to the relative order of the data within each trace.

This property is in the Marker property group.

XY graph: Object group

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

Object group properties

This group contains the following properties:

• anchor
• dock
• objHeight
• objName
• objWidth
• objX
• objY
• transparencyPercent
• 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.

transparencyPercent

Sets the transparency of this chart.

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.

XY graph: Plot Area group

Properties in this group control the appearance of the plot area, the rectangular area that serves as background for the grid lines and trace lines (but not for the legend or axis labels; see XY graph: Background group).

Plot Area group properties

The group includes the following properties:

• gridBgColor
• gridBgGradientFlag
• gridBgImage
• gridColor

gridBgColor

To set the color of the plot area, select the … button and choose a color from the palette to set the background color. Close the Color Chooser window when you are done.

This property is in the Plot Area property group.

gridBgGradientFlag

Select to display a gradient in the grid background. Set the color of the grid background with the gridBgColor property.

This property is in the Plot Area property group.

gridBgImage

Specify an image (.gif, .jpg, or .png file) to display in the plot area. Select the name of the image file from the drop down menu, or enter the pathname of the file. The drop down menu contains the names of image files located in the current directory (by default, the dashboards directory of 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.

This property is in the Plot Area property group.

gridColor

Sets the color of the dotted, horizontal midline of the plot area. Select the … button and choose a color from the palette. Close the Color Chooser window when you are done.

This property is in the Plot Area property group.

XY graph: Trace group

Properties in this group control the appearance of trace lines and trace markers (but see also XY graph: Marker group), including color, style, and line width.

Trace group properties

This group includes the following properties:

• traceFillStyle
• traceProperties

traceFillStyle

Set traceFillStyle to one of the following fill styles for the area under the trace:

• Solid
• Transparent
• Gradient
• Transparent Gradient
• None

None is the default.

This property is in the Trace property group.

traceProperties

Specify the line color, line style, line width, marker color and marker style of all traces.

In the Object Properties window, double-click on traceProperties in the Property Name field to bring up the Trace Properties dialog. In the Trace Properties dialog you can assign attributes to each plotting trace in your graph.

The dialog has six columns of fields:

• Trace: One field for each trace that is currently in the graph. Current settings for each trace are shown.
• Line Color: Select the ellipsis button in the Color column and choose a color from the palette. Close the Color Chooser window.
• Line Style: Select the ellipsis button in the Line Style column and choose a style from the drop down menu. Choose either No Line, Solid, Dotted, Dashed, or Dot Dashed.
• Line Width: Select the ellipsis button in the Line Width column and choose a size from the drop down menu. Choose either Thin, Medium or Thick.
• Marker Color: Select the ellipsis button in the Marker Color column and choose a color from the palette. Close the Color Chooser window.
• Marker Style: Select the ellipsis button in the Marker Style column and choose a style from the drop down menu. Choose either No Marker, Dot, +, *, o, x, Filled Circle, Filled Diamond, Filled Triangle, Filled Square, or Filled Star.

The dialog contains the following buttons:

• Add Trace Property: Click to add a trace property field. The data for the trace does not have to be available yet. You may consider adding and assigning attributes to more traces than your data currently needs for when you have more data to show. It is not necessary to set properties for each trace you currently or subsequently have. This is optional and can be done after additional data is displayed in a subsequent new trace.
• Delete Trace Property: Removes the last trace property field from the Trace Properties dialog.
• OK: Applies values and closes the dialog.
• Apply: Applies values without closing the dialog.
• Reset: Resets all fields to last values applied. Specify the line color, line style, line width, marker color and marker style of all traces.

This property is in the Trace property group.

XY graph: X-Axis group

Properties in this group control the visibility and scaling of the x-axis, as well as x-axis label formats and x-axis divisions. They also control x-axis sorting and reversing.

X-Axis group properties

The group includes the following properties:

• xAxisAutoScaleMode
• xAxisAutoScaleRoundFlag
• xAxisFlag
• xAxisFormat
• xAxisLabel
• xAxisLabelTextHeight
• xAxisMajorDivisions
• xAxisMinorDivisions
• xAxisReverseFlag
• xValueSortFlag

xAxisAutoScaleMode

Select one of the following modes to control the x-axis range:

• Off: The xValueMin and xValueMax properties determine the range of the x-axis. This is the default.
• On: The dashboard calculates the x-axis range according to data values being plotted.
• On - Include Min/Max: The dashboard calculates the smallest range that includes xValueMin and xValueMax as well as all plotted points.

This property is in the X-Axis property group.

xAxisAutoScaleRoundFlag

Select to round values on the x-axis.

This property is in the X-Axis property group.

xAxisFlag

Select to display the x-axis.

This property is in the X-Axis property group.

xAxisFormat

Sets the numeric format of values displayed on the x-axis. Select or enter a format. Use syntax from the Java DecimalFormat class.

This property is in the X-Axis property group.

xAxisLabel

Specifies the x-axis label.

This property is in the X-Axis property group.

xAxisLabelTextHeight

Specifies the height in pixels of the x-axis labels.

This property is in the X-Axis property group.

xAxisMajorDivisions

Specify the number of major divisions on the x-axis.

This property is in the X-Axis property group.

xAxisMinorDivisions

Specify the number of minor divisions on the x- axis.

This property is in the X-Axis property group.

xAxisReverseFlag

Select to reverse the order of the x-axis values and plot values decreasing from left to right.

This property is in the X-Axis property group.

xValueSortFlag

Select to sort data from lowest to highest x values.

This property is in the X-Axis property group.

XY graph: Y-Axis group

Properties in this group control the visibility and scaling of the y-axis, as well as y-axis label formats and y-axis divisions. They also control whether there is a single y-axis, or one per trace.

Y-Axis group properties

The group includes the following properties:

• yAxisAutoScaleMode
• yAxisFlag
• yAxisFormat
• yAxisLabel
• yAxisLabelTextHeight
• yAxisMajorDivisions
• yAxisMinLabelWidth
• yAxisMinorDivisions
• yAxisMultiRangeFlag

yAxisAutoScaleMode

Select one of the following modes to control the y-axis range:

• Off: The yValueMin and yValueMax properties determine the range of the y-axis. This is the default.
• On: The dashboard calculates the y-axis range according to data values being plotted.
• On - Include Min/Max: The dashboard calculates the smallest range (with rounding) that includes both yValueMin and yValueMax as well as all plotted points.

This property is in the Y-Axis property group.

yAxisFlag

Select to display the y-axis.

This property is in the Y-Axis property group.

yAxisFormat

Sets the numeric format of values displayed on the y-axis.

Select or enter a format. Use syntax from the Java DecimalFormat class.

This property is in the Y-Axis property group.

yAxisLabel

Specifies the y-axis label.

This property is in the Y-Axis property group.

yAxisLabelTextHeight

Specifies the height in pixels of the y-axis labels.

This property is in the Y-Axis property group.

yAxisMajorDivisions

Specifies the number of major divisions on the y-axis.

This property is in the Y-Axis property group.

yAxisMinLabelWidth

Specifies the minimum width in pixels for the y-axis labels.

This property is in the Y-Axis property group.

yAxisMinorDivisions

Specifies the number of minor divisions on the y-axis.

This property is in the Y-Axis property group.

yAxisMultiRangeFlag

Select to enable one axis per trace with each trace having its own range.

This property is in the Y-Axis property group.