Documentation / @geoverse/core-libre / InfoWindow

Class: InfoWindow

Defined in: packages/core-libre/src/map/infoWindow.ts:37

信息弹窗，继承自 maplibregl.Popup。

相对原生 Popup 的增强：内容支持 HTML 字符串/元素 id/DOM 元素； 提供与 core 对齐的 open / close 语义（位置入参为 WGS-84 经纬度）。 Popup 自身已派发 'open' / 'close' 事件。

坐标：使用者给的 position 恒为 WGS-84。挂到 GMap 时按其当前 datum 把位置 forward 到地图空间（国内底图无偏移）；挂到原生 Map 则按 WGS-84 处理。

Extends

• Popup

Constructors

Constructor

new InfoWindow(opts?): InfoWindow;

Defined in: packages/core-libre/src/map/infoWindow.ts:47

Parameters

opts?

InfoWindowOptions = {}

Returns

InfoWindow

Overrides

Popup.constructor

Properties

_closeButton

_closeButton: HTMLButtonElement;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:13496

Inherited from

Popup._closeButton

---

_container

_container: HTMLElement;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:13495

Inherited from

Popup._container

---

_content

_content: HTMLElement;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:13494

Inherited from

Popup._content

---

_eventedParent

_eventedParent: Evented;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:827

Inherited from

Popup._eventedParent

---

_eventedParentData

_eventedParentData: any;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:828

Inherited from

Popup._eventedParentData

---

_flatPos

_flatPos: Point;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:13501

Inherited from

Popup._flatPos

---

_listeners

_listeners: Listeners;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:825

Inherited from

Popup._listeners

---

_lngLat

_lngLat: LngLat;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:13498

Inherited from

Popup._lngLat

---

_map

_map: Map$1;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:13492

Inherited from

Popup._map

---

_onClose

_onClose: () => void;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:13720

Returns

void

Inherited from

Popup._onClose

---

_oneTimeListeners

_oneTimeListeners: Listeners;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:826

Inherited from

Popup._oneTimeListeners

---

_pos

_pos: Point;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:13500

Inherited from

Popup._pos

---

_tip

_tip: HTMLElement;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:13497

Inherited from

Popup._tip

---

_trackPointer

_trackPointer: boolean;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:13499

Inherited from

Popup._trackPointer

---

_update

_update: (event?) => void;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:13718

Parameters

event?

MapMouseEvent | MapLibreEvent<unknown>

Returns

void

Inherited from

Popup._update

---

_updateOpacity

_updateOpacity: () => void;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:13526

Add opacity to popup if in globe projection and location is behind view

Returns

void

Inherited from

Popup._updateOpacity

---

options

options: PopupOptions;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:13493

Inherited from

Popup.options

---

remove

remove: () => this;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:13540

Removes the popup from the map it has been added to.

Returns

this

Example

let popup = new Popup().addTo(map);
popup.remove();

Inherited from

Popup.remove

Methods

_createCloseButton()

_createCloseButton(): void;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:13717

Returns

void

Inherited from

Popup._createCloseButton

---

_focusFirstElement()

_focusFirstElement(): void;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:13719

Returns

void

Inherited from

Popup._focusFirstElement

---

addClassName()

addClassName(className): this;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:13662

Adds a CSS class to the popup container element.

Parameters

className

string

Non-empty string with CSS class name to add to popup container

Returns

this

Example

let popup = new Popup()
popup.addClassName('some-class')

Inherited from

Popup.addClassName

---

addTo()

addTo(map): this;

Defined in: packages/core-libre/src/map/infoWindow.ts:68

挂载到地图；记录其 datum、订阅 datum 变更、并按之重新投影已有位置

Parameters

map

Map$1

Returns

this

Overrides

Popup.addTo

---

close()

close(): this;

Defined in: packages/core-libre/src/map/infoWindow.ts:95

关闭弹窗（从地图移除，Popup 会派发 'close'）

Returns

this

---

fire()

fire(event, properties?): this;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:855

Parameters

event

string | Event$1

properties?

any

Returns

this

Inherited from

Popup.fire

---

getElement()

getElement(): HTMLElement;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:13583

Returns the Popup's HTML element.

Returns

HTMLElement

element

Example

Change the Popup element's font size

let popup = new Popup()
  .setLngLat([-96, 37.8])
  .setHTML("<p>Hello World!</p>")
  .addTo(map);
let popupElem = popup.getElement();
popupElem.style.fontSize = "25px";

Inherited from

Popup.getElement

---

getLngLat()

getLngLat(): LngLat;

Defined in: packages/core-libre/src/map/infoWindow.ts:63

获取位置（WGS-84）

Returns

LngLat

Overrides

Popup.getLngLat

---

getMaxWidth()

getMaxWidth(): string;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:13627

Returns the popup's maximum width.

Returns

string

The maximum width of the popup.

Inherited from

Popup.getMaxWidth

---

isOpen()

isOpen(): boolean;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:13530

Returns

boolean

true if the popup is open, false if it is closed.

Inherited from

Popup.isOpen

---

listens()

listens(type): boolean;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:862

Returns a true if this instance of Evented or any forwardeed instances of Evented have a listener for the specified type.

Parameters

type

string

The event type

Returns

boolean

true if there is at least one registered listener for specified event type, false otherwise

Inherited from

Popup.listens

---

off()

off(type, listener): this;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:844

Removes a previously registered event listener.

Parameters

type

string

The event type to remove listeners for.

listener

Listener

The listener function to remove.

Returns

this

Inherited from

Popup.off

---

on()

on(type, listener): Subscription;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:837

Adds a listener to a specified event type.

Parameters

type

string

The event type to add a listen for.

listener

Listener

