OpenLayers 3 API Reference - Class: TileJSON

Class: TileJSON

ol .source.TileJSON

Layer source for tile data in TileJSON format.

new ol.source.TileJSON(options)

src/ol/source/tilejsonsource.js, line 32

Name Type Description

options

TileJSON options.

Name	Type	Description
`attributions`	Array.<ol.Attribution> \| undefined	Optional attributions for the source. If provided, these will be used instead of any attribution data advertised by the server. If not provided, any attributions advertised by the server will be used.
`crossOrigin`	null \| string \| undefined	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.
`tileLoadFunction`	ol.TileLoadFunctionType \| undefined	experimental Optional function to load a tile given a URL.
`url`	string	URL to the TileJSON file.
`wrapX`	boolean \| undefined	experimental Whether to wrap the world horizontally. Default is `true`.

Fires:

change - Triggered when the state of the source changes.
propertychange (ol.ObjectEvent) - Triggered when a property is changed.
tileloadend (ol.source.TileEvent) - Triggered when a tile finishes loading.
tileloaderror (ol.source.TileEvent) - Triggered if tile loading results in an error.
tileloadstart (ol.source.TileEvent) - Triggered when a tile starts loading.

Extends

ol.source.TileImage

Methods

changed() inherited experimental src/ol/observable.js, line 52

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

Fires:

change experimental

get(key){*} inherited src/ol/object.js, line 150

Gets a value.

Name	Type	Description
`key`	string	Key name.

Returns:

Value.

getAttributions(){Array.<ol.Attribution>} inherited src/ol/source/source.js, line 104

Get the attributions of the source.

Returns:

Attributions.

getKeys(){Array.<string>} inherited src/ol/object.js, line 164

Get a list of object property names.

Returns:

List of property names.

getLogo(){string|olx.LogoOptions|undefined} inherited src/ol/source/source.js, line 114

Get the logo of the source.

Returns:

Logo.

getProjection(){ol.proj.Projection} inherited experimental src/ol/source/source.js, line 124

Get the projection of the source.

Returns:

Projection.

getProperties(){Object.<string, *>} inherited src/ol/object.js, line 174

Get an object of all property names and values.

Returns:

Object.

getRevision(){number} inherited experimental src/ol/observable.js, line 62

Returns:

Revision.

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

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

Returns:

State.

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

Return the tile grid of the tile source.

Returns:

Tile grid.

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

Return the tile load function of the source.

Returns:

TileLoadFunction

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

Return the tile URL function of the source.

Returns:

TileUrlFunction

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

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 88

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.

set(key, value) inherited src/ol/object.js, line 203

Sets a value.

Name	Type	Description
`key`	string	Key name.
`value`	*	Value.

setProperties(values) inherited src/ol/object.js, line 216

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.

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

Set the tile load function of the source.

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

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

Set the tile URL function of the source.

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

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

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 114

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

unset(key) inherited src/ol/object.js, line 229

Unsets a property.

Name	Type	Description
`key`	string	Key name.