GaugeArrow: Initializes a GaugeArrow

In datastorm-open/rAmCharts: JavaScript Charts Tool

Initializes a GaugeArrow

Description

Uses the constructor to create the object with its properties or update an existing one with the setters.

Usage

## S4 method for signature 'GaugeArrow'
initialize(.Object, alpha = 1, axis, ...)

gaugeArrow(alpha = 1, axis, ...)

setAxis(.Object, axis = NULL, ...)

## S4 method for signature 'GaugeArrow,GaugeAxisOrCharacterOrMissing'
setAxis(.Object, axis = NULL, ...)

Arguments

.Object	GaugeArrow.
alpha	numeric.
axis	GaugeAxis. Axis of the arrow. You can use reference to the axis or id of the axis. If you don't set any axis, the first axis of the chart will be used.
...	other properties of GaugeArrow.

Value

(updated) .Object of class GaugeArrow.

Examples

# --- method initialize
new("GaugeArrow", alpha = 2)

# --- constructor
gaugeArrow(value = 10)

# -- update 'axis' property
setAxis(.Object = gaugeArrow(), id = "axis1", startValue = 0,
        endValue = 100, valueInterval = 10)
# equivalent to:
axis_obj <- gaugeAxis(id = "axis1", startValue = 0, endValue = 100, valueInterval = 10)
setAxis(.Object = gaugeArrow(), axis = axis_obj)
# or, iff, 'axis_obj' has already been added to the chart
setAxis(.Object = gaugeArrow(), axis = "axis1")

datastorm-open/rAmCharts documentation built on Oct. 4, 2022, 7:07 p.m.