DropLayer()

Summary

Removes a layer from a map.

Changes

From Version 5.0 drops any associated node layer.

Syntax

DropLayer(string map_name, string layer_name)

Argument Contents
map_name The map from which the layer is dropped
layer_name The name of the layer to be dropped

Notes

  • If map_name is null, DropLayer() affects the current map.

  • DropLayer() drops any associated node layer.

Example

// This example removes all area layers from the map
area_lyrs = GetMapLayers( , "Area")
for i = 1 to area_lyrs.length do
DropLayer(, area_lyrs[1] [i])
end

Error Codes

Error Type Meaning
NotFound There is no map or layer with the given name, or the layer is not in the map

See Also

Function Summary
AddLayer() Adds a layer from a geographic file to a map
AddCDFLayer() Adds a layer from a compact geographic file to a map
AddImageLayer() Adds an image layer to a map
AddExistingLayer() Adds an existing layer in the workspace to a map
GetLayers() Gets information on layers in the system and the current layer.
GetMapLayers() Gets a list of the layers in a map