playwith (version 0.9-54)

playState: Object representing the plot, window and device.

Description

The playState object is created by playwith to represent the state of the plot, window and device. It is central to the playwith.API.

Details

A playState object is an environment (of class "playState") containing many other objects, including:

win

the plot window (gtkWindow).

dev

the plot device, as returned by dev.cur.

call

the current plot call.

env

local environment used to store plot data objects.

accepts.arguments

whether the current main plot function accepts arguments.

callName

name of the current main plot function.

is.lattice, is.ggplot, is.vcd, is.base

whether the current plot is a Lattice / ggplot / base graphics plot. is.base is defined as TRUE if neither of the others is TRUE and viewport is undefined.

result, trellis

result is the result of evaluating the plot call. If is.lattice, the trellis object is also stored in trellis.

viewport

a named list of viewport paths (or names). One of these must be named "plot". NULL if the plot is a base graphics or Lattice plot.

spaces

a character vector listing all spaces defined in the current plot, not including "page".

labels

labels for data points, either given or guessed.

data.points

given data points or NULL.

ids

a named list of currently labelled data points. Each name corresponds to a "space", which can be "page" (positioned on page) or "plot" (positioned in plot coordinates). With Lattice graphics the space can be "packet 1" etc. Each list element is a data frame of numeric subscripts and pos (for label placement).

annotations

a named list of calls to be evaluated in a target viewport: each name corresponds to a "space", as in ids.

linked

an environment, containing a list "ids" and a list "subscribers". Elements of the former are subscripts of brushed data points. Elements of the latter are the playState objects of all linked plots in this group. This linked object is shared by all subscribers.

tools

hmm...

uiManager, actionGroups

the GtkUIManager and a named list of its action groups.

widgets

A list of the GUI widgets. The most useful one is drawingArea (the plot device widget).

tmp

a list of temporary objects, including:

plot.ready

whether the plot has been drawn and is ready for interaction.

identify.ok

whether data points and labels are defined (or a plausible guess could be made), allowing points to be identified.

There are several other standard objects which can be inspected with ls.str(playDevCur()).

Other objects can be passed in through the ... argument to playwith, or defined by tools.

See Also

playwith, playwith.API