geometry.pixel.Polygon
Extends IPixelPolygonGeometry.
The "Polygon" pixel geometry.
Constructor | Fields | Methods
Constructor
geometry.pixel.Polygon(coordinates, fillRule[, metaData])
Parameters:
Parameter |
Default value |
Description |
— |
Type: Number[][][] Coordinates of the polygon. |
|
— |
Type: String String ID that defines the polygon fill rule. Accepts one of two values:
|
|
— |
Type: Object Metadata. |
|
false |
Type: Boolean Convex indicator for a polygon. If true, it is convex; if false, it is not. For convex polygons, it is faster to calculate whether points fall in the polygon. |
* Mandatory parameter/option.
Fields
Name |
Type |
Description |
Event manager. Inherited from IEventEmitter. |
Methods
Name |
Returns |
Description |
Boolean |
Checks whether the passed point is located inside the polygon. Inherited from IPixelPolygonGeometry. |
|
Boolean |
Returns true if the passed geometry is equivalent to the given one. Inherited from IPixelGeometry. |
|
Number[][]|null |
Returns coordinates of the two opposite corners of the area that surrounds the geometry. The first item in the array is the corner with the smallest coordinate values relative to the rest of the points in the area; the second item is the corner with the largest coordinate values. Inherited from IBaseGeometry. |
|
Object |
Searches for the point nearest to "anchorPosition" on the polygon contour. Inherited from IPixelPolygonGeometry. |
|
Number[][][] |
Returns coordinates of the polygon. Inherited from IPixelPolygonGeometry. |
|
String |
Returns string ID that defines the polygon fill rule. The ID accepts one of two values:
Inherited from IPixelPolygonGeometry. |
|
Integer |
Returns the number of contours in the polygon. Inherited from IPixelPolygonGeometry. |
|
Object |
Returns metadata of the pixel geometry. Inherited from IPixelGeometry. |
|
getType() |
String |
Returns ID of the geometry type. Inherited from IBaseGeometry. |
Creates a scaled copy of the geometry. Inherited from IPixelGeometry. |
||
Creates a copy of the geometry that is shifted by the specified amount. Inherited from IPixelGeometry. |
Mandatory parameter/option.