overlay.Rectangle
Extends IOverlay.
Polygon overlay. By default, the overlays have not been added to package.full (the standard set of modules). To create your own overlay instance, use overlay.storage.
Constructor | Fields | Events | Methods
Constructor
overlay.Rectangle(geometry[, data[, options]])
Parameters:
Parameter |
Default value |
Description |
— |
Type: IPixelRectangleGeometry Pixel geometry of a shape. |
|
— |
Type: Object Data. |
|
— |
Type: Object Options. |
|
— |
Type: Number Radius of rounded corners. |
|
— |
Type: String Whether there is fill. |
|
— |
Type: String Fill color graphics.style.color. |
|
— |
Type: String Background image. When this option is enabled, the "fillColor" value is ignored. |
|
'stretch' |
Type: String Type of background fill. Accepts one of two values:
|
|
— |
Type: Number Fill transparency. |
|
true |
Type: Boolean Disables the object's reaction to DOM events. |
|
— |
Type: Number Overall transparency. |
|
— |
Type: String Whether there is an outline. |
|
— |
Type: Boolean It is drawn on a separate layer. |
|
— |
Type: String Line color graphics.style.color. |
|
— |
Type: Number Contour transparency. |
|
— |
Type: Number[]|String Contour style (not supported in Canvas mode) graphics.style.stroke. |
|
— |
Type: Number Line width. |
* Mandatory parameter/option.
Fields
Name |
Type |
Description |
Event manager. Inherited from IDomEventEmitter. |
||
Options manager. Inherited from ICustomizable. |
Events
Name |
Description |
Single left-click on the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the MapEvent class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
Calls the element's context menu. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the MapEvent class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
Data change. Data fields:
Inherited from IOverlay. |
|
Double left-click on the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the MapEvent class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
Change to the empty overlay flag. Instance of the Event class. Inherited from IOverlay. |
|
Changed geometry. Data fields:
Inherited from IOverlay. |
|
Map reference changed. Data fields:
Inherited from IOverlay. |
|
Pressing the mouse button over the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the MapEvent class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
Pointing the cursor at the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the MapEvent class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
Moving the cursor off of the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the MapEvent class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
Moving the cursor over the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the MapEvent class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
Letting go of the mouse button over an object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the MapEvent class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
End of multitouch. This event is only available on devices that support multitouch. Returns an implementation of the IMultiTouchEvent interface. Inherited from IDomEventEmitter. |
|
Repeating event during multitouch. This event is only available on devices that support multitouch. Returns an implementation of the IMultiTouchEvent interface with information about touches. Defines the touches property, which contains a list of touches. Every touch is described by an object that contains the following fields:
Inherited from IDomEventEmitter. |
|
Start of multitouch. This event is only available on devices that support multitouch. Returns an implementation of the IMultiTouchEvent interface with information about touches. Defines the touches property, which contains a list of touches. Every touch is described by an object that contains the following fields:
Inherited from IDomEventEmitter. |
|
Change to the object options. Inherited from ICustomizable. |
|
Change to the shape of the area spanning the overlay. Instance of the Event class. Inherited from IOverlay. |
|
Mouse wheel scrolling. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the MapEvent class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
Methods
Name |
Returns |
Description |
getData() |
Object |
Returns the overlay data object. Inherited from IOverlay. |
Returns the current pixel geometry. Inherited from IOverlay. |
||
getMap() |
Map|null |
Returns reference to the current map. Inherited from IOverlay. |
getShape() |
IShape|null |
Returns a shape that defines the area spanning the overlay in global pixel coordinates, or null if it is not possible to plot the shape. Inherited from IOverlay. |
isEmpty() |
Boolean |
Returns true if the layout is empty, i.e. it does not have any content. This indicator is used for hiding empty objects such as hints, balloons, and others. Inherited from IOverlay. |
Sets the overlay data. Inherited from IOverlay. |
||
Sets the overlay pixel geometry. Inherited from IOverlay. |
||
Sets the map on which to display the overlay. Inherited from IOverlay. |
Mandatory parameter/option.