Documentation / @geoverse/core-ol / FeatureEditor

Class: FeatureEditor

Defined in: packages/core-ol/src/interactions/featureEditor.ts:113

要素编辑器（旧库 vzFeatureEditor 移植）。

• start()/stop() 切换编辑态（编辑态显示顶点节点）
• 每次拖拽结束派发 adjust 事件；stop() 派发 end 事件
• destroy() 恢复原样式并回收交互

Extends

• BaseObject

Constructors

Constructor

new FeatureEditor(opts?): FeatureEditor;

Defined in: packages/core-ol/src/interactions/featureEditor.ts:119

Parameters

opts?

FeatureEditorOptions = {}

Returns

FeatureEditor

Overrides

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

BaseObject.disposed

---

features

protected features: Feature<Geometry, {
[x: string]: any;
}>[];

Defined in: packages/core-ol/src/interactions/featureEditor.ts:117

---

mapObject?

protected optional mapObject?: Map;

Defined in: packages/core-ol/src/interactions/featureEditor.ts:116

---

modify?

protected optional modify?: Modify;

Defined in: packages/core-ol/src/interactions/featureEditor.ts:115

---

on

on: ObjectOnSignature<EventsKey>;

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

Inherited from

BaseObject.on

---

once

once: ObjectOnSignature<EventsKey>;

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

Inherited from

BaseObject.once

---

source

protected readonly source: VectorSource;

Defined in: packages/core-ol/src/interactions/featureEditor.ts:114

---

un

un: ObjectOnSignature<void>;

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

Inherited from

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

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

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

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

BaseObject.changed

---

clearResult()

clearResult(): void;

Defined in: packages/core-ol/src/interactions/featureEditor.ts:203

清空编辑数据

Returns

void

---

destroy()

destroy(): void;

Defined in: packages/core-ol/src/interactions/featureEditor.ts:208

销毁：恢复样式并回收交互

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

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

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

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

BaseObject.get

---

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

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

BaseObject.getListeners

---

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

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

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

BaseObject.getRevision

---

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

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

BaseObject.hasProperties

---

init()

protected init(): void;

Defined in: packages/core-ol/src/interactions/featureEditor.ts:136

Returns

void

---

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

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

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

BaseObject.onInternal

---

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

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

BaseObject.removeEventListener

---

resetData()

resetData(dataset?): void;

Defined in: packages/core-ol/src/interactions/featureEditor.ts:169

更换编辑对象

Parameters

dataset?

| Feature<Geometry, { [x: string]: any; }> | Feature<Geometry, { [x: string]: any; }>[]

Returns

void

---

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

BaseObject.set

---

setMap()

setMap(map): void;

Defined in: packages/core-ol/src/interactions/featureEditor.ts:162

重新绑定地图（自动销毁旧绑定）

Parameters

map

Map

Returns

void

---

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

BaseObject.setProperties

---

start()

start(): void;

Defined in: packages/core-ol/src/interactions/featureEditor.ts:180

进入编辑态

Returns

void

---

stop()

stop(): void;

Defined in: packages/core-ol/src/interactions/featureEditor.ts:191

退出编辑态（恢复原样式并派发 end 事件）

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

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

BaseObject.unset