Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Object: esri/geometry/scaleUtils
[ AMD Module Require | Legacy Module Require ]
require(["esri/geometry/scaleUtils"], function(scaleUtils) { /* code goes here */ });
Description
(Added at v3.8)
Utility methods to get map scale or extent for a given scale.
When coding legacy (non-AMD) style, there is no need to require the module. All methods and properties are available in the namespace. For example,
esri.geometry.getExtentForScale().Samples
Search for samples that use this class.Methods
| Name | Return type | Summary |
|---|---|---|
| getExtentForScale(map, scale) | Extent | Get the extent for the specified scale. |
| getScale(map) | Number | Gets the current scale of the map. |
| getUnitValueForSR(sr) | Number | Returns the value of one map unit for the given spatial reference (in meters). |
Method Details
Get the extent for the specified scale.
Return type:
ExtentSample:
require([
"esri/geometry/scaleUtils", ...
], function(scaleUtils, ... ) {
var extent = scaleUtils.getExtentForScale(map, 10000);
...
});
Gets the current scale of the map.
Return type:
NumberParameters:
< |
Required | The map whose scale should be calculated. |
Sample:
require([
"esri/geometry/scaleUtils", ...
], function(scaleUtils, ... ) {
var scale = scaleUtils.getScale(map);
...
});
Returns the value of one map unit for the given spatial reference (in meters). The
sr parameter can be a SpatialReference, WKID, or WKT. See Projected Coordinate Systems and Geographic Coordinate Systems for the list of supported spatial references. (Added at v3.13)Return type:
NumberParameters:
< |
Required | The spatial reference represented as a SpatialReference class, Number, or String. |
Sample:
require([
"esri/geometry/scaleUtils", ...
], function(scaleUtils, ... ) {
var mapUnit = scaleUtils.getUnitValueForSR(map.spatialReference);
...
});