Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1556

News	FAQ
Search	Home

viewerdisplaypanel.status - Function

	Package	display
	Module	viewer
	Tool	viewerdisplaypanel

Return a record describing various attributes of the Viewerdisplaypanel tool

Synopsis
status()

Returns
record

Description

This function returns some fairly low-level information about the Viewerdisplaypanel tool. The record returned has upto two top-level fields: pixelcanvas, and paneldisplay if this Viewerdisplaypanel tool holds data.

Fields which may exist in the pixelcanvas sub-record include the following (those tagged ``dynamic'' can change during the lifetime of a Viewerdisplaypanel tool):

• width: width of the entire display area (``pixelcanvas'') in pixels (dynamic).

• height: height of the pixelcanvas in pixels (dynamic).

• depth: bit depth of the pixelcanvas, normally 8-bit.

• maptype: maptype of the pixelcanvas, normally 'index'.

• xdpi: approximate resolution in the X direction, in dots per inch (dpi).

• ydpi: approximate resolution in the Y direction.

• colortablesize: number of colors currently allocated to the pixelcanvas (dynamic).

• maxcolortablesize: maximum number of colors that could immediately be allocated to the pixelcanvas (dynamic).

• buildincolormaps: names of the colormaps that are known to the pixelcanvas.

• registeredcolormaps: a record having sub-fields names, which lists the names of the registered colormaps, and sizes, which lists the length of each of the named, registered colormaps. Normally the values in sizes should add up to colortablesize, since the colormaps will dynamically resize to fill the colortable.

Fields which may exist in the paneldisplay sub-record (they are all dynamic) include:

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

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

• xorigin: The blcX of this paneldisplay on the pixelcanvas (0.0-1.0).

• yorigin: The blcY of this paneldisplay on the pixelcanvas (0.0-1.0).

• xsize: The extent in x of this paneldisplay on the pixelcanvas (0.0-1.0).

• xsize: The extent in y of this paneldisplay on the pixelcanvas (0.0-1.0).

• linearblc: linear coordinates [x, y] of the bottom-left corner of each panel in the paneldisplay.

• lineartrc: linear coordinates [x, y] of the top-right corner of each panel in the paneldisplay.

• worldblc: world coordinates [x, y] of the bottom-left corner of each panel in the paneldisplay.

• worldtrc: world coordinates [x, y] of the top-right corner of each panel in the paneldisplay.

• axisunits: the units of the world axes