IRectangleGeometry
Extends IGeometry, IRectangleGeometryAccess.
Interface for the "Rectangle" geometry.
Constructor | Fields | Events | Methods
Constructor
IRectangleGeometry()
Fields
Name | Type | Description |
---|---|---|
events | IEventManager | Event manager. Inherited from IEventEmitter. |
options | IOptionManager | Options manager. Inherited from ICustomizable. |
Name | Type | Description |
---|---|---|
events | IEventManager | Event manager. Inherited from IEventEmitter. |
options | IOptionManager | Options manager. Inherited from ICustomizable. |
Events
Name | Description |
---|---|
change | Change to corner coordinates.
Instance of the Event class.
Names of fields that are available via the Event.get method:
Inherited from IRectangleGeometryAccess. |
mapchange | Map reference changed.
Instance of the Event class.
Names of fields that are available via the Event.get method:
Inherited from IGeometry. |
optionschange | Change to the object options. Inherited from ICustomizable. |
pixelgeometrychange | The pixel geometry changed.
Instance of the Event class.
Names of fields that are available via the Event.get method:
Inherited from IGeometry. |
Name | Description |
---|---|
change | Change to corner coordinates.
Instance of the Event class.
Names of fields that are available via the Event.get method:
Inherited from IRectangleGeometryAccess. |
mapchange | Map reference changed.
Instance of the Event class.
Names of fields that are available via the Event.get method:
Inherited from IGeometry. |
optionschange | Change to the object options. Inherited from ICustomizable. |
pixelgeometrychange | The pixel geometry changed.
Instance of the Event class.
Names of fields that are available via the Event.get method:
Inherited from IGeometry. |
Methods
Name | Returns | Description |
---|---|---|
contains(position) | Boolean | Checks whether the passed point is located inside the rectangle. Inherited from IRectangleGeometryAccess. |
freeze() | Switches the object to "frozen" mode. Inherited from IFreezable. | |
getBounds() | Number[][]|null | Returns coordinates of the two opposite corners of the area that surrounds the geometry. The first item in the array is the southwest corner of the area; the second item is the northeast corner. Inherited from IGeometry. |
getClosest(anchorPosition) | Object | Searches for the point nearest to "anchorPosition" on the rectangle contour. Inherited from IRectangleGeometryAccess. |
getCoordinates() | Number[][] | Returns coordinates of two opposite corners of the rectangle. Inherited from IRectangleGeometryAccess. |
getMap() | Map|null | Returns the current map. Inherited from IGeometry. |
getPixelGeometry([options]) | Returns the pixel geometry corresponding to the given geometry, its options, and the map state. Inherited from IGeometry. | |
getType() | String | Returns the "Rectangle" string. |
isFrozen() | Boolean | Returns true if the object is in "frozen" mode, otherwise false. Inherited from IFreezable. |
setCoordinates(coordinates) | Sets the coordinates of two opposite corners of the rectangle. Inherited from IRectangleGeometryAccess. | |
setMap(map) | Sets the map. Inherited from IGeometry. | |
unfreeze() | Switches the object to active mode. Inherited from IFreezable. |
Name | Returns | Description |
---|---|---|
contains(position) | Boolean | Checks whether the passed point is located inside the rectangle. Inherited from IRectangleGeometryAccess. |
freeze() | Switches the object to "frozen" mode. Inherited from IFreezable. | |
getBounds() | Number[][]|null | Returns coordinates of the two opposite corners of the area that surrounds the geometry. The first item in the array is the southwest corner of the area; the second item is the northeast corner. Inherited from IGeometry. |
getClosest(anchorPosition) | Object | Searches for the point nearest to "anchorPosition" on the rectangle contour. Inherited from IRectangleGeometryAccess. |
getCoordinates() | Number[][] | Returns coordinates of two opposite corners of the rectangle. Inherited from IRectangleGeometryAccess. |
getMap() | Map|null | Returns the current map. Inherited from IGeometry. |
getPixelGeometry([options]) | Returns the pixel geometry corresponding to the given geometry, its options, and the map state. Inherited from IGeometry. | |
getType() | String | Returns the "Rectangle" string. |
isFrozen() | Boolean | Returns true if the object is in "frozen" mode, otherwise false. Inherited from IFreezable. |
setCoordinates(coordinates) | Sets the coordinates of two opposite corners of the rectangle. Inherited from IRectangleGeometryAccess. | |
setMap(map) | Sets the map. Inherited from IGeometry. | |
unfreeze() | Switches the object to active mode. Inherited from IFreezable. |
Methods details
getType
{String} getType()
Returns the "Rectangle" string.