Documentation / @geoverse/core-ol / InfoWindow

Class: InfoWindow

Defined in: packages/core-ol/src/map/infoWindow.ts:50

信息弹窗，继承自 ol/Overlay。

• open(map, lonLat?) / close() 控制显隐，并派发 'open' / 'close' 事件
• 位置参数统一使用 WGS-84 经纬度，内部按当前视图投影换算

Extends

• Overlay

Constructors

Constructor

new InfoWindow(opts?): InfoWindow;

Defined in: packages/core-ol/src/map/infoWindow.ts:53

Parameters

opts?

InfoWindowOptions = {}

Returns

InfoWindow

Overrides

Overlay.constructor

Properties

autoPan

protected autoPan: PanIntoViewOptions | undefined;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:174

Inherited from

Overlay.autoPan

---

disposed

protected disposed: boolean;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Disposable.d.ts:15

The object has already been disposed.

Inherited from

Overlay.disposed

---

element

protected element: HTMLElement;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:169

Inherited from

Overlay.element

---

id

protected id: string | number | undefined;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:154

Inherited from

Overlay.id

---

insertFirst

protected insertFirst: boolean;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:159

Inherited from

Overlay.insertFirst

---

mapPostrenderListenerKey

protected mapPostrenderListenerKey: EventsKey | null;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:188

Inherited from

Overlay.mapPostrenderListenerKey

---

on

on: OverlayOnSignature<EventsKey>;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:136

Inherited from

Overlay.on

---

once

once: OverlayOnSignature<EventsKey>;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:140

Inherited from

Overlay.once

---

options

protected options: Options;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:149

Inherited from

Overlay.options

---

rendered

protected rendered: {
  transform_: string;
  visible: boolean;
};

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:180

transform_

transform_: string;

visible

visible: boolean;

Inherited from

Overlay.rendered

---

stopEvent

protected stopEvent: boolean;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:164

Inherited from

Overlay.stopEvent

---

un

un: OverlayOnSignature<void>;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:144

Inherited from

Overlay.un

Methods

addChangeListener()

addChangeListener(key, listener): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Object.d.ts:145

Parameters

key

string

Key name.

listener

Listener

Listener.

Returns

void

Inherited from

Overlay.addChangeListener

---

addEventListener()

addEventListener(type, listener): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/events/Target.d.ts:50

Parameters

type

string

Type.

listener

Listener

Listener.

Returns

void

Inherited from

Overlay.addEventListener

---

applyProperties()

protected applyProperties(source): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Object.d.ts:172

Apply any properties from another object without triggering events.

Parameters

source

BaseObject

The source object.

Returns

void

Inherited from

Overlay.applyProperties

---

changed()

changed(): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Observable.d.ts:65

Increases the revision counter and dispatches a 'change' event.

Returns

void

Api

Inherited from

Overlay.changed

---

close()

close(): void;

Defined in: packages/core-ol/src/map/infoWindow.ts:87

关闭弹窗并从地图移除

Returns

void

---

dispatchEvent()

dispatchEvent(event): boolean | undefined;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/events/Target.d.ts:61

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Parameters

event

string | BaseEvent

Event object.

Returns

boolean | undefined

false if anyone called preventDefault on the event object or if any of the listeners returned false.

Api

Inherited from

Overlay.dispatchEvent

---

dispose()

dispose(): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Disposable.d.ts:19

Clean up.

Returns

void

Inherited from

Overlay.dispose

---

disposeInternal()

protected disposeInternal(): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Disposable.d.ts:24

Extension point for disposable objects.

Returns

void

Inherited from

Overlay.disposeInternal

---

get()

get(key): any;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Object.d.ts:114

Gets a value.

Parameters

key

string

Key name.

Returns

any

Value.

Api

Inherited from

Overlay.get

---

getContent()

getContent(): string;

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

获取内容（HTML 字符串）

Returns

string

---

getElement()

getElement(): HTMLElement | undefined;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:195

Get the DOM element of this overlay.

Returns

HTMLElement | undefined

The Element containing the overlay.

Observable

Api

Inherited from

Overlay.getElement

---

getId()

getId(): string | number | undefined;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:201

Get the overlay identifier which is set on constructor.

Returns

string | number | undefined

Id.

Api

Inherited from

Overlay.getId

---

getKeys()

getKeys(): string[];

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Object.d.ts:120

Get a list of object property names.

Returns

string[]

List of property names.

Api

Inherited from

Overlay.getKeys

---

getListeners()

