Class Tile

Classdesc

Abstract base class; normally only used for creating subclasses and not instantiated in apps. Base class for sources providing images divided into a tile grid.

Abstract

Api

Hierarchy (view full)

external.olsource.Source
- Tile

Index

Constructors

constructor

Properties

disposed loading on once projection tileCache tileGrid tileOptions tmpSize un viewRejector viewResolver zDirection

Constructors

constructor

new Tile(options): external.olsource.Tile
Parameters
- options: Options
  SourceTile source options.
Returns external.olsource.Tile
Overrides Source.constructor
- Defined in ../node_modules/ol/source/Tile.d.ts:117

Properties

`Protected` disposed

disposed: boolean

The object has already been disposed.

loading

loading: boolean

This source is currently loading data. Sources that defer loading to the map's tile queue never set this to true.

on

on: TileSourceOnSignature<EventsKey>

once

once: TileSourceOnSignature<EventsKey>

`Protected` projection

projection: null | Projection

`Protected` tileCache

tileCache: TileCache

tileGrid

tileGrid: null | TileGrid

`Protected` tileOptions

tileOptions: Options

`Protected` tmpSize

tmpSize: Size

un

un: TileSourceOnSignature<void>

`Protected` viewRejector

viewRejector: ((arg0) => void)

Type declaration

- (arg0): void
- Parameters
  - arg0: Error
  Returns void

`Protected` viewResolver

viewResolver: ((arg0) => void)

Type declaration

- (arg0): void
- Parameters
  - arg0: ViewOptions
  Returns void

zDirection

zDirection: number | NearestDirectionFunction

zDirection hint, read by the renderer. Indicates which resolution should be used by a renderer if the views resolution does not match any resolution of the tile source. If 0, the nearest resolution will be used. If 1, the nearest lower resolution will be used. If -1, the nearest higher resolution will be used.

Methods

addChangeListener

addChangeListener(key, listener): void
Parameters
- key: string
  Key name.
- listener: Listener
  Listener.
Returns void
Inherited from Source.addChangeListener
- Defined in ../node_modules/ol/Object.d.ts:146

addEventListener

addEventListener(type, listener): void
Parameters
- type: string
  Type.
- listener: Listener
  Listener.
Returns void
Inherited from Source.addEventListener
- Defined in ../node_modules/ol/events/Target.d.ts:50

`Protected` applyProperties

applyProperties(source): void
Protected
Apply any properties from another object without triggering events.
Parameters
- source: Object
  The source object.
Returns void
Inherited from Source.applyProperties
- Defined in ../node_modules/ol/Object.d.ts:175

canExpireCache

canExpireCache(): boolean
Returns boolean
Can expire cache.
- Defined in ../node_modules/ol/source/Tile.d.ts:175

changed

changed(): void
Increases the revision counter and dispatches a 'change' event.

Returns void
Api
Inherited from Source.changed
- Defined in ../node_modules/ol/Observable.d.ts:65

clear

clear(): void
Remove all cached tiles from the source. The next render cycle will fetch new tiles.

Returns void
Api
- Defined in ../node_modules/ol/source/Tile.d.ts:270

dispatchEvent

dispatchEvent(event): undefined | boolean
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 undefined | boolean
false if anyone called preventDefault on the event object or if any of the listeners returned false.

Api
Inherited from Source.dispatchEvent
- Defined in ../node_modules/ol/events/Target.d.ts:61

dispose

dispose(): void
Clean up.

Returns void
Inherited from Source.dispose
- Defined in ../node_modules/ol/Disposable.d.ts:19

`Protected` disposeInternal

disposeInternal(): void
Protected
Extension point for disposable objects.

Returns void
Inherited from Source.disposeInternal
- Defined in ../node_modules/ol/Disposable.d.ts:24

expireCache

expireCache(projection, usedTiles): void
Parameters
- projection: Projection
  Projection.
- usedTiles: {
  [x: string]: boolean;
  }
  Used tiles.
  - [x: string]: boolean
Returns void
- Defined in ../node_modules/ol/source/Tile.d.ts:180

forEachLoadedTile

forEachLoadedTile(projection, z, tileRange, callback): boolean
Parameters
- projection: Projection
  Projection.
- z: number
  Zoom level.
- tileRange: TileRange
  Tile range.
