Trend objects

Sparkline charts

Sparkline charts are generally used to present trends and variations in a simple and condensed way. As the name implies there is a line associated with data, but no background or axis. It is possible to add labels at the beginning and ending points of the line, which then can be toggled on and off.

Attach scalar data to the value property or tabular data to the valueTable property. Tabular data attached to the valueTable property should have two columns: the first must contain numeric values or time stamps (x-axis values), and the second column should contain the corresponding (y-axis) numeric values.

When a sparkline chart is selected in the Builder canvas, the Object Class Name that appears at the top of the Object Properties pane is obj_sparkline.

The Object Properties panel organizes stock chart properties into the groups below.

Sparkline chart: Alert group

Properties in this group allow you to set marker colors and styles based on a threshold value.

Alert group properties

The group contains the following properties:

• valueHighAlarmEnabledFlag
• valueHighAlarm
• valueHighAlarmLineVisFlag
• valueHighAlarmMarkColor
• valueHighAlarmMarkStyle
• valueHighAlarmTraceColor
• valueHighAlarmTraceStyle
• valueLowAlarmEnabledFlag
• valueLowAlarm
• valueLowAlarmLineVisFlag
• valueLowAlarmMarkColor
• valueLowAlarmMarkStyle
• valueLowAlarmTraceColor
• valueLowAlarmTraceStyle

valueHighAlarmEnabledFlag

Select to enable the high alarm threshold and related properties.

This property is in the Alert property group.

valueHighAlarm

Set the value of the high alarm threshold.

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 the valueHighAlarmMarkColor.

This property is in the Alert property group.

valueHighAlarmMarkColor

When a trace marker’s value is greater than or equal to the valueHighAlarm property, the marker will change to the valueHighAlarmMarkColor and valueHighAlarmMarkStyle.

This property is in the Alert property group.

valueHighAlarmMarkStyle

When a trace marker’s value is greater than or equal to the valueHighAlarm property, the marker will change to the valueHighAlarmMarkColor and valueHighAlarmMarkStyle.

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 the valueHighAlarm property, that segment of the trace line will change to the valueHighAlarmTraceColor and valueHighAlarmTraceStyle.

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 the valueHighAlarm property, that segment of the trace line will change to the valueHighAlarmTraceColor and valueHighAlarmTraceStyle.

This property is in the Alert property group.

valueLowAlarmEnabledFlag

Select to enable the low alarm threshold and related properties:

This property is in the Alert property group.

valueLowAlarm

Set the value of the low alarm threshold.

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 the valueLowAlarmMarkColor.

This property is in the Alert property group.

valueLowAlarmMarkColor

When the trace marker’s value is less than or equal to the valueLowAlarm property, the marker will change to the valueLowAlarmMarkColor and valueLowAlarmMarkStyle.

This property is in the Alert property group.

valueLowAlarmMarkStyle

When the trace marker’s value is less than or equal to the valueLowAlarm property, the marker will change to the valueLowAlarmMarkColor and valueLowAlarmMarkStyle.

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 the valueLowAlarm property, that segment of the trace line will change to the valueLowAlarmTraceColor and valueLowAlarmTraceStyle.

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 the valueLowAlarm property, that segment of the trace line will change to the valueLowAlarmTraceColor and valueLowAlarmTraceStyle.

This property is in the Alert property group.

Sparkline chart: Background group

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

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.

This property is in the Background property group.

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.

Sparkline chart: Data group

Properties in this group control the data to which the chart is attached, as well as the y-axis range and the maximum number of data points contained in the chart.

Data group properties

This group includes the following properties:

• maxPointsPerTrace
• value
• valueDivisor
• valueTable
• yValueMax
• yValueMin

maxPointsPerTrace

The default is 1000. The maximum value for this property is 30000.

This property is in the Data property group.

value

Attach your scalar data to the value property.

This property is in the Data property group.

valueDivisor

Divides y-axis values by the number entered.

This property is in the Data property group.

valueTable

Attach your tabular data to the valueTable property. Tabular data attached must have two columns: the first must contain numeric values or time stamps (x-axis values) and the second column should contain the corresponding (y-axis) numeric values.

This property is in the Data property group.

yValueMax

Controls the range of y-axis if the yAxisAutoScaleMode is set to Off. Select On for the yAxisAutoScaleMode to calculate the y-axis range according to data values being plotted. To calculate the y-axis range including yValueMin and yValueMax, select On - Include Min/Max.

This property is in the Data property group.

yValueMin

Controls the range of y-axis if the yAxisAutoScaleMode is set to Off. Select On for the yAxisAutoScaleMode to calculate the y-axis range according to data values being plotted. To calculate the y-axis range including yValueMin and yValueMax, select On - Include Min/Max.

This property is in the Data property group.

Sparkline chart: Data Format group

This group contains the yValueFormat property, which controls the format of displayed values.

yValueFormat

Select or enter the numeric format of values displayed in the legend and popup legend. To enter a format, use syntax from the Java DecimalFormat class.

This property is in the Data Format property group.

Sparkline chart: Historian group

Do not use the properties in this group.

historyTableName

Do not use this property.

historyTableRowNameFlag

Do not use this property.

Sparkline chart: Interaction group

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

Interaction group properties

The group includes the following properties:

• command
• commandCloseWindowOnSuccess
• commandConfirm
• confirmText
• cursorColor
• cursorFlag
• drillDownTarget
• legendPopupFlag

command

Assign a command or group of commands to this stock chart by right-clicking on the command property name in the Object Properties window. Select Define Command and choose SYSTEM, APAMA, or MULTIPLE. 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

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

The default is yellow.

This property is in the Interaction property group.

cursorFlag

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

The cursor is disabled by default.

This property is in the Interaction property group.

drillDownTarget

To specify a drill down display, double click on 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.

legendPopupFlag

Controls whether a legend pops up when you mouse over the trend line.

This property is in the Interaction property group.

Sparkline chart: Label group

Properties in this group control the graph’s main label (which defaults to Sparkline), 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 Sparkline.

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.

Sparkline chart: Legend group

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

Legend group properties

The group contains the following properties:

• legendBgColor
• legendBgGradientColor2
• legendBgGradientMode
• legendTimeFormat
• legendValueMinSpace
• 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.

legendBgGradientColor2

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.

legendBgGradientMode

Display a gradient in the legend 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.

legendTimeFormat

Sets the format for the time displayed in the legend. Use syntax from the Java SimpleDateFormat class. For example, MMMM dd, yyyy hh:mm:ss results in the form August 30, 2010 05:32:12 PM. If no format is given, the timeFormat is used.

This property is in the Legend property group.

legendValueMinSpace

Specify the minimum distance in pixels between values and labels 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

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

This property is in the Legend property group.

Sparkline chart: Marker group

This group contains the property markDefaultSize, which controls the size of the trace marker.

markDefaultSize

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

This property is in the Marker property group.

Sparkline chart: Object group

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

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

Sets 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 stock 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 stock chart.

This property is in the Object property group.

objWidth

Sets 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 stock 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.

Sparkline chart: Plot Area group

The property in this group, traceBgColor, controls the color of the plot area.

traceBgColor

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.

Sparkline chart: Trace group

The properties control the visibility and appearance of the trace line.

Trace group properties

