hotspot.layer.Hint
Extends IHintManager.
Manager of the hint on a hotspot layer. Allows to manage the hint on a hotspot layer by opening it and hiding it. It uses the map hint manager map.Hint inside itself. Hotspot layers contain an instance of this class available as myHotspotLayer.hint. Don't create new instances of this class unless necessary.
Constructor | Fields | Events | Methods
Constructor
hotspot.layer.Hint(hotspotLayer)
Parameters:
Parameter |
Default value |
Description |
— |
Type: Object Hotspot layer. |
* Mandatory parameter/option.
Fields
Name |
Type |
Description |
Event manager. Inherited from IEventEmitter. |
Events
Name |
Description |
Closing the info object. Names of fields available via Event.get:
Inherited from IPopupManager. |
|
Opening the info object. Names of fields available via Event.get:
Inherited from IPopupManager. |
Methods
Name |
Returns |
Description |
Closes the info object. Inherited from IPopupManager. |
||
destroy() |
Disables the info object manager. Inherited from IPopupManager. |
|
getData() |
Object|null |
Returns the data of the info object or 'null'. Inherited from IPopupManager. |
IOptionManager|null |
Returns the options manager or 'null'. Inherited from IPopupManager. |
|
Returns the promise object to return the overlay. Inherited from IPopupManager. |
||
IOverlay|null |
Returns the overlay, if one exists. Inherited from IPopupManager. |
|
Number[]|null |
Returns the coordinates of the info object or 'null'. Inherited from IPopupManager. |
|
isOpen() |
Boolean |
Returns the info object state: open/closed. Inherited from IPopupManager. |
Opens a hint in the specified position. |
||
Defines new data for the info object. Inherited from IPopupManager. |
||
Defines new options for the info object. Inherited from IPopupManager. |
||
Specifies a new position for the info object. Inherited from IPopupManager. |
Methods details
open
{vow.Promise} open([position[, data[, options]]])
Opens a hint in the specified position.
Returns Promise object.
Parameters:
Parameter |
Default value |
Description |
— |
Type: Number[] The coordinates of the balloon opening in the global pixel coordinates. |
|
— |
Type: Object Data. |
|
— |
Type: Object Options. |
Mandatory parameter/option.