initialize-ChartScrollbar: Initializes a ChartScrollbar

initialize,ChartScrollbar-methodR Documentation

Initializes a ChartScrollbar

Description

ChartScrollbarSettings sets settings for chart scrollbar. If you change a property after the chart is initialized, you should call stockChart.validateNow() method. If there is no default value specified, default value of ChartScrollbar class will be used. Run api("ChartScrollbarSettings") for more informations.

Usage

## S4 method for signature 'ChartScrollbar'
initialize(.Object, graph, enabled, ...)

chartScrollbar(graph, enabled = TRUE, ...)

chartScrollbarSettings(graph, enabled = TRUE, ...)

## S4 method for signature 'ChartScrollbar,AmGraphOrCharacterOrMissing'
setGraph(.Object, graph = NULL, ...)

setEnabled(.Object, enabled)

## S4 method for signature 'ChartScrollbar,logical'
setEnabled(.Object, enabled)

Arguments

.Object

ChartScrollbar.

graph

AmGraph. Specifies which graph will be displayed in the scrollbar.

enabled

logical, specifies if the chart should be updated while dragging/resizing the scrollbar or only when user releases mouse button.

...

other properties of ChartScrollbar. Run : api("ChartScrollbar") for more information.

Examples

new("ChartScrollbar", graph = "g1")
new("ChartScrollbar", graph = amGraph(test = 1))
chartScrollbar()
chartScrollbar(enabled = TRUE)
chartScrollbar()
chartScrollbar(enabled = TRUE)
# chartScrollbar with default graph
setGraph(.Object = chartScrollbar())

# example with arguments
setGraph(.Object = chartScrollbar(), id = "graph1", balloonText = "performance")
# equivalent to:
graph_obj <- amGraph(id = "graph1", balloonText = "performance")
(chartScrollbar_obj <- setGraph(.Object = chartScrollbar(), graph = graph_obj))
# or, iff graph_obj has alreadey been added to the chart:
setGraph(.Object = chartScrollbar(), graph = "graph1")

# ---
setEnabled(.Object = chartScrollbar(), enabled = TRUE)

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