The group includes the following properties:

• traceFillStyle
• traceLabel
• traceLineColor
• traceLineStyle
• traceLineThickness
• traceNMarkColor
• traceNMarkStyle
• traceNValueHistoryFlag

traceFillStyle

Select one of the following fill styles for from the drop down menu:

• Solid
• Transparent
• Gradient
• Transparent Gradient
• None

The default setting is None.

This property is in theTrace property group.

traceLabel

Enter a label for the trace line. This label appears in the chart’s legend.

This property is in the Trace property group.

traceLineColor

Sets the trace line 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 Trace property group.

traceLineStyle

Select one of the following line styles for the trace line from the drop down menu:

• No Line
• Solid
• Dotted
• Dashed
• Dot Dashed

This property is in the Trace property group.

traceLineThickness

Select one of the following thickness specifications for the price trace line from the drop down menu:

• Thin
• Medium
• Thick

This property is in the Trace property group.

traceNMarkColor

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

This property is in the Trace property group.

traceNMarkStyle

Sets the style of the marker used on the trace. Select one of the following items from the drop down menu:

• No Marker
• Dot
• +
• *
• o
• x
• Filled Circle
• Filled Diamond
• Filled Triangle
• Filled Square
• Filled Star

This property is in the Trace property group.

traceNValueHistoryFlag

Do not use this property.

This property is in the Trace property group.

Sparkline chart: X-Axis group

Properties in this group control the range of the x-axis.

X-Axis group properties

The group includes the following properties:

• timeRange
• timeRangeBegin
• timeRangeEnd

timeRange

Sets the total amount of time, in seconds, plotted on the chart.

If timeRange is set to -1, the time range is determined by the first and last timestamp found in the attached data.

The default is -1.0.

This property is in the X-Axis property group.

timeRangeBegin

Sets the start time value of the data to be plotted on the chart. Following are the supported formats:

• mm/dd/yyyy hh:mm:ss (e.g., 01/16/2004 12:30:03)
• yyyy-mm-dd hh:mm:ss (e.g., 2004-01-16 12:30:03)
• The number of milliseconds since midnight, January 1, 1970 UTC

This property is in the X-Axis property group.

timeRangeEnd

Sets the end time value of the data to be plotted on the chart. Following are the supported formats are:

• mm/dd/yyyy hh:mm:ss (e.g., 01/16/2010 12:30:03)
• yyyy-mm-dd hh:mm:ss (e.g., 2010-01-16 12:30:03)
• The number of milliseconds since midnight, January 1, 1970 UTC

This property is in the X-Axis property group.

Sparkline chart: Y-Axis group

This group contains the yAxisAutoScalMode property, which controls the range of the y-axis.

yAxisAutoScalMode

Select how the y-axis range is calculated from the drop down menu:

• Off: The yValueMin and yValueMax properties determine the range of y-axis.
• 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 yValueMin as well as all plotted points.

This property is in the Y-Axis property group.

Stock charts

Stock charts visualize live and historical data related to financial instrument trades. They can include overlays that allow the display of data from multiple instruments or the display of periodic events such as stock splits and earnings announcements.

Each plotted point on a stock chart encapsulates four pieces of quantitative information for a particular instrument and time period: opening value, high value, low value, and closing value. Each chart visualizes tabular data that includes a time-valued column as well four numerical columns (for opening, high, low, and closing values).

Use the priceTraceCurrentTable and priceTraceHistoryTable properties to attach data to a stock chart. Use the timeRangeMode property to specify the duration of the time period represented by each plotted point.

Use the overlayCount property to specify the number of overlays to be included in the chart. Use the overlayNCurrentTable and overlayNHistoryTable properties to add the Nth overlay.

When a stock chart is selected in the Builder canvas, the Object Class Name that appears at the top of the Object Properties pane is obj_stockchart.

The Object Properties panel organizes stock chart properties into the groups below.

Stock chart: Background group

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

Background group properties

The group contains the following properties:

• bgBorderFlag
• bgColor
• bgEdgeWidth
• bgGradientColor2
• bgGradientMode
• bgRaisedFlag
• bgRoundness
• bgShadowFlag
• bgStyleFlag
• bgVisFlag
• borderPixels

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.

Stock chart: Data group

Properties in this group control the y-axis range.

Data group properties

The group contains the following properties:

• yValueMax
• yValueMin

yValueMax

Controls the y-axis range.

This property is in the Data property group.

yValueMin

Controls the y-axis range.

This property is in the Data property group.

Stock chart: Data Format group

The property in this group, yValueFormat, controls the numeric format of values displayed in the legend and popup legend.

yValueFormat

Select or enter the numeric format of values displayed in the legend and popup legend. To enter a format, use syntax from the Java DecimalFormat class.

This property is in the Data Format property group.

Stock chart: Interaction group

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

Interaction group properties

The group includes the following properties:

• command
• commandCloseWindowOnSuccess
• commandConfirm
• confirmText
• cursorColor
• cursorFlag
• drillDownColumnSubs
• drillDownSelectMode
• drillDownTarget
• mouseOverFlag
• scrollbarMode
• scrollbarSize
• 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

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

The default is yellow.

This property is in the Interaction property group.

cursorFlag

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

The cursor is disabled by default.

This property is in the Interaction property group.

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 to enable trace element tooltips. When the enabled, hold the mouse over a location to display in a tooltip the time and the open and close values of all traces at the location.

This property is in the Interaction property group.

scrollbarMode

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

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

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.

zoomEnabledFlag

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

This property is in the Interaction property group.

Stock chart: Historian group

Do not use the properties in this group.

historyTableName

Do not use this property.

historyTableRowNameFlag

Do not use this property.

Stock chart: Label group

Properties in this group control the chart’s main label (which defaults to Stock Chart), 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 Stock Chart.

This property is in the Label property group.

labelTextAlignX

Specifies the alignment of the chart label. Select Left, Right, or Center from the drop down list.

This property is in the Label property group.

labelTextColor

Specifies the color of the chart label text. 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. 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.

This property is in the Label property group.

Stock chart: Legend group

Properties in this group control the visibility, appearance, and content of the chart 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

When the cursorFlag property is enabled, select legendPopupFlag to display the legend along the cursor.

This property is in the Legend property group.

legendValueMinSpace

Specifies the minimum distance in pixels between values and labels in the legend.

This property is in the Legend property group.

legendValueVisFlag

Select to display the numerical values of your data in the legend. If cursorFlag is enabled, the numerical values are always shown 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

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

This property is in the Legend property group.

Stock chart: Object group

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

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.

Stock chart: Plot Area group

Properties in this group control the appearance of the plot area, the rectangular area that serves as background for the trace markers (but not for the legend or axis labels; see Stock chart: Background group). There is also a property that controls the color of the horizontal grid line or lines.

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 plot area.

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 dotted, horizontal grid line in the plot area (see xAxisMajorDivisions). 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.

Stock chart: Price Trace group

The properties control the visibility and appearance of the price trace, as well as the data to which it is attached.

Trace group properties

The group includes the following properties:

• priceTraceBarGainColor
• priceTraceBarLossColor
• priceTraceCurrentTable
• priceTraceFillStyle
• priceTraceHistoryTable
• priceTraceLabel
• priceTraceLineColor
• priceTraceLineStyle
• priceTraceLineThickness
• priceTraceType
• priceTraceVisFlag

