GetScale()

Summary

Gets the scale of a map.

 

Syntax

scale = GetScale(string map_name)

 

Argument	Contents
map_name	The map for which the scale is required

 

Returns

A real number that is denominator of the map scale expressed as a ratio. For example, if the map scale is 1:2,000,000, GetScale() returns 2,000,000.

 

Example

curr_scl = GetScale()

new_scl = curr_scl / 2.0

SetScale(new_scl)

SetScale(GetScale() / 2.0)

 

Error Codes

Error Type	Meaning
NotFound	The specified map name does not exist

 

See Also

Function	Summary
GetLayerAutoscale()	Determines whether a layer is hidden in the current map due to autoscaling
GetLayerScale()	Gets the range of scales at which a layer displays (autoscale)
GetLayerScaleFlag()	Gets the autoscale flag for a layer
GetSetScale()	Gets the range of scales at which a selection set displays (autoscale)
SetLayerScale()	Sets the range of scales at which a layer displays (autoscale)
SetLayerScaleFlag()	Sets the autoscale flag for a layer
SetScale()	Sets the scale of a map
SetSetScale()	Sets the range of scales at which a selection set displays (autoscale)