rAmCharts (version 2.0.2)

initialize,TrendLine-method: Initializes a TrendLine

Description

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

Usage

"initialize"(.Object, initialValue, initialXValue, finalValue, finalXValue, valueAxis, valueAxisX, ...)
trendLine(.Object, initialValue, initialXValue, finalValue, finalXValue, valueAxis, valueAxisX, ...)
setInitialValue(.Object, initialValue)
"setInitialValue"(.Object, initialValue)
setInitialXValue(.Object, initialXValue)
"setInitialXValue"(.Object, initialXValue)
setFinalValue(.Object, finalValue)
"setFinalValue"(.Object, finalValue)
setFinalXValue(.Object, finalXValue)
"setFinalXValue"(.Object, finalXValue)
"setValueAxis"(.Object, valueAxis = NULL, ...)
setValueAxisX(.Object, valueAxisX = NULL, ...)
"setValueAxisX"(.Object, valueAxisX = NULL, ...)

Arguments

.Object

TrendLine.

initialValue

numeric, value from which trend line should start.

initialXValue

numeric, used by XY chart only. X value from which trend line should start.

finalValue

numeric, value at which trend line should end.

finalXValue

numeric, used by XY chart only. X value at which trend line should end.

valueAxis

ValueAxis. Value axis of the trend line. Will use first value axis of the chart if not set any. You can use a reference to the value axis object or id of value axis.

valueAxisX

ValueAxis. Used by XY chart only. X axis of trend line. Will use first X axis of the chart if not set any. You can use a reference to the value axis object or id of value axis.

...

other properties of TrendLine.

Value

(possibly updated) .Object of class TrendLine.

Examples

new("TrendLine", initialValue = 1, finalValue = 11)

# Other example
valueAxis <- valueAxis(title = "Hello !", axisTitleOffset = 12)
new("TrendLine", valueAxis = valueAxis)

trendLine(initialValue = 1, finalValue = 11)
setInitialValue(.Object = trendLine(), initialValue = 16)
setInitialXValue(.Object = trendLine(), initialXValue = 16)
setFinalValue(.Object = trendLine(), finalValue = 16)
setFinalXValue(.Object = trendLine(), finalXValue = 16)
setValueAxis(.Object = trendLine(), id = "valueAxis-1",
             title = "Hello !", axisTitleOffset = 12)
# equival to:
valueAxis_obj <- valueAxis(id = "valueAxis-1", title = "Hello !", axisTitleOffset = 12)
trendLine(valueAxis = valueAxis_obj)
# or...
trendLine(valueAxis = "valueAxis-1")
# valid if and only if 'valueAxis_obj' has already been added to the chart

setValueAxisX(.Object = trendLine(), id = "valueAxisX-1",
              title = "Hello !", axisTitleOffset = 12)
# equival to:
valueAxisX_obj <- valueAxis(id = "valueAxisX-1", title = "Hello !", axisTitleOffset = 12)
trendLine(valueAxisX = valueAxisX_obj)
# or...
trendLine(valueAxisX = "valueAxisX-1")
# valid if and only if 'valueAxisX_obj' has already been added to the chart