OpenLayers v5.3.0 API - Class: TileSource

Class: TileSource

ol/source/Tile~TileSource

import TileSource from 'ol/source/Tile';

Abstract base class; normally only used for creating subclasses and not instantiated in apps. Base class for sources providing images divided into a tile grid.

new TileSource(options)

source/Tile.js, line 38

Name Type Description

options

SourceTile source options.

Name	Type	Default	Description
`attributions`	module:ol/source/Source~AttributionLike
`attributionsCollapsible`	boolean	true	Attributions are collapsible.
`cacheSize`	number
`opaque`	boolean
`tilePixelRatio`	number
`projection`	module:ol/proj~ProjectionLike
`state`	module:ol/source/State
`tileGrid`	module:ol/tilegrid/TileGrid~TileGrid
`wrapX`	boolean	true
`transition`	number
`key`	string

Fires:

change (module:ol/events/Event~Event) - Generic change event. Triggered when the revision counter is increased.
propertychange (module:ol/Object.ObjectEvent) - Triggered when a property is changed.

Subclasses

Extends

module:ol/source/Source~Source

Methods

changed() inherited Observable.js, line 36

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

get(key){*} inherited Object.js, line 119

Gets a value.

Name	Type	Description
`key`	string	Key name.

Returns:

Value.

getKeys(){Array.<string>} inherited Object.js, line 132

Get a list of object property names.

Returns:

List of property names.

getProjection(){module:ol/proj/Projection~Projection} inherited source/Source.js, line 119

Get the projection of the source.

Returns:

Projection.

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

Get an object of all property names and values.

Returns:

Object.

getRevision(){number} inherited Observable.js, line 47

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

Returns:

Revision.

getState(){module:ol/source/State} inherited source/Source.js, line 136

Get the state of the source, see module:ol/source/State~State for possible states.

Returns:

State.

getTileGrid(){module:ol/tilegrid/TileGrid~TileGrid} source/Tile.js, line 213

Return the tile grid of the tile source.

Returns:

Tile grid.

on(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited Observable.js, line 60

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.

once(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited Observable.js, line 82

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.

refresh() inherited source/Source.js, line 151

Refreshes the source and finally dispatches a 'change' event.

set(key, value, opt_silent) inherited Object.js, line 164

Sets a value.

Name	Type	Description
`key`	string	Key name.
`value`	*	Value.
`silent`	boolean	Update without triggering an event.

setAttributions(attributions) inherited source/Source.js, line 162

Set the attributions of the source.

Name	Type	Description
`attributions`	module:ol/source/Source~AttributionLike \| undefined	Attributions. Can be passed as `string`, `Array<string>`, `module:ol/source/Source&tilde;Attribution`, or `undefined`.

setProperties(values, opt_silent) inherited Object.js, line 183

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	Update without triggering an event.

un(type, listener) inherited 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.

unset(key, opt_silent) inherited Object.js, line 195

Unsets a property.

Name	Type	Description
`key`	string	Key name.
`silent`	boolean	Unset without triggering an event.