ShowLegend()
Summary
Shows a map legend.
Syntax
ShowLegend (string map_name)
| Argument | Contents |
|---|---|
| map_name | The name of the map |
Notes
-
ShowLegend() is used only when the legend is displayed in a separate window.
-
If the legend is attached to the map and not shown in a separate window, set the legend type to Automatic using SetLegendSettings() to show the legend.
-
If the legend was hidden with HideLegend(), ShowLegend() displays it.
-
If the legend is currently displayed, ShowLegend() redraws it.
Example
ShowLegend("U.S. Map")Error Codes
| Error Type | Meaning |
|---|---|
| NotFound | The named map does not exist or has no legend |
See Also
| Function | Summary |
|---|---|
| HideLegend() | Hides a map legend |
| SetLegendSettings() | Change the settings for a map legend |