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

Setter for PanelsSettings.

Usage

## S3 method for class 'AmStockChart':
initialize(.Object, categoryAxesSettings,
  chartCursorSettings, chartScrollbarSettings, comparedDataSets, dataSets,
  dataSetSelector, legendSettings, mainDataSet, panels, panelsSettings,
  periodSelector, stockEventsSettings, theme, valueAxesSettings,
  pathToImages = "http://www.amcharts.com/lib/3/images/", ...)
amStockChart(categoryAxesSettings, chartCursorSettings, chartScrollbarSettings,
  comparedDataSets, dataSets, dataSetSelector, legendSettings, mainDataSet,
  panels, panelsSettings, periodSelector, stockEventsSettings, theme,
  valueAxesSettings, ...)
setCategoryAxesSettings(.Object, categoryAxesSettings = NULL, ...)
## S3 method for class 'AmStockChart':
setCategoryAxesSettings(.Object,
  categoryAxesSettings = NULL, ...)
setChartCursorSettings(.Object, chartCursorSettings = NULL, ...)
## S3 method for class 'AmStockChart':
setChartCursorSettings(.Object,
  chartCursorSettings = NULL, ...)
setChartScrollbarSettings(.Object, chartScrollbarSettings = NULL, ...)
## S3 method for class 'AmStockChart':
setChartScrollbarSettings(.Object,
  chartScrollbarSettings = NULL, ...)
setComparedDataSets(.Object, comparedDataSets)
## S3 method for class 'AmStockChart':
setComparedDataSets(.Object, comparedDataSets)
addComparedDataSet(.Object, dataSet = NULL, ...)
## S3 method for class 'AmStockChart':
addComparedDataSet(.Object, dataSet = NULL, ...)
setDataSets(.Object, dataSets)
## S3 method for class 'AmStockChart':
setDataSets(.Object, dataSets)
addDataSet(.Object, dataSet = NULL, ...)
## S3 method for class 'AmStockChart':
addDataSet(.Object, dataSet = NULL, ...)
setDataSetSelector(.Object, ...)
## S3 method for class 'AmStockChart':
setDataSetSelector(.Object, ...)
setLegendSettings(.Object, ...)
## S3 method for class 'AmStockChart':
setLegendSettings(.Object, ...)
setMainDataSet(.Object, dataSet = NULL, ...)
## S3 method for class 'AmStockChart':
setMainDataSet(.Object, dataSet = NULL, ...)
setPanels(.Object, panels)
## S3 method for class 'AmStockChart,list':
setPanels(.Object, panels)
addPanel(.Object, panel = NULL, ...)
## S3 method for class 'AmStockChart':
addPanel(.Object, panel = NULL, ...)
setPanelsSettings(.Object, ...)
## S3 method for class 'AmStockChart':
setPanelsSettings(.Object, ...)
setPeriodSelector(.Object, periodSelector = NULL, ...)
## S3 method for class 'AmStockChart':
setPeriodSelector(.Object, periodSelector = NULL,
  ...)
setStockEventsSettings(.Object, ...)
## S3 method for class 'AmStockChart':
setStockEventsSettings(.Object, ...)
setValueAxesSettings(.Object, valueAxesSettings = NULL, ...)
## S3 method for class 'AmStockChart':
setValueAxesSettings(.Object,
  valueAxesSettings = NULL, ...)

Arguments

.Object

AmStockChart.

categoryAxesSettings

list of CategoryAxis. CategoryAxesSettings settings 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

chartCursorSettings

list of ChartCursor. 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

chartScrollbarSettings

list of ChartScrollbar. ChartScrollbarSettings settings set's settings for chart scrollbar. If you change a property after the chart is initialized, you should call stockChart.validateNow() method in order for it to

comparedDataSets

DataSet. Data sets selected for comparing.

dataSets

list of DataSet.

dataSetSelector

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

legendSettings

list. Legend settings.

mainDataSet

list. Data set selected as main.

panels

list of StockPanel.

panelsSettings

list. Settings for stock panels.

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.

stockEventsSettings

list. Settings for stock events.

theme

character

valueAxesSettings

list. Settings for value axes.

pathToImages

character

...

Other properties...

dataSet

DataSet.

panel

StockPanel.

Value

An object of class AmStockChart.

Functions

amStockChart:

Examples

Run this code

new("AmStockChart", theme = "dark")
amStockChart()
setCategoryAxesSettings(.Object = amStockChart(), gridPosition = "start")
setChartCursorSettings(.Object = amStockChart(), oneBallOnly = TRUE)
setChartCursorSettings(.Object = amStockChart(), chartCursorSettings = chartCursor())
setChartCursorSettings(.Object = amStockChart(), chartCursorSettings = "foo")
setChartScrollbarSettings(.Object = amStockChart(), chartScrollbarSettings = chartScrollbar())
library(pipeR)
amStockChart() %>>% setComparedDataSets(list(dataSet(compared = TRUE), dataSet(compared = TRUE)))
addComparedDataSet(.Object = amStockChart(), compared = TRUE)
library(pipeR)
amStockChart() %>>% setDataSets(list(dataSet(compared = FALSE), dataSet(compared = FALSE)))
library(pipeR)
amStockChart() %>>% addDataSet(compared = FALSE) %>>% addDataSet(dataSet())
setDataSetSelector(.Object = amStockChart(), width = 180)
setLegendSettings(.Object = amStockChart(), equalWidths = TRUE)
setMainDataSet(.Object = amStockChart(), showInCompare = TRUE)
panels <- list(stockPanel(compared = TRUE), stockPanel(compared = TRUE))
setPanels(.Object = amStockChart(), panels = panels)
addPanel(.Object = amStockChart(), allowTurningOff = TRUE)
setPanelsSettings(.Object = amStockChart(), backgroundAlpha = 0)
setPeriodSelector(.Object = amStockChart(), dateFormat = "DD-MM-YYYY")
setStockEventsSettings(.Object = amStockChart(), backgroundAlpha = 1)
setValueAxesSettings(.Object = amStockChart(), autoGridCount = "TRUE")