IContainerPane

Extends IPane, IPositioningContext.

Interface for the map pane intended for representations of the objects placed on the surface of the map. Allows you to transform global map pixels into a custom local coordinate system, thus enabling the object to be positioned within itself. Also informs about changes to the map status and thus allows the object to handle these changes.

Constructor | Fields | Events | Methods

Constructor

IContainerPane()

Fields

Name

Type

Description

events

IEventManager

Event manager.

Inherited from IEventEmitter.

Events

Name

Description

actionbegin

The start of pane movement. Instance of IEvent.

actionend

The end of pane movement. Instance of IEvent.

clientpixelschange

Change to the pane's local coordinate system. This event means that objects that calculate their positions inside the pane from the map's global pixel coordinates must recalculate it and update their positions inside the pane's DOM element. Instance of IEvent.

overflowchange

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

Inherited from IPane.

viewportchange

Change to a pane's viewport. Instance of IEvent.

zindexchange

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

Inherited from IPane.

Methods

Name

Returns

Description

destroy()

Destroys the pane.

Inherited from IPane.

fromClientPixels(clientPixelPoint)

Number[]

Converts client pixel coordinates to global coordinates.

Inherited from IPositioningContext.

getElement()

HTMLElement

Returns a reference to the pane's DOM container.

Inherited from IPane.

getMap()

Map

Returns the map that the pane belongs to.

Inherited from IPane.

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.

Inherited from IPane.

getViewport()

Number[][]

Returns the viewport for the pane, in client coordinates.

getZIndex()

Number

Returns the zIndex of the pane.

Inherited from IPane.

getZoom()

Number

Returns the current zoom level at which the positioning context works.

Inherited from IPositioningContext.

toClientPixels(globalPixelPoint)

Number[]

Converts global pixel coordinates to client coordinates.

Inherited from IPositioningContext.

Events details

actionbegin

The start of pane movement. Instance of IEvent.

actionend

The end of pane movement. Instance of IEvent.

clientpixelschange

Change to the pane's local coordinate system. This event means that objects that calculate their positions inside the pane from the map's global pixel coordinates must recalculate it and update their positions inside the pane's DOM element. Instance of IEvent.

viewportchange

Change to a pane's viewport. Instance of IEvent.

Methods details

getViewport

{Number[][]} getViewport()

Returns the viewport for the pane, in client coordinates.