Documentation / @geoverse/core-ol / GVectorLayer

Class: GVectorLayer

Defined in: packages/core-ol/src/layers/vectorLayer.ts:22

通用矢量要素图层，继承 ol/layer/Vector。

• 默认自带空 VectorSource，可直接 addFeature
• 维护 projection 属性：要素以 EPSG:3857 创建，加入图层时 自动转换到图层当前投影（GMap 底图切换时也会同步该属性并重投影）

Extends

• VectorLayer<VectorSource>

Extended by

• ClusterLayer
• SuperClusterLayer
• NameLayer

Constructors

Constructor

new GVectorLayer(options?): GVectorLayer;

Defined in: packages/core-ol/src/layers/vectorLayer.ts:23

Parameters

options?

GVectorLayerOptions = {}

Returns

GVectorLayer

Overrides

VectorLayer<VectorSource>.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

VectorLayer.disposed

---

on

on: LayerOnSignature<EventsKey>;

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

Inherited from

VectorLayer.on

---

once

once: LayerOnSignature<EventsKey>;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Layer.d.ts:228

Inherited from

VectorLayer.once

---

rendered

protected rendered: boolean;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Layer.d.ts:262

Inherited from

VectorLayer.rendered

---

un

un: LayerOnSignature<void>;

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

Inherited from

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

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

VectorLayer.addEventListener

---

addFeature()

addFeature(feature): void;

Defined in: packages/core-ol/src/layers/vectorLayer.ts:63

添加要素

Parameters

feature

Feature

Returns

void

---

addFeatures()

addFeatures(features): void;

Defined in: packages/core-ol/src/layers/vectorLayer.ts:68

批量添加要素

Parameters

features

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

Returns

void

---

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

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

VectorLayer.changed

---

clear()

clear(): void;

Defined in: packages/core-ol/src/layers/vectorLayer.ts:89

清空图层要素

Returns

void

---

clearRenderer()

clearRenderer(): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Layer.d.ts:388

This will clear the renderer so that a new one can be created next time it is needed

Returns

void

Inherited from

VectorLayer.clearRenderer

---

createRenderer()

protected createRenderer(): CanvasVectorLayerRenderer;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Layer.d.ts:384

Create a renderer for this layer.

Returns

CanvasVectorLayerRenderer

A layer renderer.

Inherited from

VectorLayer.createRenderer

---

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

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

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

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

VectorLayer.get

---

getAttributions()

getAttributions(view?): string[];

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Layer.d.ts:319

Get the attributions of the source of this layer for the given view.

Parameters

view?

View | ViewStateLayerStateExtent

View or import("../Map.js").FrameState. Only required when the layer is not added to a map.

Returns

string[]

Attributions for this layer at the given view.

Api

Inherited from

VectorLayer.getAttributions

---

getBackground()

getBackground(): false | BackgroundColor;

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

Get the background for this layer.

Returns

false | BackgroundColor

Layer background.

Inherited from

VectorLayer.getBackground

---

getClassName()

getClassName(): string;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Base.d.ts:168

Returns

string

CSS class name.

Inherited from

VectorLayer.getClassName

---

getData()

getData(pixel): 
  | Uint8ClampedArray<ArrayBufferLike>
  | Uint8Array<ArrayBufferLike>
  | Float32Array<ArrayBufferLike>
  | DataView<ArrayBufferLike>
  | null;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Layer.d.ts:301

Parameters

pixel

Pixel

Pixel.

Returns

| Uint8ClampedArray<ArrayBufferLike> | Uint8Array<ArrayBufferLike> | Float32Array<ArrayBufferLike> | DataView<ArrayBufferLike> | null

Pixel data.

Inherited from

VectorLayer.getData

---

getDeclutter()

getDeclutter(): string;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Layer.d.ts:325

Returns

string

Declutter

Inherited from

VectorLayer.getDeclutter

---

getExtent()

getExtent(): Extent | undefined;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Base.d.ts:198

Return the module:ol/extent~Extent extent of the layer or undefined if it will be visible regardless of extent.

Returns

Extent | undefined

The layer extent.

Observable

Api

Inherited from

VectorLayer.getExtent

---

getFeatureById()

getFeatureById(id): 
  | Feature<Geometry, {
[x: string]: any;
}>
  | null;

Defined in: packages/core-ol/src/layers/vectorLayer.ts:58

按 featureId 获取要素

Parameters

id

string | number

Returns

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

---

getFeatures()

getFeatures(pixel): Promise<FeatureLike[]>;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Layer.d.ts:296

Parameters

pixel

Pixel

Pixel.

Returns

Promise<FeatureLike[]>

Promise that resolves with an array of features.

Inherited from

VectorLayer.getFeatures

---

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

