This documentation is for OpenLayers v
10.6.1. The
latestis v
.
ol/source/DataTile~DataTileSourceimport DataTileSource from 'ol/source/DataTile.js';
A source for typed array data tiles.
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.
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
.
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.Increases the revision counter and dispatches a 'change' event.
Remove all cached reprojected tiles from the source. The next render cycle will create new tiles.
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.
event
BaseEvent | string
Event object.
false
if anyone called preventDefault on the event object or if any of the listeners returned false.
Gets a value.
Name Type Descriptionkey
string
Key name.
Get the attribution function for the source.
Get a list of object property names.
Get the projection of the source.
Get an object of all property names and values.
Get the version number for this object. Each time the object is modified, its version number will be incremented.
Get the state of the source, see State
for possible states.
Return the tile grid of the tile source.
Listen for a certain type of event.
Name Type Descriptiontype
string | Array.<string>
The event type or array of event types.
listener
function
The listener function.
Listen once for a certain type of event.
Name Type Descriptiontype
string | Array.<string>
The event type or array of event types.
listener
function
The listener function.
Sets a value.
Name Type Descriptionkey
string
Key name.
value
*
Value.
silent
boolean | undefined
Update without triggering an event.
Set the attributions of the source.
Name Type Descriptionattributions
AttributionLike | undefined
Attributions. Can be passed as string
, Array<string>
, Attribution
, or undefined
.
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 Descriptionvalues
Object.<string, *>
Values.
silent
boolean | undefined
Update without triggering an event.
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 Descriptionprojection
ProjectionLike
Projection.
tilegrid
TileGrid
Tile grid to use for the projection.
Unlisten for a certain type of event.
Name Type Descriptiontype
string | Array.<string>
The event type or array of event types.
listener
function
The listener function.
Unsets a property.
Name Type Descriptionkey
string
Key name.
silent
boolean | undefined
Unset without triggering an event.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4