Apama 10.15.0 | Building and Using Apama Dashboards | Dashboard Property Reference for Graphs, Tables and Trends | Trend Objects | Stock charts | Stock chart: X-Axis 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.
Note: 
timeRange is ignored if both timeRangeBegin and timeRangeEnd are set.
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
Note: 
If only the time is specified, the current date is used.
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
Note: 
If only the time is specified, the current date is used.
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.
Note: 
If the price trace data is more granular than the time interval specified in your data attachment, the price trace data will be aggregated to match the timeRangeMode.
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.
Note: 
This property applies when the timeRangeMode property is set to Continuous.
This property is in the X-Axis property group.