initialize-ChartCursor: Initializes a ChartCursor

Description Usage Arguments Value Examples

Description

Initializes or updates a ChartCursor.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
## S4 method for signature 'ChartCursor'
initialize(.Object, oneBalloonOnly, valueLineAxis, ...)

chartCursor(animationDuration = 0.3, oneBalloonOnly, valueLineAxis, ...)

setOneBalloonOnly(.Object, oneBalloonOnly)

## S4 method for signature 'ChartCursor,logical'
setOneBalloonOnly(.Object, oneBalloonOnly)

setValueLineAxis(.Object, valueLineAxis = NULL, ...)

## S4 method for signature 'ChartCursor,ValueAxisOrCharacterOrMissing'
setValueLineAxis(.Object,
  valueLineAxis = NULL, ...)

Arguments

.Object

ChartCursor.

oneBalloonOnly

logical, if TRUE, border color will be changed when user rolls-over the slice, graph, etc, instead of background color.

valueLineAxis

ValueAxis. If you set valueLineBalloonEnabled to TRUE, but you have more than one axis, you can use this property to indicate which axis should display balloon.

...

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

animationDuration

numeric, duration of animation of a line, in seconds.

Value

(updated) .Object of class ChartCursor.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
new("ChartCursor", oneBalloonOnly = TRUE)

chartCursor()
chartCursor(oneBalloonOnly = TRUE)

setOneBalloonOnly(.Object = chartCursor(), oneBalloonOnly = TRUE)
setValueLineAxis(.Object = chartCursor(), id = "valueAxis1",
                 title = "Hello !", axisTitleOffset = 12)
# equivalent to:
valueLineAxis_obj <- valueAxis(id = "valueAxis1", title = "Hello !", axisTitleOffset = 12)
setValueLineAxis(.Object = chartCursor(), valueLineAxis  = valueLineAxis_obj)
# or iff 'valueLineAxis_obj' has already been added to the chart:
setValueLineAxis(.Object = chartCursor(), valueLineAxis  = "valueAxis1")

rAmCharts documentation built on May 29, 2017, 9:41 a.m.

Search within the rAmCharts package
Search all R packages, documentation and source code