Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1556

News	FAQ
Search	Home

viewerdisplaypanel.getoptions - Function

	Package	display
	Module	viewer
	Tool	viewerdisplaypanel

Return a record describing some modifiable state of this tool

Synopsis
getoptions()

Returns
record

Description

This function returns a record which describes some of the internal state of this Viewerdisplaypanel tool. The record differs from that returned by the status tool function in both format and content: it is suitable for construction of an Autogui tool, and contains explicitly modifiable parameters. A brief description of the fields which may exist in the returned record follows:

• colortablesize: the number of colors currently allocated to this Viewerdisplaypanel tools pixelcanvas.

• papercolors: a boolean specifying whether screen or paper colors (black/white or white/black background/foreground) should be used.

• leftmarginspacepg: left margin space in PgPlot character units.

• bottommarginspacepg: bottom margin space in PgPlot character units.

• rightmarginspacepg: right margin space in PgPlot character units.

• topmarginspacepg: top margin space in PgPlot character units.

• nxpanels: The number of panels in x direction on this paneldisplay.

• nypanels: The number of panels in y direction on this paneldisplay.

• xspacing: The space between adjacent panels in x direction.

• yspacing: The space between adjacent panels in y direction.