Welcome to the Harris Geospatial documentation center. Here you will find reference guides and help documents.


  >  Docs Center  >  ENVI API  >  Application Control  >  ENVIPreferenceItem

ENVIPreferenceItem

ENVIPreferenceItem

ENVIPreferenceItem manages an individual preference.

To retrieve an ENVIPreferenceItem, use the bracket notation on the ENVIPreferences class, for example:

Result = e.Preferences['display general:default 16 bit stretch']

Example


; Launch ENVI
e = ENVI()
 
; Retrieve and print an ENVIPreferenceItem
prefItem = e.Preferences['display general:default 16 bit stretch']
PRINT, prefItem
 
;IDL prints:
ENVIPreferenceItem <236358>
NAME = display general:default 16 bit stretch
VALUE = Optimized Linear
TYPE = STRING
VALID_RANGE = !NULL
CHOICE_LIST = [No stretch,
  Linear,
  Linear 1%,
  Linear 2%,
  Linear 5%,
  Equalization,
  Gaussian,
  Square Root,
  Logarithmic,
  Optimized Linear]
  DEFAULT = Optimized Linear

Methods


RestoreDefault

Save

Properties


Properties marked as (Init) are applied only during the initial creation of the object. Properties marked as (Get) can be retrieved but not set. All other properties can be set during the creation of the object, or retrieved or changed after creation.

CHOICE_LIST (Get)

An array of possible values for the preference. If the preference item is not limited to a list of choices, this property will return !NULL.

DEFAULT (Get)

The default value for the preference.

NAME (Get)

The full name of the preference, in the form of category:name. The list of the categories and API names is listed in Preferences.

TYPE (Get)

The IDL data type of the preference value.

VALID_RANGE (Get)

The range of possible values for the preference. This property only applies to preferences with numeric type. If the preference is not limited to a certain range, this property will return !NULL

VALUE (Get, Set)

The preference value. Set this property to modify a preference in the ENVI application.

Note: Most preference changes take effect immediately. However, the following preference items require that you restart ENVI before they take effect:

  • localization:language
  • directories:extensions file directory
  • directories:custom code directory

Version History


ENVI 5.2

Introduced

API Version


3.3

See Also


ENVI, ENVIPreferences



© 2019 Harris Geospatial Solutions, Inc. |  Legal
My Account    |    Store    |    Contact Us