The function to be called when the event is fired. The listener function is called with the data object passed to fire, extended with target and type properties.

Returns

Subscription

Inherited from

Popup.on

---

once()

once(type, listener?): Promise<any> | InfoWindow;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:854

Adds a listener that will be called only once to a specified event type.

The listener will be called first time the event fires after the listener is registered.

Parameters

type

string

The event type to listen for.

listener?

Listener

The function to be called when the event is fired the first time.

Returns

Promise<any> | InfoWindow

this or a promise if a listener is not provided

Inherited from

Popup.once

---

open()

open(map, lngLat?): this;

Defined in: packages/core-libre/src/map/infoWindow.ts:88

打开弹窗；可选传入新的经纬度位置

Parameters

map

Map$1

lngLat?

LngLatLike

Returns

this

---

removeClassName()

removeClassName(className): this;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:13674

Removes a CSS class from the popup container element.

Parameters

className

string

Non-empty string with CSS class name to remove from popup container

Returns

this

Example

let popup = new Popup()
popup.removeClassName('some-class')

Inherited from

Popup.removeClassName

---

setContent()

setContent(content): this;

Defined in: packages/core-libre/src/map/infoWindow.ts:101

设置内容（HTML 字符串 / 元素 id / DOM 元素）

Parameters

content

string | HTMLElement

Returns

this

---

setDOMContent()

setDOMContent(htmlNode): this;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:13650

Sets the popup's content to the element provided as a DOM node.

Parameters

htmlNode

Node

A DOM node to be used as content for the popup.

Returns

this

Example

Create an element with the popup content

let div = document.createElement('div');
div.innerHTML = 'Hello, world!';
let popup = new Popup()
  .setLngLat(e.lngLat)
  .setDOMContent(div)
  .addTo(map);

Inherited from

Popup.setDOMContent

---

setEventedParent()

setEventedParent(parent?, data?): this;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:866

Bubble all events fired by this instance of Evented to this parent instance of Evented.

Parameters

parent?

Evented | null

data?

any

Returns

this

Inherited from

Popup.setEventedParent

---

setHTML()

setHTML(html): this;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:13621

Sets the popup's content to the HTML provided as a string.

This method does not perform HTML filtering or sanitization, and must be used only with trusted content. Consider Popup.setText if the content is an untrusted text string.

Parameters

html

string

A string representing HTML content for the popup.

Returns

this

Example

let popup = new Popup()
  .setLngLat(e.lngLat)
  .setHTML("<h1>Hello World!</h1>")
  .addTo(map);

See

• Display a popup
• Display a popup on hover
• Display a popup on click
• Attach a popup to a marker instance

Inherited from

Popup.setHTML

---

setLngLat()

setLngLat(lngLat): this;

Defined in: packages/core-libre/src/map/infoWindow.ts:56

设置位置（WGS-84）；按当前挂载地图 datum 投影到地图空间

Parameters

lngLat

LngLatLike

Returns

this

Overrides

Popup.setLngLat

---

setMaxWidth()

setMaxWidth(maxWidth): this;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:13634

Sets the popup's maximum width. This is setting the CSS property max-width. Available values can be found here: https://developer.mozilla.org/en-US/docs/Web/CSS/max-width

Parameters

maxWidth

string

A string representing the value for the maximum width.

Returns

this

Inherited from

Popup.setMaxWidth

---

setOffset()

setOffset(offset?): this;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:13680

Sets the popup's offset.

Parameters

offset?

Offset

Sets the popup's offset.

Returns

this

Inherited from

Popup.setOffset

---

setPadding()

setPadding(padding?): void;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:13716

Sets the popup's padding constraints for positioning.

Parameters

padding?

PaddingOptions

The padding to apply as a PaddingOptions object.

Returns

void

Example

popup.setPadding({ top: 10, right: 20, bottom: 30, left: 40 });

Inherited from

Popup.setPadding

---

setSubpixelPositioning()

setSubpixelPositioning(value): void;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:13706

Set the option to allow subpixel positioning of the popup by passing a boolean

Parameters

value

boolean

When boolean is true, subpixel positioning is enabled for the popup.

Returns

void

Example

let popup = new Popup()
popup.setSubpixelPositioning(true);

Inherited from

Popup.setSubpixelPositioning

---

setText()

setText(text): this;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:13600

Sets the popup's content to a string of text.

This function creates a Text node in the DOM, so it cannot insert raw HTML. Use this method for security against XSS if the popup content is user-provided.

Parameters

text

string

Textual content for the popup.

Returns

this

Example

let popup = new Popup()
  .setLngLat(e.lngLat)
  .setText('Hello, world!')
  .addTo(map);

Inherited from

Popup.setText

---

toggleClassName()

toggleClassName(className): boolean | undefined;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:13694

Add or remove the given CSS class on the popup container, depending on whether the container currently has that class.

Parameters

className

string

Non-empty string with CSS class name to add/remove

Returns

boolean | undefined

if the class was removed return false, if class was added, then return true, undefined if there is no container

Example

let popup = new Popup()
popup.toggleClassName('toggleClass')

Inherited from

Popup.toggleClassName

---

trackPointer()

trackPointer(): this;

Defined in: node_modules/.pnpm/maplibre-gl@5.24.0/node_modules/maplibre-gl/dist/maplibre-gl.d.ts:13568

Tracks the popup anchor to the cursor position on screens with a pointer device (it will be hidden on touchscreens). Replaces the setLngLat behavior. For most use cases, set closeOnClick and closeButton to false.

Returns

this

Example

let popup = new Popup({ closeOnClick: false, closeButton: false })
  .setHTML("<h1>Hello World!</h1>")
  .trackPointer()
  .addTo(map);

Inherited from

Popup.trackPointer