Documentation / @geoverse/core-ol / Overview

Class: Overview

Defined in: packages/core-ol/src/controls/overview.ts:53

鹰眼控件（旧库 vzOverview 移植），默认复制主图底图。

Extends

• OverviewMap

Constructors

Constructor

new Overview(opts?): Overview;

Defined in: packages/core-ol/src/controls/overview.ts:54

Parameters

opts?

OverviewOptions = {}

Returns

Overview

Overrides

OverviewMap.constructor

Properties

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

OverviewMap.disposed

---

element

protected element: HTMLElement;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/control/Control.d.ts:67

Inherited from

OverviewMap.element

---

listenerKeys

protected listenerKeys: EventsKey[];

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/control/Control.d.ts:82

Inherited from

OverviewMap.listenerKeys

---

on

on: ObjectOnSignature<EventsKey>;

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

Inherited from

OverviewMap.on

---

once

once: ObjectOnSignature<EventsKey>;

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

Inherited from

OverviewMap.once

---

ovmapPostrenderKey_

ovmapPostrenderKey_: any;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/control/OverviewMap.d.ts:199

Inherited from

OverviewMap.ovmapPostrenderKey_

---

un

un: ObjectOnSignature<void>;

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

Inherited from

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

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

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

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

OverviewMap.changed

---

close()

close(): void;

Defined in: packages/core-ol/src/controls/overview.ts:86

收起鹰眼

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

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

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

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

OverviewMap.get

---

getCollapsed()

getCollapsed(): boolean;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/control/OverviewMap.d.ts:234

Determine if the overview map is collapsed.

Returns

boolean

The overview map is collapsed.

Api

Inherited from

OverviewMap.getCollapsed

---

getCollapsible()

getCollapsible(): boolean;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/control/OverviewMap.d.ts:214

Return true if the overview map is collapsible, false otherwise.

Returns

boolean

True if the widget is collapsible.

Api

Inherited from

OverviewMap.getCollapsible

---

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

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

OverviewMap.getListeners

---

getMap()

getMap(): Map | null;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/control/Control.d.ts:94

Get the map associated with this control.

Returns

Map | null

Map.

Api

Inherited from

OverviewMap.getMap

---

getOverviewMap()

getOverviewMap(): Map;

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

Return the overview map.

Returns

Map

Overview map.

Api

Inherited from

OverviewMap.getOverviewMap

---

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

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

OverviewMap.getPropertiesInternal

---

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

OverviewMap.getRevision

---

getRotateWithView()

getRotateWithView(): boolean;

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

Return true if the overview map view can rotate, false otherwise.

Returns

boolean

True if the control view can rotate.

Api

Inherited from

OverviewMap.getRotateWithView

---

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

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

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

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

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

OverviewMap.onInternal

---

open()

open(): void;

Defined in: packages/core-ol/src/controls/overview.ts:81

展开鹰眼

Returns

void

---

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

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

OverviewMap.removeEventListener

---

render()

render(mapEvent): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/control/Control.d.ts:88

Renders the control.

Parameters

mapEvent

MapEvent

Map event.

Returns

void

Api

Inherited from

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

OverviewMap.set

---

setCollapsed()

setCollapsed(collapsed): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/control/OverviewMap.d.ts:228

Collapse or expand the overview map according to the passed parameter. Will not do anything if the overview map isn't collapsible or if the current collapsed state is already the one requested.

Parameters

collapsed

boolean

True if the widget is collapsed.

Returns

void

Api

Inherited from

OverviewMap.setCollapsed

---

setCollapsible()

setCollapsible(collapsible): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/control/OverviewMap.d.ts:220

Set whether the overview map should be collapsible.

Parameters

collapsible

boolean

True if the widget is collapsible.

Returns

void

Api

Inherited from

OverviewMap.setCollapsible

---

setMap()

setMap(map): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/control/Control.d.ts:103

Remove the control from its current map and attach it to the new map. Pass null to just remove the control from the current map. Subclasses may set up event handlers to get notified about changes to the map here.

Parameters

map

Map | null

Map.

Returns

void

Api

Inherited from

OverviewMap.setMap

---

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

OverviewMap.setProperties

---

setRotateWithView()

setRotateWithView(rotateWithView): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/control/OverviewMap.d.ts:246

Set whether the overview map view should rotate with the main map view.

Parameters

rotateWithView

boolean

True if the control view should rotate.

Returns

void

Api

Inherited from

OverviewMap.setRotateWithView

---

setTarget()

setTarget(target): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/control/Control.d.ts:113

This function is used to set a target element for the control. It has no effect if it is called after the control has been added to the map (i.e. after setMap is called on the control). If no target is set in the options passed to the control constructor and if setTarget is not called then the control is added to the map's overlay container.

Parameters

target

string | HTMLElement

Target.

Returns

void

Api

Inherited from

OverviewMap.setTarget

---

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

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

OverviewMap.unset