Documentation
Reference
2.1.50 (current version)
collection
interactivityModel
Interfaces

clusterer.Hint

Extends IHintManager.

The clusterer's hint manager. Provides management of the cluster's hint, opening it and hiding it. It uses the map hint manager map.Hint inside itself. Clusterers contain an instance of this class, which is available as myClusterer.hint. Don't create new instances of this class unless necessary.

See Hint

Constructor | Fields | Events | Methods

Constructor

clusterer.Hint(clusterer)

Parameters:

ParameterDefault valueDescription
clusterer *
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Clusterer

Clusterer.

* Mandatory parameter/option.

Fields

NameTypeDescription
eventsIEventManager

Event manager.

Inherited from IEventEmitter.

Events

NameDescription
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

NameReturnsDescription
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.