Documentation / @geoverse/core-ol / GFeature

Class: GFeature

Defined in: packages/core-ol/src/features/feature.ts:65

GeoVerse 要素基类，继承 ol/Feature，提供样式（图标/文字/描边/填充）与坐标的便捷读写。

Extends

Feature

Extended by

Constructors

Constructor

new GFeature(geometryOrProperties?): GFeature;

Defined in: packages/core-ol/src/features/feature.ts:68

Parameters

geometryOrProperties?

Geometry | ObjectWithGeometry<Geometry>

Returns

GFeature

Overrides

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

Feature.disposed

on

on: FeatureOnSignature<EventsKey>;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Feature.d.ts:107

Inherited from

Feature.on

once

once: FeatureOnSignature<EventsKey>;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Feature.d.ts:111

Inherited from

Feature.once

un

un: FeatureOnSignature<void>;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Feature.d.ts:115

Inherited from

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

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

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

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

Feature.changed

clone()

clone(): Feature<Geometry>;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Feature.d.ts:148

Clone this feature. If the original feature has a geometry it is also cloned. The feature id is not set in the clone.

Returns

Feature<Geometry>

The clone.

Api

Inherited from

Feature.clone

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

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

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

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

Feature.get

getFillColor()

getFillColor(): Color | ColorLike | PatternDescriptor | null;

Defined in: packages/core-ol/src/features/feature.ts:284

Returns

Color | ColorLike | PatternDescriptor | null

getGeometry()

getGeometry(): Geometry | undefined;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Feature.d.ts:157

Get the feature's default geometry. A feature may have any number of named geometries. The "default" geometry (the one that is rendered by default) is set when calling module:ol/Feature~Feature#setGeometry.

Returns

Geometry | undefined

The default geometry for the feature.

Api

Observable

Inherited from

Feature.getGeometry

getGeometryName()

getGeometryName(): string;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Feature.d.ts:173

Get the name of the feature's default geometry. By default, the default geometry is named geometry.

Returns

string

Get the property name associated with the default geometry for this feature.

Api

Inherited from

Feature.getGeometryName

getIcon()

getIcon(): string | undefined;

Defined in: packages/core-ol/src/features/feature.ts:151

获取图标地址

Returns

string | undefined

getId()

getId(): string | number | undefined;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Feature.d.ts:165

Get the feature identifier. This is a stable identifier for the feature and is either set when reading data from a remote source or set explicitly by calling module:ol/Feature~Feature#setId.

Returns

string | number | undefined

Id.

Api

Inherited from

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

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

Feature.getListeners

getPath()

getPath(): CoordinatesLike | null;

Defined in: packages/core-ol/src/features/feature.ts:327

获取路径坐标（线/面类几何）

Returns

CoordinatesLike | null

getPositions()

getPositions(): CoordinatesLike | null;

Defined in: packages/core-ol/src/features/feature.ts:104

获取几何坐标（Circle 为圆心）

Returns

CoordinatesLike | null

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

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

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

Feature.getRevision

getRotateAngle()

getRotateAngle(): string;

Defined in: packages/core-ol/src/features/feature.ts:161

获取旋转角（度，字符串整数，与旧库一致）

Returns

string

getScale()

getScale(): number | Size;

Defined in: packages/core-ol/src/features/feature.ts:237

获取图标缩放

Returns

number | Size

getStrokeColor()

getStrokeColor(): Color | ColorLike | PatternDescriptor | undefined;

Defined in: packages/core-ol/src/features/feature.ts:260

Returns

Color | ColorLike | PatternDescriptor | undefined

getStrokeDashed()

getStrokeDashed(): boolean;

Defined in: packages/core-ol/src/features/feature.ts:295

Returns

boolean

getStrokeWeight()

getStrokeWeight(): number | undefined;

Defined in: packages/core-ol/src/features/feature.ts:273

Returns

number | undefined

getStyle()

getStyle(): StyleLike | undefined;

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

