SetMapLabelOptions()
Summary
Controls whether automatic labels on a map can overlap.
Changes
In Version 6.0/2012 is still available but will now do nothing if called.
Syntax
SetMapLabelOptions(string map_name, array options)
| Argument | Contents |
|---|---|
| map_name | The name of the map, or null for the current map |
| Option | Type | Contents |
|---|---|---|
| Overlap | Boolean | "True" if automatic labels are permitted to overlap; "False" if they are not permitted to overlap |
Notes
-
This setting does not affect overlaps between text annotations or between automatic labels and text annotations.
Example
// Overlap allowed in this map
SetMapLabelOptions("My Map", {{"Overlap", "True"}})
// Overlap not allowed in the current map
SetMapLabelOptions(, {{"Overlap", "False"}})Error Codes
| Error Type | Meaning |
|---|---|
| Error | An option is invalid |
| NotFound | The specified map does not exist |
See Also
| Function | Summary |
|---|---|
| GetMapLabelOptions() | Gets the automatic label option settings for a map |
| GetLabelOptions() | Gets the label option settings for a layer or selection set |
| SetLabelOptions() | Changes the option settings for automatic labels |
| SetLabels() | Enables or disables labeling for a map layer or selection set |