Skip to contents

R6 class defining the configuration of background

Active bindings

watermark

Label object

plot

BackgroundElement object

panel

BackgroundElement object

xAxis

LineElement object

yAxis

LineElement object

xGrid

LineElement object

yGrid

LineElement object

Methods


Method new()

Create a new BackgroundConfiguration object

Usage

BackgroundConfiguration$new(
  watermark = NULL,
  plot = NULL,
  panel = NULL,
  xAxis = NULL,
  yAxis = NULL,
  xGrid = NULL,
  yGrid = NULL
)

Arguments

watermark

Label object defining properties of watermark

plot

BackgroundElement object defining oustide plot background properties

panel

BackgroundElement object defining panel (inside of plot) background properties

xAxis

LineElement object defining properties of x-axis

yAxis

LineElement object defining properties of y-axis

xGrid

LineElement object defining properties of x-grid

yGrid

LineElement object defining properties of y-grid

Returns

A new BackgroundConfiguration object


Method updatePlot()

Update background a ggplot object from BackgroundConfiguration properties

Usage

BackgroundConfiguration$updatePlot(plotObject)

Arguments

plotObject

a ggplot object

Returns

A ggplot object


Method clone()

The objects of this class are cloneable with this method.

Usage

BackgroundConfiguration$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.