priceTraceBarGainColor

Sets the color to indicate that a stock price value at market close is greater than value at market open. Select the … button and choose a color from the palette. Close the Color Chooser window when you are done.

The default is green.

This property is in the Price Trace property group.

priceTraceBarLossColor

Sets the color to indicate that a stock price value at market close is less than value at market open. Select the … button and choose a color from the palette. Close the Color Chooser window when you are done.

The default is red.

This property is in the Price Trace property group.

priceTraceCurrentTable

Attach your tabular data to the priceTraceHistoryTable and priceTraceCurrentTable properties. The priceTraceCurrentTable property is used for viewing live data. The table in your data attachment should contain a single row that corresponds to and continually updates the last point on the graph.

Unless you attach this property to a DataView OHLC table, the table in your data attachment must contain the following five columns in this specific order:

• Date: Following are the supported formats for this column are:
  • mm/dd/yyyy hh:mm:ss (for example, 01/16/2010 12:30:03)
  • yyyy-mm-dd hh:mm:ss (for example, 2010-01-16 12:30:03)
  • The number of milliseconds since midnight, January 1, 1970 UTC
• Open: Value of stock price at first market open for defined time period
• High: High value of stock price for defined time period
• Low: Low value of stock price for defined time period
• Close: Value of stock price at last market close for defined time period

See Attaching dashboards to correlator data.

This property is in the Price Trace property group.

priceTraceFillStyle

Select one of the following candlestick fill styles for from the drop down menu:

• Solid
• Transparent
• Gradient
• Transparent Gradient
• None

This setting has an effect only if priceTraceType is set to CandleStick.

The default setting is None.

This property is in the Price Trace property group.

priceTraceHistoryTable

Attach your tabular data to the priceTraceHistoryTable or priceTraceCurrentTable property. The priceTraceHistoryTable property is used for viewing and analyzing historical data (data generated before the correlator first sends data to this particular chart). The table in your data attachment should contain multiple rows, each corresponding to a point on the graph.

Unless you attach this property to a DataView OHLC table, the table in your data attachment must contain the following five columns in this specific order:

• Date: Following are the supported formats for this column:
  • mm/dd/yyyy hh:mm:ss (for example, 01/16/2010 12:30:03)
  • yyyy-mm-dd hh:mm:ss (for example, 2010-01-16 12:30:03)
  • The number of milliseconds since midnight, January 1, 1970 UTC
• Open: Value of stock price at first market open for the defined time period
• High: High value of stock price for the defined time period
• Low: Low value of stock price for the defined time period
• Close: Value of stock price at last market close for the defined time period

See Attaching dashboards to correlator data.

This property is in the Price Trace property group.

priceTraceLabel

Enter a label for the price trace line. This label appears in the chart’s legend, as well as in the tooltip enabled by the mouseOverFlag property.

This property is in the Price Trace property group.

priceTraceLineColor

Sets the price trace line 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 Price Trace property group.

priceTraceLineStyle

Select one of the following line styles for the price trace line from the drop down menu:

• No Line
• Solid
• Dotted
• Dashed
• Dot Dashed

This property is in the Price Trace property group.

priceTraceLineThickness

Select one of the following thickness specifications for the price trace line from the drop down menu:

• Thin
• Medium
• Thick

This property is in the Price Trace property group.

priceTraceType

Select one of the following trace types from the drop down menu:

• Line: A line graph that shows closing price values
• Bar: A bar graph that shows closing price values
• OHLC: A bar extending from the low to high price for each trading day. A left flange indicates the opening price and a right flange indicates the closing price. The priceTraceBarLossColor and priceTraceBarGainColor properties show whether the stock closed at a higher or lower price than the opening price.
• Candlestick: A bar extending from the opening to closing price for each trading period. The wicks on either end show the high and low for the trading period. The priceTraceBarLossColor and priceTraceBarGainColor properties show whether the stock closed at a higher or lower price than the opening price.

This property is in the Price Trace property group.

priceTraceVisFlag

Use the checkbox to control price trace visibility.

This property is in the Price Trace property group.

Stock chart: Trace group

Properties in this group control the number of overlays the chart contains, as well as the overlay fill style.

Trace group properties

The group includes the following properties:

• overlayCount
• overlayFillStyle

overlayCount

Sets the number of overlays. The maximum is nineteen. For each overlay, the Dashboard Builder automatically creates a set of properties in the Object Properties window.

This property is in the Trace property group.

overlayFillStyle

When the value of overlayNType is Line, this specifies the effect with which to fill the area from the line to the bottom of the graph. The color is determined by overlayNLineColor. Select one of the following fill styles from the drop down menu:

• Solid
• Transparent
• Gradient
• Transparent Gradient.
• None (default)

This property is in the Trace property group.

Stock chart: TraceN group

There is one group of these properties for each overlay in the chart (see overlayCount). The properties control the visibility and appearance of overlays, as well as the data to which they are attached.

TraceN group properties

The group includes the following properties:

• overlayNCurrentTable
• overlayNHistoryTable
• overlayNLabel
• overlayNLineColor
• overlayNLineStyle
• overlayNLineThickness
• overlayNType
• overlayNVisFlag

overlayNCurrentTable

The overlayNCurrentTable and overlayNHistoryTable properties are used in conjunction with the priceTraceHistoryTable or priceTraceCurrentTable properties to compare data (for example, to compare the activity of several stocks). See Attaching dashboards to correlator data. To enable, set the overlayCount to the number of overlay traces that you want to show.

This property is in the TraceN property group.

overlayNHistoryTable

The overlayNCurrentTable and overlayNHistoryTable properties are used in conjunction with the priceTraceHistoryTable or priceTraceCurrentTable properties to compare data (e.g. to compare the activity of several stocks). See Attaching dashboards to correlator data. By default the overlays are disabled. To enable, set the overlayCount to the number of overlay traces you want to show.

This property is in the TraceN property group.

overlayNLabel

Enter a label for the overlay line. This label appears in legend and tooltip enabled by mouseOverFlag.

This property is in the TraceN property group.

overlayNLineColor

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

This property is in the TraceN property group.

overlayNLineStyle

Select one of the following styles for the overlay line from the drop down menu:

• No Line
• Solid
• Dotted
• Dashed
• Dot Dashed

This property is in the TraceN property group.

overlayNLineThickness

Select the following thickness of the overlay line from the drop down menu:

• Thin
• Medium
• Thick

This property is in the TraceN property group.

overlayNType

Select one of the following overlay types from the drop down menu:

• Line: A line graph that shows closing price values
• Bar: A bar graph that shows closing price values
• Event: A series of markers representing company events such as stock splits, company merges, etc. The first letter of the overlayNLabel is the letter that appears in each event marker.

This property is in the TraceN property group.

overlayNVisFlag

Use the checkbox to control overlay visibility.

This property is in the TraceN property group.

Stock chart: X-Axis group

Properties in this group control the range and labeling of the x-axis, as well as the time interval between plotted points.

X-Axis group properties

The group includes the following properties:

