+Stock
Chart
Stock charts (class
name: obj_stockchart) are useful for displaying live and archived
stock data. Overlays can be used to compare this data against other stock,
overall activity on the stock index, or to show periodic events such as
stock splits and earnings announcements. The chart
supports up to nineteen overlays.
Price Trace Properties
Attach your tabular data
to the priceTraceHistoryTable or priceTraceCurrentTable
property.
To
attach data to either property, the table in your data attachment must
contain the following five columns (as described in the table below)
in this specific order: Date, Open, High, Low, Close.
The priceTraceHistoryTable
property is used for viewing and analyzing archived data (data generated
before the current moment). The table in your data attachment should contain
multiple rows, each corresponding to a point on the graph.
The
priceTraceCurrentTable
property
is used for viewing live data and would most likely be used in conjunction
with the priceTraceHistoryTable. The table in your data attachment
should contain a single row that corresponds to and continually updates
the last point on the graph.
Specify how price traces
are displayed in the chart.
| Property
Name |
Description |
| priceTraceBarGainColor |
Set 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. The
default is green.
NOTE: This property does not apply
if you have chosen Line for the priceTraceType
property. |
| priceTraceBarLossColor |
Set 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. The
default is red.
NOTE: This property does not apply
if you have chosen Line for the priceTraceType
property. |
| priceTraceFillStyle |
Select the appearance of the
price trace
from the drop down menu: Solid, Transparent,
Gradient,
or Transparent Gradient. Set to
None, the default, to disable.
The effects change based
on the priceTraceType:
Line - Fills from
the line to the bottom of the graph with the color and effect you choose.
Bar - Has no effect.
OHLC - Has no effect.
Candlestick - Fills
the Candlestick icon with the color and effect you choose. |
| priceTraceLabel |
Enter a label for the price
trace line. Appears in legend and tooltip enabled by mouseOverFlag. |
| priceTraceLineColor |
Select the
button and choose a color from the palette to set the price trace line
color.
NOTE: This property does not apply
if you chose OHLC or Bar for priceTraceType. |
| priceTraceLineStyle |
Select the style of the
price
trace
line from the drop down menu:
No Line, Solid, Dotted,
Dashed or Dot
Dashed.
NOTE: This property does not apply
if you chose OHLC or Bar for priceTraceType. |
| priceTraceLineThickness |
Select the thickness of
the price
trace line from the drop down menu: Thin, Medium
or Thick.
NOTE: This property does not apply
if you chose OHLC or Bar for priceTraceType. |
| priceTraceType |
Select the appearance of
the price trace from the drop down menu:
Line - A line graph
showing closing price values.
Bar - A bar graph
showing closing price values.
OHLC - 
- A bar extending from the low to high price data points. A left flange
indicates the opening price and the 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 data points. The "wicks"
on either end show the high and low for the day. The
priceTraceBarLossColor
and priceTraceBarGainColor properties show whether the stock closed
at a higher or lower price than the opening price. |
| priceTraceVisFlag |
Select to control price
trace visibility. |
Trace Properties
The overlay*CurrentTable
and overlay*HistoryTable properties are used in conjunction with
the priceTraceHistoryTable or priceTraceCurrentTable properties
to compare data (e.g. to compare the activity of several stocks). The tables
in these data attachments must have the following two columns: a Date column
(as
described in the table below) and a Value column
(numerical). The overlay*HistoryTable property should contain multiple
rows, each corresponding to a point on the graph. By default the overlays
are disabled. To enable, set the overlayCount to the number of overlay
traces you want to show.
NOTE: See the Attach to
Data section specific to your data source for details on how to use
the Select Columns dialog.
| Column Name |
Description |
| Date |
Supported formats
for time column are:
mm/dd/yyyy hh:mm:ss
(01/16/2004 12:30:03)
yyyy-mm-dd hh:mm:ss
(2004-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. |
Specify how traces are displayed
in the chart.
| Property
Name |
Description |
| overlayCount |
Set the number of overlays.
Maximum is nineteen. |
| overlayFillStyle |
Select the fill style of
the price trace from the drop down menu. Sets the appearance of the
overlay*Type.
Set to Solid, Transparent,
Gradient, or Transparent
Gradient. Set to None, the default, to disable.
The effects change based
on the overlay*Type:
Line - Fills from
the line to the bottom of the graph with the color and effect you choose.
Bar - Has no effect.
Event- Has no effect. |
| overlay*Label |
Enter a label for the overlay
line. Appears in legend and tooltip enabled by mouseOverFlag. |
| overlay*LineColor |
Select the
button and choose a color from the palette to set the overlay line color. |
| overlay*LineStyle |
Select the style of the
overlay line from the drop down menu:
No Line, Solid, Dotted, Dashed or
Dot Dashed.
NOTE: This property does
not apply if you chose Bar or Event for overlay*Type. |
| overlay*LineThickness |
Select the thickness of the overlay
line from the drop down menu:
No Line, Solid,
Dotted, Dashed or Dot
Dashed. NOTE: This
property does not apply if you chose Bar or Event for overlay*Type. |
| overlay*Type |
Select the appearance of
the overlay trace from the
drop down menu:
Line - A line graph.
Bar - A bar graph.
Event - A series
of markers representing company events such as stock splits, company merges,
etc. The first letter of the overlay*Label is the letter that appears
in each event marker. |
| overlay*VisFlag |
Select to control overlay
trace visibility. |
Background Properties
Specify how the background
is displayed in the stock chart.
| Property
Name |
Description |
| bg3dFlag |
Select to display a 3D edge on the
background rectangle. |
| bgColor |
Select the
button and choose a color from the palette to set the background color. |
| bgEdgeWidth |
Set the width of the 3D
edge on the background rectangle. This property is only used if the bg3dFlag
is selected. |
| bgGradientFlag |
Select to display a gradient
in the background rectangle. |
| bgVisFlag |
Select to display the background
rectangle. |
Column Properties
Specify which columns are
displayed in your stock chart.
| Property
Name |
Description |
| columnsToHide |
Specify which columns to
hide in your graph or add columns to your graph. |
Data Format Properties
Specify data format in your
stock chart.
| Property
Name |
Description |
| 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. |
Legend Properties
Specify the way the legend
is displayed in the stock chart.
| Property
Name |
Description |
| legendBgColor |
Select the
button and choose a color from the palette to set the background color
of the legend. |
| legendBgGradientFlag |
Select the legendBgGradientFlag
to display a gradient in the legend background. |
| legendValueMinSpace |
Specify the minimum distance
between values and labels in the legend. |
| legendValueVisFlag |
Select to display the numerical
values of your data in the legend. If the cursorFlag is enabled,
the numerical values are always shown in the legend. |
| legendVisFlag |
Select to display the legend. |
| legendWidthPercent |
Set the percent of the total
width of the object used for the legend. |
Interaction Properties
Select the mouseOverFlag
to enable tooltips. To display a tooltip, select the chart and point to
a bar or marker with the mouse. The tooltip will contain information from
your data attachment about that bar or marker.
To specify a drill
down display, double click on the drillDownTarget Property
Name. Any display (.rtv) file can be targeted as a drill down. Based on
your data attachment, substitutions
are created that will be passed into drill down displays. To customize
which substitutions will be passed into drill down displays, double-click
on drillDownColumnSubs
in the Object Properties window to open the Drill Down Column Substitutions
dialog. Once a drill down target has been set, double-click on the bar
or trace marker in the chart to activate the drill down. Drill down displays
can be activated in the same window that contains the chart or open in
a separate window. This allows you to build a customizable hierarchy of
displays.
Use drillDownSelectMode to control
how a drill down display is activated. Set to Anywhere to activate
a drill down display by double-clicking anywhere on the chart. Set to Element
Only
to enable a drill down display only when you double-click on a
bar in the chart.
Specify how you view the
data in the chart.
| Property
Name |
Description |
| 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. |
| legendPopupFlag |
When the cursor is enabled,
select the legendPopupFlag to display the legend along the cursor. |
| scrollbarMode |
Set whether and when the scroll bar
appears in the chart. There are three options:
Never - The
default setting.
Always - Displays a scroll
bar at all times.
As Needed - Displays 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
to view all data loaded into the chart. |
| 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. |
| 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. |
X-Axis Properties
Specify the way the x axis
is displayed and set time values to control how much data is plotted in
the stock chart.
| Property
Name |
Description |
| timeFormat |
Set 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 would result in the form August 30, 2003 05:32:12
PM. If no format is given, the date and time will not be 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 would
result in the form 08\30 05:32:12. If left blank, the axis is labeled
with a default format based on the range.
NOTE: This property is only used when
the timeRangeMode is Continuous. |
| 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 overlay*HistoryTable
and/or overlay*CurrentTable.
NOTE: timeRange is
ignored if both timeRangeBegin and timeRangeEnd are set. |
| timeRangeBegin |
Set the start time value
of the data to be plotted on the chart. Supported formats are:
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
NOTE: If only the time is
specified, then today's date will be used. |
| timeRangeEnd |
Set the end time value of
the data to be plotted on the chart. Supported formats are:
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
NOTE: If only the time is
specified, then today's date will be used. |
| timeRangeMode |
Select the timeRangeMode from
the drop down menu. Sets the interval between
trace data points. timeRangeMode also determines the type of label
to be used in a graph. For example, the label used on the x-axis could
be the date or the time depending on the time interval specified for the
data to be displayed. 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: hourly, every 15 minutes, etc.
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. |
| xAxisFlag |
Select to display the x-axis. |
| xAxisLabel |
Specify label to display
below the x-axis. |
| xAxisLabelTextHeight |
Specify the height in pixels
of the x-axis labels. |
| xAxisMajorDivisions |
Specify the number of major
divisions on the x-axis. |
| xAxisMinorDivisions |
Specify the number of minor
divisions on the x-axis.
NOTE: This property applies
when the timeRangeMode property is set to Continuous. |
Y-Axis Properties
Specify the way the x and
y axes are displayed in the stock chart.
| Property
Name |
Description |
| tradeDayBegin |
Defines the daily start
time of the trading day. This property is only used with intraday data
(time intervals less than one day: hourly, every 15 minutes, etc.). The
default value is 09:30. |
| tradeDayEnd |
Defines the daily end time
of the trading day. This property is only used with intraday data (time
intervals less than one day: hourly, every 15 minutes, etc.). The default
value is 16:00. |
| 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 a unique point 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. |
| yAxisAutoScaleMode |
Select how the
y-axis range is calculated from the drop down menu:
Off - The yValueMin
and yValueMax properties control the range of y-axis.
On - The
yAxisAutoScaleMode
calculates the y-axis range according
to data values being plotted.
On - Include Min/Max
- The yAxisAutoScaleMode calculates
the y-axis range including yValueMin and yValueMax. |
| yAxisFlag |
Select to display the y-axis. |
| 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. |
| yAxisLabel |
Specify label to display
to the left of the y-axis. |
| yAxisLabelTextHeight |
Specify the height of the
y-axis labels in pixels. |
| yAxisMajorDivisions |
Specify the number of major
divisions on the y-axis. |
| yAxisMinLabelWidth |
Specify the minimum
width of the y-axis labels in pixels. |
| yAxisMinorDivisions |
Specify the number of minor
divisions on the y-axis. |
| 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. |
| yAxisPercentFlag |
Select
to show the percent changed from the first data point instead of values
for the y-axis. |
|
