Class: TileImage

ol.source.TileImage

Base class for sources providing images divided into a tile grid.

new ol.source.TileImage(options) experimental

Name Type Description
options

Image tile options.

Name Type Description
attributions Array.<ol.Attribution> | undefined experimental

Attributions.

crossOrigin null | string | undefined experimental

The crossOrigin attribute for loaded images. Note that you must provide a crossOrigin value if you are using the WebGL renderer or if you want to access pixel data with the Canvas renderer. See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.

logo string | olx.LogoOptions | undefined experimental

Logo.

opaque boolean | undefined experimental

Whether the layer is opaque.

projection ol.proj.ProjectionLike experimental

Projection.

state ol.source.State | string | undefined experimental

Source state.

tileClass function | undefined experimental

Class used to instantiate image tiles. Default is ol.ImageTile.

tileGrid ol.tilegrid.TileGrid | undefined experimental

Tile grid.

tileLoadFunction ol.TileLoadFunctionType | undefined experimental

Optional function to load a tile given a URL.

tilePixelRatio number | undefined experimental

The pixel ratio used by the tile service. For example, if the tile service advertizes 256px by 256px tiles but actually sends 512px by 512px images (for retina/hidpi devices) then tilePixelRatio should be set to 2. Default is 1.

tileUrlFunction ol.TileUrlFunctionType | undefined experimental

Optional function to get tile URL given a tile coordinate and the projection.

Fires:
  • change experimental - Triggered when the state of the source changes.

Subclasses

Extends

Methods

changed() inherited experimental

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

Fires:
  • change experimental
Returns:
Attributions.
Returns:
Logo.
Returns:
Projection.

getRevision(){number} inherited experimental

Returns:
Revision.
Returns:
State.
Returns:
Tile grid.
Returns:
TileLoadFunction
Returns:
TileUrlFunction

on(type, listener, opt_this){goog.events.Key} inherited

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.

this Object

The object to use as this in listener.

Returns:
Unique key for the listener.

once(type, listener, opt_this){goog.events.Key} inherited

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.

this Object

The object to use as this in listener.

Returns:
Unique key for the listener.

setTileLoadFunction(tileLoadFunction) experimental

Name Type Description
tileLoadFunction ol.TileLoadFunctionType

Tile load function.

setTileUrlFunction(tileUrlFunction) experimental

Name Type Description
tileUrlFunction ol.TileUrlFunctionType

Tile URL function.

un(type, listener, opt_this) inherited

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.

this Object

The object which was used as this by the listener.

Removes an event listener using the key returned by on() or once(). Note that using the ol.Observable.unByKey static function is to be preferred.

Name Type Description
key goog.events.Key

The key returned by on() or once().