Module: ol/featureloader

Methods

module:ol/featureloader.setWithCredentials(xhrWithCredentials)

featureloader.js, line 177

import {setWithCredentials} from 'ol/featureloader';

Setter for the withCredentials configuration for the XHR.

Name	Type	Description
xhrWithCredentials	boolean	The value of withCredentials to set. Compare https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/

module:ol/featureloader.xhr(url, format){module:ol/featureloader~FeatureLoader}

featureloader.js, line 135

import {xhr} from 'ol/featureloader';

Create an XHR feature loader for a url and format. The feature loader loads features (with XHR), parses the features, and adds them to the vector source.

Name	Type	Description
url	string | module:ol/featureloader~FeatureUrlFunction	Feature URL service.
format	module:ol/format/Feature~FeatureFormat	Feature format.

Returns:

The feature loader.

Type Definitions

FeatureLoader()

featureloader.js, line 13

module:ol/source/Vector~VectorSource sources use a function of this type to load features.

This function takes up to 5 arguments. These are an module:ol/extent~Extent representing the area to be loaded, a {number} representing the resolution (map units per pixel), an module:ol/proj/Projection~Projection for the projection, an optional success callback that should get the loaded features passed as an argument and an optional failure callback with no arguments. If the callbacks are not used, the corresponding vector source will not fire 'featuresloadend' and 'featuresloaderror' events. this within the function is bound to the module:ol/source/Vector~VectorSource it's called from.

The function is responsible for loading the features and adding them to the source.

FeatureUrlFunction()

featureloader.js, line 36

module:ol/source/Vector~VectorSource sources use a function of this type to get the url to load features from.

This function takes an module:ol/extent~Extent representing the area to be loaded, a {number} representing the resolution (map units per pixel) and an module:ol/proj/Projection~Projection for the projection as arguments and returns a {string} representing the URL.