Documentation
Reference
2.1.56 (current version)
collection
interactivityModel
Interfaces

IPane

Extends IEventEmitter.

Interface for a map pane. The map pane is an object that hosts its DOM element with a certain zIndex inside the map container. A pane can serve as a container to hold representations of various map elements, such as tiles, overlays, static map controls, etc. A pane can also act as a non-transparent screen for DOM events where you can listen to mouse events.

Constructor | Fields | Events | Methods

Constructor

IPane()

Fields

NameTypeDescription
eventsIEventManager

Event manager.

Inherited from IEventEmitter.

Events

NameDescription
overflowchange

Change to the "overflow" parameter, which defines visibility of the pane contents when going outside of the map container. Instance of IEvent.

zindexchange

Change to the zIndex value of a pane. Instance of IEvent.

Methods

NameReturnsDescription
destroy()

Destroys the pane.

getElement()

HTMLElement

Returns a reference to the pane's DOM container.

getMap()

Map

Returns the map that the pane belongs to.

getOverflow()

String

Returns value of the "overflow" parameter, which defines visibility of the pane contents when going outside of the map container. This parameter can take one of the following string values:

  • "visible" - When you go off the map container, the content of the pane remains visible.
  • "hidden" - The viewport for the pane content is limited by the map container.
.

getZIndex()

Number

Returns the zIndex of the pane.

Events details

overflowchange

Change to the "overflow" parameter, which defines visibility of the pane contents when going outside of the map container. Instance of IEvent.

zindexchange

Change to the zIndex value of a pane. Instance of IEvent.

Methods details

destroy

{} destroy()

Destroys the pane.

getElement

{HTMLElement} getElement()

Returns a reference to the pane's DOM container.

getMap

{Map} getMap()

Returns the map that the pane belongs to.

getOverflow

{String} getOverflow()

Returns value of the "overflow" parameter, which defines visibility of the pane contents when going outside of the map container. This parameter can take one of the following string values:

  • "visible" - When you go off the map container, the content of the pane remains visible.
  • "hidden" - The viewport for the pane content is limited by the map container.
.

getZIndex

{Number} getZIndex()

Returns the zIndex of the pane.