SetLabelOverride()

Summary

Sets the label override settings for a map feature.

 

Changes

Added to Version 6.0/2012.

 

Syntax

SetLabelOverride(string layer_name, integer id, array settings)

 

Argument	Contents
layer_name	The name of the layer
integer id	The ID of the map feature
settings	An options array with any of the following options

 

Option	Type	Contents
Alignment	String	Desired label position relative to the feature, expressed as a compass direction ("NW", "N", "NE", "W", "C", "E", "SW", "S," "SE") or "Auto" for automatic positioning
Callout Flag	Boolean	If "'True" then draw a callout for this label if it is in a custom location; the default is "False"
Callout Color	Color	Color of the callout line
Callout Line Style	Linestyle	Style of the callout line
Callout Style	Integer	1=straight line, 2=straight line with vertical bar, 3=bent line, or 4=bent line with vertical bar, corresponding to the four styles displayed on the callout tab
Callout Width	Real	Width of the callout line
Color	Color	Custom color for the label
Font	String	Font name, size, and style for the label
Force Display	Boolean	If "'True" then give the label top priority for display; the default is "False"
Location	Coord	Custom location of the label; null to use the default position
Slope	Real	A value between -90 and 90 to specify the slope of the label
Suppress Display	Boolean	If "'True" then prevent display of a label; the default is "False"

 

Example

// Open a map and use a tool to customize a label

opts = GetSelectedLabel()

settings = null

settings.Slope = 45.

SetLabelOverride(opts.Layer, opts.ID, settings)

 

Error Codes

Error Type	Meaning
NotFound	The specified layer or map feature does not exist

 

See Also

Function	Summary
ClickLabel()	Allows the user to move, with optional callouts, or rotate labels on the map to customize them
GetHiddenLabelDisplayStatus()	Gets the status of whether labels that are otherwise hidden are displayed in a lighter shading
GetLabelOverride()	Gets the label override settings for a map feature
GetSelectedLabel()	Returns the layer name and ID of the last label clicked on
SetHiddenLabelDisplayStatus()	Sets the status of whether labels that are otherwise hidden are displayed in a lighter shading