geometry.Rectangle
Extends IRectangleGeometry.
The "Rectangle" geometry.
See Rectangle
Constructor | Fields | Events | Methods
Constructor
geometry.Rectangle([coordinates[, options]])
Parameters:
Parameter |
Default value |
Description |
null |
Type: Number[][]|null An array containing coordinates of two opposite corners of the rectangle. |
|
— |
Type: Object Geometry options. |
|
— |
Type: String String ID defining the algorithm for recalculating geometry coordinates as pixel coordinates. For the "Rectangle" geometry, can accept one of three values:
|
|
false |
Type: Boolean Enables display using geodesic lines. |
|
"jumpy" |
Type: String Method for calculating pixel coordinates of the shape in cycled projections. This option accepts one of the following values:
|
|
— |
Type: IProjection Projection. |
Example:
// Creating an instance of the point geometry (specifying coordinates).
var rectangleGeometry = new ymaps.geometry.Rectangle([[30, 50], [31, 51]]);
// Instantiating the geo object and passing our geometry to the constructor.
var rectangleGeoObject = new ymaps.GeoObject({ geometry: rectangleGeometry });
// Changing the coordinates via the geo object's "geometry" property.
rectangleGeoObject.geometry.setCoordinates([[10, 20], [51, 71]]);
// Or directly.
rectangleGeometry.setCoordinates([[10, 20], [51, 71]]);
// You can also access rectangleGeometry via rectangleGeoObject.geometry.
Fields
Name |
Type |
Description |
Event manager. Inherited from IEventEmitter. |
||
Options manager. Inherited from ICustomizable. |
Events
Name |
Description |
Change to corner coordinates. Instance of the Event class. Names of fields that are available via the Event.get method:
Inherited from IRectangleGeometryAccess. |
|
Map reference changed. Instance of the Event class. Names of fields that are available via the Event.get method:
Inherited from IGeometry. |
|
Change to the object options. Inherited from ICustomizable. |
|
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 |
Boolean |
Checks whether the passed point is located inside the rectangle. Inherited from IRectangleGeometryAccess. |
|
freeze() |
Switches the object to "frozen" mode. Inherited from IFreezable. |
|
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. |
|
Object |
Searches for the point nearest to "anchorPosition" on the rectangle contour. Inherited from IRectangleGeometryAccess. |
|
Number[][] |
Returns coordinates of two opposite corners of the rectangle. Inherited from IRectangleGeometryAccess. |
|
getMap() |
Map|null |
Returns the current map. Inherited from IGeometry. |
Returns the pixel geometry corresponding to the given geometry, its options, and the map state. Inherited from IGeometry. |
||
getType() |
String |
Returns the "Rectangle" string. Inherited from IRectangleGeometry. |
isFrozen() |
Boolean |
Returns true if the object is in "frozen" mode, otherwise false. Inherited from IFreezable. |
Sets the coordinates of two opposite corners of the rectangle. Inherited from IRectangleGeometryAccess. |
||
Sets the map. Inherited from IGeometry. |
||
unfreeze() |
Switches the object to active mode. Inherited from IFreezable. |