GetLayerVisibility()

Summary

Determine whether a layer is visible (displayed) in a map.

 

Syntax

visibility = GetLayerVisibility(string map_bar_layer)

 

Argument	Contents
map_bar_layer	The name of the map and layer

 

Returns

The string "On" if the layer is visible in the map, or "Off" if the layer is not visible.

 

Notes

• If map_bar_layer is null, GetLayerVisibility() returns information on the current layer in the current map.

• If map_bar_layer is a layer name, GetLayerVisibility() returns information on the current map.

• Even if a layer is visible, the autoscale settings for the layer may cause it not to be displayed at the current map scale.

Example

// Make States visible but Counties hidden

states = GetLayerVisibility("States")

counties = GetLayerVisibility("Counties")

if states = "Off" then SetLayerVisibility("States", "On")

if counties = "On" then SetLayerVisibility("Counties", "Off")

 

Error Codes

Error Type	Meaning
NotFound	The specified layer does not exist or is not in the specified map

 

See Also

Function	Summary
GetDisplayStatus()	Returns information on how features in a selection set are displayed on a map
GetLayerAutoscale()	Determines whether a layer is hidden in the current map due to autoscaling
GetLayerScale()	Gets the range of scales at which a layer displays (autoscale)
GetLayerScaleFlag()	Gets the autoscale flag for a layer
SetLayerScale()	Sets the range of scales at which a layer displays (autoscale)
SetLayerScaleFlag()	Sets the autoscale flag for a layer
SetDisplayStatus()	Changes how features in a selection set are displayed on a map
SetLayerVisibility()	Sets whether a layer is visible (displayed) in a map