Documentation / @geoverse/core-ol / TrafficLayer

Class: TrafficLayer

Defined in: packages/core-ol/src/layers/trafficLayer.ts:49

实时路况图层（高德/百度路况瓦片）。

• isDynamic: true 时按 rate 间隔刷新瓦片时间戳
• 图层销毁（dispose）时定时器一定被清理（旧库的定时器泄漏已修复）

Extends

• TileLayer<TileSource>

Constructors

Constructor

new TrafficLayer(opts?): TrafficLayer;

Defined in: packages/core-ol/src/layers/trafficLayer.ts:56

Parameters

opts?

TrafficLayerOptions = {}

Returns

TrafficLayer

Overrides

TileLayer<TileSource>.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

TileLayer.disposed

---

on

on: BaseTileLayerOnSignature<EventsKey>;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseTile.d.ts:154

Inherited from

TileLayer.on

---

once

once: BaseTileLayerOnSignature<EventsKey>;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseTile.d.ts:158

Inherited from

TileLayer.once

---

rendered

protected rendered: boolean;

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

Inherited from

TileLayer.rendered

---

un

un: BaseTileLayerOnSignature<void>;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseTile.d.ts:162

Inherited from

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

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

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

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

TileLayer.changed

---

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

TileLayer.clearRenderer

---

createRenderer()

createRenderer(): CanvasTileLayerRenderer<TrafficLayer>;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/Tile.d.ts:22

Returns

CanvasTileLayerRenderer<TrafficLayer>

Inherited from

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

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

TileLayer.dispose

---

disposeInternal()

protected disposeInternal(): void;

Defined in: packages/core-ol/src/layers/trafficLayer.ts:114

销毁时清理定时器

Returns

void

Overrides

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

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

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

TileLayer.getBackground

---

getCacheSize()

protected getCacheSize(): number | undefined;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseTile.d.ts:172

Returns

number | undefined

The suggested cache size

Inherited from

TileLayer.getCacheSize

---

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

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

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

TileLayer.getDeclutter

---

getDynamic()

getDynamic(): boolean;

Defined in: packages/core-ol/src/layers/trafficLayer.ts:99

当前是否处于定时刷新状态

Returns

boolean

---

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

TileLayer.getExtent

---

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

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

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

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

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

TileLayer.getLayerStatesArray

---

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

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

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

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

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

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

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

TileLayer.getOpacity

---

getPreload()

getPreload(): number;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseTile.d.ts:179

Return the level as number to which we will preload tiles up to.

Returns

number

The level to preload tiles up to.

Observable

Api

Inherited from

TileLayer.getPreload

---

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

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

TileLayer.getPropertiesInternal

---

getRenderer()

getRenderer(): 
  | CanvasTileLayerRenderer<
  | TileLayer<TileSource<Tile>>
  | VectorTileLayer<VectorTile<any>, any>>
  | 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

| CanvasTileLayerRenderer< | TileLayer<TileSource<Tile>> | VectorTileLayer<VectorTile<any>, any>> | null

The layer renderer.

Inherited from

TileLayer.getRenderer

---

getRenderSource()

getRenderSource(): TileSource<Tile> | null;

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

Returns

TileSource<Tile> | null

The source being rendered.

Inherited from

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

TileLayer.getRevision

---

getSource()

getSource(): TileSource<Tile> | null;

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

Get the layer source.

Returns

TileSource<Tile> | null

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

Observable

Api

Inherited from

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

TileLayer.getSourceState

---

getUseInterimTilesOnError()

getUseInterimTilesOnError(): boolean;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseTile.d.ts:193

Deprecated. Whether we use interim tiles on error.

Returns

boolean

Use interim tiles on error.

Observable

Api

Inherited from

TileLayer.getUseInterimTilesOnError

---

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

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

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

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

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

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

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

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

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

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

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

TileLayer.removeEventListener

---

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

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

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

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

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

TileLayer.setBackground

---

setDynamic()

setDynamic(flag): void;

Defined in: packages/core-ol/src/layers/trafficLayer.ts:104

启停定时刷新

Parameters

flag

boolean

Returns

void

---

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

TileLayer.setExtent

---

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

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

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

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

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

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

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

TileLayer.setOpacity

---

setPreload()

setPreload(preload): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseTile.d.ts:186

Set the level as number to which we will preload tiles up to.

Parameters

preload

number

The level to preload tiles up to.

Returns

void

Observable

Api

Inherited from

TileLayer.setPreload

---

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

TileLayer.setProperties

---

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

TileSource<Tile> | null

The layer source.

Returns

void

Observable

Api

Inherited from

TileLayer.setSource

---

setUseInterimTilesOnError()

setUseInterimTilesOnError(useInterimTilesOnError): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseTile.d.ts:200

Deprecated. Set whether we use interim tiles on error.

Parameters

useInterimTilesOnError

boolean

Use interim tiles on error.

Returns

void

Observable

Api

Inherited from

TileLayer.setUseInterimTilesOnError

---

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

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

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

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

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

TileLayer.unset