Get the feature's style. Will return what was provided to the module:ol/Feature~Feature#setStyle method.

Returns

StyleLike | undefined

The feature style.

Api

Inherited from

Feature.getStyle

getStyleFunction()

getStyleFunction(): StyleFunction | undefined;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Feature.d.ts:187

Get the feature's style function.

Returns

StyleFunction | undefined

Return a function representing the current style of this feature.

Api

Inherited from

Feature.getStyleFunction

getType()

getType(): string | undefined;

Defined in: packages/core-ol/src/features/feature.ts:256

几何类型

Returns

string | undefined

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

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

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

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

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

Feature.onInternal

onPointer()

onPointer(type, listener): EventsKey;

Defined in: packages/core-ol/src/features/feature.ts:76

订阅地图派发的要素级交互事件（click / mouseover / mouseout）。仅在要素位于 GMap 容器中时触发。

Parameters

type

FeaturePointerEventType

listener

(evt) => void

Returns

EventsKey

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

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

Feature.removeEventListener

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

Feature.set

setFillColor()

setFillColor(color): void;

Defined in: packages/core-ol/src/features/feature.ts:290

Parameters

color

Color | ColorLike | null

Returns

void

setFlatStyle()

setFlatStyle(flatStyle): void;

Defined in: packages/core-ol/src/features/feature.ts:249

以声明式 FlatStyle（ol/style/flat 的纯数据 JSON）设置样式。

FlatStyle 可序列化、便于作为 React/Vue 组件 prop 传入；内部用 ol 的 flatStylesToStyleFunction 转为 StyleFunction 应用到要素。

Parameters

flatStyle

FlatStyle | FlatStyle[]

Returns

void

setGeometry()

setGeometry(geometry): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Feature.d.ts:203

Set the default geometry for the feature. This will update the property with the name returned by module:ol/Feature~Feature#getGeometryName.

Parameters

geometry

Geometry | undefined

The new geometry.

Returns

void

Api

Observable

Inherited from

Feature.setGeometry

setGeometryName()

setGeometryName(name): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Feature.d.ts:231

Set the property name to be used when getting the feature's default geometry. When calling module:ol/Feature~Feature#getGeometry, the value of the property with this name will be returned.

Parameters

name

string

The property name of the default geometry.

Returns

void

Api

Inherited from

Feature.setGeometryName

setIcon()

setIcon(opts?): void;

Defined in: packages/core-ol/src/features/feature.ts:122

替换图标（保留原 Icon 的其余样式参数）

Parameters

opts?

SetIconOptions = {}

Returns

void

setId()

setId(id): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Feature.d.ts:223

Set the feature id. The feature id is considered stable and may be used when requesting features or comparing identifiers returned from a remote source. The feature id can be used with the module:ol/source/Vector~VectorSource#getFeatureById method.

Parameters

id

string | number | undefined

The feature id.

Returns

void

Api

Fires

module:ol/events/Event~BaseEvent#event:change

Inherited from

Feature.setId

setPath()

setPath(path): void;

Defined in: packages/core-ol/src/features/feature.ts:348

设置路径坐标（线/面类几何）。

Polygon 的坐标是「环数组」(number[][][])，而 path 沿用构造选项的单环约定 (number[][])，故此处对 Polygon 包一层环，避免把单环误当作环数组传入 setCoordinates 而把几何破坏成多个空环。

Parameters

path

CoordinatesLike

Returns

void

setPositions()

setPositions(position): void;

Defined in: packages/core-ol/src/features/feature.ts:86

设置几何坐标（Circle 为圆心）

Parameters

position

CoordinatesLike

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

Feature.setProperties

setRotateAngle()

setRotateAngle(angle): void;

Defined in: packages/core-ol/src/features/feature.ts:169

设置旋转角（度）

Parameters

angle

number

Returns

void

setScale()

setScale(scale): void;

Defined in: packages/core-ol/src/features/feature.ts:231

