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 24
Name Type Description
options

Image tile options.

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

Attributions.
crossOrigin null | string | undefined experimental

crossOrigin setting for image requests. Default is null.
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

tile class
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

dispatchChangeEvent() inherited experimental

src/ol/observable.js, line 42

Dispatches a change event.

Fires:
  • change experimental

getAttributions(){Array.<ol.Attribution>} inherited

src/ol/source/source.js, line 96
Returns:
Attributions.
src/ol/source/source.js, line 105
Returns:
Logo.

getProjection(){ol.proj.Projection} inherited experimental

src/ol/source/source.js, line 114
Returns:
Projection.

getRevision(){number} inherited experimental

src/ol/observable.js, line 52
Returns:
Revision.

getState(){ol.source.State} inherited experimental

src/ol/source/source.js, line 129
Returns:
State.

getTileGrid(){ol.tilegrid.TileGrid} inherited

src/ol/source/tilesource.js, line 170
Returns:
Tile grid.

getTileLoadFunction(){ol.TileLoadFunctionType} experimental

src/ol/source/tileimagesource.js, line 131
Returns:
TileLoadFunction

getTileUrlFunction(){ol.TileUrlFunctionType} experimental

src/ol/source/tileimagesource.js, line 140
Returns:
TileUrlFunction

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

src/ol/observable.js, line 65

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

src/ol/observable.js, line 78

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

src/ol/source/tileimagesource.js, line 149
Name Type Description
tileLoadFunction ol.TileLoadFunctionType

Tile load function.

setTileUrlFunction(tileUrlFunction) experimental

src/ol/source/tileimagesource.js, line 160
Name Type Description
tileUrlFunction ol.TileUrlFunctionType

Tile URL function.

un(type, listener, opt_this) inherited

src/ol/observable.js, line 91

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.

unByKey(key) inherited

src/ol/observable.js, line 101

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

Name Type Description
key goog.events.Key

Key.