Skip to contents

BackgroundConfiguration

Source: R/plotconfiguration-background.R
BackgroundConfiguration.Rd

R6 class defining the configuration of background

See also

Other PlotConfiguration classes: AxisConfiguration, BackgroundElement, BoxWhiskerPlotConfiguration, CumulativeTimeProfilePlotConfiguration, DDIRatioPlotConfiguration, ExportConfiguration, HistogramPlotConfiguration, LabelConfiguration, LegendConfiguration, LineElement, ObsVsPredPlotConfiguration, PKRatioPlotConfiguration, PieChartPlotConfiguration, PlotConfiguration, PlotGridConfiguration, QQPlotConfiguration, ResVsPredPlotConfiguration, ResVsTimePlotConfiguration, TimeProfilePlotConfiguration, TornadoPlotConfiguration, XAxisConfiguration, YAxisConfiguration

Active bindings

watermark

Label object

plot

BackgroundElement object

panel

BackgroundElement object

xAxis

LineElement object

yAxis

LineElement object

y2Axis

LineElement object

xGrid

LineElement object

yGrid

LineElement object

y2Grid

LineElement object

Methods

Public methods

Method new()

Create a new BackgroundConfiguration object

Usage

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

Arguments

watermark

Label object defining properties of watermark

plot

BackgroundElement object defining outside 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

y2Axis

LineElement object defining properties of right y-axis

xGrid

LineElement object defining properties of x-grid

yGrid

LineElement object defining properties of y-grid

y2Grid

LineElement object defining properties of right 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.