VectorLayer.getKeys

---

getLayersArray()

abstract getLayersArray(array?): Layer<Source, LayerRenderer<any>, {
[x: string]: any;
}>[];

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Base.d.ts:183

Parameters

array?

Layer<Source, LayerRenderer<any>, { [x: string]: any; }>[]

Array of layers (to be modified in place).

Returns

Layer<Source, LayerRenderer<any>, { [x: string]: any; }>[]

Array of layers.

Inherited from

VectorLayer.getLayersArray

---

getLayerState()

getLayerState(managed?): State;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Base.d.ts:176

This method is not meant to be called by layers or layer renderers because the state is incorrect if the layer is included in a layer group.

Parameters

managed?

boolean

Layer is managed.

Returns

State

Layer state.

Inherited from

VectorLayer.getLayerState

---

getLayerStatesArray()

abstract getLayerStatesArray(states?): State[];

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Base.d.ts:190

Parameters

states?

State[]

Optional list of layer states (to be modified in place).

Returns

State[]

List of layer states.

Inherited from

VectorLayer.getLayerStatesArray

---

getLinkFeatures()

getLinkFeatures(): Feature<Geometry, {
[x: string]: any;
}>[];

Defined in: packages/core-ol/src/layers/vectorLayer.ts:53

获取图层内全部要素

Returns

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

---

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

VectorLayer.getListeners

---

getMapInternal()

getMapInternal(): Map | null;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Layer.d.ts:345

For use inside the library only.

Returns

Map | null

Map.

Inherited from

VectorLayer.getMapInternal

---

getMaxResolution()

getMaxResolution(): number;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Base.d.ts:206

Return the maximum resolution of the layer. Returns Infinity if the layer has no maximum resolution set.

Returns

number

The maximum resolution of the layer.

Observable

Api

Inherited from

VectorLayer.getMaxResolution

---

getMaxZoom()

getMaxZoom(): number;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Base.d.ts:230

Return the maximum zoom level of the layer. Returns Infinity if the layer has no maximum zoom set.

Returns

number

The maximum zoom level of the layer.

Observable

Api

Inherited from

VectorLayer.getMaxZoom

---

getMinResolution()

getMinResolution(): number;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Base.d.ts:214

Return the minimum resolution of the layer. Returns 0 if the layer has no minimum resolution set.

Returns

number

The minimum resolution of the layer.

Observable

Api

Inherited from

VectorLayer.getMinResolution

---

getMinZoom()

getMinZoom(): number;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Base.d.ts:222

Return the minimum zoom level of the layer. Returns -Infinity if the layer has no minimum zoom set.

Returns

number

The minimum zoom level of the layer.

Observable

Api

Inherited from

VectorLayer.getMinZoom

---

getOpacity()

getOpacity(): number;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Base.d.ts:237

Return the opacity of the layer (between 0 and 1).

Returns

number

The opacity of the layer.

Observable

Api

Inherited from

VectorLayer.getOpacity

---

getProperties()

