map.Hint

Extends IHintManager, IHintSharingManager.

Map hint manager. Each map already has its own hint manager, available as myMap.hint. Only one hint, controlled by this manager, can be open on the map at a time. Don't create new instances of this class unless necessary.

See HintMap.hint

Constructor | Fields | Events | Methods

Constructor

map.Hint(map)

Parameters:

Parameter

Default value

Description

map*

Type: Map

Reference to a map object.

* Mandatory parameter/option.

Fields

Name

Type

Description

events

IEventManager

Event manager.

Inherited from IEventEmitter.

Events

Name

Description

close

Closing the info object. Names of fields available via Event.get:

  • target - Reference to the object where the closing occurred.

Inherited from IPopupManager.

open

Opening the info object. Names of fields available via Event.get:

  • target - Reference to the object where the opening occurred.

Inherited from IPopupManager.

Methods

Name

Returns

Description

close([force])

vow.Promise

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.

getOptions()

IOptionManager|null

Returns the options manager or 'null'.

Inherited from IPopupManager.

getOverlay()

vow.Promise

Returns the promise object to return the overlay.

Inherited from IPopupManager.

getOverlaySync()

IOverlay|null

Returns the overlay, if one exists.

Inherited from IPopupManager.

getPosition()

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.

open([position[, data[, options]]])

vow.Promise

Opens the info object at the specified position.

Inherited from IPopupManager.

setData(data)

vow.Promise

Defines new data for the info object.

Inherited from IPopupManager.

setOptions(options)

vow.Promise

Defines new options for the info object.

Inherited from IPopupManager.

setPosition(position)

vow.Promise

Specifies a new position for the info object.

Inherited from IPopupManager.