initialize,Guide-method {rAmCharts}

Initializes a Guide

Description

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

Usage

## S4 method for signature 'Guide'
initialize(.Object, fillAlpha, valueAxis, value, ...)

guide(fillAlpha, valueAxis, value, ...)

setFillAlpha(.Object, fillAlpha)

## S4 method for signature 'Guide,numeric'
setFillAlpha(.Object, fillAlpha)

## S4 method for signature 'Guide,ValueAxisOrCharacterOrMissing'
setValueAxis(.Object, valueAxis = NULL, ...)

Arguments

.Object

Guide

fillAlpha

numeric, specifies if a grid line is placed on the center of a cell or on the beginning of a cell. Possible values are: "start" and "middle" This setting doesn't work if parseDates is set to TRUE.

valueAxis

ValueAxis class. As you can add guides directly to the chart, you might need to specify which value axis should be used.

value

numeric.

...

other properties of Guide.

Examples

# --- method initialize
new("Guide", fillAlpha = 0.1, gridThickness = 1, value = 1)

# --- constructor
guide(fillAlpha = .4, value = 1)
guide(fillAlpha = .4, adjustBorderColor = TRUE, gridThickness = 1)

setFillAlpha(.Object = guide(), fillAlpha = 1)
valueAxis_obj <- valueAxis(test = "foo")
setValueAxis(.Object = guide(), valueAxis = valueAxis_obj)