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/webMercatorUtils
[ AMD Module Require | Legacy Module Require ]
require(["esri/geometry/webMercatorUtils"], function(webMercatorUtils) { /* code goes here */ });
Description
(Added at v3.8)
Convert Web Mercator coordinates to geographic and vice versa.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.geographicToWebMercator().Samples
Search for samples that use this class.Methods
| Name | Return type | Summary |
|---|---|---|
| canProject(source, target) | Boolean | Returns true if the 'source' can be projected to 'target' by the project() function, or if the 'source' and 'target' is the same spatialReference. |
| geographicToWebMercator(geometry) | Geometry | Converts geometry from geographic units to Web Mercator units. |
| lngLatToXY(long, lat) | Number[] | Translates the given latitude and longitude values to Web Mercator. |
| project(geometry, target) | Object | Project the geometry clientside (if possible). |
| webMercatorToGeographic(geometry, isLinear?) | Geometry | Converts geometry from Web Mercator units to geographic units. |
| xyToLngLat(x, y) | Number[] | Translates the given Web Mercator coordinates to Longitude and Latitude. |
Method Details
Returns true if the 'source' can be projected to 'target' by the project() function, or if the 'source' and 'target' is the same spatialReference. (Added at v3.11)
Return type:
BooleanParameters:
< |
Required | An input of type SpatialReference or an object with spatialReference property such as Geometry or Map. |
< |
Required | The target spatial reference, of type SpatialReference or an object with spatialReference property such as Map. |
Sample:
var pt = Point(0, 0), // a geographic point.
result;
if (webMercatorUtils.canProject(pt, map)) {
result = webMercatorUtils.project(pt, map);
}Converts geometry from geographic units to Web Mercator units.
Return type:
GeometryParameters:
< |
Required | The geometry to convert. |
Sample:
require([
"esri/geometry/webMercatorUtils", ...
], function(webMercatorUtils, ... ) {
var geom = webMercatorUtils.geographicToWebMercator(candidate.location);
...
});
Translates the given latitude and longitude values to Web Mercator.
Return type:
Number[]Parameters:
< |
Required | The longitude value to convert. |
< |
Required | The latitude value to convert. |
Sample:
require([
"esri/geometry/webMercatorUtils", ...
], function(webMercatorUtils, ... ) {
webMercatorUtils.lngLatToXY(-120, 33);
...
});
Project the geometry clientside (if possible). (Added at v3.11)
Return type:
ObjectParameters:
< |
Required | An input geometry. |
< |
Required | The target spatial reference, of type SpatialReference or an object with spatialReference property such as Map. |
Sample:
var pt = Point(0, 0), // a geographic point.
result;
if (webMercatorUtils.canProject(pt, map)) {
result = webMercatorUtils.project(pt, map);
}Converts geometry from Web Mercator units to geographic units.
Return type:
GeometryParameters:
< |
Required | The geometry to convert. |
< |
Optional | Indicates whether to work with linear values, i.e., do not normalize. By default, this conversion method normalizes xmin and xmax values. If this is not desired, specify this value as true. Default value is false. |
Sample:
require([
"esri/geometry/webMercatorUtils", ...
], function(webMercatorUtils, ... ) {
query.geometry = webMercatorUtils.webMercatorToGeographic(geometries[0]);
...
});
Translates the given Web Mercator coordinates to Longitude and Latitude. By default the returned longitude is normalized so that it is within -180 and +180.
Return type:
Number[]Parameters:
< |
Required | The x coordinate value to convert. |
< |
Required | The y coordinate value to convert. |
Sample:
require([
"esri/geometry/webMercatorUtils", ...
], function(webMercatorUtils, ... ) {
var normalizedVal = webMercatorUtils.xyToLngLat(42215329, 1321748);
console.log(normalizedVal); //returns 19.226, 11.789
var value = webMercatorUtils.xyToLngLat(42215329, 1321748, true);
console.log(value); // returns 379.22, 11.78
...
});