Type class
AmStockChart is a main class Stock chart.
Inheritance
AmStockChart does not extend any other symbol.
AmStockChart is not extended by any other symbol.
Properties
animationPlayed # |
Type Default Specifies if animation was already played. Animation is only played once, when chart is rendered for the first time. If you want the animation to be repeated, set this property to false. |
---|---|
balloon # |
Type Default Balloon object. |
categoryAxesSettings # |
Type Default Settings for category axes. |
chartCreated # |
Type Indicates if the chart is created. |
chartCursorSettings # |
Type Default Chart cursor settings. |
chartScrollbarSettings # |
Default Chart scrollbar settings. |
colors # |
Type Default Array of colors used by data sets if no color was set explicitly on data set itself. |
comparedDataSets # |
Type Default Array of data sets selected for comparing. |
dataSets # |
Type Default Array of DataSets. |
dataSetSelector # |
Type Default DataSetSelector object. You can add it if you have more than one data set and want users to be able to select/compare them. |
endDate # |
Type Default Current end date of the selected period, get only. To set start/end dates, use stockChart.zoom(startDate, endDate) method. |
firstDayOfWeek # |
Type Default Defines on which day week starts. 0 - Sunday, 1 - Monday... |
glueToTheEnd # |
Type Default If set to true the scope of the data view will be set to the end after data update. |
legendSettings # |
Type Default Legend settings. |
mainDataSet # |
Type Default Data set selected as main. |
panels # |
Type Default Array of StockPanels (charts). |
panelsSettings # |
Type Default Settings for stock panels. |
periodSelector # |
Type Default Period selector object. You can add it if you want user's to be able to enter date ranges or zoom chart with predefined period buttons. |
scrollbarChart # |
Type Default Scrollbar's chart object, get only. |
startDate # |
Type Default Current start date of the selected period, get only. To set start/end dates, use stockChart.zoom(startDate, endDate) method. |
stockEventsSettings # |
Type Default Settings for stock events. |
valueAxesSettings # |
Type Default Settings for value axes. |
version # |
Type Default read-only. Indicates current version of a script. |
zoomOutOnDataSetChange # |
Type Default Specifies whether the chart should zoom-out when main data set is changed. |
Methods
addListener( |
Returns type - string like 'dataUpdated' (should be listed in 'events' section of this class). handler - function which is called when event happens |
---|---|
addPanel( |
Returns panel - [[StockPanel]] |
addPanelAt( |
Returns panel - [[StockPanel]], index - Number |
clear() |
Returns Destroys chart, all timeouts and listeners. |
hideStockEvents() |
Returns |
removeListener( |
Returns |
removePanel( |
Returns panel - [[StockPanel]] |
showStockEvents() |
Returns |
validateData() |
Returns |
validateNow() |
Returns |
zoom( |
Returns startDate, endDate - Date objects. |
zoomOut() |
Returns |
Events
#clickStockEvent |
Param Dispatched when the user clicks on the Stock event (bullet). |
---|---|
#dataUpdated |
Param Dispatched when the chart was updated with new data. |
#init |
Param Dispatched when the chart is initialized for the first time. In case you want it to fire again after validateNow() method is called, set chart.chartCreated = false. |
#panelRemoved |
Param Dispatched when the StockPanel is removed. |
#rendered |
Param Dispatched each when chart is rendered. |
#rollOutStockEvent |
Param Dispatched when the user rolls-out of the Stock event (bullet). |
#rollOverStockEvent |
Param Dispatched when the user rolls-over the Stock event (bullet). |
#zoomed |
Param Dispatched when the chart is zoomed (even for the first time, when chart is initialized). |
Adapters
AmStockChart does not have any adapters.