PopupOptions

Properties

Link copied to clipboard
abstract var attribution: String?

String to be shown in the attribution control, e.g. "© OpenStreetMap contributors". It describes the layer data and is often a legal obligation towards copyright holders and tile providers.

Link copied to clipboard
abstract var autoClose: Boolean?

Set it to false if you want to override the default behavior of the popup closing when another popup is opened.

Link copied to clipboard
abstract var autoPan: Boolean?

Set it to false if you don't want the map to do panning animation to fit the opened popup.

Link copied to clipboard
abstract var autoPanPadding: Point?

Equivalent of setting both top left and bottom right auto-pan padding to the same value.

Link copied to clipboard

The margin between the popup and the bottom right corner of the map view after auto-panning was performed.

Link copied to clipboard

The margin between the popup and the top left corner of the map view after auto-panning was performed.

Link copied to clipboard
Link copied to clipboard
abstract var className: String?

A custom CSS class name to assign to the overlay.

Link copied to clipboard
abstract var closeButton: Boolean?

Controls the presence of a close button in the popup.

Link copied to clipboard
abstract var closeOnClick: Boolean?

Set it if you want to override the default behavior of the popup closing when user clicks on the map. Defaults to the map's closePopupOnClick option.

Link copied to clipboard
abstract var closeOnEscapeKey: Boolean?

Set it to false if you want to override the default behavior of the ESC key for closing of the popup.

Link copied to clipboard
abstract var interactive: Boolean?

If true, the popup/tooltip will listen to the mouse events.

Link copied to clipboard
abstract var keepInView: Boolean?

Set it to true if you want to prevent users from panning the popup off of the screen while it is open.

Link copied to clipboard
abstract var maxHeight: Number?

If set, creates a scrollable container of the given height inside a popup if its content exceeds it.

Link copied to clipboard
abstract var maxWidth: Number?

Max width of the popup, in pixels.

Link copied to clipboard
abstract var minWidth: Number?

Min width of the popup, in pixels.

Link copied to clipboard
abstract var offset: Point

The offset of the overlay position.

Link copied to clipboard
abstract var pane: String?

By default, the layer will be added to the map's overlay pane. Overriding this option will cause the layer to be placed on another pane by default.