GetMapWindowScope()

Summary

Gets the scope of a map using the current window width and height.

 

Syntax

scp = GetMapWindowScope(string map_name)

 

Argument	Contents
map_name	The map for which the scope is calculated

 

Returns

The scope of the map window.

 

Notes

• The map window shows the entire map scope, plus some additional area that fills out the excess width or height of the map window. The map window scope is the scope that matches the entire area displayed in the window.

• For a full list of scope-related GISDK functions, see Map Scales and Scopes.

 

Example

scp = GetLayerScope("U.S. States")

SetMapScope(, scp)	// Sets the map so that the entire U.S. is shown
scp1 = GetMapWindowScope()	// scp1 is probably larger than scp!

 

Error Codes

Error Type	Meaning
NotFound	The specified map does not exist

 

See Also

Function	Summary
SetMapScope()	Sets the scope of a map
GetMapScope()	Gets the scope of a map