HideLegend()

Summary

Hides a map legend.

Syntax

HideLegend (string map_name)

Argument Contents
map_name The name of the map

Notes

  • HideLegend() can be 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 "None" using SetLegendSettings() to hide the legend.

Example

HideLegend("U.S. Map")

Error Codes

Error Type Meaning
NotFound The named map does not exist or has no legend

See Also

Function Summary
SetLegendSettings() Change the settings for a map legend
ShowLegend() Shows a map legend