R: Query the displays/windows of a ggobi instance.

getDisplays.ggobi {Rggobi}

R Documentation

Query the displays/windows of a ggobi instance.

Description

This returns a list of display or plot windows references or full descriptions of each display owned by a particular ggobi instance.

Usage

getDisplays.ggobi(describe = FALSE, .gobi=getDefaultGGobi())

Arguments

`describe`	a logical value indicating whether the full description should be returned (`TRUE`), or simply a reference to the display in the form of a code{ggobiDisplay}.
`.gobi`	the ggobi instance whose displays are to be described or referenced. This should be an object of class `ggobi` or an integer.

Value

A list with an element for each display in the ggobi instance. If describe is specified as TRUE, each element has $5$ components:

`Name`	The title on the display's window.
`Type`	The type of display (e.g. scatterplot, parallel coordinat plot, ...) given as a named integer vector whose value is the internal type code and whose name is a more descriptive identifier for the plot type.
`Plots`	A list describing each of the sub-plots within the display/window. Each element is a list containing 3 elements: variables a named integer vector identifying the variables in the plot by both name and also index. (The indeces are problematic if one removes variables in the dataset). dataset an object of class `ggobiDataset` identifying the dataset in which the variables are located. ggobi an object of class `ggobiInstance` specifying to which ggobi the data and plot ``belong''.
`dataset`	an object of class `ggobiDataset` which is a reference to the dataset that is associated with this display, i.e. which contains the variables in the different plots in this display.
`display`	an object of class `ggobiDisplay` which can be used to operate on the display and allows the need to refer to it by index.

If describe is FALSE, each element is an object of class ggobiDisplay and this is an opaque reference to the internal C-level dataset.

Author(s)

Duncan Temple Lang

References

http://www.ggobi.org

Examples

 g <- ggobi(system.file("data", "flea.xml", package="Rggobi"))
 g$scatmat(1:3)
   # Now see what we have.
 g$getDisplays(TRUE)

   # Get references to the displays and close the 
   # second one.
 close(g$getDisplays()[[2]])

[Package Rggobi version 1.1-2 Index]