Overlay

Extends

• BaseObject

Observable Properties

Name	Type	Settable	ObjectEvent type	Description
element	HTMLElement | undefined	yes	change:element	The Element containing the overlay.
map	Map | null	yes	change:map	The map that the overlay is part of.
offset	Array.<number>	yes	change:offset	The offset.
position	Coordinate | undefined	yes	change:position	The spatial point that the overlay is anchored at.
positioning	Positioning	yes	change:positioning	How the overlay is positioned relative to its point on the map.

Methods

changed() inherited

Observable.js, line 72

Increases the revision counter and dispatches a 'change' event.

dispatchEvent(event){boolean | undefined} inherited

events/Target.js, line 85

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Name	Type	Description
event	BaseEvent | string	Event object.

Returns:

false if anyone called preventDefault on the event object or if any of the listeners returned false.

get(key){*} inherited

Object.js, line 136

Gets a value.

Name	Type	Description
key	string	Key name.

Returns:

Value.

getElement(){HTMLElement | undefined}

Overlay.js, line 218

Get the DOM element of this overlay.

Returns:

The Element containing the overlay.

getId(){number | string | undefined}

Overlay.js, line 227

Get the overlay identifier which is set on constructor.

Returns:

Id.

getKeys(){Array.<string>} inherited

Object.js, line 149

Get a list of object property names.

Returns:

List of property names.

getMap(){Map | null}

Overlay.js, line 238

Get the map associated with this overlay.

Returns:

The map that the overlay is part of.

getOffset(){Array.<number>}

Overlay.js, line 250

Get the offset of this overlay.

Returns:

The offset.

getPosition(){Coordinate | undefined}

Overlay.js, line 261

Get the current position of this overlay.

Returns:

The spatial point that the overlay is anchored at.

getPositioning(){Positioning}

Overlay.js, line 274

Get the current positioning of this overlay.

Returns:

How the overlay is positioned relative to its point on the map.

getProperties(){NoInfer.<Properties>} inherited

Object.js, line 158

Get an object of all property names and values.

Returns:

Object.

getRevision(){number} inherited

Observable.js, line 83

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:

Revision.

on(type, listener){EventsKey | Array<EventsKey>} inherited

Observable.js, line 156

Listen for a certain type of event.

Name	Type	Description
type	string | Array.<string>	The event type or array of event types.
listener	function	The listener function.

Returns:

Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

once(type, listener){EventsKey | Array<EventsKey>} inherited

Observable.js, line 168

Listen once for a certain type of event.

Name	Type	Description
type	string | Array.<string>	The event type or array of event types.
listener	function	The listener function.

Returns:

Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

panIntoView(panIntoViewOptions)

Overlay.js, line 410

Pan the map so that the overlay is entirely visible in the current viewport (if necessary).

Name	Type	Description
panIntoViewOptions	Options for the pan action Name Type Description animation PanOptions (defaults to {}) The animation parameters for the pan margin number (defaults to 20) The margin (in pixels) between the overlay and the borders of the map when panning into view.

set(key, value, silent) inherited

Object.js, line 218

Sets a value.

Name	Type	Description
key	string	Key name.
value	*	Value.
silent	boolean | undefined	Update without triggering an event.

setElement(element)

Overlay.js, line 356

Set the DOM element to be associated with this overlay.

Name	Type	Description
element	HTMLElement | undefined	The Element containing the overlay.

setMap(map)

Overlay.js, line 367

Set the map to be associated with this overlay.

Name	Type	Description
map	Map | null	The map that the overlay is part of. Pass null to just remove the overlay from the current map.

setOffset(offset)

Overlay.js, line 377

Set the offset for this overlay.

Name	Type	Description
offset	Array.<number>	Offset.

setPosition(position)

Overlay.js, line 389

Set the position for this overlay. If the position is undefined the overlay is hidden.

Name	Type	Description
position	Coordinate | undefined	The spatial point that the overlay is anchored at.

setPositioning(positioning)

Overlay.js, line 503

Set the positioning for this overlay.

Name	Type	Description
positioning	Positioning	how the overlay is positioned relative to its point on the map.

setProperties(values, silent) inherited

Object.js, line 241

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Name	Type	Description
values	Partial.<NoInfer.<Properties>>	Values.
silent	boolean | undefined	Update without triggering an event.

un(type, listener) inherited

Observable.js, line 177

Unlisten for a certain type of event.

Name	Type	Description
type	string | Array.<string>	The event type or array of event types.
listener	function	The listener function.

unset(key, silent) inherited

Object.js, line 265

Unsets a property.

Name	Type	Description
key	string	Key name.
silent	boolean | undefined	Unset without triggering an event.