getListeners(type): Listener[] | undefined;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/events/Target.d.ts:69

Get the listeners for a specified event type. Listeners are returned in the order that they will be called in.

Parameters

type

string

Type.

Returns

Listener[] | undefined

Listeners.

Inherited from

Overlay.getListeners

---

getMap()

getMap(): Map | null;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:209

Get the map associated with this overlay.

Returns

Map | null

The map that the overlay is part of.

Observable

Api

Inherited from

Overlay.getMap

---

getOffset()

getOffset(): number[];

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:216

Get the offset of this overlay.

Returns

number[]

The offset.

Observable

Api

Inherited from

Overlay.getOffset

---

getOptions()

getOptions(): Options;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:338

returns the options this Overlay has been created with

Returns

Options

overlay options

Inherited from

Overlay.getOptions

---

getPosition()

getPosition(): Coordinate | undefined;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:224

Get the current position of this overlay.

Returns

Coordinate | undefined

The spatial point that the overlay is anchored at.

Observable

Api

Inherited from

Overlay.getPosition

---

getPositioning()

getPositioning(): Positioning;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:232

Get the current positioning of this overlay.

Returns

Positioning

How the overlay is positioned relative to its point on the map.

Observable

Api

Inherited from

Overlay.getPositioning

---

getProperties()

getProperties(): NoInfer<{
[x: string]: any;
}>;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Object.d.ts:126

Get an object of all property names and values.

Returns

NoInfer<{ [x: string]: any; }>

Object.

Api

Inherited from

Overlay.getProperties

---

getPropertiesInternal()

getPropertiesInternal(): 
  | Partial<NoInfer<{
[x: string]: any;
}>>
  | null;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Object.d.ts:131

Get an object of all property names and values.

Returns

| Partial<NoInfer<{ [x: string]: any; }>> | null

Object.

Inherited from

Overlay.getPropertiesInternal

---

getRect()

protected getRect(element, size): Extent;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:308

Get the extent of an element relative to the document

Parameters

element

HTMLElement

The element.

size

Size

The size of the element.

Returns

Extent

The extent.

Inherited from

Overlay.getRect

---

getRevision()

getRevision(): number;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Observable.d.ts:72

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns

number

Revision.

Api

Inherited from

Overlay.getRevision

---

getZIndex()

getZIndex(): string | undefined;

Defined in: packages/core-ol/src/map/infoWindow.ts:121

获取弹窗容器 zIndex

Returns

string | undefined

---

handleElementChanged()

protected handleElementChanged(): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:236

Returns

void

Inherited from

Overlay.handleElementChanged

---

handleMapChanged()

protected handleMapChanged(): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:240

Returns

void

Inherited from

Overlay.handleMapChanged

---

handleOffsetChanged()

protected handleOffsetChanged(): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:248

Returns

void

Inherited from

Overlay.handleOffsetChanged

---

handlePositionChanged()

protected handlePositionChanged(): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:252

Returns

void

Inherited from

Overlay.handlePositionChanged

---

handlePositioningChanged()

protected handlePositioningChanged(): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:256

Returns

void

Inherited from

Overlay.handlePositioningChanged

---

hasListener()

hasListener(type?): boolean;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/events/Target.d.ts:75

Parameters

type?

string

Type. If not provided, true will be returned if this event target has any listeners.

Returns

boolean

Has listeners.

Inherited from

Overlay.hasListener

---

hasProperties()

hasProperties(): boolean;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Object.d.ts:135

Returns

boolean

The object has properties.

Inherited from

Overlay.hasProperties

---

notify()

notify(key, oldValue): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Object.d.ts:140

Parameters

key

string

Key name.

oldValue

any

Old value.

Returns

void

Inherited from

Overlay.notify

---

onceInternal()

protected onceInternal(type, listener): EventsKey | EventsKey[];

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Observable.d.ts:86

Parameters

type

string | string[]

Type.

listener

(arg0) => unknown

Listener.

Returns

EventsKey | EventsKey[]

Event key.

Inherited from

Overlay.onceInternal

---

onInternal()

protected onInternal(type, listener): EventsKey | EventsKey[];

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Observable.d.ts:79

Parameters

type

string | string[]

Type.

listener

(arg0) => unknown

Listener.

Returns

EventsKey | EventsKey[]

Event key.

Inherited from

Overlay.onInternal

---

open()

open(map, lonLat?): void;

Defined in: packages/core-ol/src/map/infoWindow.ts:75

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

Parameters

map

Map

lonLat?

Coordinate