• timeFormat
• timeRange
• timeRangeBegin
• timeRangeEnd
• timeRangeMode
• tradeDayBegin
• tradeDayEnd
• tradeDayEndLabelFlag
• xAxisFlag
• xAxisLabel
• xAxisLabelTextHeight
• xAxisMajorDivisions
• xAxisMinorDivisions

timeFormat

Sets the format for the time displayed in the x-axis using syntax from the Java SimpleDateFormat class. This property is only used when the timeRangeMode is Continuous.

For example, MMMM dd, yyyy hh:mm:ss a results in dates of the form August 30, 2010 05:32:12 PM. If no format is given, the date and time are not displayed on the x-axis.

Include a new line character (’\n’) to display multiple-line text in the time axis labels. For example, MM\dd’\n’hh:mm:ss results in the following form:

08\30
05:32:12

If left blank, the axis is labeled with a default format based on the range.

This property is in the X-Axis property group.

timeRange

Sets the total amount of time, in seconds, plotted on the chart.

If timeRange is set to -1, the time range is determined by the first and last timestamp found in the priceTraceHistoryTable and priceTraceCurrentTable. If both tables are empty, the chart uses the first and last timestamp of the first overlay trace that has a non-empty overlayNHistoryTable or overlayNCurrentTable.

The default is -1.0.

This property is in the X-Axis property group.

timeRangeBegin

Sets the start time value of the data to be plotted on the chart. Following are the supported formats:

• mm/dd/yyyy hh:mm:ss (e.g., 01/16/2010 12:30:03)
• yyyy-mm-dd hh:mm:ss (e.g., 2010-01-16 12:30:03)
• The number of milliseconds since midnight, January 1, 1970 UTC

This property is in the X-Axis property group.

timeRangeEnd

Sets the end time value of the data to be plotted on the chart. Following are the supported formats are:

• mm/dd/yyyy hh:mm:ss (e.g., 01/16/2010 12:30:03)
• yyyy-mm-dd hh:mm:ss (e.g., 2010-01-16 12:30:03)
• The number of milliseconds since midnight, January 1, 1970 UTC

This property is in the X-Axis property group.

timeRangeMode

Select the timeRangeMode from the drop down menu. This property sets the interval between trace data points. timeRangeMode also affects the x-axis labels. With some time intervals, for example, x-axis labels are dates, while with other time intervals, x-axis labels are times. There are eight modes:

• Auto: Selects the setting that best matches the time intervals in the price trace data table.
• Intra-Day: Time intervals are less than one day, for example, hourly or every 15 minutes.
• Daily: Time intervals are days.
• Weekly: Time intervals are weeks.
• Monthly: Time intervals are months.
• Quarterly: Time intervals are quarters.
• Yearly: Time intervals are annual.
• Continuous: Plots each point using the corresponding timestamp from the data table. This data can vary in time intervals.

This property is in the X-Axis property group.

tradeDayBegin

Defines the daily start time of the trading day. This property is used only with intraday data (time intervals less than one day, for example, hourly or every 15 minutes). The default value is 09:30.

This property is in the X-Axis property group.

tradeDayEnd

Defines the daily end time of the trading day. This property is used only with intraday data (time intervals less than one day, for example, hourly or every 15 minutes). The default value is 16:00.

This property is in the X-Axis property group.

tradeDayEndLabelFlag

Select to show the last data point of a day and the first data point of the next day (which are equal values) with separate points on the chart. Otherwise, they are shown together at one point on the chart.

This property is only used with intraday data.

The default is disabled.

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.

xAxisLabel

Specifies a label to display below the x-axis.

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.

Stock chart: Y-Axis group

Properties in this group control the visibility and scaling of the y-axis or y-axes, as well as y-axis labeling and y-axis divisions. They also control the visibility of y-axis grid lines (but see also Stock chart: Plot Area group).

Y-Axis group properties

The group includes the following properties:

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

yAxisAutoScaleMode

Select how the y-axis range is calculated from the drop down menu:

• Off: The yValueMin and yValueMax properties determine the range of y-axis.
• 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

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

This property is in the Y-Axis property group.

yAxisLabel

Specify label to display to the left of the y-axis.

This property is in the Y-Axis property group.

yAxisLabelTextHeight

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

This property is in the Y-Axis property group.

yAxisMajorDivisions

Specify the number of major divisions on the y-axis. Major divisions are separated by horizontal grid lines. See gridColor.

This property is in the Y-Axis property group.

yAxisMinLabelWidth

Specify the minimum width of the y-axis labels in pixels.

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.

yAxisMultiRangeFlag

Select to have one axis per trace, with each trace having its own range. The first trace is drawn on the outer left of the graph. The remaining traces are drawn on the inner left of the trace area.

Otherwise, all traces are plotted against a single y-axis.

The default is enabled.

This property is in the Y-Axis property group.

yAxisPercentFlag

Select to show the percent changed from the first data point instead of values for the y-axis.

This property is in the Y-Axis property group.

Trend graphs

Trend graphs visualize live and historical, time-indexed, quantitative data. Each graph contains one or more traces, and each trace visualizes tabular data that includes one, two, or three columns:

• One-column data contains a numerical column. The dashboard assigns a time stamp to each row as the data is received.
• Two-column data contains a time-valued column and a numerical column.
• Three-column data contains a time-valued column, a numerical column, and a string (data-label) column.

Use the traceCount property to specify the number of traces to be included in the chart. Use the traceNValue and traceNValueTable properties to attach data to the Nth overlay.

Alternatively, enable multiTraceTableFlag and use multiTraceHistoryValueTable and multiTraceCurrentValueTable in order to specify data for multiple traces by using a single history attachment and a single current value attachment.

Trend graphs include the following visualization objects from the Trends tab:

• Stock Chart
• Sparkline
• Single Variable Trend
• Multiple Variable Trend
• Filled Trend
• Threshold Trend
• Trend with Banded Group

Trend graphs include the following visualization objects from the Trends HTML5 tab:

• Sparkline
• Single Variable Trend
• Multiple Variable Trend
• Filled Trend
• Threshold Trend
• Trend with Trace Group

These visualizations all share the same properties. They differ from one another only with regard to their default values for these properties. When any 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_stockchart.

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

Trend graph: Alert group

Properties in this group allow you to specify changes in the appearance of trace lines, and trace markers in response to changes in the status of plotted data elements. See also traceNValueAlarmStatus and traceNValueAlarmStatusTable in the Trend graph: TraceN group property group.

Alert group properties

This group includes the following properties:

• 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

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. But see also traceNValueAlarmStatus and traceNValueAlarmStatusTable.

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. But see also traceNValueAlarmStatus and traceNValueAlarmStatusTable.

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 valueHighAlarmTraceStyle 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. But see also traceNValueAlarmStatus and traceNValueAlarmStatusTable.

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. But see also traceNValueAlarmStatus and traceNValueAlarmStatusTable.

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. But see also traceNValueAlarmStatus and traceNValueAlarmStatusTable.

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. But see also traceNValueAlarmStatus and traceNValueAlarmStatusTable.

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, valueLowWarningMarkColor, 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. But see also traceNValueAlarmStatus and traceNValueAlarmStatusTable.

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. But see also traceNValueAlarmStatus and traceNValueAlarmStatusTable.

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.

Trend 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:

