Documentation
Reference
2.1.50 (current version)
collection
interactivityModel
Interfaces

pane.StaticPane

Extends IContainerPane.

A static map pane.

Constructor | Fields | Events | Methods

Constructor

pane.StaticPane(map, params)

Parameters:

ParameterDefault valueDescription
map *
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Map

Map.

params *
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Object

Parameters.

params.css

Type: Object

CSS styles of the DOM element of the pane.

params.margin 0

Type: Number

Extra padding around the edges of the map container, extending the viewport of the pane.

params.overflow "hidden"

Type: String

This parameter 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.
.

params.zIndex 0

Type: Number

The zIndex of the pane.

* Mandatory parameter/option.

Fields

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

Inherited from IContainerPane.

eventsIEventManager

Event manager.

Inherited from IEventEmitter.

Events

NameDescription
actionbegin

The start of pane movement. Instance of IEvent.

Inherited from IContainerPane.

actionend

The end of pane movement. Instance of IEvent.

Inherited from IContainerPane.

clientpixelschange

Change to the coordinate system of the client pixels.

Inherited from IContainerPane.

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.

Inherited from IContainerPane.

zindexchange

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

Inherited from IPane.

zoomchange

Change to the current zoom level of the pane. Instance of IEvent.

Inherited from IContainerPane.

Methods

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

Inherited from IContainerPane.

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.