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/screenUtils
[ AMD Module Require | Legacy Module Require ]
require(["esri/geometry/screenUtils"], function(screenUtils) { /* code goes here */ });
Description
(Added at v3.8)
Convert map coordinates to screen coordinates 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.toMapGeometry().Samples
Search for samples that use this class.Methods
| Name | Return type | Summary |
|---|---|---|
| toMapGeometry(extent, width, height, screenGeometry) | Geometry | Converts the geometry argument to map coordinates based on the extent, width, and height of the Map. |
| toMapPoint(extent, width, height, screenPoint) | Point | Converts and returns the argument screen point in map coordinates. |
| toScreenGeometry(extent, width, height, mapGeometry) | Geometry | Converts the geometry argument to screen coordinates based on the extent, width, and height of the Map. |
| toScreenPoint(extent, width, height, mapPoint) | ScreenPoint | Converts and returns the argument map point in screen coordinates. |
Method Details
Converts the geometry argument to map coordinates based on the extent, width, and height of the Map.
Return type:
GeometryParameters:
< |
Required | The current extent of the map in map coordinates. |
< |
Required | The current width of the map in screen units. |
< |
Required | The current height of the map in screen units. |
< |
Required | The geometry to convert from screen to map units. |
Converts and returns the argument screen point in map coordinates. Deprecated, use toMapGeometry instead.
Return type:
PointParameters:
< |
Required | The current extent of the map in map coordinates. |
< |
Required | The current width of the map in screen units. |
< |
Required | The current height of the map in screen units. |
< |
Required | The screenPoint to convert from screen to map units. At version 3.3, use an instance of ScreenPoint. Prior to 3.3 specify as a Point. |
Converts the geometry argument to screen coordinates based on the extent, width, and height of the Map.
Return type:
GeometryParameters:
< |
Required | The current extent of the map in map coordinates. |
< |
Required | The current width of the map in screen units. |
< |
Required | The current height of the map in screen units. |
< |
Required | The geometry to convert from map to screen units. |
Converts and returns the argument map point in screen coordinates. At version 3.3, the return value is an instance of ScreenPoint. Prior to 3.3 the value will be a Point. Deprecated at v1.1. Use toScreenGeometry instead.
Return type:
ScreenPointParameters:
< |
Required | The current extent of the map in map coordinates. |
< |
Required | The current width of the map in screen units. |
< |
Required | The current height of the map in screen units. |
< |
Required | The point to convert from map to screen units. |