SetLabelOverlapStatus()
Summary
Sets the status of whether labels can be drawn on top of point icons.
Changes
Added to Version 3.0.
Syntax
SetLabelOverlapStatus(string lyr_set_name, string allows_overlap)
| Argument | Contents |
|---|---|
| lyr_set_name | The name of the layer and selection set |
| allows_overlap | "True" to prevent labels from overlapping the point icons, otherwise "False" |
Example
// Open a map with at least one layer
lyr = GetLayer()
SetLabelOverlapStatus(lyr + "|", "True")
overlap_status = GetLabelOverlapStatus(lyr + "|")
ShowMessage("The overlap status is " + overlap_status)Error Codes
| Error Type | Meaning |
|---|---|
| NotFound | The specified layer or selection set does not exist |
See Also
| Function | Summary |
|---|---|
| GetLabelOptions() | Get the label option settings for a layer or selection set |
| GetLabelOverlapStatus() | Gets the status of whether labels can be drawn on top of point icons |
| SetLabels() | Enables or disables labeling for a layer or selection set |
| SetLabelOptions() | Changes the option settings for labels |