components: components
In R-graphic-design/RGD: A package for Graphic Design in R

components

R Documentation

components

Description

An S4 class to represent a single element in a graphic;

Usage

component(...)

## S4 method for signature 'component'
initialize(
  .Object,
  ...,
  type = "points",
  style = list(),
  units = list(),
  data = list(),
  action = list(),
  build = list(),
  display = list(),
  active = TRUE,
  visible = TRUE,
  ref = as.character(),
  frames = integerSet()
)

component(...)

Arguments

`type, style, units, action, build, display, active, visible`	parameters for the constructor new("component") go directly into the relevant slots
`data, ref, ...`	These parameters are merged into the data slot. Note any arguments named ".type",".frames", ".abcd", ".useData" and ".repeats" are ignored.
`frames`	If this is an integerSet, it goes directly into the relevant slot. If it is a numeric vector it is converted into an integerSet for you.

Details

The default component made by the constructor is a point, with no parameters, no functions and no units. It is active and plotted on every frame.

Slots

type: The name(s) of the plotting function(s) used to plot the component. Defaults to "points". This can also include the names of classes linked to a plotting function.
units: A list of units to use for parameters.
data: a list of parameters.
style: a list of parameters to pass to par or gpar that are set for this component only.
active: logical. If FALSE the component functions aren't run
visible: logical. If FALSE the component isn't plotted.
action: list. Functions that act on the component or the elements of data. Changes made persist between frames. Actions run before build, camera, display and plot functions.
build: list. Functions that act on the component or the elements of data. Changes made last until the frame is plotted. Build functions run before camera, display and plot functions.
display: list. Functions that act on the component or the elements of data. Changes made last until the frame is plotted. Display functions run before plot functions.
frames: an integerSet. The set of frames the component can be displayed in, (assuming visible is TRUE).