Returns

void

---

panIntoView()

panIntoView(panIntoViewOptions?): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:300

Pan the map so that the overlay is entirely visible in the current viewport (if necessary).

Parameters

panIntoViewOptions?

PanIntoViewOptions

Options for the pan action

Returns

void

Api

Inherited from

Overlay.panIntoView

---

performAutoPan()

protected performAutoPan(): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:293

Pan the map so that the overlay is entirely visible in the current viewport (if necessary) using the configured autoPan parameters

Returns

void

Inherited from

Overlay.performAutoPan

---

removeChangeListener()

removeChangeListener(key, listener): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Object.d.ts:150

Parameters

key

string

Key name.

listener

Listener

Listener.

Returns

void

Inherited from

Overlay.removeChangeListener

---

removeEventListener()

removeEventListener(type, listener): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/events/Target.d.ts:80

Parameters

type

string

Type.

listener

Listener

Listener.

Returns

void

Inherited from

Overlay.removeEventListener

---

render()

protected render(): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:244

Returns

void

Inherited from

Overlay.render

---

set()

set(
   key, 
   value, 
   silent?): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Object.d.ts:158

Sets a value.

Parameters

key

string

Key name.

value

any

Value.

silent?

boolean

Update without triggering an event.

Returns

void

Api

Inherited from

Overlay.set

---

setContent()

setContent(content): void;

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

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

Parameters

content

string | HTMLElement

Returns

void

---

setElement()

setElement(element): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:263

Set the DOM element to be associated with this overlay.

Parameters

element

HTMLElement | undefined

The Element containing the overlay.

Returns

void

Observable

Api

Inherited from

Overlay.setElement

---

setLonLatPosition()

setLonLatPosition(lonLat): void;

Defined in: packages/core-ol/src/map/infoWindow.ts:110

以 WGS-84 经纬度设置弹窗位置（按当前视图投影换算）

Parameters

lonLat

Coordinate

Returns

void

---

setMap()

setMap(map): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:271

Set the map to be associated with this overlay.

Parameters

map

Map | null

The map that the overlay is part of. Pass null to just remove the overlay from the current map.

Returns

void

Observable

Api

Inherited from

Overlay.setMap

---

setOffset()

setOffset(offset): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:278

Set the offset for this overlay.

Parameters

offset

number[]

Offset.

Returns

void

Observable

Api

Inherited from

Overlay.setOffset

---

setPosition()

setPosition(position): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:287

Set the position for this overlay. If the position is undefined the overlay is hidden.

Parameters

position

Coordinate | undefined

The spatial point that the overlay is anchored at.

Returns

void

Observable

Api

Inherited from

Overlay.setPosition

---

setPositioning()

setPositioning(positioning): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:316

Set the positioning for this overlay.

Parameters

positioning

Positioning

how the overlay is positioned relative to its point on the map.

Returns

void

Observable

Api

Inherited from

Overlay.setPositioning

---

setProperties()

setProperties(values, silent?): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Object.d.ts:166

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Parameters

values

Partial<NoInfer<Properties>>

Values.

silent?

boolean

Update without triggering an event.

Returns

void

Api

Inherited from

Overlay.setProperties

---

setVisible()

protected setVisible(visible): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:322

Modify the visibility of the element.

Parameters

visible

boolean

Element visibility.

Returns

void

Inherited from

Overlay.setVisible

---

setZIndex()

setZIndex(zIndex): void;

Defined in: packages/core-ol/src/map/infoWindow.ts:127

设置弹窗容器 zIndex

Parameters

zIndex

string | number

Returns

void

---

unInternal()

protected unInternal(type, listener): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Observable.d.ts:93

Unlisten for a certain type of event.

Parameters

type

string | string[]

Type.

listener

(arg0) => unknown

Listener.

Returns

void

Inherited from

Overlay.unInternal

---

unset()

unset(key, silent?): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Object.d.ts:179

Unsets a property.

Parameters

key

string

Key name.

silent?

boolean

Unset without triggering an event.

Returns

void

Api

Inherited from

Overlay.unset

---

updatePixelPosition()

protected updatePixelPosition(): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:327

Update pixel position.

Returns

void

Inherited from

Overlay.updatePixelPosition

---

updateRenderedPosition()

protected updateRenderedPosition(pixel, mapSize): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Overlay.d.ts:333

Parameters

pixel

Pixel

The pixel location.

mapSize

Size | undefined

The map size.

Returns

void

Inherited from

Overlay.updateRenderedPosition