• bgBorderFlag
• bgColor
• bgEdgeWidth
• bgGradientColor2
• bgGradientMode
• bgRaisedFlag
• bgRoundness
• bgShadowFlag
• bgStyleFlag
• bgVisFlag
• borderPixels

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.

Trend graph: Data group

Properties in this group control the y-axis range, as well as the maximum number of data points contained in the chart. It also contains a flag that controls whether only historical data is included.

Data group properties

The group contains the following properties:

• historyOnlyFlag
• maxPointsPerTrace
• yValueMax
• yValueMin

historyOnlyFlag

When checked, the graph plots only data that is applied to the traceNValueTable properties and will ignore the timeShift property and any data that is applied to the traceNValue properties. This is useful when the same graph instance is to be used to view either historical data or historical data together with current data by setting substitutions on the display.

The default is unchecked.

This property is in the Data property group.

maxPointsPerTrace

The maximum number of data points contained in the chart. Specify a value between 2 and 30000, inclusive.

The default is 1000.

This property is in the Data property group.

yValueMax

Determines the range of the y-axis if the yAxisAutoScaleMode is set to Off. Select On for the yAxisAutoScaleMode to calculate the y-axis range according to data values being plotted. To calculate a y-axis range that always includes yValueMin and yValueMax, select On - Include Min/Max.

This property is used only if yAxisMultiRangeMode is set to Off or Classic.

This property is in the Data property group.

yValueMin

Controls the range of y-axis if the yAxisAutoScaleMode is set to Off. Select On for the yAxisAutoScaleMode to calculate the y-axis range according to data values being plotted. To calculate a y-axis range that always includes yValueMin and yValueMax, select On - Include Min/Max.

This property is used only if yAxisMultiRangeMode is set to Off or Classic.

This property is in the Data property group.

Trend graph: Data Format group

This group contains the yValueFormat property, which controls the format of displayed values.

yValueFormat

Select or enter the numeric format of values displayed in the legend and popup legend. To enter a format, use syntax from the Java DecimalFormat class.

This property is in the Data Format property group.

Trend graph: Interaction group

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

Interaction group properties

This group contains the following properties:

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

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.

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.

commandConfirm

By default, when the end user executes a command (see command), the command confirmation dialog is disabled. To control this option for each individual object, use the commandConfirm check box. If confirmation is required for a MULTIPLE command group, a single confirmation dialog is presented; if you confirm the execution, all individual commands in the group are executed with no further confirmation. If the you cancel the execution, none of the commands in the group is executed.

You can also override the confirmation status of individual objects with an application-wide policy. Select Tools > Options and choose from three confirmation values:

• Do not confirm: Indicates that no commands require confirmation (regardless of each object’s confirmation status).
• Confirm all: Indicates that all commands require confirmation (regardless of each object’s confirmation status).
• Use object confirm flag (default): Indicates that the confirmation status of each object will determine whether confirmation is required.

This property is in the Interaction property group.

confirmText

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

This property is in the Interaction property group.

cursorColor

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

The default is grey.

This property is in the Interaction property group.

cursorFlag

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

The cursor is enabled by default.

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

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.

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

• $traceNumber: number of the trace (1 to 10) that contains the selected point
• $traceLabel: label of selected trace
• $pointValue: y value of point
• $pointTimestamp: timestamp of point
• $pointLabel: data label (if any) of point
• $pointIndex: position of point in trace data (0 to maxPointsPerTrace)

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

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

• If this feature is used on a graph with many trace points, the performance of the browser may be sluggish when the display is loading or refreshing. To avoid this, set the timeRange property so that only a portion of the trace points are visible at a time.
• If a thin client display refresh occurs while positioning the mouse over a point, the browser tooltip may not appear or it may appear in the wrong location.
• When maxPointsPerTrace is exceeded on a trace (1000 by default), an old trace point is shifted out of the trace for each new point that is added. If this occurs between the time that the thin client display was last refreshed and the time that the user clicks on a point, the drilldown substitutions reflect the new set of data points. For example, if two points are shifted out of the trace, the drilldown substitutions are set as though the selected point were two positions to the right of the point the user actually clicked.

This property is in the Interaction property group.

scrollbarMode

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

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

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.

zoomEnabledFlag

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

This property is in the Interaction property group.

Trend graph: Label group

Properties in this group control the chart’s main label (which defaults to Stock Chart), 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 Single Variable Trend, Multiple Variable Trend, Filled Trend, Threshold Trend, or Single Trend with Marks.

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.

Trend graph: Legend group

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

Legend group properties

The group contains the following properties:

• legendBgColor
• legendBgGradientFlag
• legendPopupFlag
• legendTimeFormat
• legendValueMinSpace
• 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 the legendBgGradientFlag to display a gradient in the legend background.

This property is in the Legend property group.

legendPopupFlag

When the cursorFlag property is enabled, select legendPopupFlag to display the legend along the cursor.

This property is in the Legend property group.

legendTimeFormat

Sets the format for the time displayed in the legend. Use syntax from the Java SimpleDateFormat class. For example, MMMM dd, yyyy hh:mm:ss results in the form August 30, 2003 05:32:12 PM. If no format is given, the timeFormat is used.

This property is in the Legend property group.

legendValueMinSpace

Specify the minimum distance in pixels between values and labels 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

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

This property is in the Legend property group.

Trend graph: Marker group

Properties in this group control the size of trace markers.

Marker group properties

The group includes the following properties:

• markDefaultSize
• markScaleMode

markDefaultSize

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

This property is in the Marker property group.

markScaleMode

Select one of the following from the drop down menu to set the scale mode:

• No Scale: All makers, across and within traces, are the same size.
• Scale by Trace: Scale markers according to the trace in which they reside, that is, markers in the first trace are the largest, across all traces, and the markers in the last trace are the smallest.
• Scale Within Trace: Scale markers according to the relative temporal order of the data within each trace, that is, the marker for the earliest data in any given trace is the smallest in that trace and the marker for the latest data in the trace is the largest in that trace.

This property is in the Marker property group.

Trend graph: Object group

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

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

Sets 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 stock 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 stock chart.

This property is in the Object property group.

objWidth

Sets 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 stock 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.

Trend graph: Plot Area group

Properties in this group control the appearance of the plot area, the rectangular area that serves as background for the traces (but not for the legend or axis labels; see Trend graph: Background group). There is also a property that controls the color of the horizontal grid line or lines.

Plot Area group

This group contains the following properties:

• gridColor
• traceBgColor
• traceBgGradientFlag
• traceBgImage

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.

traceBgColor

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.

traceBgGradientFlag

Select to display a gradient in the plot area.

This property is in the Plot Area property group.

traceBgImage

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.

Trend graph: Trace group

Properties in this group control the number of traces that the chart contains, as well as the trace fill style. They can also specify the trace data, if a single data table is used for multiple traces.

Trace group properties

The group contains the following properties:

• multiTraceCurrentValueTable
• multiTraceHistoryValueTable
• multiTraceTableFlag
• traceCount
• traceFillStyle

multiTraceCurrentValueTable

To display current data for multiple traces by using a single attachment, attach a table to this property. The first column in the data table must be a timestamp column. The remaining columns are expected to be Y data values to be plotted. The Nth data column is used for trace N’s data, and the column name is used for traceNLabel (if not already assigned).

