rAmCharts (version 1.1.2)

initialize,AmStockChart-method: Initialize an AmStockChart

Description

Method for initializing any S4 class provided by the package.

amStockChart is a shortcut constructor for instantiating AmChart of type stock

Usage

"initialize"(.Object, balloon, comparedDataSets, dataSets, dataSetSelector, mainDataSet, panels, periodSelector, theme, ...)
amStockChart(balloon, comparedDataSets, dataSets, dataSetSelector, mainDataSet, panels, periodSelector, theme, ...)
"setBalloon"(.Object, amBalloon = NULL, ...)
setCategoryAxesSettings(.Object, ...)
"setCategoryAxesSettings"(.Object, ...)
setChartCursorSettings(.Object, ...)
"setChartCursorSettings"(.Object, ...)
setChartScrollbarSettings(.Object, chartScrollbarSettings = NULL, ...)
 "setChartScrollbarSettings"(.Object, chartScrollbarSettings = NULL, ...)
setComparedDataSets(.Object, comparedDataSets)
"setComparedDataSets"(.Object, comparedDataSets)
addComparedDataSet(.Object, dataSet = NULL, ...)
"addComparedDataSet"(.Object, dataSet = NULL, ...)
setDataSets(.Object, dataSets)
"setDataSets"(.Object, dataSets)
addDataSet(.Object, dataSet = NULL, ...)
"addDataSet"(.Object, dataSet = NULL, ...)
setDataSetSelector(.Object, dataSetSelector = NULL, ...)
"setDataSetSelector"(.Object, dataSetSelector = NULL, ...)
setLegendSettings(.Object, ...)
"setLegendSettings"(.Object, ...)
setMainDataSet(.Object, dataSet = NULL, ...)
"setMainDataSet"(.Object, dataSet = NULL, ...)
setPanels(.Object, panels)
"setPanels"(.Object, panels)
addPanel(.Object, panel = NULL, ...)
"addPanel"(.Object, panel = NULL, ...)
setPanelsSettings(.Object, ...)
"setPanelsSettings"(.Object, ...)
setPeriodSelector(.Object, periodSelector = NULL, ...)
"setPeriodSelector"(.Object, periodSelector = NULL, ...)
setStockEventsSettings(.Object, ...)
"setStockEventsSettings"(.Object, ...)
setValueAxesSettings(.Object, ...)
"setValueAxesSettings"(.Object, ...)

Arguments

.Object

AmStockChart.

balloon

AmBalloon.

comparedDataSets

list of DataSet. Properties of data sets selected for comparing.

dataSets

list of DataSet. Each element must a list of DataSet properties.

dataSetSelector

list of DataSetSelector. You can add it if you have more than one data set and want users to be able to select/compare them.

mainDataSet

DataSet. Data set selected as main.

panels

list of StockPanel.

periodSelector

PeriodSelector. You can add it if you want user's to be able to enter date ranges or zoom chart with predefined period buttons.

theme

character.

...

Other properties...

amBalloon

AmBalloon. Argument for method setBalloon.

chartScrollbarSettings

ChartScrollbar. If you change a property after the chart is initialized, you should call stockChart.validateNow() method in order for it to work. If there is no default value specified, default value of ChartScrollbar class will be used.

dataSet

DataSet.

panel

StockPanel.

Value

An object of class AmStockChart.

Functions

• amStockChart:

Details

CategoryAxesSettings set's settings common for all CategoryAxes of StockPanels. If you change a property after the chart is initialized, you should call stockChart.validateNow() method in order for it to work. If there is no default value specified, default value of CategoryAxis class will be used. you should get this axis from the chart and set properties to this object.

ChartCursorSettings settings set's settings for chart cursor. If you change a property after the chart is initialized, you should call stockChart.validateNow() method in order for it to work. If there is no default value specified, default value of ChartCursor class will be used.

You can add it if you have more than one data set and want users to be able to select/compare them.

Examples

new("AmStockChart", theme = "dark")
amStockChart()
# ---
setBalloon(.Object = amStockChart(), gridPosition = "start")
# ---
setCategoryAxesSettings(.Object = amStockChart(), gridPosition = "start")
# ---
setChartCursorSettings(.Object = amStockChart(), oneBallOnly = TRUE)
# ---
setChartScrollbarSettings(.Object = amStockChart(), enabled = TRUE)
# equivalent to:
chartScrollbarSettings_obj <- chartScrollbarSettings()
setChartScrollbarSettings(.Object = amStockChart(),
                          chartScrollbarSettings = chartScrollbarSettings_obj)
# ---
comparedDataSets_ls <- list(dataSet(compared = TRUE), dataSet(compared = TRUE))
setComparedDataSets(.Object = amStockChart(), comparedDataSets = comparedDataSets_ls)
addComparedDataSet(.Object = amStockChart(), compared = TRUE)
# ---
dataSets_ls <- list(dataSet(compared = FALSE), dataSet(compared = FALSE))
setDataSets(.Object = amStockChart(), dataSets = dataSets_ls)
# ---
addDataSet(.Object = amStockChart(), compared = FALSE)
# equivalent to:
dataSet_obj <- dataSet(compared = FALSE)
addDataSet(.Object = amStockChart(), dataSet = dataSet_obj)
# ---
print(setDataSetSelector(.Object = amStockChart(), width = 180))

# equivalent to:
dataSetSelector_obj <- dataSetSelector(width = 180)
print(setDataSetSelector(.Object = amStockChart(),
                         dataSetSelector = dataSetSelector_obj))
setLegendSettings(.Object = amStockChart(), equalWidths = TRUE)
setMainDataSet(.Object = amStockChart(), showInCompare = TRUE)
panels_ls <- list(stockPanel(compared = TRUE), stockPanel(compared = TRUE))
setPanels(.Object = amStockChart(), panels = panels_ls)
addPanel(.Object = amStockChart(), allowTurningOff = TRUE)
# equivalent to:
panel_obj <- panel(allowTurningOff = TRUE)
addPanel(.Object = amStockChart(), panel = panel_obj)
setPanelsSettings(.Object = amStockChart(), backgroundAlpha = 0)
setPeriodSelector(.Object = amStockChart(), dateFormat = "DD-MM-YYYY")
setStockEventsSettings(.Object = amStockChart(), backgroundAlpha = 1)
setValueAxesSettings(.Object = amStockChart(), autoGridCount = "TRUE")