GetLegend()

Summary

Gets the definition of an automatic map legend.

Syntax

leg_info = GetLegend(string map_name)

Argument Contents
map_name The name of the map

Returns

An array of two elements, as described below:

Element Type Contents
1 Array Sample objects showing the appearance of each legend item
2 Array An array of type-contents pairs describing each legend element
Element Type Contents
1 String The type of the legend item: "Text", "Set", or "Theme"
2 String The contents of the legend element. For a Text item, the actual text that appears in the legend. For a Set or Theme item, the name of the set or theme.

Notes

  • Use GetLegend() to display a list of the items in a legend.

Example

leg = GetLegend("New York Map")

Error Codes

Error Type Meaning
NotFound The named map was not found, the map has no legend, or the legend is empty

See Also

Function Summary
CreateLegend() Creates a map legend
GetLegendSettings() Gets the settings for a map legend
GetLegendOptions() Gets the values of one or more options for a map legend