Documentation
Reference
2.1.56 (current version)
collection
interactivityModel
Interfaces

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.

See Hint GeoObject.hint

Constructor | Fields | Events | Methods

Constructor

geoObject.Hint(geoObject)

Parameters:

ParameterDefault valueDescription
geoObject *
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Object

Geo object.

* 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 hint for the geo object.

setData([data])

vow.Promise

Sets new user data.

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.

Methods details

open

Opens the hint for the geo object.

Returns Promise object.

Parameters:

ParameterDefault valueDescription
position

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.

data

Type: Object

Data to add to the userData field for the object of data passed to the hint.

options

Type: Object

Options.

setData

{vow.Promise} setData([data])

Sets new user data.

Returns Promise object.

Parameters:

ParameterDefault valueDescription
data

Type: Object

Data to add to the userData field for the object of data passed to the hint.