Documentation / @geoverse/core-ol / Circle

Class: Circle

Defined in: packages/core-ol/src/features/circle.ts:25

圆形要素（自带样式）。

Extends

• GFeature

Constructors

Constructor

new Circle(opts?): Circle;

Defined in: packages/core-ol/src/features/circle.ts:26

Parameters

opts?

CircleOptions = {}

Returns

Circle

Overrides

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

GFeature.disposed

---

on

on: FeatureOnSignature<EventsKey>;

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

Inherited from

GFeature.on

---

once

once: FeatureOnSignature<EventsKey>;

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

Inherited from

GFeature.once

---

un

un: FeatureOnSignature<void>;

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

Inherited from

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

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

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

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

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

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

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

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

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

GFeature.get

---

getFillColor()

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

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

Returns

Color | ColorLike | PatternDescriptor | null

Inherited from

GFeature.getFillColor

---

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

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

GFeature.getGeometryName

---

getIcon()

getIcon(): string | undefined;

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

获取图标地址

Returns

string | undefined

Inherited from

GFeature.getIcon

---

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

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

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

GFeature.getListeners

---

getPath()

getPath(): CoordinatesLike | null;

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

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

Returns

CoordinatesLike | null

Inherited from

GFeature.getPath

---

getPositions()

getPositions(): CoordinatesLike | null;

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

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

Returns

CoordinatesLike | null

Inherited from

GFeature.getPositions

---

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

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

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

GFeature.getRevision

---

getRotateAngle()

getRotateAngle(): string;

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

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

Returns

string

Inherited from

GFeature.getRotateAngle

---

getScale()

getScale(): number | Size;

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

获取图标缩放

Returns

number | Size

Inherited from

GFeature.getScale

---

getStrokeColor()

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

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

Returns

Color | ColorLike | PatternDescriptor | undefined

Inherited from

GFeature.getStrokeColor

---

getStrokeDashed()

getStrokeDashed(): boolean;

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

Returns

boolean

Inherited from

GFeature.getStrokeDashed

---

getStrokeWeight()

getStrokeWeight(): number | undefined;

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

Returns

number | undefined

Inherited from

GFeature.getStrokeWeight

---

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

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

GFeature.getStyleFunction

---

getType()

getType(): string | undefined;

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

几何类型

Returns

string | undefined

Inherited from

GFeature.getType

---

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

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

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

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

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

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

Inherited from

GFeature.onPointer

---

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

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

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

GFeature.set

---

setFillColor()

setFillColor(color): void;

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

Parameters

color

Color | ColorLike | null

Returns

void

Inherited from

GFeature.setFillColor

---

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

Inherited from

GFeature.setFlatStyle

---

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

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

GFeature.setGeometryName

---

setIcon()

setIcon(opts?): void;

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

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

Parameters

opts?

SetIconOptions = {}

Returns

void

Inherited from

GFeature.setIcon

---

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

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

Inherited from

GFeature.setPath

---

setPositions()

setPositions(position): void;

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

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

Parameters

position

CoordinatesLike

Returns

void

Inherited from

GFeature.setPositions

---

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

GFeature.setProperties

---

setRotateAngle()

setRotateAngle(angle): void;

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

设置旋转角（度）

Parameters

angle

number

Returns

void

Inherited from

GFeature.setRotateAngle

---

setScale()

setScale(scale): void;

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

设置图标缩放

Parameters

scale

number | Size

Returns

void

Inherited from

GFeature.setScale

---

setStrokeColor()

setStrokeColor(color): void;

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

Parameters

color

Color | ColorLike

Returns

void

Inherited from

GFeature.setStrokeColor

---

setStrokeDashed()

setStrokeDashed(dashed): void;

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

Parameters

dashed

boolean

Returns

void

Inherited from

GFeature.setStrokeDashed

---

setStrokeWeight()

setStrokeWeight(width): void;

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

Parameters

width

number | undefined

Returns

void

Inherited from

GFeature.setStrokeWeight

---

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

GFeature.setStyle

---

setText()

setText(options?): void;

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

设置文字标注

Parameters

options?

SetTextOptions = {}

Returns

void

Inherited from

GFeature.setText

---

setTitle()

setTitle(title): void;

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

设置标题属性

Parameters

title

unknown

Returns

void

Inherited from

GFeature.setTitle

---

setVisible()

setVisible(visible): void;

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

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

Parameters

visible

boolean

Returns

void

Inherited from

GFeature.setVisible

---

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

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

GFeature.unset