Class: TileVector

ol.source.TileVector

A vector source in one of the supported formats, where the data is divided into tiles in a fixed grid pattern.

new ol.source.TileVector(options) experimental

Name Type Description
options

Options.

Name Type Description
attributions Array.<ol.Attribution> | undefined experimental

Attributions.

defaultProjection ol.proj.ProjectionLike experimental

Default projection.

format ol.format.Feature experimental

Format.

logo string | olx.LogoOptions | undefined experimental

Logo.

object GeoJSONObject | undefined experimental

Object.

projection ol.proj.ProjectionLike experimental

Destination projection. If provided, features will be transformed to this projection. If not provided, features will not be transformed.

tileGrid ol.tilegrid.TileGrid experimental

Tile grid.

tileUrlFunction ol.TileUrlFunctionType | undefined experimental

Optional function to get tile URL given a tile coordinate and the projection. Required if url or urls are not provided.

url string | undefined experimental

URL template. Must include {x}, {y} or {-y}, and {z} placeholders.

urls Array.<string> | undefined experimental

An array of URL templates.

Fires:

Extends

Methods

Name Type Description
feature ol.Feature

Feature.

Name Type Description
features Array.<ol.Feature>

Features.

Remove all features.

dispatchChangeEvent() inherited experimental

Dispatches a change event.

Fires:
  • change experimental

forEachFeature(f, opt_this){S|undefined}

Name Type Description
f function

Callback.

this T

The object to use as this in f.

forEachFeatureInExtent(extent, f, opt_this){S|undefined} experimental

Name Type Description
extent ol.Extent

Extent.

f function

Callback.

this T

The object to use as this in f.

Returns:
Attributions.

getClosestFeatureToCoordinate(coordinate){ol.Feature}

Name Type Description
coordinate ol.Coordinate

Coordinate.

Returns:
Closest feature.

Get the extent of the features currently in the source.

Returns:
Extent.

Get a feature by its identifier (the value returned by feature.getId()). Note that the index treats string and numeric identifiers as the same. So source.getFeatureById(2) will return a feature with id '2' or 2.

Name Type Description
id string | number

Feature identifier.

Returns:
The feature (or null if not found).
Returns:
Features.

getFeaturesAtCoordinate(coordinate){Array.<ol.Feature>} inherited

Name Type Description
coordinate ol.Coordinate

Coordinate.

Returns:
Features.
Returns:
Logo.
Returns:
Projection.

getRevision(){number} inherited experimental

Returns:
Revision.
Returns:
State.

on(type, listener, opt_this){goog.events.Key} 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.

once(type, listener, opt_this){goog.events.Key} 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.

readFeatures(source){Array.<ol.Feature>} inherited experimental

Name Type Description
source ArrayBuffer | Document | Node | Object | string

Source.

Returns:
Features.
Name Type Description
feature ol.Feature

Feature.

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().

Name Type Description
key goog.events.Key

Key.