playState {playwith} | R Documentation |
Object representing the plot, window and device.
Description
This object is used by playwith
to
represent the state of the plot, window and device.
The playState object is central to the playwith.API.
However, it may also be seen by users controlling the "device" with
playDevCur
, playDevList
etc.
Usage
## S3 method for class 'playState':
print(x, ...)
Arguments
x |
a playState object. |
... |
ignored. |
Details
A playState object is actually an environment
(of class "playState"
)
containing many other objects. It will always contain:
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 evaluated plot call arguments.
is.lattice
- whether the current plot is a Lattice plot.
is.ggplot
- whether the current plot is a ggplot plot.
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.
labels
- labels for data points, either given or guessed.
data.points
- given data points or
NULL
.
time.mode
- whether time mode is active (horizontal scroll bar).
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.
The numeric vector in each list element gives the indices
of currently identified points in that space.
annotations
- a named list of calls.
Each name corresponds to a "space", as in
ids
.
brushed
- a named list of currently brushed data points.
tools
- a list of the widgets generated by the tool constructors.
widgets
- A list of the GUI widgets. The only one that might be useful
is
drawingArea
(the plot device itself).
drawingArea
topToolbar
leftToolbar
bottomToolbar
rightToolbar
callToolbar
callEntry
undoButton
redoButton
pageEntry
pageScrollbar
pageScrollBox
timeEntry
timeScrollbar
timeScrollBox
promptBox
promptLabel
vbox
hbox
accepts.arguments
- whether the called function accepts arguments.
plot.ready
- whether the plot has been drawn and is ready for interaction.
trellis
- the trellis object corresponding to the current plot,
if it is a Lattice plot.
Miscellaneous elements include:
page, pages, time.vector, cur.index, on.close,
.args, deviceToSpace, baseViewports
.
Other objects can be passed in through the ...
argument to
playwith
, or defined by tools.
Author(s)
Felix Andrews felix@nfrac.org
See Also
playwith
, playwith.API
[Package
playwith version 0.8.51
Index]