GetMapLabelOptions()

Summary

Gets the automatic label option settings for a map.

 

Changes

In Version 6.0/2012 is still available but will now do nothing if called.

 

Syntax

options = GetMapLabelOptions(string map_name, array options)

 

Argument	Contents
map	The name of the map
options	The list of option names (strings) for which the current values are requested

 

Returns

An array of option pairs for the requested options, selected from the following list.

 

Option	Type	Contents
Overlap	Boolean	Whether automatic labels are permitted to overlap

 

Notes

• Specify only labeling options that apply to all layers in the specified map. For options that apply on a per layer or per set basis, use GetLabelOptions() instead.

Example

x = GetMapLabelOptions("My Map", {"Overlap"})

// x = {{"Overlap", "True"}}

 

Error Codes

Error Type	Meaning
Error	An option is invalid
NotFound	The specified map does not exist

 

See Also

Function	Summary
SetMapLabelOptions()	Controls whether automatic labels on a map can overlap
GetLabelOptions()	Gets the label option settings for a layer or selection set.