OpenLayers 3 API Documentation

Class: TileImage

ol .source.TileImage

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

new ol.source.TileImage(options) experimental

src/ol/source/tileimagesource.js, line 25

Name Type Description

options

Image tile options.

Name	Type	Description
`attributions`	Array.<ol.Attribution> \| undefined	optional Attributions.
`crossOrigin`	null \| string \| undefined	optional crossOrigin setting for image requests. Default is `null`.
`extent`	ol.Extent \| undefined	optional Extent.
`logo`	string \| undefined	optional Logo.
`opaque`	boolean \| undefined	optional Whether the layer is opaque.
`pixelRatio`	number \| undefined	optional Tile size pixel ratio provided by the server.
`projection`	ol.proj.ProjectionLike	Projection.
`tileClass`	function \| undefined	optional tile class
`tileGrid`	ol.tilegrid.TileGrid \| undefined	optional Tile grid.
`tileLoadFunction`	ol.TileLoadFunctionType \| undefined	optional Optional function to load a tile given a URL.
`tileUrlFunction`	ol.TileUrlFunctionType \| undefined	optional 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

ol.source.Tile

Methods

dispatchChangeEvent() inherited experimental src/ol/observable.js, line 41

Dispatches a change event.

Fires:

change experimental

getState(){ol.source.State} inherited experimental src/ol/source/source.js, line 142

Returns:

State.

getTileGrid(){ol.tilegrid.TileGrid} inherited experimental src/ol/source/tilesource.js, line 167

Returns:

Tile grid.

getTileLoadFunction(){ol.TileLoadFunctionType} experimental src/ol/source/tileimagesource.js, line 130

Returns:

TileLoadFunction

getTileUrlFunction(){ol.TileUrlFunctionType} experimental src/ol/source/tileimagesource.js, line 139

Returns:

TileUrlFunction

on(type, listener, opt_this){goog.events.Key} inherited experimental src/ol/observable.js, line 63

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	optional The object to use as `this` in `listener`.

Returns:

Unique key for the listener.

once(type, listener, opt_this){goog.events.Key} inherited experimental src/ol/observable.js, line 76

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	optional The object to use as `this` in `listener`.

Returns:

Unique key for the listener.

setTileLoadFunction(tileLoadFunction) experimental src/ol/source/tileimagesource.js, line 148

Name	Type	Description
`tileLoadFunction`	ol.TileLoadFunctionType	Tile load function.

setTileUrlFunction(tileUrlFunction) experimental src/ol/source/tileimagesource.js, line 159

Name	Type	Description
`tileUrlFunction`	ol.TileUrlFunctionType	Tile URL function.

un(type, listener, opt_this) inherited experimental src/ol/observable.js, line 88

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	optional The object to use as `this` in `listener`.

unByKey(key) inherited experimental src/ol/observable.js, line 98

Removes an event listener using the key returned by on() or once().

Name	Type	Description
`key`	goog.events.Key	Key.