# Class: DataTileSource

This documentation is for OpenLayers v10.9.0. The latest is v.

## ol/source/DataTile~DataTileSource

    import DataTileSource from 'ol/source/DataTile.js';

A source for typed array data tiles.

#### new DataTileSource(options)

source/DataTile.js, line 83

  Name | Type | Description
  --- | --- | ---
  `loader` | Loader | undefined | Data loader. Called with z, x, and y tile coordinates. Returns `data` for a tile or a promise for the same. For loaders that generate images, the promise should not resolve until the image is loaded.
  `attributions` | AttributionLike | undefined | Attributions.
  `attributionsCollapsible` | boolean (defaults to true) | Attributions are collapsible.
  `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 | Size (defaults to [256, 256]) | The pixel width and height of the source tiles. This may be different than the rendered pixel size if a `tileGrid` is provided.
  `gutter` | number (defaults to 0) | The size in pixels of the gutter around data tiles to ignore. This allows artifacts of rendering at tile edges to be ignored. Supported data should be wider and taller than the tile size by a value of `2 x gutter`.
  `maxResolution` | number | undefined | Optional tile grid resolution at level zero. Not used if `tileGrid` is provided.
  `projection` | ProjectionLike (defaults to 'EPSG:3857') | Tile projection.
  `tileGrid` | TileGrid | undefined | Tile grid.
  `state` | State | undefined | The source state.
  `wrapX` | boolean (defaults to false) | Render tiles beyond the antimeridian.
  `transition` | number | undefined | Transition time when fading in new tiles (in milliseconds).
  `bandCount` | number (defaults to 4) | Number of bands represented in the data.
  `interpolate` | boolean (defaults to false) | Use interpolated values when resampling. By default, the nearest neighbor is used when resampling.
  `crossOrigin` | CrossOriginAttribute (defaults to 'anonymous') | The crossOrigin property to pass to loaders for image data.
  `referrerPolicy` | ReferrerPolicy | undefined | The `referrerPolicy` property for loaded images.
  `key` | string | undefined | Key for use in caching tiles.
  `zDirection` | number | NearestDirectionFunction (defaults to 0) | Choose whether to use tiles with a higher or lower zoom level when between integer zoom levels. See `getZForResolution`.

  ##### Fires:

  - `change` (BaseEvent) - Generic change event. Triggered when the revision counter is increased.
  - `error` (BaseEvent) - Generic error event. Triggered when an error occurs.
  - `propertychange` (ObjectEvent) - Triggered when a property is changed.
  - `tileloadend` (TileSourceEvent) - Triggered when a tile finishes loading, either when its data is loaded, or when loading was aborted because the tile is no longer needed.
  - `tileloaderror` (TileSourceEvent) - Triggered if tile loading results in an error. Note that this is not the right place to re-fetch tiles. See `load` for details.
  - `tileloadstart` (TileSourceEvent) - Triggered when a tile starts loading.

### Subclasses

- GeoTIFFSource
- ImageTileSource
- SentinelHub

### Extends

- TileSource

### Methods

#### changed() inherited

Observable.js, line 68

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

#### clear() inherited

source/Tile.js, line 258

  Remove all cached reprojected tiles from the source. The next render cycle will create 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` | 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 136

  Gets a value.

  Name | Type | Description
  --- | --- | ---
  `key` | string | Key name.

  ##### Returns:

  Value.

#### getAttributions(){Attribution} inherited

source/Source.js, line 129

  Get the attribution function for the source.

  ##### Returns:

  Attribution function.

#### getAttributionsCollapsible(){boolean} inherited

source/Source.js, line 137

  ##### Returns:

  Attributions are collapsible.

#### getKeys(){Array.<string>} inherited

Object.js, line 149

  Get a list of object property names.

  ##### Returns:

  List of property names.

#### getProjection(){Projection | null} inherited

source/Source.js, line 146

  Get the projection of the source.

  ##### Returns:

  Projection.

#### getProperties(){NoInfer.<Properties>} inherited

Object.js, line 158

  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(){State} inherited

source/Source.js, line 170

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

  ##### Returns:

  State.

#### getTileGrid(){TileGrid | null} inherited

source/Tile.js, line 190

  Return the tile grid of the tile source.

  ##### Returns:

  Tile grid.

#### on(type, listener){EventsKey | Array<EventsKey>} inherited

Observable.js, line 152

  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){EventsKey | Array<EventsKey>} inherited

Observable.js, line 164

  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.

#### set(key, value, silent) inherited

Object.js, line 218

  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 203

  Set the attributions of the source.

  Name | Type | Description
  --- | --- | ---
  `attributions` | AttributionLike | undefined | Attributions. Can be passed as `string`, `Array<string>`, `Attribution`, or `undefined`.

#### setProperties(values, silent) inherited

Object.js, line 238

  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` | Partial.<NoInfer.<Properties>> | Values.
  `silent` | boolean | undefined | Update without triggering an event.

#### setTileGridForProjection(projection, tilegrid)

source/DataTile.js, line 468

  Sets the tile grid to use when reprojecting the tiles to the given projection instead of the default tile grid for the projection.

  This can be useful when the default tile grid cannot be created (e.g. projection has no extent defined) or for optimization reasons (custom tile size, resolutions, ...).

  Name | Type | Description
  --- | --- | ---
  `projection` | ProjectionLike | Projection.
  `tilegrid` | TileGrid | Tile grid to use for the projection.

#### un(type, listener) inherited

Observable.js, line 173

  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, silent) inherited

Object.js, line 262

  Unsets a property.

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