initialize-StockEvent: Initialize a StockEvent

In rAmCharts: JavaScript Charts Tool

Initialize a StockEvent

Description

Use the constructor to create the object or update an existing one with the setters.

Usage

## S4 method for signature 'StockEvent'
initialize(.Object, backgroundAlpha = 1, stockGraph, ...)

stockEvent(backgroundAlpha = 1, stockGraph, ...)

setStockGraph(.Object, stockGraph = NULL, ...)

## S4 method for signature 'StockEvent,AmGraphOrCharacterOrMissing'
setStockGraph(.Object, stockGraph = NULL, ...)

Arguments

.Object	StockEvent.
backgroundAlpha	numeric.
stockGraph	AmGraph created with stockGraph(*). This is the graph on which event will be displayed. You can use a reference to the stock graph object or id of the graph.
...	other properties of StockEvent.

Value

(updated) argument .Object of class StockEvent.

Examples

new("StockEvent")
stockEvent()
setStockGraph(.Object = stockEvent(), id = "stockGraph1", balloonText = "balloonText")
# equivalent to:
stockGraph_obj <- stockGraph(id = "stockGraph1", balloonText = "balloonText")
setStockGraph(.Object = stockEvent(), stockGraph = stockGraph_obj)
# if stockGraph_obj has already been added to the chart:
setStockGraph(.Object = stockEvent(), stockGraph = "stockGraph1")

rAmCharts documentation built on Sept. 30, 2022, 5:06 p.m.