geoObject.Hint
Extends IHintManager.
Geo object hint manager. Allows a geo object to manage a hint by opening it and hiding it. Passes data to the hint in the format IGeoObjectPopupData. Uses the map hint manager map.Hint internally. Geo objects contain an instance of this class, which is available as myGeoObject.hint. Don't create new instances of this class unless necessary.
Constructor | Fields | Events | Methods
Constructor
geoObject.Hint(geoObject)
Parameters:
Parameter |
Default value |
Description |
— |
Type: Object Geo object. |
* 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 the hint for the geo object. |
||
Sets new user data. |
||
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 the hint for the geo object.
Returns Promise object.
Parameters:
Parameter |
Default value |
Description |
— |
Type: Number[] Coordinates of the point where the hint is opened. By default: the geometric center of gravity of the geoobject. The projection of the coordinates can be specified in the options, otherwise the geo object projection is used. |
|
— |
Type: Object Data to add to the userData field for the object of data passed to the hint. |
|
— |
Type: Object Options. |
setData
{vow.Promise} setData([data])
Sets new user data.
Returns Promise object.
Parameters:
Parameter |
Default value |
Description |
— |
Type: Object Data to add to the userData field for the object of data passed to the hint. |
Mandatory parameter/option.