- callback: ((arg0) => boolean | void)
  Called with each loaded tile. If the callback returns false, the tile will not be considered loaded.
  - - (arg0): boolean | void
    - Parameters
      arg0: external.ol.Tile
      Returns boolean | void
Returns boolean
The tile range is fully covered with loaded tiles.
- Defined in ../node_modules/ol/source/Tile.d.ts:192

get

get(key): any
Gets a value.
Parameters
- key: string
  Key name.
Returns any
Value.

Api
Inherited from Source.get
- Defined in ../node_modules/ol/Object.d.ts:111

getAttributions

getAttributions(): null | Attribution
Get the attribution function for the source.

Returns null | Attribution
Attribution function.

Api
Inherited from Source.getAttributions
- Defined in ../node_modules/ol/source/Source.d.ts:148

getAttributionsCollapsible

getAttributionsCollapsible(): boolean
Returns boolean
Attributions are collapsible.

Api
Inherited from Source.getAttributionsCollapsible
- Defined in ../node_modules/ol/source/Source.d.ts:153

getGutterForProjection

getGutterForProjection(projection): number
Parameters
- projection: Projection
  Projection.
Returns number
Gutter.
- Defined in ../node_modules/ol/source/Tile.d.ts:197

getInterpolate

getInterpolate(): boolean
Returns boolean
Use linear interpolation when resampling.
Inherited from Source.getInterpolate
- Defined in ../node_modules/ol/source/Source.d.ts:182

getKey

getKey(): string
Return the key to be used for all tiles in the source.

Returns string
The key for all tiles.
- Defined in ../node_modules/ol/source/Tile.d.ts:202

getKeys

getKeys(): string[]
Get a list of object property names.

Returns string[]
List of property names.

Api
Inherited from Source.getKeys
- Defined in ../node_modules/ol/Object.d.ts:117

getListeners

getListeners(type): undefined | Listener[]
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 undefined | Listener[]
Listeners.
Inherited from Source.getListeners
- Defined in ../node_modules/ol/events/Target.d.ts:69

getOpaque

getOpaque(projection): boolean
Parameters
- projection: Projection
  Projection.
Returns boolean
Opaque.
- Defined in ../node_modules/ol/source/Tile.d.ts:213

getProjection

getProjection(): null | Projection
Get the projection of the source.

Returns null | Projection
Projection.

Api
Inherited from Source.getProjection
- Defined in ../node_modules/ol/source/Source.d.ts:159

getProperties

getProperties(): {
[x: string]: any;
}
Get an object of all property names and values.

Returns {
[x: string]: any;
}
Object.
- [x: string]: any
Api
Inherited from Source.getProperties
- Defined in ../node_modules/ol/Object.d.ts:123

getPropertiesInternal

getPropertiesInternal(): null | {
[x: string]: any;
}
Get an object of all property names and values.

Returns null | {
[x: string]: any;
}
Object.
Inherited from Source.getPropertiesInternal
- Defined in ../node_modules/ol/Object.d.ts:130

getResolutions

getResolutions(projection?): null | number[]
Parameters
- Optional projection: Projection
  Projection.
Returns null | number[]
Resolutions.
Inherited from Source.getResolutions
- Defined in ../node_modules/ol/source/Source.d.ts:164

getRevision

getRevision(): number
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 Source.getRevision
- Defined in ../node_modules/ol/Observable.d.ts:72

getState

getState(): State
Get the state of the source, see import("./Source.js").State for possible states.

Returns State
State.

Api
Inherited from Source.getState
- Defined in ../node_modules/ol/source/Source.d.ts:174

getTile

getTile(z, x, y, pixelRatio, projection): external.ol.Tile
Parameters
- z: number
  Tile coordinate z.
- x: number
  Tile coordinate x.
- y: number
  Tile coordinate y.
- pixelRatio: number
  Pixel ratio.
- projection: Projection
  Projection.
Returns external.ol.Tile
Tile.

Abstract
- Defined in ../node_modules/ol/source/Tile.d.ts:223

`Protected` getTileCacheForProjection

getTileCacheForProjection(projection): TileCache
Protected
Parameters
- projection: Projection
  Projection.
Returns TileCache
Tile cache.
- Defined in ../node_modules/ol/source/Tile.d.ts:240