设置图标缩放

Parameters

scale

number | Size

Returns

void

setStrokeColor()

setStrokeColor(color): void;

Defined in: packages/core-ol/src/features/feature.ts:268

Parameters

color

Color | ColorLike

Returns

void

setStrokeDashed()

setStrokeDashed(dashed): void;

Defined in: packages/core-ol/src/features/feature.ts:303

Parameters

dashed

boolean

Returns

void

setStrokeWeight()

setStrokeWeight(width): void;

Defined in: packages/core-ol/src/features/feature.ts:279

Parameters

width

number | undefined

Returns

void

setStyle()

setStyle(style?): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Feature.d.ts:213

Set the style for the feature to override the layer style. This can be a single style object, an array of styles, or a function that takes a resolution and returns an array of styles. To unset the feature style, call setStyle() without arguments or a falsey value.

Parameters

style?

StyleLike

Style for this feature.

Returns

void

Api

Fires

module:ol/events/Event~BaseEvent#event:change

Inherited from

Feature.setStyle

setText()

setText(options?): void;

Defined in: packages/core-ol/src/features/feature.ts:177

设置文字标注

Parameters

options?

SetTextOptions = {}

Returns

void

setTitle()

setTitle(title): void;

Defined in: packages/core-ol/src/features/feature.ts:226

设置标题属性

Parameters

title

unknown

Returns

void

setVisible()

setVisible(visible): void;

Defined in: packages/core-ol/src/features/feature.ts:313

设置可见性：隐藏时暂存样式，显示时恢复。

Parameters

visible

boolean

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

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

Feature.unset

Class: GFeature ​

Extends ​

Extended by ​

Constructors ​

Constructor ​

Parameters ​

geometryOrProperties? ​

Returns ​

Overrides ​

Properties ​

disposed ​

Inherited from ​

on ​

Inherited from ​

once ​

Inherited from ​

un ​

Inherited from ​

Methods ​

addChangeListener() ​

Parameters ​

key ​

listener ​

Returns ​

Inherited from ​

addEventListener() ​

Parameters ​

type ​

listener ​

Returns ​

Inherited from ​

applyProperties() ​

Parameters ​

source ​

Returns ​

Inherited from ​

changed() ​

Returns ​

Api ​

Inherited from ​

clone() ​

Returns ​

Api ​

Inherited from ​

dispatchEvent() ​

Parameters ​

event ​

Returns ​

Api ​

Inherited from ​

dispose() ​

Returns ​

Inherited from ​

disposeInternal() ​

Returns ​

Inherited from ​

get() ​

Parameters ​

key ​

Returns ​

Api ​

Inherited from ​

getFillColor() ​

Returns ​

getGeometry() ​

Returns ​

Api ​

Observable ​

Inherited from ​

getGeometryName() ​

Returns ​

Api ​

Inherited from ​

getIcon() ​

Returns ​

getId() ​

Returns ​

Api ​

Inherited from ​

getKeys() ​

Class: GFeature

Extends

Extended by

Constructors

Constructor

Parameters

geometryOrProperties?

Returns

Overrides

Properties

disposed

Inherited from

on

Inherited from

once

Inherited from

un

Inherited from

Methods

addChangeListener()

Parameters

key

listener

Returns

Inherited from

addEventListener()

Parameters

type

listener

Returns

Inherited from

applyProperties()

Parameters

source

Returns

Inherited from

changed()

Returns

Api

Inherited from

clone()

Returns

Api

Inherited from

dispatchEvent()

Parameters

event

Returns

Api

Inherited from

dispose()

Returns

Inherited from

disposeInternal()

Returns

Inherited from

get()

Parameters

key

Returns

Api

Inherited from

getFillColor()

Returns

getGeometry()

Returns

Api

Observable

Inherited from

getGeometryName()

Returns

Api

Inherited from

getIcon()

Returns

getId()

Returns

Api

Inherited from

getKeys()