Move Options to ol/format/MVT

This commit is contained in:
Tim Schaub
2018-03-11 16:06:32 -06:00
parent a7c5ae1ca3
commit 7f6c4ef6cf
3 changed files with 18 additions and 66 deletions

View File

@@ -5,56 +5,6 @@
let olx;
/**
* @typedef {{featureClass: (function((ol.geom.Geometry|Object.<string, *>)=)|
* function(ol.geom.GeometryType,Array.<number>,
* (Array.<number>|Array.<Array.<number>>),Object.<string, *>)|
* undefined),
* geometryName: (string|undefined),
* layers: (Array.<string>|undefined),
* layerName: (string|undefined)}}
*/
olx.format.MVTOptions;
/**
* Class for features returned by {@link ol.format.MVT#readFeatures}. Set to
* {@link ol.Feature} to get full editing and geometry support at the cost of
* decreased rendering performance. The default is {@link ol.render.Feature},
* which is optimized for rendering and hit detection.
* @type {undefined|function((ol.geom.Geometry|Object.<string,*>)=)|
* function(ol.geom.GeometryType,Array.<number>,
* (Array.<number>|Array.<Array.<number>>),Object.<string,*>,number)}
* @api
*/
olx.format.MVTOptions.prototype.featureClass;
/**
* Geometry name to use when creating features. Default is 'geometry'.
* @type {string|undefined}
* @api
*/
olx.format.MVTOptions.prototype.geometryName;
/**
* Name of the feature attribute that holds the layer name. Default is 'layer'.
* @type {string|undefined}
* @api
*/
olx.format.MVTOptions.prototype.layerName;
/**
* Layers to read features from. If not provided, features will be read from all
* layers.
* @type {Array.<string>|undefined}
* @api
*/
olx.format.MVTOptions.prototype.layers;
/**
* @typedef {{factor: (number|undefined),
* geometryLayout: (ol.geom.GeometryLayout|undefined)}}

View File

@@ -1,19 +1,4 @@
/**
* @typedef {Object} format_MVTOptions
* @property {undefined|function((ol.geom.Geometry|Object.<string,*>)=)| function(ol.geom.GeometryType,Array.<number>,
(Array.<number>|Array.<Array.<number>>),Object.<string,*>,number)}
featureClass Class for features returned by {@link ol.format.MVT#readFeatures}. Set to
* {@link ol.Feature} to get full editing and geometry support at the cost of
* decreased rendering performance. The default is {@link ol.render.Feature},
* which is optimized for rendering and hit detection.
* @property {string|undefined} geometryName Geometry name to use when creating features. Default is 'geometry'.
* @property {string|undefined} layerName Name of the feature attribute that holds the layer name. Default is 'layer'.
* @property {Array.<string>|undefined} layers Layers to read features from. If not provided, features will be read from all
* layers.
*/
/**
* @typedef {Object} format_PolylineOptions
* @property {number|undefined} factor The factor by which the coordinates values will be scaled.

View File

@@ -21,13 +21,30 @@ import Projection from '../proj/Projection.js';
import Units from '../proj/Units.js';
import RenderFeature from '../render/Feature.js';
/**
* @typedef {Object} Options
* @property {undefined|function((ol.geom.Geometry|Object.<string,*>)=)|function(ol.geom.GeometryType,Array.<number>,(Array.<number>|Array.<Array.<number>>),Object.<string,*>,number)} featureClass
* Class for features returned by {@link ol.format.MVT#readFeatures}. Set to
* {@link ol.Feature} to get full editing and geometry support at the cost of
* decreased rendering performance. The default is {@link ol.render.Feature},
* which is optimized for rendering and hit detection.
* @property {string|undefined} geometryName Geometry name to use when creating
* features. Default is `'geometry'`.
* @property {string|undefined} layerName Name of the feature attribute that
* holds the layer name. Default is `'layer'`.
* @property {Array.<string>|undefined} layers Layers to read features from. If not
* provided, features will be read from all layers.
*/
/**
* @classdesc
* Feature format for reading data in the Mapbox MVT format.
*
* @constructor
* @extends {ol.format.Feature}
* @param {olx.format.MVTOptions=} opt_options Options.
* @param {module:ol/format/MVT~Options=} opt_options Options.
* @api
*/
const MVT = function(opt_options) {