getTileCoordForTileUrlFunction

getTileCoordForTileUrlFunction(tileCoord, projection?): TileCoord
Returns a tile coordinate wrapped around the x-axis. When the tile coordinate is outside the resolution and extent range of the tile grid, null will be returned.
Parameters
- tileCoord: TileCoord
  Tile coordinate.
- Optional projection: Projection
  Projection.
Returns TileCoord
Tile coordinate to be passed to the tileUrlFunction or null if no tile URL should be created for the passed tileCoord.
- Defined in ../node_modules/ol/source/Tile.d.ts:265

getTileGrid

getTileGrid(): null | TileGrid
Return the tile grid of the tile source.

Returns null | TileGrid
Tile grid.

Api
- Defined in ../node_modules/ol/source/Tile.d.ts:229

getTileGridForProjection

getTileGridForProjection(projection): TileGrid
Parameters
- projection: Projection
  Projection.
Returns TileGrid
Tile grid.
- Defined in ../node_modules/ol/source/Tile.d.ts:234

getTilePixelRatio

getTilePixelRatio(pixelRatio): number
Get the tile pixel ratio for this source. Subclasses may override this method, which is meant to return a supported pixel ratio that matches the provided pixelRatio as close as possible.
Parameters
- pixelRatio: number
  Pixel ratio.
Returns number
Tile pixel ratio.
- Defined in ../node_modules/ol/source/Tile.d.ts:248

getTilePixelSize

getTilePixelSize(z, pixelRatio, projection): Size
Parameters
- z: number
  Z.
- pixelRatio: number
  Pixel ratio.
- projection: Projection
  Projection.
Returns Size
Tile size.
- Defined in ../node_modules/ol/source/Tile.d.ts:255

getView

getView(): Promise<ViewOptions>
Returns Promise<ViewOptions>
A promise for view-related properties.
Inherited from Source.getView
- Defined in ../node_modules/ol/source/Source.d.ts:168

getWrapX

getWrapX(): undefined | boolean
Returns undefined | boolean
Wrap X.
Inherited from Source.getWrapX
- Defined in ../node_modules/ol/source/Source.d.ts:178

hasListener

hasListener(type?): boolean
Parameters
- Optional type: string
  Type. If not provided, true will be returned if this event target has any listeners.
Returns boolean
Has listeners.
Inherited from Source.hasListener
- Defined in ../node_modules/ol/events/Target.d.ts:75

hasProperties

hasProperties(): boolean
Returns boolean
The object has properties.
Inherited from Source.hasProperties
- Defined in ../node_modules/ol/Object.d.ts:136

notify

notify(key, oldValue): void
Parameters
- key: string
  Key name.
- oldValue: any
  Old value.
Returns void
Inherited from Source.notify
- Defined in ../node_modules/ol/Object.d.ts:141

`Protected` onInternal

onInternal(type, listener): EventsKey | EventsKey[]
Protected
Parameters
- type: string | string[]
  Type.
- listener: ((arg0) => unknown)
  Listener.
  - - (arg0): unknown
    - Parameters
      arg0: Event | BaseEvent
      Returns unknown
Returns EventsKey | EventsKey[]
Event key.
Inherited from Source.onInternal
- Defined in ../node_modules/ol/Observable.d.ts:79

`Protected` onceInternal

onceInternal(type, listener): EventsKey | EventsKey[]
Protected
Parameters
- type: string | string[]
  Type.
- listener: ((arg0) => unknown)
  Listener.
  - - (arg0): unknown
    - Parameters
      arg0: Event | BaseEvent
      Returns unknown
Returns EventsKey | EventsKey[]
Event key.
Inherited from Source.onceInternal
- Defined in ../node_modules/ol/Observable.d.ts:86

refresh

refresh(): void
Refreshes the source. The source will be cleared, and data from the server will be reloaded.

Returns void
Api
Inherited from Source.refresh
- Defined in ../node_modules/ol/source/Source.d.ts:187

removeChangeListener

removeChangeListener(key, listener): void
Parameters
- key: string
  Key name.
- listener: Listener
  Listener.
Returns void
Inherited from Source.removeChangeListener
- Defined in ../node_modules/ol/Object.d.ts:151

removeEventListener

removeEventListener(type, listener): void
Parameters
- type: string
  Type.
