Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://openlayers.org/en/latest/apidoc/module-ol_source_ImageTile-ImageTileSource.html below:

OpenLayers v10.6.1 API - Class: ImageTileSource

This documentation is for OpenLayers v

. The

is v

.

import ImageTileSource from 'ol/source/ImageTile.js';

A source for typed array data tiles.

new ImageTileSource(options)

Name Type Description url UrlLike | undefined

The image URL template. In addition to a single URL template, an array of URL templates or a function can be provided. If a function is provided, it will be called with z, x, y tile coordinates and loader options and should return a URL.

loader Loader | undefined

Data loader. Called with z, x, and y tile coordinates. Returns an image for a tile or a promise for the same. The promise should not resolve until the image is loaded. If the url option is provided, a loader will be created.

attributions AttributionLike | undefined

Attributions.

attributionsCollapsible boolean (defaults to true)

Attributions are collapsible.

maxZoom number (defaults to 42)

Optional max zoom level. Not used if tileGrid is provided.

minZoom number (defaults to 0)

Optional min zoom level. Not used if tileGrid is provided.

tileSize number | Size (defaults to [256, 256])

The pixel width and height of the source tiles. This may be different than the rendered pixel size if a tileGrid is provided.

gutter number (defaults to 0)

The size in pixels of the gutter around data tiles to ignore. This allows artifacts of rendering at tile edges to be ignored. Supported data should be wider and taller than the tile size by a value of 2 x gutter.

maxResolution number | undefined

Optional tile grid resolution at level zero. Not used if tileGrid is provided.

projection ProjectionLike (defaults to 'EPSG:3857')

Tile projection.

tileGrid TileGrid | undefined

Tile grid.

state State | undefined

The source state.

wrapX boolean (defaults to true)

Render tiles beyond the antimeridian.

transition number | undefined

Transition time when fading in new tiles (in miliseconds).

interpolate boolean (defaults to true)

Use interpolated values when resampling.

crossOrigin CrossOriginAttribute (defaults to 'anonymous')

The crossOrigin property to pass to loaders for image data.

zDirection number | NearestDirectionFunction (defaults to 0)

Choose whether to use tiles with a higher or lower zoom level when between integer zoom levels. See getZForResolution.

Fires:

• change (BaseEvent) - Generic change event. Triggered when the revision counter is increased.
• error (BaseEvent) - Generic error event. Triggered when an error occurs.
• propertychange (ObjectEvent) - Triggered when a property is changed.
• tileloadend (TileSourceEvent) - Triggered when a tile finishes loading, either when its data is loaded, or when loading was aborted because the tile is no longer needed.
• tileloaderror (TileSourceEvent) - Triggered if tile loading results in an error. Note that this is not the right place to re-fetch tiles. See load for details.
• tileloadstart (TileSourceEvent) - Triggered when a tile starts loading.

• TileDebug

• DataTileSource

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

Remove all cached reprojected tiles from the source. The next render cycle will create new tiles.

dispatchEvent(event){boolean | undefined} inherited

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.

Name Type Description event BaseEvent | string

Event object.

Returns:false if anyone called preventDefault on the event object or if any of the listeners returned false.

Gets a value.

Name Type Description key string

Key name.

Returns: Value.

Get the attribution function for the source.

Returns: Attribution function.

getAttributionsCollapsible(){boolean} inherited

Returns: Attributions are collapsible.

Get a list of object property names.

Returns: List of property names.

Get the projection of the source.

Returns: Projection.

getProperties(){Object.<string, *>} inherited

Get an object of all property names and values.

Returns: Object.

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns: Revision.

Get the state of the source, see State for possible states.

Returns: State.

Return the tile grid of the tile source.

Returns: Tile grid.

Listen for a certain type of event.

Name Type Description type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

Returns: Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

Listen once for a certain type of event.

Name Type Description type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

Returns: Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

Sets a value.

Name Type Description key string

Key name.

value *

Value.

silent boolean | undefined

Update without triggering an event.

Set the attributions of the source.

Name Type Description attributions AttributionLike | undefined

Attributions. Can be passed as string, Array<string>, Attribution, or undefined.

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

Name Type Description values Object.<string, *>

Values.

silent boolean | undefined

Update without triggering an event.

setTileGridForProjection(projection, tilegrid) inherited

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, ...).

Name Type Description projection ProjectionLike

Projection.

tilegrid TileGrid

Tile grid to use for the projection.

Name Type Description url UrlLike

The new URL.

Unlisten for a certain type of event.

Name Type Description type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

Unsets a property.

Name Type Description key string

Key name.

silent boolean | undefined

Unset without triggering an event.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4