geometry.pixel.MultiPolygon
Extends IPixelMultiPolygonGeometry.
The "Polygon from multiple shapes" pixel geometry.
Constructor | Fields | Methods
Constructor
geometry.pixel.MultiPolygon(coordinates, fillRule[, metaData])
Parameters:
Parameter |
Default value |
Description |
— |
Type: Number[][][][] Coordinates of the polygons. |
|
— |
Type: String String ID that defines the fill rule for the polygons. 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 multipolygon. Inherited from IPixelMultiPolygonGeometry. |
|
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 multipolygon contour. Inherited from IPixelMultiPolygonGeometry. |
|
Number[][][][] |
Returns coordinates of the multipolygon. Inherited from IPixelMultiPolygonGeometry. |
|
String |
Returns the string ID that defines the multipolygon fill rule. The ID can have one of two values:
Inherited from IPixelMultiPolygonGeometry. |
|
Integer |
Returns the number of polygons in the multipolygon. Inherited from IPixelMultiPolygonGeometry. |
|
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.