getProperties(): NoInfer<NoInfer<{
[x: string]: any;
}> & {
[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<NoInfer<{ [x: string]: any; }> & { [x: string]: any; }>

Object.

Api

Inherited from

VectorLayer.getProperties

---

getPropertiesInternal()

getPropertiesInternal(): 
  | Partial<NoInfer<NoInfer<{
[x: string]: any;
}> & {
[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<NoInfer<{ [x: string]: any; }> & { [x: string]: any; }>> | null

Object.

Inherited from

VectorLayer.getPropertiesInternal

---

getRenderBuffer()

getRenderBuffer(): number | undefined;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseVector.d.ts:167

Returns

number | undefined

Render buffer.

Inherited from

VectorLayer.getRenderBuffer

---

getRenderer()

getRenderer(): CanvasVectorLayerRenderer | null;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Layer.d.ts:374

Get the renderer for this layer.

Returns

CanvasVectorLayerRenderer | null

The layer renderer.

Inherited from

VectorLayer.getRenderer

---

getRenderOrder()

getRenderOrder(): OrderFunction | null | undefined;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseVector.d.ts:171

Returns

OrderFunction | null | undefined

Render order.

Inherited from

VectorLayer.getRenderOrder

---

getRenderSource()

getRenderSource(): 
  | VectorSource<Feature<Geometry, {
[x: string]: any;
}>>
  | null;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Layer.d.ts:282

Returns

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

The source being rendered.

Inherited from

VectorLayer.getRenderSource

---

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

VectorLayer.getRevision

---

getSource()

getSource(): 
  | VectorSource<Feature<Geometry, {
[x: string]: any;
}>>
  | null;

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

Get the layer source.

Returns

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

The layer source (or null if not yet set).

Observable

Api

Inherited from

VectorLayer.getSource

---

getSourceState()

abstract getSourceState(): State;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Base.d.ts:242

Returns

State

Source state.

Inherited from

VectorLayer.getSourceState

---

getStyle()

getStyle(): StyleLike | FlatStyleLike | null | undefined;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseVector.d.ts:178

Get the style for features. This returns whatever was passed to the style option at construction or to the setStyle method.

Returns

StyleLike | FlatStyleLike | null | undefined

Layer style.

Api

Inherited from

VectorLayer.getStyle

---

getStyleFunction()

getStyleFunction(): StyleFunction | undefined;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseVector.d.ts:184

Get the style function.

Returns

StyleFunction | undefined

Layer style function.

Api

Inherited from

VectorLayer.getStyleFunction

---

getUpdateWhileAnimating()

getUpdateWhileAnimating(): boolean;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseVector.d.ts:189

Returns

boolean

Whether the rendered layer should be updated while animating.

Inherited from

VectorLayer.getUpdateWhileAnimating

---

getUpdateWhileInteracting()

getUpdateWhileInteracting(): boolean;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseVector.d.ts:194

Returns

boolean

Whether the rendered layer should be updated while interacting.

Inherited from

VectorLayer.getUpdateWhileInteracting

---

getVisible()

getVisible(): boolean;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Base.d.ts:250

Return the value of this layer's visible property. To find out whether the layer is visible on a map, use isVisible() instead.

Returns

boolean

The value of the visible property of the layer.

Observable

Api

Inherited from

VectorLayer.getVisible

---

getZIndex()

getZIndex(): number | undefined;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Base.d.ts:258

Return the Z-index of the layer, which is used to order layers before rendering. Returns undefined if the layer is unmanaged.

Returns

number | undefined

The Z-index of the layer.

Observable

Api

Inherited from

VectorLayer.getZIndex

---

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

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

VectorLayer.hasProperties

---

hasRenderer()

hasRenderer(): boolean;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Layer.d.ts:378

Returns

boolean

The layer has a renderer.

Inherited from

VectorLayer.hasRenderer

---

isVisible()

isVisible(view?): boolean;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Layer.d.ts:311

The layer is visible on the map view, i.e. within its min/max resolution or zoom and extent, not set to visible: false, and not inside a layer group that is set to visible: false.

Parameters

view?

View | ViewStateLayerStateExtent

View or import("../Map.js").FrameState. Only required when the layer is not added to a map.

Returns

boolean

The layer is visible in the map view.

Api

Inherited from

VectorLayer.isVisible

---

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

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

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

VectorLayer.onInternal

---

refresh()

refresh(): void;

Defined in: packages/core-ol/src/layers/vectorLayer.ts:84

刷新图层数据

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

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

VectorLayer.removeEventListener

---

removeFeature()

removeFeature(feature): void;

Defined in: packages/core-ol/src/layers/vectorLayer.ts:73

移除要素

Parameters

feature

Feature

Returns

void

---

removeFeatureById()

removeFeatureById(id): void;

Defined in: packages/core-ol/src/layers/vectorLayer.ts:78

按 featureId 移除要素

Parameters

id

string | number

Returns

void

---

render()

render(frameState, target): HTMLElement | null;

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

In charge to manage the rendering of the layer. One layer type is bounded with one layer renderer.

Parameters

frameState

FrameState | null

Frame state.

target

HTMLElement

Target which the renderer may (but need not) use for rendering its content.

Returns

HTMLElement | null

The rendered element.

Inherited from

VectorLayer.render

---

renderDeclutter()

renderDeclutter(frameState, layerState): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Layer.d.ts:330

Parameters

frameState

FrameState

Frame state.

layerState

State

Layer state.

Returns

void

Inherited from

VectorLayer.renderDeclutter

---

renderDeferred()

renderDeferred(frameState): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Layer.d.ts:335

When the renderer follows a layout -> render approach, do the final rendering here.

Parameters

frameState

FrameState

Frame state

Returns

void

Inherited from

VectorLayer.renderDeferred

---

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

VectorLayer.set

---

setBackground()

setBackground(background?): void;

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

Sets the background color.

Parameters

background?

BackgroundColor

Background color.

Returns

void

Inherited from

VectorLayer.setBackground

---

setDeclutter()

setDeclutter(declutter): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseVector.d.ts:226

Parameters

declutter

string | number | boolean

Declutter images and text.

Returns

void

Api

Inherited from

VectorLayer.setDeclutter

---

setExtent()

setExtent(extent): void;

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

Set the extent at which the layer is visible. If undefined, the layer will be visible at all extents.

Parameters

extent

Extent | undefined

The extent of the layer.

Returns

void

Observable

Api

Inherited from

VectorLayer.setExtent

---

setFlatStyle()

setFlatStyle(flatStyle): void;

Defined in: packages/core-ol/src/layers/vectorLayer.ts:97

以声明式 FlatStyle 设置图层样式（ol 原生支持，内部转换为样式函数）。 适合序列化存储与作为响应式框架的 prop 传入。

Parameters

flatStyle

FlatStyleLike

Returns

void

---

setMap()

setMap(map): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Layer.d.ts:357

Sets the layer to be rendered on top of other layers on a map. The map will not manage this layer in its layers collection. This is useful for temporary layers. To remove an unmanaged layer from the map, use #setMap(null).

To add the layer to a map and have it managed by the map, use module:ol/Map~Map#addLayer instead.

Parameters

map

Map | null

Map.

Returns

void

Api

Inherited from

VectorLayer.setMap

---

setMapInternal()

setMapInternal(map): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Layer.d.ts:340

For use inside the library only.

Parameters

map

Map | null

Map.

Returns

void

Inherited from

VectorLayer.setMapInternal

---

setMaxResolution()

setMaxResolution(maxResolution): void;

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

Set the maximum resolution at which the layer is visible.

Parameters

maxResolution

number

The maximum resolution of the layer.

Returns

void

Observable

Api

Inherited from

VectorLayer.setMaxResolution

---

setMaxZoom()

setMaxZoom(maxZoom): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Base.d.ts:294

Set the maximum zoom (exclusive) at which the layer is visible. Note that the zoom levels for layer visibility are based on the view zoom level, which may be different from a tile source zoom level.

Parameters

maxZoom

number

The maximum zoom of the layer.

Returns

void

Observable

Api

Inherited from

VectorLayer.setMaxZoom

---

setMinResolution()

setMinResolution(minResolution): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Base.d.ts:285

Set the minimum resolution at which the layer is visible.

Parameters

minResolution

number

The minimum resolution of the layer.

Returns

void

Observable

Api

Inherited from

VectorLayer.setMinResolution

---

setMinZoom()

setMinZoom(minZoom): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Base.d.ts:303

Set the minimum zoom (inclusive) at which the layer is visible. Note that the zoom levels for layer visibility are based on the view zoom level, which may be different from a tile source zoom level.

Parameters

minZoom

number

The minimum zoom of the layer.

Returns

void

Observable

Api

Inherited from

VectorLayer.setMinZoom

---

setOpacity()

setOpacity(opacity): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Base.d.ts:310

Set the opacity of the layer, allowed values range from 0 to 1.

Parameters

opacity

number

The opacity of the layer.

Returns

void

Observable

Api

Inherited from

VectorLayer.setOpacity

---

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

VectorLayer.setProperties

---

setRenderOrder()

setRenderOrder(renderOrder): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseVector.d.ts:199

Parameters

renderOrder

OrderFunction | null | undefined

Render order.

Returns

void

Inherited from

VectorLayer.setRenderOrder

---

setSource()

setSource(source): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Layer.d.ts:369

Set the layer source.

Parameters

source

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

The layer source.

Returns

void

Observable

Api

Inherited from

VectorLayer.setSource

---

setStyle()

setStyle(style?): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseVector.d.ts:221

Set the style for features. This can be a single style object, an array of styles, or a function that takes a feature and resolution and returns an array of styles. If set to null, the layer has no style (a null style), so only features that have their own styles will be rendered in the layer. Call setStyle() without arguments to reset to the default style. See [the ol/style/Style module]module:ol/style/Style~Style for information on the default style.

If your layer has a static style, you can use [flat style]module:ol/style/flat~FlatStyle object literals instead of using the Style and symbolizer constructors (Fill, Stroke, etc.):

vectorLayer.setStyle({
  "fill-color": "yellow",
  "stroke-color": "black",
  "stroke-width": 4
})

Parameters

style?

StyleLike | FlatStyleLike | null

Layer style.

Returns

void

Api

Inherited from

VectorLayer.setStyle

---

setVisible()

setVisible(visible): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Base.d.ts:317

Set the visibility of the layer (true or false).

Parameters

visible

boolean

The visibility of the layer.

Returns

void

Observable

Api

Inherited from

VectorLayer.setVisible

---

setZIndex()

setZIndex(zindex): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Base.d.ts:325

Set Z-index of the layer, which is used to order layers before rendering. The default Z-index is 0.

Parameters

zindex

number

The z-index of the layer.

Returns

void

Observable

Api

Inherited from

VectorLayer.setZIndex

---

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

VectorLayer.unInternal

---

unrender()

unrender(): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Layer.d.ts:323

Called when a layer is not visible during a map render.

Returns

void

Inherited from

VectorLayer.unrender

---

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

VectorLayer.unset