sections: sections

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

sections

Description

An S4 class to represent a piece of a graphic. It can include a co-ordinate system.

Usage

## S4 method for signature 'section'
initialize(
  .Object,
  ...,
  x = unit(0.5, "npc"),
  y = unit(0.5, "npc"),
  width = unit(1, "npc"),
  height = unit(1, "npc"),
  just = "centre",
  clip = "inherit",
  xscale = 0:1,
  yscale = 0:1,
  angle = 1,
  layers = list(),
  sections = list(),
  data = list(),
  style = list(),
  units = list(),
  borderCol = NULL,
  fillCol = NULL,
  borderLWD = 0.05,
  tableBox = NULL,
  action = list(),
  build = list(),
  camera = list(),
  display = list(),
  frames = integerSet(),
  tags = as.character()
)

section(...)

Arguments

x, y, width, height, clip, angle, xscale, yscale, sections, p, style, units, functions, tags	parameters for the constructor new("section") go directly into the relevant slots
just	can be 1 or 2 numbers, or a character vector including "left", "right", "top" or "bottom".
layers, ...	These parameters are merged into the layers slot.
borderCol, fillCol, borderLWD	REALLY NOT USED??? REMOVE
tableBox	USED??????? REMOVE????????
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 layer made by the constructor completely empty, with no parameters, no components, no sublayers, no functions, no units. It is active and plotted on every frame.

Slots

x,y,just

used to position the section

width,height

used to give the size of the section

clip

if grid is used, this controls clipping.

data

a list of parameters inherited by components, layers and sections in this section

style

a list of parameters inherited by components, layers and sections in this section

angle

used for rotation of viewports in grid

xscale,yscale

used for co-ordinates that use "native" co-ordinate units

layers

a list of layers

sections

a list of sections

units

a list of units inherited by components, layers and sections in this section

action,build,display

a list of section functions that can apply to the section, the list of parameters in data or layers, components and sections contained in the section.

camera

a list of functions that apply to layers and components in the section.

tags

USED??? REMOVE??

frames

controls which frames the section is plotted.

Examples

print(1+1)

R-graphic-design/RGD documentation built on Jan. 2, 2023, 10:30 p.m.