AddExistingLayer()

Summary

Adds an existing layer in the workspace to a map.

 

Syntax

actual_lyr_name = AddExistingLayer(string map_name, string layer_name)

 

Argument	Contents
map_name	The name of the map to which the layer is added
layer_name	The name of the layer to add

 

Returns

A string indicating the actual name of the layer, which is identical to layer_name unless the layer name is already in use.

 

Notes

• If the map_name is null, AddExistingLayer() adds the layer to the current map.

• Adding a layer to a map does not set any display characteristics for the layer. In other words, the layer is not visible until display colors and styles are assigned. Default display settings can be made with the New Layer Default Settings Standard Interface Macro.

• Maptitude keeps track of geographic files and their layer names in the workspace, not just in individual map and dataview windows. The same geographic file can have the same layer name in different maps, but different geographic files cannot have the same layer name even if they are in different maps. In the latter case, Maptitude adds a colon and a sequence number to the desired layer name to make the actual layer name unique.

Example

// Before running the example, create a map by opening nesouth.cdf

// and a second map by opening ne_plc.cdf, both in the Tutorial folder.

lyr_info = GetLayers()

if lyr_info[3] <> null then do

    // Add the current layer to another map  

    new_lyr = AddExistingLayer("U.S. Counties", lyr_info[3]) 

    SetMap("U.S. Counties") 

    RunMacro("G30 new layer default settings", new_lyr) 

end 

 

Error Codes

Error Type	Meaning
Error	The map or the specified layer does not exist; or the layer is already in the map
NotFound	The map or the specified layer is not found

 

See Also

Function	Summary
AddCDFLayer()	Adds a layer from a compact geographic file to a map
AddImageLayer()	Adds an image layer to a map
AddLayerToWorkspace()	Adds a layer to a workspace without it appearing in a map or dataview
AddLayer()	Adds a layer from a geographic file to a map
DropLayer()	Removes a layer from a map
GetMapLayers()	Gets a list of the layers in a map
GetLayers()	Gets information on layers in the system and the current layer.