- listener: Listener
  Listener.
Returns void
Inherited from Source.removeEventListener
- Defined in ../node_modules/ol/events/Target.d.ts:80

set

set(key, value, silent?): void
Sets a value.
Parameters
- key: string
  Key name.
- value: any
  Value.
- Optional silent: boolean
  Update without triggering an event.
Returns void
Api
Inherited from Source.set
- Defined in ../node_modules/ol/Object.d.ts:159

setAttributions

setAttributions(attributions): void
Set the attributions of the source.
Parameters
- attributions: undefined | AttributionLike
  Attributions. Can be passed as string, Array<string>, module:ol/source/Source~Attribution, or undefined.
Returns void
Api
Inherited from Source.setAttributions
- Defined in ../node_modules/ol/source/Source.d.ts:195

`Protected` setKey

setKey(key): void
Protected
Set the value to be used as the key for all tiles in the source.
Parameters
- key: string
  The key for tiles.
Returns void
- Defined in ../node_modules/ol/source/Tile.d.ts:208

setProperties

setProperties(values, silent?): void
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: {
  [x: string]: any;
  }
  Values.
  - [x: string]: any
- Optional silent: boolean
  Update without triggering an event.
Returns void
Api
Inherited from Source.setProperties
- Defined in ../node_modules/ol/Object.d.ts:167

setState

setState(state): void
Set the state of the source.
Parameters
- state: State
  State.
Returns void
Inherited from Source.setState
- Defined in ../node_modules/ol/source/Source.d.ts:200

`Protected` unInternal

unInternal(type, listener): void
Protected
Unlisten for a certain type of event.
Parameters
- type: string | string[]
  Type.
- listener: ((arg0) => unknown)
  Listener.
  - - (arg0): unknown
    - Parameters
      arg0: Event | BaseEvent
      Returns unknown
Returns void
Inherited from Source.unInternal
- Defined in ../node_modules/ol/Observable.d.ts:93

unset

unset(key, silent?): void
Unsets a property.
Parameters
- key: string
  Key name.
- Optional silent: boolean
  Unset without triggering an event.
Returns void
Api
Inherited from Source.unset
- Defined in ../node_modules/ol/Object.d.ts:182

updateCacheSize

updateCacheSize(tileCount, projection): void
Increases the cache size if needed
Parameters
- tileCount: number
  Minimum number of tiles needed.
- projection: Projection
  Projection.
Returns void
- Defined in ../node_modules/ol/source/Tile.d.ts:276

useTile

useTile(z, x, y, projection): void
Marks a tile coord as being used, without triggering a load.
Parameters
- z: number
  Tile coordinate z.
- x: number
  Tile coordinate x.
- y: number
  Tile coordinate y.
- projection: Projection
  Projection.
Returns void
Abstract
- Defined in ../node_modules/ol/source/Tile.d.ts:285

Class Tile

Classdesc

Abstract

Api

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns external.olsource.Tile

Properties

Protected disposed

loading

on

once

Protected projection

Protected tileCache

tileGrid

Protected tileOptions

Protected tmpSize

un

Protected viewRejector

Type declaration

Parameters

Returns void

Protected viewResolver

Type declaration

Parameters

Returns void

zDirection

Methods

addChangeListener

Parameters

Returns void

addEventListener

Parameters

Returns void

Protected applyProperties

Parameters

Returns void

canExpireCache

Returns boolean

changed

Returns void

Api

clear

Returns void

Api

dispatchEvent

Parameters

Returns undefined | boolean

Api

dispose

Returns void

Protected disposeInternal

Returns void

expireCache

Parameters

[x: string]: boolean

Returns void

forEachLoadedTile

Parameters

Parameters

Returns boolean | void

Returns boolean

get

Parameters

Returns any

Api

getAttributions

Returns null | Attribution

Api

getAttributionsCollapsible

Returns boolean

Api

getGutterForProjection

Parameters

`Protected` disposed

`Protected` projection

`Protected` tileCache

`Protected` tileOptions

`Protected` tmpSize

`Protected` viewRejector

`Protected` viewResolver

`Protected` applyProperties

`Protected` disposeInternal

Returns {
[x: string]: any;
}

Returns null | {
[x: string]: any;
}

`Protected` getTileCacheForProjection

`Protected` onInternal