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
Class: ScreenPoint
[ AMD Module Require | Legacy Module Require ]
require(["esri/geometry/ScreenPoint"], function(ScreenPoint) { /* code goes here */ });
Description
(Added at v3.3)
ScreenPoint represents a point in terms of pixels relative to the top-left corner of the map control. Prior to version 3.3, a screen point was represented using a regular Point where the point object is defined without a spatial reference. Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new ScreenPoint(x, y) | Creates a new ScreenPoint object with X-, Y- coordinates. |
| new ScreenPoint(coords) | Creates a new ScreenPoint object with an array containing X-, Y- coordinates. |
| new ScreenPoint(json) | Creates a new ScreenPoint object with a JSON object. |
Properties
| Name | Type | Summary |
|---|---|---|
| x | Number | X-coordinate relative to the top-left corner of the map control in pixels. |
| y | Number | Y-coordinate relative to the top-left corner of the map control in pixels. |
Methods
| Name | Return type | Summary |
|---|---|---|
| offset(dx, dy) | ScreenPoint | Offsets the point in an x and y direction. |
| setX(x) | ScreenPoint | Sets x-coordinate of point. |
| setY(y) | ScreenPoint | Sets y-coordinate of point. |
| toJson() | Object | Converts object to its ArcGIS Server JSON representation. |
| update(x, y) | ScreenPoint | Updates a ScreenPoint. |
Constructor Details
Creates a new ScreenPoint object with X-, Y- coordinates.
Creates a new ScreenPoint object with an array containing X-, Y- coordinates.
Parameters:
< |
Required | An array that includes X-, Y- coordinates. For example: [100,50]. |
Creates a new ScreenPoint object with a JSON object.
Parameters:
< |
Required | A JSON object that includes X-, Y- coordinates. |
Property Details
<Number
NumberX-coordinate relative to the top-left corner of the map control in pixels.
<Number
NumberY-coordinate relative to the top-left corner of the map control in pixels.
Method Details
Offsets the point in an x and y direction.
Return type:
ScreenPointSets x-coordinate of point.
Return type:
ScreenPointParameters:
< |
Required | Value for x-coordinate of point. |
Sets y-coordinate of point.
Return type:
ScreenPointParameters:
< |
Required | Value for y-coordinate of point. |
Updates a ScreenPoint.
Return type:
ScreenPoint