C_04_lattice.options

0th

Percentile

Low-level Options Controlling Behaviour of Lattice

Functions to handle settings used by lattice. Their main purpose is to make code maintainance easier, and users normally should not need to use these functions. However, fine control at this level maybe useful in certain cases.

Keywords
dplot
Usage
lattice.options(...) lattice.getOption(name)
Arguments
name
character giving the name of a setting
...
new options can be defined, or existing ones modified, using one or more arguments of the form name = value or by passing a list of such tagged values. Existing values can be retrieved by supplying the names (as character strings) of the components as unnamed arguments.
Details

These functions are modeled on options and getOption, and behave similarly for the most part. Some of the available components are documented here, but not all. The purpose of the ones not documented are either fairly obvious, or not of interest to the end-user.

In addition, there is an option for the default prepanel and panel function for each high-level function; e.g., panel.xyplot and prepanel.default.xyplot for xyplot. The options for the others have similarly patterned names.

Value

lattice.getOption returns the value of a single component, whereas lattice.options always returns a list with one or more named components. When changing the values of components, the old values of the modified components are returned by lattice.options. If called without any arguments, the full list is returned.

See Also

options, trellis.device, trellis.par.get, Lattice

Aliases
  • lattice.options
  • lattice.getOption
Examples
library(lattice) names(lattice.options()) str(lattice.getOption("layout.widths"), max.level = 2)
Documentation reproduced from package lattice, version 0.20-34, License: GPL (>= 2)

Community examples

Looks like there are no examples yet.