If the multiTraceTableFlag is checked, the number of traces whose properties are shown in the Builder’s property sheet is determined by the number of data columns in the data table attachments or by the traceCount property, whichever is larger. However, the number of traces that are plotted on the graph is determined by the number of data columns in the data table attachments.

Typically, the data attachment for multiTraceHistoryValueTable provides the initial data points to be plotted while multiTraceCurrentValueTable provides the new data points to be plotted while the display is viewed. If a trace plots only historical or only current data, only one of the properties needs to be attached to data. However if both properties are attached to data, be sure that the tables applied to both have the same number and type of columns.

When multiTraceTableFlag is checked, the properties traceNValueTable and traceNValue (for N between 1 and 10, inclusive) are not shown in the property sheet, since all trace data is expected to be provided via multiTraceCurrentValueTable or multiTraceHistoryValueTable.

This property is in the Trace property group.

multiTraceHistoryValueTable

To display historical data for multiple traces by using a single attachment, attach a table to this property. The first column in the data table must be a timestamp column. The remaining columns are expected to be Y data values to be plotted. The Nth data column is used for trace N’s data, and the column name is used for traceNLabel (if not already assigned).

If multiTraceTableFlag is checked, the number of traces whose properties are shown in the Builder’s property sheet is determined by the number of data columns in the data table attachments or by the traceCount property, whichever is larger. However, the number of traces that are plotted on the graph is determined by the number of data columns in the data table attachments.

Typically, the data attachment for multiTraceHistoryValueTable provides the initial data points to be plotted while multiTraceCurrentValueTable provides the new data points to be plotted while the display is viewed. If a trace plots only historical or only current data, only one of the properties needs to be attached to data. However if both properties are attached to data, be sure that the tables applied to both have the same number and type of columns.

When multiTraceTableFlag is checked, the properties traceNValueTable and traceNValue (for N between 1 and 10, inclusive) are not shown in the property sheet, since all trace data is expected to be provided via multiTraceCurrentValueTable or multiTraceHistoryValueTable.

This property is in the Trace property group.

multiTraceTableFlag

Controls whether data for multiple traces can be attached to the graph with a single table. When checked, the properties multiTraceCurrentValueTable and multiTraceHistoryValueTable, are shown in the Trace category.

When multiTraceTableFlag is checked, the properties traceNValueTable and traceNValue (for N between 1 and 10, inclusive) are not shown in the property sheet, since all trace data is expected to be provided via multiTraceCurrentValueTable or multiTraceHistoryValueTable.

If multiTraceTableFlag is checked, the number of traces whose properties are shown in the Builder’s property sheet is determined by the number of data columns in the data table attachments or by the traceCount property, whichever is larger. However, the number of traces that are plotted on the graph is determined by the number of data columns in the data table attachments.

This property is in the Trace property group.

traceCount

Sets the number of traces. The maximum is ten. For each overlay, the Dashboard Builder automatically creates a set of properties in the Object Properties window.

This property is in the Trace property group.

traceFillStyle

Specifies the effect with which to fill the area from the trace line to the bottom of the graph. The color is determined by traceNLineColor. Select one of the following fill styles from the drop down menu:

• Solid
• Transparent
• Gradient
• Transparent Gradient
• None (default)

This property is in the Trace property group.

Trend graph: TraceN group

The properties in this group control the visibility and appearance of the price trace, as well as the data to which it is attached (unless multiTraceTableFlag is enabled). They also control y-axis visibility, scaling, and labeling. In addition, there are properties to which you can attach a data table that indicates the alarm status of plotted data; see Trend graph: Alert group.

TraceN group properties

The group includes the following properties:

• traceNLabel
• traceNLineColor
• traceNLineStyle
• traceNLineThickness
• traceNMarkColor
• traceNMarkStyle
• traceNType
• traceNValue
• traceNValueAlarmStatus
• traceNValueAlarmStatusTable
• traceNValueDivisor
• traceNValueHistoryFlag
• traceNValueTable
• traceNVisFlag
• traceNYAxisAutoScaleMode
• traceNYAxisFlag
• traceNYAxisGridVisFlag
• traceNYAxisMinLabelWidth
• traceNYAxisValueLabels
• traceNYAxisValueMax
• traceNYAxisValueMin

traceNLabel

Enter a label for the trace line. This label appears in the chart’s legend.

This property is in the TraceN property group.

traceNLineColor

Sets the trace line 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 TraceN property group.

traceNLineStyle

Select one of the following line styles for the trace line from the drop down menu:

• No Line
• Solid
• Dotted
• Dashed
• Dot Dashed

This property is in the TraceN property group.

traceNLineThickness

Select one of the following thickness specifications for the price trace line from the drop down menu:

• Thin
• Medium
• Thick

This property is in the TraceN property group.

traceNMarkColor

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

This property is in the TraceN property group.

traceNMarkStyle

Sets the style of the marker used on the trace. Select one of the following items from the drop down menu:

• No Marker
• Dot
• +
• *
• o
• x
• Filled Circle
• Filled Diamond
• Filled Triangle
• Filled Square
• Filled Star

This property is in the TraceN property group.

traceNType

Sets the trace type. The valid values are Line (the default), Bar, and Event.

A Bar type trace draws a vertical bar for each data point, from zero to the point’s Y value. The bar is just a vertical line whose width is determined by traceNLineThickness. The traceNLineColor and traceNLineStyle also control the appearance of the bar. If the point exceeds an alarm limit specified on the graph, the alarm color is used for the bar color. If traceNMarkStyle is set to any value other than None, the mark is drawn at the end of the bar.

For an Event type trace, no line is drawn. Instead, a small rectangle containing a single text character is drawn for each data point. The character is the first character of the corresponding data label if any, otherwise it is the first character of the trace label. The traceNColor property determines the color of edges of the box and the text character, unless the point exceeds an alarm limit specified on the graph, in which case the corresponding alarm color is used. The box’s fill color is set to traceNMarkColor or the appropriate alarm mark color, if any. However, if the mark color is the same as the color used for the box edge and text, traceBgColor is used as the box fill color instead.

Each event box is positioned vertically according to the Y data value for the corresponding data point. However, if traceN is attached to a data table that provides data labels but no Y data values, an Event trace is plotted regardless of the traceNType setting. The event boxes are all drawn near the bottom of the trace area.

This property is in the TraceN property group.

traceNValue

To display current data, attach to this property. When you attach data to this property, the time displayed on the trend graph is automatically updated each time data is received. The table in your data attachment can contain either a single point of data, two columns of data, or three columns of data. If it contains a single point of data, the dashboard assigns the time stamp when the graph receives the data.

If it contains two columns of data, the first column must be the time value and the second column the value to plot.

Following are supported formats for the time value column:

• mm/dd/yyyy hh:mm:ss (for example, 01/16/2004 12:30:03)
• yyyy-mm-dd hh:mm:ss (for example, 2004-01-16 12:30:03)
• Number of milliseconds since midnight, January 1, 1970 UTC

In order to view all available data, you must set the properties timeRange to -1 and timeShift to a negative value. This negative value will be used to round the start and end times for the Y Axis. For example, if you specify -15 for the timeShift property, the start and end times for the Y Axis will be rounded to the nearest 15 seconds.

