Improve docs for source.Vector options

This commit is contained in:
Peter Robins
2015-04-20 13:19:32 +00:00
parent fc02d715d7
commit 30b52ef213
+9 -9
View File
@@ -4969,9 +4969,8 @@ olx.source.VectorOptions.prototype.features;
/** /**
* The feature format used by the XHR loader when `url` is set. Required * The feature format used by the XHR feature loader when `url` is set.
* if `url` is set, otherwise ignored. Default is `undefined`. * Required if `url` is set, otherwise ignored. Default is `undefined`.
* `url`
* @type {ol.format.Feature|undefined} * @type {ol.format.Feature|undefined}
* @api * @api
*/ */
@@ -4980,7 +4979,8 @@ olx.source.VectorOptions.prototype.format;
/** /**
* The loader function used to load features, from a remote source for example. * The loader function used to load features, from a remote source for example.
* Note that the source will create and use an XHR loader when `src` is set. * Note that the source will create and use an XHR feature loader when `url` is
* set.
* @type {ol.FeatureLoader|undefined} * @type {ol.FeatureLoader|undefined}
* @api * @api
*/ */
@@ -4997,8 +4997,7 @@ olx.source.VectorOptions.prototype.logo;
/** /**
* The loading strategy to use. By default an {@link ol.loadingstrategy.all} * The loading strategy to use. By default an {@link ol.loadingstrategy.all}
* strategy is used, which means that features at loaded all at once, and * strategy is used, a one-off strategy which loads all features at once.
* once.
* @type {ol.LoadingStrategy|undefined} * @type {ol.LoadingStrategy|undefined}
* @api * @api
*/ */
@@ -5006,9 +5005,10 @@ olx.source.VectorOptions.prototype.strategy;
/** /**
* Set this option if you want the source to download features all at once * Setting this option instructs the source to use an XHR loader (see
* and once for good. Internally the source uses an XHR feature loader (see * {@link ol.featureloader.xhr}) and an {@link ol.loadingstrategy.all} for a
* {@link ol.featureloader.xhr}). Requires `format` to be set as well. * one-off download of all features from that URL.
* Requires `format` to be set as well.
* @type {string|undefined} * @type {string|undefined}
* @api * @api
*/ */