Class: DataTileSource

ol/source/DataTile~DataTileSource 


import DataTileSource from 'ol/source/DataTile';

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

new DataTileSource(options)

source/DataTile.js, line 39
Name Type Description
options

Image tile options.

Name Type Description
loader function | undefined

Data loader. Called with z, x, and y tile coordinates. Returns a promise that resolves to a module:ol/DataTile~Data.
maxZoom number (defaults to 42)

Optional max zoom level. Not used if tileGrid is provided.
minZoom number (defaults to 0)

Optional min zoom level. Not used if tileGrid is provided.
tileSize number | module:ol/size~Size (defaults to [256, 256])

The pixel width and height of the tiles.
maxResolution number | undefined

Optional tile grid resolution at level zero. Not used if tileGrid is provided.
projection module:ol/proj~ProjectionLike (defaults to 'EPSG:3857')

Tile projection.
tileGrid module:ol/tilegrid/TileGrid~TileGrid | undefined

Tile grid.
opaque boolean (defaults to false)

Whether the layer is opaque.
state module:ol/source/State | undefined

The source state.
tilePixelRatio number | undefined

Tile pixel ratio.
wrapX boolean (defaults to true)

Render tiles beyond the antimeridian.
transition number | undefined

Transition time when fading in new tiles (in miliseconds).
bandCount number (defaults to 4)

Number of bands represented in the data.
Fires:

Subclasses

Extends

Methods

changed() inherited

Observable.js, line 68

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

clear() inherited

source/Tile.js, line 336

Remove all cached tiles from the source. The next render cycle will fetch new tiles.

dispatchEvent(event){boolean|undefined} inherited

events/Target.js, line 85

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Name Type Description
event module:ol/events/Event~BaseEvent | string

Event object.
Returns:
false if anyone called preventDefault on the event object or if any of the listeners returned false.

get(key){*} inherited

Object.js, line 135

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

getAttributions(){module:ol/source/Source~Attribution} inherited

source/Source.js, line 122

Get the attribution function for the source.

Returns:
Attribution function.

getAttributionsCollapsible(){boolean} inherited

source/Source.js, line 130
Returns:
Attributions are collapsible.

getKeys(){Array.<string>} inherited

Object.js, line 148

Get a list of object property names.

Returns:
List of property names.

getProjection(){module:ol/proj/Projection~Projection} inherited

source/Source.js, line 139

Get the projection of the source.

Returns:
Projection.

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

Object.js, line 157

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited

Observable.js, line 79

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 163

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

Returns:
State.

getTileGrid(){module:ol/tilegrid/TileGrid~TileGrid} inherited

source/Tile.js, line 256

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 153

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 165

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 185

Refreshes the source. The source will be cleared, and data from the server will be reloaded.

set(key, value, opt_silent) inherited

Object.js, line 203

Sets a value.

Name Type Description
key string

Key name.
value *

Value.
silent boolean | undefined

Update without triggering an event.

setAttributions(attributions) inherited

source/Source.js, line 196

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~Attribution, or undefined.

setProperties(values, opt_silent) inherited

Object.js, line 223

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 | undefined

Update without triggering an event.

un(type, listener) inherited

Observable.js, line 174

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 247

Unsets a property.

Name Type Description
key string

Key name.
silent boolean | undefined

Unset without triggering an event.