Class: Tile

ol.source.Tile

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.

new ol.source.Tile(options) experimental

Name Type Description
options ol.SourceTileOptions

Tile source options.

Fires:

Subclasses

Extends

Classes

Event

Methods

changed() inherited experimental

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

dispatchEvent(event) inherited experimental

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 Object | ol.events.Event | string

Event object.

Gets a value.

Name Type Description
key string

Key name.

Returns:
Value.

Get the attributions of the source.

Returns:
Attributions.

getKeys(){Array.<string>} inherited

Get a list of object property names.

Returns:
List of property names.

Get the logo of the source.

Returns:
Logo.

Get the projection of the source.

Returns:
Projection.

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

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited experimental

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:
Revision.

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

Returns:
State.

Return the tile grid of the tile source.

Returns:
Tile grid.

on(type, listener, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited

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.

this Object

The object to use as this in listener.

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, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited

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.

this Object

The object to use as this in listener.

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 experimental

Refreshes the source and finally dispatches a 'change' event.

set(key, value, opt_silent) inherited

Sets a value.

Name Type Description
key string

Key name.

value *

Value.

silent boolean

Update without triggering an event.

setAttributions(attributions) inherited experimental

Set the attributions of the source.

Name Type Description
attributions ol.AttributionLike | undefined

Attributions. Can be passed as string, Array<string>, ol.Attribution, Array<ol.Attribution> or undefined.

setProperties(values, opt_silent) inherited

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

Update without triggering an event.

un(type, listener, opt_this) inherited

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.

this Object

The object which was used as this by the listener.

Removes an event listener using the key returned by on() or once(). Note that using the ol.Observable.unByKey static function is to be preferred.

Name Type Description
key ol.EventsKey | Array.<ol.EventsKey>

The key returned by on() or once() (or an array of keys).

unset(key, opt_silent) inherited

Unsets a property.

Name Type Description
key string

Key name.

silent boolean

Unset without triggering an event.