This documentation is for OpenLayers v
10.6.1. The
latestis v
.
ol/source/Tile~TileSourceimport TileSource from 'ol/source/Tile.js';
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.
attributions
AttributionLike | undefined
Attributions.
attributionsCollapsible
boolean (defaults to true)
Attributions are collapsible.
cacheSize
number | undefined
Deprecated. Use the cacheSize option on the layer instead.
tilePixelRatio
number | undefined
TilePixelRatio.
projection
ProjectionLike | undefined
Projection.
state
State | undefined
State.
tileGrid
TileGrid | undefined
TileGrid.
wrapX
boolean (defaults to false)
WrapX.
transition
number | undefined
Transition.
key
string | undefined
Key.
zDirection
number | NearestDirectionFunction (defaults to 0)
ZDirection.
interpolate
boolean (defaults to false)
Use interpolated values when resampling. By default, the nearest neighbor is used when resampling.
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.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.
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