Class IIIF

loading

on

once

tileGrid

un

zDirection

addChangeListener

• addChangeListener(key, listener): void

• Parameters

  • key: string

    Key name.
  • listener: Listener

    Listener.

  Returns void

addEventListener

• addEventListener(type, listener): void

• Parameters

  • type: string

    Type.
  • listener: Listener

    Listener.

  Returns void

canExpireCache

• canExpireCache(): boolean

• Returns boolean

  Can expire cache.

changed

• changed(): void

• Increases the revision counter and dispatches a 'change' event.

  Returns void

  Api

clear

• clear(): void

• Remove all cached tiles from the source. The next render cycle will fetch new tiles.

  Returns void

  Api

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

dispose

• dispose(): void

• Clean up.

  Returns void

expireCache

• expireCache(projection, usedTiles): void

• Parameters

  • projection: Projection

    Projection.
  • usedTiles: {
        [x: string]: boolean;
    }

    Used tiles.

    • [x: string]: boolean

  Returns void

forEachLoadedTile

• forEachLoadedTile(projection, z, tileRange, callback): boolean

• Parameters

  • projection: Projection

    Projection.
  • z: number

    Zoom level.
  • tileRange: TileRange

    Tile range.
  • callback: ((arg0: external.ol.Tile) => 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.

get

• get(key): any

• Gets a value.

  Parameters

  • key: string

    Key name.

  Returns any

  Value.

  Api

getAttributions

• getAttributions(): null | Attribution

• Get the attribution function for the source.

  Returns null | Attribution

  Attribution function.

  Api

getAttributionsCollapsible

• getAttributionsCollapsible(): boolean

• Returns boolean

  Attributions are collapsible.

  Api

getGutter

• getGutter(): number

• Returns number

  Gutter.

getGutterForProjection

• getGutterForProjection(projection): number

• Parameters

  • projection: Projection

    Projection.

  Returns number

  Gutter.

getInterpolate

• getInterpolate(): boolean

• Returns boolean

  Use linear interpolation when resampling.

getKey

• getKey(): string

• Return the key to be used for all tiles in the source.

  Returns string

  The key for all tiles.

getKeys

• getKeys(): string[]

• Get a list of object property names.

  Returns string[]

  List of property names.

  Api

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.

getOpaque

• getOpaque(projection): boolean

• Parameters

  • projection: Projection

    Projection.

  Returns boolean

  Opaque.

getProjection

• getProjection(): null | Projection

• Get the projection of the source.

  Returns null | Projection

  Projection.

  Api

getProperties

• getProperties(): {
      [x: string]: any;
  }

• Get an object of all property names and values.

  Returns {
      [x: string]: any;
  }

  Object.

  • [x: string]: any

  Api

getPropertiesInternal

• getPropertiesInternal(): null | {
      [x: string]: any;
  }

• Get an object of all property names and values.

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

  Object.

getResolutions

• getResolutions(projection?): null | number[]

• Parameters

  • Optionalprojection: Projection

    Projection.

  Returns null | number[]

  Resolutions.

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

getState

• getState(): State

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

  Returns State

  State.

  Api

getTile

• getTile(z, x, y, pixelRatio, projection): ImageTile | ReprojTile

• Parameters

  • z: number

    Tile coordinate z.
  • x: number

    Tile coordinate x.
  • y: number

    Tile coordinate y.
  • pixelRatio: number

    Pixel ratio.
  • projection: Projection

    Projection.

  Returns ImageTile | ReprojTile

  Tile.

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.
  • Optionalprojection: 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.

getTileGrid

• getTileGrid(): null | TileGrid

• Return the tile grid of the tile source.

  Returns null | TileGrid

  Tile grid.

  Api

getTileGridForProjection

• getTileGridForProjection(projection): TileGrid

• Parameters

  • projection: Projection

    Projection.

  Returns TileGrid

  Tile grid.

getTileLoadFunction

• getTileLoadFunction(): LoadFunction

• Return the tile load function of the source.

  Returns LoadFunction

  TileLoadFunction

  Api

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.

getTilePixelSize

• getTilePixelSize(z, pixelRatio, projection): Size

• Parameters

  • z: number

    Z.
  • pixelRatio: number

    Pixel ratio.
  • projection: Projection

    Projection.

  Returns Size

  Tile size.

getTileUrlFunction

• getTileUrlFunction(): UrlFunction

• Return the tile URL function of the source.

  Returns UrlFunction

  TileUrlFunction

  Api

getUrls

• getUrls(): null | string[]

• Return the URLs used for this source. When a tileUrlFunction is used instead of url or urls, null will be returned.

  Returns null | string[]

  URLs.

  Api

getView

• getView(): Promise<ViewOptions>

• Returns Promise<ViewOptions>

  A promise for view-related properties.

getWrapX

• getWrapX(): undefined | boolean

• Returns undefined | boolean

  Wrap X.

hasListener

• hasListener(type?): boolean

• Parameters

  • Optionaltype: string

    Type. If not provided, true will be returned if this event target has any listeners.

  Returns boolean

  Has listeners.

hasProperties

• hasProperties(): boolean

• Returns boolean

  The object has properties.

notify

• notify(key, oldValue): void

• Parameters

  • key: string

    Key name.
  • oldValue: any

    Old value.

  Returns void

refresh

• refresh(): void

• Refreshes the source. The source will be cleared, and data from the server will be reloaded.

  Returns void

  Api

removeChangeListener

• removeChangeListener(key, listener): void

• Parameters

  • key: string

    Key name.
  • listener: Listener

    Listener.

  Returns void

removeEventListener

• removeEventListener(type, listener): void

• Parameters

  • type: string

    Type.
  • listener: Listener

    Listener.

  Returns void

set

• set(key, value, silent?): void

• Sets a value.

  Parameters

  • key: string

    Key name.
  • value: any

    Value.
  • Optionalsilent: boolean

    Update without triggering an event.

  Returns void

  Api

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

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

  • Optionalsilent: boolean

    Update without triggering an event.

  Returns void

  Api

setRenderReprojectionEdges

• setRenderReprojectionEdges(render): void

• Sets whether to render reprojection edges or not (usually for debugging).

  Parameters

  • render: boolean

    Render the edges.

  Returns void

  Api

setState

• setState(state): void

• Set the state of the source.

  Parameters

  • state: State

    State.

  Returns void

setTileGridForProjection

• setTileGridForProjection(projection, tilegrid): void

• Sets the tile grid to use when reprojecting the tiles to the given projection instead of the default tile grid for the projection.

  This can be useful when the default tile grid cannot be created (e.g. projection has no extent defined) or for optimization reasons (custom tile size, resolutions, ...).

  Parameters

  • projection: ProjectionLike

    Projection.
  • tilegrid: TileGrid

    Tile grid to use for the projection.

  Returns void

  Api

setTileLoadFunction

• setTileLoadFunction(tileLoadFunction): void

• Set the tile load function of the source.

  Parameters

  • tileLoadFunction: LoadFunction

    Tile load function.

  Returns void

  Api

setTileUrlFunction

• setTileUrlFunction(tileUrlFunction, key?): void

• Set the tile URL function of the source.

  Parameters

  • tileUrlFunction: UrlFunction

    Tile URL function.
  • Optionalkey: string

    Optional new tile key for the source.

  Returns void

  Api

setUrl

• setUrl(url): void

• Set the URL to use for requests.

  Parameters

  • url: string

    URL.

  Returns void

  Api

setUrls

• setUrls(urls): void

• Set the URLs to use for requests.

  Parameters

  • urls: string[]

    URLs.

  Returns void

  Api

tileUrlFunction

• tileUrlFunction(tileCoord, pixelRatio, projection): undefined | string

• Parameters

  • tileCoord: TileCoord

    Tile coordinate.
  • pixelRatio: number

    Pixel ratio.
  • projection: Projection

    Projection.

  Returns undefined | string

  Tile URL.

unset

• unset(key, silent?): void

• Unsets a property.

  Parameters

  • key: string

    Key name.
  • Optionalsilent: boolean

    Unset without triggering an event.

  Returns void

  Api

updateCacheSize

• updateCacheSize(tileCount, projection): void

• Increases the cache size if needed

  Parameters

  • tileCount: number

    Minimum number of tiles needed.
  • projection: Projection

    Projection.

  Returns void

useTile

• useTile(z, x, y): 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.

  Returns void