PopupOptions interface

The options for a popup.

Extends

Properties

closeButton

Specifies if the close button should be displayed in the popup or not. default true

content

The content to display within the popup. default span

draggable

Specifies if the popup can be dragged away from its position. default false

fillColor

Specifies the fill color of the popup. default "#FFFFFF"

pixelOffset

An array of [pixelsRight, pixelsDown] for how many pixels to the right and down the anchor of the popup should be offset. Negative numbers can be used to offset the popup left and up. default [0, 0]

position

The position on the map where the popup should be anchored. default [0, 0]

showPointer

Specifies if the pointer should be displayed in the popup or not. default true

Property Details

closeButton

Specifies if the close button should be displayed in the popup or not. default true

closeButton?: boolean

Property Value

boolean

content

The content to display within the popup. default span

content?: HTMLElement | string

Property Value

HTMLElement | string

draggable

Specifies if the popup can be dragged away from its position. default false

draggable?: boolean

Property Value

boolean

fillColor

Specifies the fill color of the popup. default "#FFFFFF"

fillColor?: string

Property Value

string

pixelOffset

An array of [pixelsRight, pixelsDown] for how many pixels to the right and down the anchor of the popup should be offset. Negative numbers can be used to offset the popup left and up. default [0, 0]

pixelOffset?: Pixel

Property Value

position

The position on the map where the popup should be anchored. default [0, 0]

position?: Position

Property Value

showPointer

Specifies if the pointer should be displayed in the popup or not. default true

showPointer?: boolean

Property Value

boolean