| targetElement |
na |
string |
Example |
|
Sets the ID of the target element (div, p , span etc) that will host the interactive chart.
Must be set before calling CreateChart(). |
|
| defaultChart |
initparams:DefaultChart=XXX |
string |
Example |
|
Sets the default chart template to display. The default chart value is the value
returned from saveChartTemplate. If rememberUserChanges is set to true and the
userId has been set, then the users last chart will be displayed instead. |
|
| userID |
initparams:userID=kgilb123 |
string |
Example |
|
Used in conjunction with rememberUserChanges. If rememberUserChanges is set to true, this will identify the user to save the changes. Must be set before calling createChart(). Optional
|
|
| userStorageKey |
initparams:UserStorageKey=MyKey |
string |
Example |
|
Used in conjunction with the userID and rememberUserChanges. If rememberUserChanges is set to true, this will identify a unique key for the chart to save for the user. Used if there are multiple instances of the Interactive Chart widget on a website. Must be set before calling CreateChart().
Optional |
|
| rememberUserChanges |
initparams: RemeberUserChanges=True |
boolean |
Example |
|
Used in conjunction with the userID and userStorageKey. If rememberUserChanges
is set to true, any changes a user makes to a chart will be remembered the next
time that chart is loaded. Must be set before calling CreateChart() Optional |
|
| timeFrame_set(value) |
initparams: ChartTimeFrame=1-Minute |
string |
Example |
|
Sets the timeframe (frequency) of the bars on the chart. |
|
| timeFrame_get(value) |
na |
string |
Example |
|
Gets the timeframe (frequency) of the bars on the chart. |
|
| bgColor_set(colorHex) |
initparams: ChartBackgroundColor=#FFFFFF |
string |
Example |
|
Sets the chart background color.
This function takes a standard web hex color, or an 8 hex color with alpha.
|
|
| bgColor_get() |
initparams:none |
string |
Example |
|
Gets the chart background color.
This function returns a standard web hex color, or an 8 hex color with alpha as a
string.
|
|
| numBarsVis_set(number) |
initparams: NumberOfBars=50 |
integer |
Example |
|
Sets the number of bars of data to show on the chart.
|
|
| numBarsVis_get() |
none |
integer |
Example |
|
Returns the number of bars visible on the chart
|
|
| showZoomScroll_set(bool) |
initparams: ZoomScrollVisible=false |
boolean |
Example |
|
Displays the Zoom scroll slider at the bottom of the chart. Default is Enabled; |
|
| showZoomScroll_get() |
none |
boolean |
Example |
|
Returns true if the ZoomScroll slider is visible, false if not.
|
|
| fixedEndDate_set(date) |
initparams: FixedEndDate=3/11/2009 |
Date |
Example |
|
Sets the chart end date (the date on the right hand side of the chart) to a
specific date |
|
| fixedEndDate_get(date) |
na |
Date |
Example |
|
Gets the fixed chart end date |
|
| watermarkOpacity_set(value) |
initparams: WatermarkOpacity=.5 |
integer |
Example |
Sets the symbol overlay watermark opacity. Values are 0-100.
0 = invisible 100 = opaque. The init params takes a value from 0-1.
|
|
| watermarkOpacity_get() |
na |
integer |
Example |
|
Gets the symbol overlay watermark opacity. Returns 0-100
|
|
| showValueScale_set(bool) |
initparmas:ValueScaleVisible=true |
boolean |
Example |
|
Sets the value scale on the right hand side of the chart visible or hidden. True = visible, False =
hidden
|
|
| showValueScale_get(bool) |
na |
boolean |
Example |
|
Returns whether the value scale is visible or hidden. True = visible, False =
hidden
|
|
| showDateScale_set(bool) |
initparmas:DateScaleVisible=true |
boolean |
Example |
|
Sets the Date scale on the bottom of the chart visible or
hidden.. True = visible, False =
hidden
|
|
| showDateScale_get(bool) |
na |
boolean |
Example |
|
Gets the Date scale visibilty.. True = visible, False =
hidden
|
|
| valueScaleFontSize_set(integer) |
initparmas:ValueScaleFontSize=11 |
integer |
Example |
|
Sets the value scale font size in points
|
|
| valueScaleFontSize_get(integer) |
na |
integer |
Example |
|
Gets the value scale font size in points
|
|
| dateScaleFontSize_set(integer) |
initparmas: DateScaleFontSize=11 |
integer |
Example |
|
Sets the date scale font size in points
|
|
| dateScaleFontSize_get(integer) |
na |
integer |
Example |
|
Gets the date scale font size in points
|
|
| showToolBar_set(boolean) |
initparams:ShowToolBar=true |
boolean |
Example |
|
Sets the top toolbar visible or hidden. True = visible, False = hidden
|
|
| showToolBar_get(boolean) |
na |
boolean |
Example |
|
Gets the visibility of the top toolbar. True = visible, False = hidden
|
|
| showChangeSymbol_set(boolean) |
initparams:ShowChangeSymbol=true |
boolean |
Example |
|
Sets the visibility of the change symbol text box at the top of the chart. True = visible, False = hidden
|
|
| showChangeSymbol_get(boolean) |
na |
boolean |
Example |
|
Gets the visibility of the change symbol text box at the top of the chart. True = visible, False = hidden
|
|
| showChangeTimeFrame_set(boolean) |
initparams:ShowChangeTimeFrame=true |
boolean |
Example |
|
Sets the visibility of the time frame dropdown at the top of the chart. True = visible, False = hidden
|
|
| showChangeTimeFrame_get(boolean) |
na |
boolean |
Example |
|
Gets the visibility of the time frame dropdown at the top of the chart. True = visible, False = hidden
|
|
| showComparison_set(boolean) |
initparams:ShowComparison=true |
boolean |
Example |
|
Sets the visibility of the comparison option at the top of the chart. True = visible, False = hidden
|
|
| showComparison_get(boolean) |
na |
boolean |
Example |
|
Gets the visibility of the comparison option at the top of the chart. True = visible, False = hidden
|
|
| showChangeIndicator_set(boolean) |
initparams:ShowChangeIndicator=true |
boolean |
Example |
|
Sets the visibility of the indicators options at the top of the chart. True = visible, False = hidden
|
|
| showChangeIndicator_get(boolean) |
na |
boolean |
Example |
|
Gets the visibility of the indicators options at the top of the chart. True = visible, False = hidden
|
|
| showChangeChartSettings_set(boolean) |
initparams: ShowChangeChartSettings |
boolean |
Example |
|
Sets the visibility of the chart settings at the top of the chart. True = visible, False = hidden
|
|
| showChangeChartSettings_get(boolean) |
na |
boolean |
Example |
|
Gets the visibility of the chart settings at the top of the chart. True = visible, False = hidden
|
|