rAmCharts (version 2.0.2)

initialize,AmStockChart-method: Initializes an AmStockChart

Description

Method to initialize any S4 class provided by the package.

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 be 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 of AmStockChart.

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.

Details

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

ChartCursorSettings sets settings for chart cursor. If you change a property after the chart is initialized, you should call stockChart.validateNow() method. If there is no specified value, 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

# --- method 'initialize'
new("AmStockChart", theme = "dark")



# --- constructor
amStockChart()

library(pipeR)


# Dummy example
amStockChart() %>>% setBalloon(gridPosition = "start")


# Dummy example
setCategoryAxesSettings(.Object = amStockChart(), gridPosition = "start")


# Dummy example
setChartCursorSettings(.Object = amStockChart(), oneBallOnly = TRUE)


# Dummy example
amchart <- setChartScrollbarSettings(.Object = amStockChart(), enabled = TRUE)
print(amchart)

# equivalent to:
chartScrollbarSettings_obj <- chartScrollbarSettings()
setChartScrollbarSettings(.Object = amStockChart(),
                          chartScrollbarSettings = chartScrollbarSettings_obj)


# Dummy example
comparedDataSets_ls <- list(dataSet(compared = TRUE), dataSet(compared = TRUE))
setComparedDataSets(.Object = amStockChart(), comparedDataSets = comparedDataSets_ls)


# Dummy example
addComparedDataSet(.Object = amStockChart(), compared = TRUE)


# Dummy example
dataSets_ls <- list(dataSet(compared = FALSE), dataSet(compared = FALSE))
setDataSets(.Object = amStockChart(), dataSets = dataSets_ls)


# Dummy example
addDataSet(.Object = amStockChart(), compared = FALSE)
# equivalent to:
dataSet_obj <- dataSet(compared = FALSE)
addDataSet(.Object = amStockChart(), dataSet = dataSet_obj)


# Dummy example
print(setDataSetSelector(.Object = amStockChart(), width = 180))

# equivalent to:
dataSetSelector_obj <- dataSetSelector(width = 180)
print(setDataSetSelector(.Object = amStockChart(),
                         dataSetSelector = dataSetSelector_obj))


# Dummy example
setLegendSettings(.Object = amStockChart(), equalWidths = TRUE)


# Dummy example
setMainDataSet(.Object = amStockChart(), showInCompare = TRUE)


# Dummy example
panels_ls <- list(stockPanel(compared = TRUE), stockPanel(compared = TRUE))
setPanels(.Object = amStockChart(), panels = panels_ls)


# Dummy example
addPanel(.Object = amStockChart(), allowTurningOff = TRUE)
# equivalent to:
panel_obj <- panel(allowTurningOff = TRUE)
addPanel(.Object = amStockChart(), panel = panel_obj)


# Dummy example
setPanelsSettings(.Object = amStockChart(), backgroundAlpha = 0)


# Dummy example
setPeriodSelector(.Object = amStockChart(), dateFormat = "DD-MM-YYYY")


# Dummy example
setStockEventsSettings(.Object = amStockChart(), backgroundAlpha = 1)


# Dummy example
setValueAxesSettings(.Object = amStockChart(), autoGridCount = "TRUE")