GetDisplayedThemes()

Summary

Gets a list of themes shown on a layer or selection set.

 

Syntax

theme_names = GetDisplayedThemes(string lyr_set_name)

 

Argument	Contents
lyr_set_name	Name of the layer or selection set

 

Returns

An array of theme name strings.

 

Notes

• If lyr_set_name is null then GetDisplayedThemes() returns an array of theme name strings for the working layer in the working map.

• The lyr_set_name can include a map specification, as in "MyMap|States|Selection"; if a map specification is not included, the working map is used.

• If no themes are being shown, the return value is null.

• GetDisplayedThemes() does not return all themes defined on a layer, only those on the layer in the working map.

• Use GetThemes() to obtain a list of all themes defined on a layer.

Example

thms = GetDisplayedThemes("States|")

for i = 1 to thms.length do

     HideTheme("States|", thms[i])

     end

 

Error Codes

Error Type	Meaning
NotFound	The specified layer or selection set does not exist

 

See Also

Function	Summary
ShowTheme()	Displays a theme on a layer or selection set
GetTheme()	Gets information about a theme
GetThemes()	Gets a list of themes defined on the current layer
HideTheme()	Switches off the display of a theme on a layer or selection set