Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1556

News	FAQ
Search	Home

viewerdisplaydata.setoptions - Function

	Package	display
	Module	viewer
	Tool	viewerdisplaydata

Set the state of this tool

Synopsis
setoptions(newopts, emit, id)

Arguments

newopts		options record describing requested state
		Allowed:	record
emit		emit the options that have been installed
		Allowed:	Boolean
		Default:	T
id		option request identification tag
		Allowed:	Numeric
		Default:	-1

Returns
T

Description

This function should be used to set the internal state of a Viewerdisplaydata tool. The format of the newopts record is a short form of the record returned by the getoptions function, and simply consists of one or more top-level fields, whose values are the values that should be set for each option. The emit argument should rarely be anything other than T, since this is how other interested parties can find out when the Viewerdisplaydata tool has been adjusted. The id argument is reserved for internal use, and should never be explicitly listed in a call to this function, other than from calls from within the Viewer tool which manages this tool.

Installing new options in a Viewerdisplaydata tool will generally cause the refresh (that is, a total re-drawing) of any Viewerdisplaypanel tools on which this tool is registered. This is because modifying the options will modify the appearance of the drawing of this data. Furthermore, there are some options (for example, region and complexmode) which, when adjusted, will cause internal changes to other options, normally datamin and datamax for raster tools.

Example
A simple example will help clarify things:

- mv := viewer();
- mdd := mv.loaddata('myimage', 'raster');
- mdd.setoptions([power=1.6, aspect='flexible']);