If the attachment contains three columns of data, the third column must be a string column, which is used as the data label for the corresponding data point. The data label for a point is shown in the fixed legend and in the popup legend, between the trace value and the trace label, and is enclosed in parentheses. If the cursorFlag property is checked, the data label shown in the legend is for the data point that is directly under or to the left of the cursor.

This property is in the TraceN property group.

traceNValueAlarmStatus

To apply an alarm status to traceN, enter an alarm status index, which indicates how to determine the marker color and style for each new plotted point derived from traceNValue. Enter one of the following integers:

0: Normal marker color and style. See traceNMarkColor and traceNMarkStyle.

1: Low alarm marker color and style: See valueLowAlarmMarkColor and valueLowAlarmMarkStyle.

2: Low warning marker color and style. See valueLowWarningMarkColor and valueLowWarningMarkStyle.

3: High warning marker color and style. See valueHighWarningMarkColor and valueHighWarningMarkStyle.

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

The default is -1.

This property is in the TraceN property group.

traceNValueAlarmStatusTable

Attach an alarm table containing status indexes to tracenValueAlarmStatusTable to enable rule based alarm statuses for trace markers. This table must have a time column (formatted like the time value in the traceNValueTable) and a value column where the value column contains alarm status values 0-4. The table must also have the same number of rows as the corresponding tracenValueTable. For each data element in traceNValueTable, the status index at the corresponding position in tracenvalueAlarmStatusTable is used to set the alarm status of the marker.

Valid indexes are:

0: Normal marker color and style. See traceNMarkColor and traceNMarkStyle.

1: Low alarm marker color and style. See valueLowAlarmMarkColor and valueLowAlarmMarkStyle.

2: Low warning marker color and style. See valueLowWarningMarkColor and valueLowWarningMarkStyle.

3: High warning marker color and style. See valueHighWarningMarkColor and valueHighWarningMarkStyle.

4: 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 tracenValueAlarmStatusTable, then 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 TraceN property group.

traceNValueDivisor

All trace values are divided by the number entered into the tracenValueDivisor.

This property is in the TraceN property group.

traceNValueHistoryFlag

Do not use this property.

This property is in the TraceN property group.

traceNValueTable

To display historical data, attach to tracenValueTable, where n is the trace number, and include two columns in your attachment. The first column must be the time value and the second column the value to plot. Following are supported formats for the time value column:

• mm/dd/yyyy hh:mm:ss (for example, 01/16/2004 12:30:03)
• yyyy-mm-dd hh:mm:ss (for example, 2004-01-16 12:30:03)
• Number of milliseconds since midnight, January 1, 1970 UTC

In order to view all available data, you must set the properties timeRange to -1 and timeShift to a negative value. This negative value will be used to round the start and end times for the Y Axis. For example, if you specify -15 for the timeShift property, the start and end times for the Y Axis will be rounded to the nearest 15 seconds.

This property is in the TraceN property group.

traceNVisFlag

Select to control trace visibility. Mouse over a trace’s entry in the legend and hold down the left mouse button in order to temporarily hide all other traces in the graph.

This property is in the TraceN property group.

traceNYAxisAutoScaleMode

Controls how the y-axis range is calculated for this trace, if yAxisMultiRangeMode is set to Multiple Axis or Strip Chart. Select one of the following from the drop down menu:

• Off: The traceNYAxisValueMin and traceNYAxisValueMax properties determine the range of the y-axis.
• 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 traceNYAxisValueMin and traceNYAxisValueMax as well as all plotted points.

This property is in the TraceN property group.

traceNYAxisFlag

Controls the visibility of the labels and ticks for traceN, if yAxisMultiRangeMode is set to Multiple Axis or Strip Chart.

This property is in the TraceN property group.

traceNYAxisGridVisFlag

Set to display a horizontal line for each major y-axis division for traceN, if yAxisMultiRangeMode is set to Multiple Axis or Strip Chart.

This property is in the TraceN property group.

traceNYAxisMinLabelWidth

Specifies the minimum width of the y-axis labels in pixels, if yAxisMultiRangeMode is set to Multiple Axis or Strip Chart.

This property is in the TraceN property group.

traceNYAxisValueLabels

Set to display a text label or tick mark on the y-axis in place of a numerical value, if yAxisMultiRangeMode is set to Multiple Axis or Strip Chart. Include a value with no label to display a tick mark without a label. Use this format:

value1=label1,value2,value3=label2

Here is an example:

0=Off,1,2=On

This property is in the TraceN property group.

traceNYAxisValueMax

Controls the range of y-axis if the traceNYAxisAutoScaleMode is set to Off. Select On for the traceNYAxisAutoScaleMode to calculate the y-axis range according to data values being plotted. To calculate a y-axis range that always includes traceNYAxisValueMin and traceNYAxisValueMax, select On - Include Min/Max.

This property is used only if yAxisMultiRangeMode is set to Multiple Axis or Strip Chart.

This property is in the TraceN property group.

traceNYAxisValueMin

Controls the range of y-axis if the traceNYAxisAutoScaleMode is set to Off. Select On for the traceNYAxisAutoScaleMode to calculate the y-axis range according to data values being plotted. To calculate a y-axis range that always includes traceNYAxisValueMin and traceNYAxisValueMax, select On - Include Min/Max.

This property is used only if yAxisMultiRangeMode is set to Multiple Axis or Strip Chart.

This property is in the TraceN property group.

Trend graph: Trace Groups group

The properties in this group allow you to form trace groups. A trace group is a collection of two or more traces, and is useful for the following:

• Identifying multiple traces that should share one vertical axis, in strip chart or multi-axis modes
• Identifying three traces to be combined as a banded trace

By default, the category contains a single property, traceGroupCount, with a default value of zero. Legal values are 0 through 5. If nonzero, the traceGroupNTraceNumbers and traceGroupNBandedFlag properties appear in the Trace Group category, for each groupN, where N is between 1 and traceGroupCount, inclusive.

Follow these steps to construct an example:

1. Set traceCount = 3.
2. Set traceGroupCount = 1 (this makes the next 2 properties appear).
3. Set traceGroup1TraceNumbers = 1, 2, 3.
4. Set traceGroup1BandedFlag = true (checked).
5. Attach trace 1, 2, and 3 to data.

Note also the following:

• For each trace that is in a group, the y axis for the group is visible unless traceNYAxisVisFlag or traceVisFlag is false (unchecked) for all traces in the group. Similarly, the group’s y axis grid is visible unless the traceNYAxisGridVisFlag property is false for all traces in the group.
• If traceN is in a group, these properties are hidden: traceNYAxisAutoScaleMode, traceNYAxisValueMax, traceNYAxisValueMin. The graph’s yAXisAutoScaleMode, yValueMax, and yValueMin properties are used to scale each group’s y axis range.
• If yAxisMultiRangeMode is Multiple Axis, the color of the axis for a group is determined by traceNLineColor of the first visible trace in the group. In Multiple Axis mode it may not be visually obvious which traces belong to which groups, unless you assign a similar line color or style, or mark color or style, to all the traces in a group.

Trace Groups group properties

The group includes the following properties:

• traceGroupNBandedFlag
• traceGroupNTraceNumbers
• traceGroupCount

traceGroupNBandedFlag

