overlay.Placemark
Extends IOverlay.
Placemark 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.Placemark(geometry[, data[, options]])
Parameters:
Parameter |
Default value |
Description |
— |
Type: IPixelPointGeometry Pixel geometry. |
|
— |
Type: Object Data. |
|
— |
Type: Object Options. |
|
— |
Type: String Cursor when the mouse is hovering. |
|
true |
Type: Boolean Disables the object's reaction to DOM events. |
|
'default#geoObject' |
Type: String Interactivity model. Available keys and their values are listed in the description of interactivityModel.storage. |
|
— |
Type: Function|String Layout. (Type: constructor for an object with the ILayout interface). |
|
[0,0] |
Type: Array Offset in pixels. |
|
'places' |
Type: String Container where the placemark layout will be placed. |
|
false |
Type: Boolean Flag for whether there is a shadow. |
|
— |
Type: Function|String Layout for the shadow. (Type: constructor for an object with the ILayout interface). |
|
[0,0] |
Type: Array Shadow offset in pixels. |
|
'shadows' |
Type: Array Container where the placemark shadow layout will be placed. |
|
— |
Type: Number The z-index of the element. |
* 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. |
HTMLElement |
Returns parent element of the icon layout. |
|
Returns the current pixel geometry. Inherited from IOverlay. |
||
HTMLElement |
Returns parent element of the icon layout. |
|
Returns Promise object to return the icon layout. |
||
ILayout|null |
Returns icon layout. |
|
Returns Promise object to return the icon layout. |
||
ILayout|null |
Returns icon layout. |
|
getMap() |
Map|null |
Returns reference to the current map. Inherited from IOverlay. |
HTMLElement |
Returns parent element of the icon shadow layout. |
|
Returns Promise object to return the icon shadow layout. |
||
ILayout|null |
Returns layout for the icon shadow. |
|
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. |
Methods details
getElement
{HTMLElement} getElement()
Returns parent element of the icon layout.
getIconElement
{HTMLElement} getIconElement()
Returns parent element of the icon layout.
getIconLayout
{vow.Promise} getIconLayout()
Returns Promise object to return the icon layout.
getIconLayoutSync
{ILayout|null} getIconLayoutSync()
Returns icon layout.
getLayout
{vow.Promise} getLayout()
Returns Promise object to return the icon layout.
getLayoutSync
{ILayout|null} getLayoutSync()
Returns icon layout.
getShadowElement
{HTMLElement} getShadowElement()
Returns parent element of the icon shadow layout.
getShadowLayout
{vow.Promise} getShadowLayout()
Returns Promise object to return the icon shadow layout.
getShadowLayoutSync
{ILayout|null} getShadowLayoutSync()
Returns layout for the icon shadow.
Mandatory parameter/option.