TileDebug~TileDebug

import TileDebug from 'ol/source/TileDebug.js';

A pseudo tile source, which does not fetch tiles from a server, but renders a grid outline for the tile grid/projection along with the coordinates for each tile. See examples/canvas-tiles for an example.

new TileDebug(options) source/TileDebug.js, line 37

Name	Type	Description
`projection`	ProjectionLike (defaults to 'EPSG:3857')	Optional projection.
`tileGrid`	TileGrid \| undefined	Tile grid.
`wrapX`	boolean (defaults to true)	Whether to wrap the world horizontally.
`zDirection`	number \| NearestDirectionFunction (defaults to 0)	Set to `1` when debugging `VectorTile` sources with a default configuration. Choose whether to use tiles with a higher or lower zoom level when between integer zoom levels. See `getZForResolution`.
`source`	TileSource \| undefined	Tile source. This allows `projection`, `tileGrid`, `wrapX` and `zDirection` to be copied from another source. If both `source` and individual options are specified the individual options will have precedence.
`template`	string (defaults to 'z:{z} x:{x} y:{y}')	Template for labeling the tiles. Should include `{x}`, `{y}` or `{-y}`, and `{z}` placeholders.
`color`	string (defaults to 'grey')	CSS color to fill text and stroke grid lines of each tile.

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.

Extends

ImageTileSource

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 201

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.

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

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

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 234

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) inherited source/DataTile.js, line 484

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.

setUrl(url) inherited source/ImageTile.js, line 205

Name	Type	Description
`url`	UrlLike	The new URL.

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.