If this property is checked, the group is expected to have three traces. The plot area beneath the first trace in the group (the low band trace) is filled, the second trace in the group (the value trace) is not filled, and the area above the third trace (the high band trace) is filled.

This property is in the TraceGroups property group.

traceGroupNTraceNumbers

Specifies a comma-separated list of the traces that belong to the group. If the trend graph is in strip chart mode or multi-axis mode, all the traces in the group share the same axis or strip.

This property is in the TraceGroups property group.

traceGroupCount

Sets the number of trace groups. The default is 0. Allowable values are 0 through 5. If nonzero, the properties traceGroupNTraceNumbers and traceGroupNBandedFlag appear in the Trace Group category, for each groupN, where N is between 1 and the value of traceGroupCount, inclusive.

This property is in the TraceGroups property group.

Trend graph: X-Axis group

Properties in this group control the range and labeling of the x-axis.

X-Axis group properties

The group includes the following properties:

• timeFormat
• timeRange
• timeRangeBegin
• timeRangeEnd
• timeRangeOfHistory
• timeShift
• xAxisFlag
• xAxisGridVisFlag
• xAxisLabelTextHeight
• xAxisMajorDivisions
• xAxisMinorDivisions

timeFormat

Sets the format for the time displayed in the x-axis using syntax from the Java SimpleDateFormat class.

For example, MMMM dd, yyyy hh:mm:ss a results in dates of the form August 30, 2003 05:32:12 PM. If no format is given, the date and time are not displayed on the x-axis.

Include a new line character ('\n') to display multiple-line text in the time axis labels. For example, MM\dd’\n’hh:mm:ss results in the following form:

08\30
05:32:12

If left blank, the axis is labeled with a default format based on the range.

This property is in the X-Axis property group.

timeRange

Sets the total amount of time, in seconds, plotted on the chart.

If timeRange is set to -1, the time range is determined by the first and last timestamp found in the traceNValue and traceNValueTable. If both tables are empty, the chart uses the first and last timestamp of the first overlay trace that has a non-empty traceNValueTable or traceNValue.

The default is -1.0.

This property is in the X-Axis property group.

timeRangeBegin

Sets the start time value of the data to be plotted on the chart. Following are the supported formats:

• mm/dd/yyyy hh:mm:ss (for example, 01/16/2004 12:30:03)
• yyyy-mm-dd hh:mm:ss (for example, 2004-01-16 12:30:03)
• The number of milliseconds since midnight, January 1, 1970 UTC

This property is in the X-Axis property group.

timeRangeEnd

Sets the end time value of the data to be plotted on the chart. Following are the supported formats are:

• mm/dd/yyyy hh:mm:ss (for example, 01/16/2004 12:30:03)
• yyyy-mm-dd hh:mm:ss (for example, 2004-01-16 12:30:03)
• The number of milliseconds since midnight, January 1, 1970 UTC

This property is in the X-Axis property group.

timeRangeOfHistory

Do not use this property

This property is in the X-Axis property group.

timeShift

Used to round the start and end times for the Y Axis. For example, if you specify -15 for the timeShift property, the start and end times for the Y Axis are rounded to the nearest 15 seconds.

The default value is -1.0.

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.

xAxisGridVisFlag

Set to display a vertical line for each major x-axis division.

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 (long ticks) on the x-axis.

This property is in the X-Axis property group.

xAxisMinorDivisions

Specify the number of minor divisions (short ticks) on the x-axis.

This property is in the X-Axis property group.

Trend graph: Y-Axis group

Properties in this group control the visibility and scaling of the y-axis or y-axes, as well as y-axis labeling and y-axis divisions. They also control the visibility of y-axis grid lines (but see also Trend graph: TraceN group).

Y-Axis group properties

The group includes the following properties:

• yAxisAutoScaleMode
• yAxisAutoScaleVisTracesOnlyFlag
• yAxisFlag
• yAxisGridVisFlag
• yAxisLabelTextHeight
• yAxisMajorDivisions
• yAxisMinLabelWidth
• yAxisMinorDivisions
• yAxisMultiRangeMode
• yAxisPosition
• yAxisValueLabels

yAxisAutoScaleMode

Controls how the y-axis range is calculated. Select one of the following from the drop down menu:

• Off: The yValueMin and yValueMax properties determine the range of y-axis.
• 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.

yAxisAutoScaleVisTracesOnlyFlag

Specifies that only visible traces should be used in scaling the y-axis when yAxisAutoScaleMode is not OFF. See traceNVisFlag.

This property is in the Y-Axis property group.

yAxisFlag

Controls the visibility of the labels and ticks for trace01, if yAxisMultiRangeMode is set to Off or Classic.

This property is in the Y-Axis property group.

yAxisGridVisFlag

Set to display a horizontal line for each major y-axis division for trace01, if yAxisMultiRangeMode is set to Off or Classic.

This property is in the Y-Axis property group.

yAxisLabelTextHeight

Specifies the height of the y-axis labels in pixels, if yAxisMultiRangeMode is set to Off or Classic

This property is in the Y-Axis property group.

yAxisMajorDivisions

Specifies the number of major divisions (wide ticks) on the y-axis, if yAxisMultiRangeMode is set to Off or Classic.

This property is in the Y-Axis property group.

yAxisMinLabelWidth

Specifies the minimum width of the y-axis labels in pixels, if yAxisMultiRangeMode is set to Off or Classic.

This property is in the Y-Axis property group.

yAxisMinorDivisions

Specifies the number of minor divisions (narrow ticks) on the y-axis, if yAxisMultiRangeMode is set to Off or Classic.

This property is in the Y-Axis property group.

yAxisMultiRangeMode

To specify the appearance of the y-axis when this chart has multiple traces, select one of the following from the drop down menu:

• Off: Only a single set of labels and ticks appears on the y-axis. The label range is based on the following properties: yAxisAutoScaleMode, yValueMin, and yValueMax.
• Classic: Ticks and labels for trace01 appear on the left, outside of the plot area. Labels for the remaining traces appear on the left, inside of the plot area. With this setting for yAxisMultiRangMode, the yAxisPosition property is ignored. The label range for each trace is based on the following properties: yAxisAutoScaleMode, yValueMin, and yValueMax.
• Multiple Axis: A set of labels and ticks appears for each trace. The label range is determined independently for each trace, based on the following properties: traceNYAxisAutoScaleMode, traceNYAxisValueMin, traceNYAxisValueMax.
• Strip Chart: The y-axis is divided into sections, one for each trace. The traces are not overlaid, but rather appear one on top of the other. A set of labels and ticks appears for each trace. The label range is determined independently for each trace, based on the following properties: traceNYAxisAutoScaleMode, traceNYAxisValueMin, traceNYAxisValueMax.

This property is in the Y-Axis property group.

yAxisPosition

Specify the position of the y-axis ticks and labels. This property is ignored if yAxisMultiRangeMode is Multiple Axis or Strip Chart.

This property is in the Y-Axis property group.

yAxisValueLabels

Set to display a text label or tick mark on the y-axis in place of a numerical value, if yAxisMultiRangeMode is set to Off or Classic. Include a value with no label to display a tick mark without a label. Use this format:

value1=label1,value2,value3=label2

Here is an example:

0=Off,1,2=On

This property is in the Y-Axis property group.