ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Shorter module paths for default exports

Browse Source
This commit is contained in:
ahocevar
2018-04-25 17:23:56 +02:00
parent 6cb115d6a4
commit 440d1ad3e1
233 changed files with 2136 additions and 2042 deletions
Download Patch File Download Diff File Expand all files Collapse all files

132
src/ol/format/EsriJSON.js
View File

@@ -24,7 +24,7 @@ import {get as getProjection} from '../proj.js';
/**
* @const
* @type {Object.<module:ol/geom/GeometryType, function(EsriJSONGeometry): module:ol/geom/Geometry~Geometry>}
* @type {Object.<module:ol/geom/GeometryType, function(EsriJSONGeometry): module:ol/geom/Geometry>}
*/
const GEOMETRY_READERS = {};
GEOMETRY_READERS[GeometryType.POINT] = readPointGeometry;
@@ -37,7 +37,7 @@ GEOMETRY_READERS[GeometryType.MULTI_POLYGON] = readMultiPolygonGeometry;
/**
* @const
* @type {Object.<string, function(module:ol/geom/Geometry~Geometry, module:ol/format/Feature~WriteOptions=): (EsriJSONGeometry)>}
* @type {Object.<string, function(module:ol/geom/Geometry, module:ol/format/Feature~WriteOptions=): (EsriJSONGeometry)>}
*/
const GEOMETRY_WRITERS = {};
GEOMETRY_WRITERS[GeometryType.POINT] = writePointGeometry;
@@ -59,7 +59,7 @@ GEOMETRY_WRITERS[GeometryType.MULTI_POLYGON] = writeMultiPolygonGeometry;
* Feature format for reading and writing data in the EsriJSON format.
*
* @constructor
* @extends {module:ol/format/JSONFeature~JSONFeature}
* @extends {module:ol/format/JSONFeature}
* @param {module:ol/format/EsriJSON~Options=} opt_options Options.
* @api
*/
@@ -84,7 +84,7 @@ inherits(EsriJSON, JSONFeature);
/**
* @param {EsriJSONGeometry} object Object.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/geom/Geometry~Geometry} Geometry.
* @return {module:ol/geom/Geometry} Geometry.
*/
function readGeometry(object, opt_options) {
if (!object) {
@@ -115,8 +115,8 @@ function readGeometry(object, opt_options) {
}
}
const geometryReader = GEOMETRY_READERS[type];
return /** @type {module:ol/geom/Geometry~Geometry} */ (transformWithOptions(
geometryReader(object), false, opt_options)
return (
/** @type {module:ol/geom/Geometry} */ (transformWithOptions(geometryReader(object), false, opt_options))
);
}
@@ -176,7 +176,7 @@ function convertRings(rings, layout) {
/**
* @param {EsriJSONGeometry} object Object.
* @return {module:ol/geom/Geometry~Geometry} Point.
* @return {module:ol/geom/Geometry} Point.
*/
function readPointGeometry(object) {
let point;
@@ -198,7 +198,7 @@ function readPointGeometry(object) {
/**
* @param {EsriJSONGeometry} object Object.
* @return {module:ol/geom/Geometry~Geometry} LineString.
* @return {module:ol/geom/Geometry} LineString.
*/
function readLineStringGeometry(object) {
const layout = getGeometryLayout(object);
@@ -208,7 +208,7 @@ function readLineStringGeometry(object) {
/**
* @param {EsriJSONGeometry} object Object.
* @return {module:ol/geom/Geometry~Geometry} MultiLineString.
* @return {module:ol/geom/Geometry} MultiLineString.
*/
function readMultiLineStringGeometry(object) {
const layout = getGeometryLayout(object);
@@ -235,7 +235,7 @@ function getGeometryLayout(object) {
/**
* @param {EsriJSONGeometry} object Object.
* @return {module:ol/geom/Geometry~Geometry} MultiPoint.
* @return {module:ol/geom/Geometry} MultiPoint.
*/
function readMultiPointGeometry(object) {
const layout = getGeometryLayout(object);
@@ -245,7 +245,7 @@ function readMultiPointGeometry(object) {
/**
* @param {EsriJSONGeometry} object Object.
* @return {module:ol/geom/Geometry~Geometry} MultiPolygon.
* @return {module:ol/geom/Geometry} MultiPolygon.
*/
function readMultiPolygonGeometry(object) {
const layout = getGeometryLayout(object);
@@ -257,7 +257,7 @@ function readMultiPolygonGeometry(object) {
/**
* @param {EsriJSONGeometry} object Object.
* @return {module:ol/geom/Geometry~Geometry} Polygon.
* @return {module:ol/geom/Geometry} Polygon.
*/
function readPolygonGeometry(object) {
const layout = getGeometryLayout(object);
@@ -266,14 +266,14 @@ function readPolygonGeometry(object) {
/**
* @param {module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {EsriJSONGeometry} EsriJSON geometry.
*/
function writePointGeometry(geometry, opt_options) {
const coordinates = /** @type {module:ol/geom/Point~Point} */ (geometry).getCoordinates();
const coordinates = /** @type {module:ol/geom/Point} */ (geometry).getCoordinates();
let esriJSON;
const layout = /** @type {module:ol/geom/Point~Point} */ (geometry).getLayout();
const layout = /** @type {module:ol/geom/Point} */ (geometry).getLayout();
if (layout === GeometryLayout.XYZ) {
esriJSON = /** @type {EsriJSONPoint} */ ({
x: coordinates[0],
@@ -306,7 +306,7 @@ function writePointGeometry(geometry, opt_options) {
/**
* @param {module:ol/geom/SimpleGeometry~SimpleGeometry} geometry Geometry.
* @param {module:ol/geom/SimpleGeometry} geometry Geometry.
* @return {Object} Object with boolean hasZ and hasM keys.
*/
function getHasZM(geometry) {
@@ -321,76 +321,84 @@ function getHasZM(geometry) {
/**
* @param {module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {EsriJSONPolyline} EsriJSON geometry.
*/
function writeLineStringGeometry(geometry, opt_options) {
const hasZM = getHasZM(/** @type {module:ol/geom/LineString~LineString} */(geometry));
return /** @type {EsriJSONPolyline} */ ({
hasZ: hasZM.hasZ,
hasM: hasZM.hasM,
paths: [
/** @type {module:ol/geom/LineString~LineString} */ (geometry).getCoordinates()
]
});
const hasZM = getHasZM(/** @type {module:ol/geom/LineString} */(geometry));
return (
/** @type {EsriJSONPolyline} */ {
hasZ: hasZM.hasZ,
hasM: hasZM.hasM,
paths: [
/** @type {module:ol/geom/LineString} */ (geometry).getCoordinates()
]
}
);
}
/**
* @param {module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {EsriJSONPolygon} EsriJSON geometry.
*/
function writePolygonGeometry(geometry, opt_options) {
// Esri geometries use the left-hand rule
const hasZM = getHasZM(/** @type {module:ol/geom/Polygon~Polygon} */(geometry));
return /** @type {EsriJSONPolygon} */ ({
hasZ: hasZM.hasZ,
hasM: hasZM.hasM,
rings: /** @type {module:ol/geom/Polygon~Polygon} */ (geometry).getCoordinates(false)
});
const hasZM = getHasZM(/** @type {module:ol/geom/Polygon} */(geometry));
return (
/** @type {EsriJSONPolygon} */ {
hasZ: hasZM.hasZ,
hasM: hasZM.hasM,
rings: /** @type {module:ol/geom/Polygon} */ (geometry).getCoordinates(false)
}
);
}
/**
* @param {module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {EsriJSONPolyline} EsriJSON geometry.
*/
function writeMultiLineStringGeometry(geometry, opt_options) {
const hasZM = getHasZM(/** @type {module:ol/geom/MultiLineString~MultiLineString} */(geometry));
return /** @type {EsriJSONPolyline} */ ({
hasZ: hasZM.hasZ,
hasM: hasZM.hasM,
paths: /** @type {module:ol/geom/MultiLineString~MultiLineString} */ (geometry).getCoordinates()
});
const hasZM = getHasZM(/** @type {module:ol/geom/MultiLineString} */(geometry));
return (
/** @type {EsriJSONPolyline} */ {
hasZ: hasZM.hasZ,
hasM: hasZM.hasM,
paths: /** @type {module:ol/geom/MultiLineString} */ (geometry).getCoordinates()
}
);
}
/**
* @param {module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {EsriJSONMultipoint} EsriJSON geometry.
*/
function writeMultiPointGeometry(geometry, opt_options) {
const hasZM = getHasZM(/** @type {module:ol/geom/MultiPoint~MultiPoint} */(geometry));
return /** @type {EsriJSONMultipoint} */ ({
hasZ: hasZM.hasZ,
hasM: hasZM.hasM,
points: /** @type {module:ol/geom/MultiPoint~MultiPoint} */ (geometry).getCoordinates()
});
const hasZM = getHasZM(/** @type {module:ol/geom/MultiPoint} */(geometry));
return (
/** @type {EsriJSONMultipoint} */ {
hasZ: hasZM.hasZ,
hasM: hasZM.hasM,
points: /** @type {module:ol/geom/MultiPoint} */ (geometry).getCoordinates()
}
);
}
/**
* @param {module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {EsriJSONPolygon} EsriJSON geometry.
*/
function writeMultiPolygonGeometry(geometry, opt_options) {
const hasZM = getHasZM(/** @type {module:ol/geom/MultiPolygon~MultiPolygon} */(geometry));
const coordinates = /** @type {module:ol/geom/MultiPolygon~MultiPolygon} */ (geometry).getCoordinates(false);
const hasZM = getHasZM(/** @type {module:ol/geom/MultiPolygon} */(geometry));
const coordinates = /** @type {module:ol/geom/MultiPolygon} */ (geometry).getCoordinates(false);
const output = [];
for (let i = 0; i < coordinates.length; i++) {
for (let x = coordinates[i].length - 1; x >= 0; x--) {
@@ -412,7 +420,7 @@ function writeMultiPolygonGeometry(geometry, opt_options) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/Feature~Feature} Feature.
* @return {module:ol/Feature} Feature.
* @api
*/
EsriJSON.prototype.readFeature;
@@ -425,7 +433,7 @@ EsriJSON.prototype.readFeature;
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {Array.<module:ol/Feature~Feature>} Features.
* @return {Array.<module:ol/Feature>} Features.
* @api
*/
EsriJSON.prototype.readFeatures;
@@ -461,7 +469,7 @@ EsriJSON.prototype.readFeaturesFromObject = function(object, opt_options) {
const options = opt_options ? opt_options : {};
if (esriJSONObject.features) {
const esriJSONFeatureCollection = /** @type {EsriJSONFeatureCollection} */ (object);
/** @type {Array.<module:ol/Feature~Feature>} */
/** @type {Array.<module:ol/Feature>} */
const features = [];
const esriJSONFeatures = esriJSONFeatureCollection.features;
options.idField = object.objectIdFieldName;
@@ -481,7 +489,7 @@ EsriJSON.prototype.readFeaturesFromObject = function(object, opt_options) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/geom/Geometry~Geometry} Geometry.
* @return {module:ol/geom/Geometry} Geometry.
* @api
*/
EsriJSON.prototype.readGeometry;
@@ -500,7 +508,7 @@ EsriJSON.prototype.readGeometryFromObject = function(object, opt_options) {
*
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {module:ol/proj/Projection~Projection} Projection.
* @return {module:ol/proj/Projection} Projection.
* @api
*/
EsriJSON.prototype.readProjection;
@@ -521,13 +529,13 @@ EsriJSON.prototype.readProjectionFromObject = function(object) {
/**
* @param {module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {EsriJSONGeometry} EsriJSON geometry.
*/
function writeGeometry(geometry, opt_options) {
const geometryWriter = GEOMETRY_WRITERS[geometry.getType()];
return geometryWriter(/** @type {module:ol/geom/Geometry~Geometry} */(
return geometryWriter(/** @type {module:ol/geom/Geometry} */(
transformWithOptions(geometry, true, opt_options)), opt_options);
}
@@ -536,7 +544,7 @@ function writeGeometry(geometry, opt_options) {
* Encode a geometry as a EsriJSON string.
*
* @function
* @param {module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} EsriJSON.
* @api
@@ -547,7 +555,7 @@ EsriJSON.prototype.writeGeometry;
/**
* Encode a geometry as a EsriJSON object.
*
* @param {module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {EsriJSONGeometry} Object.
* @override
@@ -562,7 +570,7 @@ EsriJSON.prototype.writeGeometryObject = function(geometry, opt_options) {
* Encode a feature as a EsriJSON Feature string.
*
* @function
* @param {module:ol/Feature~Feature} feature Feature.
* @param {module:ol/Feature} feature Feature.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} EsriJSON.
* @api
@@ -573,7 +581,7 @@ EsriJSON.prototype.writeFeature;
/**
* Encode a feature as a esriJSON Feature object.
*
* @param {module:ol/Feature~Feature} feature Feature.
* @param {module:ol/Feature} feature Feature.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {Object} Object.
* @override
@@ -606,7 +614,7 @@ EsriJSON.prototype.writeFeatureObject = function(feature, opt_options) {
* Encode an array of features as EsriJSON.
*
* @function
* @param {Array.<module:ol/Feature~Feature>} features Features.
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} EsriJSON.
* @api
@@ -617,7 +625,7 @@ EsriJSON.prototype.writeFeatures;
/**
* Encode an array of features as a EsriJSON object.
*
* @param {Array.<module:ol/Feature~Feature>} features Features.
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {Object} EsriJSON Object.
* @override

24
src/ol/format/Feature.js
View File

@@ -64,13 +64,13 @@ const FeatureFormat = function() {
/**
* @protected
* @type {module:ol/proj/Projection~Projection}
* @type {module:ol/proj/Projection}
*/
this.defaultDataProjection = null;
/**
* @protected
* @type {module:ol/proj/Projection~Projection}
* @type {module:ol/proj/Projection}
*/
this.defaultFeatureProjection = null;
@@ -136,7 +136,7 @@ FeatureFormat.prototype.getType = function() {};
* @abstract
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/Feature~Feature} Feature.
* @return {module:ol/Feature} Feature.
*/
FeatureFormat.prototype.readFeature = function(source, opt_options) {};
@@ -147,7 +147,7 @@ FeatureFormat.prototype.readFeature = function(source, opt_options) {};
* @abstract
* @param {Document|Node|ArrayBuffer|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {Array.<module:ol/Feature~Feature>} Features.
* @return {Array.<module:ol/Feature>} Features.
*/
FeatureFormat.prototype.readFeatures = function(source, opt_options) {};
@@ -158,7 +158,7 @@ FeatureFormat.prototype.readFeatures = function(source, opt_options) {};
* @abstract
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/geom/Geometry~Geometry} Geometry.
* @return {module:ol/geom/Geometry} Geometry.
*/
FeatureFormat.prototype.readGeometry = function(source, opt_options) {};
@@ -168,7 +168,7 @@ FeatureFormat.prototype.readGeometry = function(source, opt_options) {};
*
* @abstract
* @param {Document|Node|Object|string} source Source.
* @return {module:ol/proj/Projection~Projection} Projection.
* @return {module:ol/proj/Projection} Projection.
*/
FeatureFormat.prototype.readProjection = function(source) {};
@@ -177,7 +177,7 @@ FeatureFormat.prototype.readProjection = function(source) {};
* Encode a feature in this format.
*
* @abstract
* @param {module:ol/Feature~Feature} feature Feature.
* @param {module:ol/Feature} feature Feature.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} Result.
*/
@@ -188,7 +188,7 @@ FeatureFormat.prototype.writeFeature = function(feature, opt_options) {};
* Encode an array of features in this format.
*
* @abstract
* @param {Array.<module:ol/Feature~Feature>} features Features.
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} Result.
*/
@@ -199,7 +199,7 @@ FeatureFormat.prototype.writeFeatures = function(features, opt_options) {};
* Write a single geometry in this format.
*
* @abstract
* @param {module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} Result.
*/
@@ -208,11 +208,11 @@ FeatureFormat.prototype.writeGeometry = function(geometry, opt_options) {};
export default FeatureFormat;
/**
* @param {module:ol/geom/Geometry~Geometry|module:ol/extent~Extent} geometry Geometry.
* @param {module:ol/geom/Geometry|module:ol/extent~Extent} geometry Geometry.
* @param {boolean} write Set to true for writing, false for reading.
* @param {(module:ol/format/Feature~WriteOptions|module:ol/format/Feature~ReadOptions)=} opt_options
* Options.
* @return {module:ol/geom/Geometry~Geometry|module:ol/extent~Extent} Transformed geometry.
* @return {module:ol/geom/Geometry|module:ol/extent~Extent} Transformed geometry.
*/
export function transformWithOptions(geometry, write, opt_options) {
const featureProjection = opt_options ?
@@ -220,7 +220,7 @@ export function transformWithOptions(geometry, write, opt_options) {
const dataProjection = opt_options ?
getProjection(opt_options.dataProjection) : null;
/**
* @type {module:ol/geom/Geometry~Geometry|module:ol/extent~Extent}
* @type {module:ol/geom/Geometry|module:ol/extent~Extent}
*/
let transformed;
if (featureProjection && dataProjection &&

6
src/ol/format/GML.js
View File

@@ -12,7 +12,7 @@ import GML3 from '../format/GML3.js';
* @constructor
* @param {module:ol/format/GMLBase~Options=} opt_options
* Optional configuration object.
* @extends {module:ol/format/GMLBase~GMLBase}
* @extends {module:ol/format/GMLBase}
* @api
*/
const GML = GML3;
@@ -22,7 +22,7 @@ const GML = GML3;
* Encode an array of features in GML 3.1.1 Simple Features.
*
* @function
* @param {Array.<module:ol/Feature~Feature>} features Features.
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Options.
* @return {string} Result.
* @api
@@ -34,7 +34,7 @@ GML.prototype.writeFeatures;
* Encode an array of features in the GML 3.1.1 format as an XML node.
*
* @function
* @param {Array.<module:ol/Feature~Feature>} features Features.
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Options.
* @return {Node} Node.
* @api

38
src/ol/format/GML2.js
View File

@@ -27,7 +27,7 @@ const schemaLocation = GMLNS + ' http://schemas.opengis.net/gml/2.1.2/feature.xs
*
* @constructor
* @param {module:ol/format/GMLBase~Options=} opt_options Optional configuration object.
* @extends {module:ol/format/GMLBase~GMLBase}
* @extends {module:ol/format/GMLBase}
* @api
*/
const GML2 = function(opt_options) {
@@ -150,7 +150,7 @@ GML2.prototype.GEOMETRY_NODE_FACTORY_ = function(value, objectStack, opt_nodeNam
const multiCurve = context['multiCurve'];
let nodeName;
if (!Array.isArray(value)) {
nodeName = /** @type {module:ol/geom/Geometry~Geometry} */ (value).getType();
nodeName = /** @type {module:ol/geom/Geometry} */ (value).getType();
if (nodeName === 'MultiPolygon' && multiSurface === true) {
nodeName = 'MultiSurface';
} else if (nodeName === 'Polygon' && surface === true) {
@@ -168,7 +168,7 @@ GML2.prototype.GEOMETRY_NODE_FACTORY_ = function(value, objectStack, opt_nodeNam
/**
* @param {Node} node Node.
* @param {module:ol/Feature~Feature} feature Feature.
* @param {module:ol/Feature} feature Feature.
* @param {Array.<*>} objectStack Node stack.
*/
GML2.prototype.writeFeatureElement = function(node, feature, objectStack) {
@@ -215,7 +215,7 @@ GML2.prototype.writeFeatureElement = function(node, feature, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/geom/LineString~LineString} geometry LineString geometry.
* @param {module:ol/geom/LineString} geometry LineString geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
@@ -241,7 +241,7 @@ GML2.prototype.writeCurveOrLineString_ = function(node, geometry, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/geom/LineString~LineString} line LineString geometry.
* @param {module:ol/geom/LineString} line LineString geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
@@ -256,7 +256,7 @@ GML2.prototype.writeLineStringOrCurveMember_ = function(node, line, objectStack)
/**
* @param {Node} node Node.
* @param {module:ol/geom/MultiLineString~MultiLineString} geometry MultiLineString geometry.
* @param {module:ol/geom/MultiLineString} geometry MultiLineString geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
@@ -278,7 +278,7 @@ GML2.prototype.writeMultiCurveOrLineString_ = function(node, geometry, objectSta
/**
* @param {Node} node Node.
* @param {module:ol/geom/Geometry~Geometry|module:ol/extent~Extent} geometry Geometry.
* @param {module:ol/geom/Geometry|module:ol/extent~Extent} geometry Geometry.
* @param {Array.<*>} objectStack Node stack.
*/
GML2.prototype.writeGeometryElement = function(node, geometry, objectStack) {
@@ -294,7 +294,7 @@ GML2.prototype.writeGeometryElement = function(node, geometry, objectStack) {
value = geometry;
}
} else {
value = transformWithOptions(/** @type {module:ol/geom/Geometry~Geometry} */ (geometry), true, context);
value = transformWithOptions(/** @type {module:ol/geom/Geometry} */ (geometry), true, context);
}
pushSerializeAndPop(/** @type {module:ol/xml~NodeStackItem} */
(item), this.GEOMETRY_SERIALIZERS_,
@@ -320,7 +320,7 @@ GML2.prototype.createCoordinatesNode_ = function(namespaceURI) {
/**
* @param {Node} node Node.
* @param {module:ol/geom/LineString~LineString|module:ol/geom/LinearRing~LinearRing} value Geometry.
* @param {module:ol/geom/LineString|module:ol/geom/LinearRing} value Geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
@@ -342,7 +342,7 @@ GML2.prototype.writeCoordinates_ = function(node, value, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/geom/LineString~LineString} line LineString geometry.
* @param {module:ol/geom/LineString} line LineString geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
@@ -355,7 +355,7 @@ GML2.prototype.writeCurveSegments_ = function(node, line, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/geom/Polygon~Polygon} geometry Polygon geometry.
* @param {module:ol/geom/Polygon} geometry Polygon geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
@@ -403,7 +403,7 @@ GML2.prototype.RING_NODE_FACTORY_ = function(value, objectStack, opt_nodeName) {
/**
* @param {Node} node Node.
* @param {module:ol/geom/Polygon~Polygon} polygon Polygon geometry.
* @param {module:ol/geom/Polygon} polygon Polygon geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
@@ -416,7 +416,7 @@ GML2.prototype.writeSurfacePatches_ = function(node, polygon, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/geom/LinearRing~LinearRing} ring LinearRing geometry.
* @param {module:ol/geom/LinearRing} ring LinearRing geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
@@ -454,7 +454,7 @@ GML2.prototype.getCoords_ = function(point, opt_srsName, opt_hasZ) {
/**
* @param {Node} node Node.
* @param {module:ol/geom/Point~Point} geometry Point geometry.
* @param {module:ol/geom/Point} geometry Point geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
@@ -475,7 +475,7 @@ GML2.prototype.writePoint_ = function(node, geometry, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/geom/MultiPoint~MultiPoint} geometry MultiPoint geometry.
* @param {module:ol/geom/MultiPoint} geometry MultiPoint geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
@@ -496,7 +496,7 @@ GML2.prototype.writeMultiPoint_ = function(node, geometry, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/geom/Point~Point} point Point geometry.
* @param {module:ol/geom/Point} point Point geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
@@ -509,7 +509,7 @@ GML2.prototype.writePointMember_ = function(node, point, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/geom/LinearRing~LinearRing} geometry LinearRing geometry.
* @param {module:ol/geom/LinearRing} geometry LinearRing geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
@@ -527,7 +527,7 @@ GML2.prototype.writeLinearRing_ = function(node, geometry, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/geom/MultiPolygon~MultiPolygon} geometry MultiPolygon geometry.
* @param {module:ol/geom/MultiPolygon} geometry MultiPolygon geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
@@ -549,7 +549,7 @@ GML2.prototype.writeMultiSurfaceOrPolygon_ = function(node, geometry, objectStac
/**
* @param {Node} node Node.
* @param {module:ol/geom/Polygon~Polygon} polygon Polygon geometry.
* @param {module:ol/geom/Polygon} polygon Polygon geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/

60
src/ol/format/GML3.js
View File

@@ -39,7 +39,7 @@ const schemaLocation = GMLNS +
* @constructor
* @param {module:ol/format/GMLBase~Options=} opt_options
* Optional configuration object.
* @extends {module:ol/format/GMLBase~GMLBase}
* @extends {module:ol/format/GMLBase}
* @api
*/
const GML3 = function(opt_options) {
@@ -96,10 +96,10 @@ inherits(GML3, GMLBase);
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @private
* @return {module:ol/geom/MultiLineString~MultiLineString|undefined} MultiLineString.
* @return {module:ol/geom/MultiLineString|undefined} MultiLineString.
*/
GML3.prototype.readMultiCurve_ = function(node, objectStack) {
/** @type {Array.<module:ol/geom/LineString~LineString>} */
/** @type {Array.<module:ol/geom/LineString>} */
const lineStrings = pushParseAndPop([],
this.MULTICURVE_PARSERS_, node, objectStack, this);
if (lineStrings) {
@@ -116,10 +116,10 @@ GML3.prototype.readMultiCurve_ = function(node, objectStack) {
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @private
* @return {module:ol/geom/MultiPolygon~MultiPolygon|undefined} MultiPolygon.
* @return {module:ol/geom/MultiPolygon|undefined} MultiPolygon.
*/
GML3.prototype.readMultiSurface_ = function(node, objectStack) {
/** @type {Array.<module:ol/geom/Polygon~Polygon>} */
/** @type {Array.<module:ol/geom/Polygon>} */
const polygons = pushParseAndPop([],
this.MULTISURFACE_PARSERS_, node, objectStack, this);
if (polygons) {
@@ -240,7 +240,7 @@ GML3.prototype.exteriorParser_ = function(node, objectStack) {
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @private
* @return {module:ol/geom/Polygon~Polygon|undefined} Polygon.
* @return {module:ol/geom/Polygon|undefined} Polygon.
*/
GML3.prototype.readSurface_ = function(node, objectStack) {
/** @type {Array.<Array.<number>>} */
@@ -268,7 +268,7 @@ GML3.prototype.readSurface_ = function(node, objectStack) {
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @private
* @return {module:ol/geom/LineString~LineString|undefined} LineString.
* @return {module:ol/geom/LineString|undefined} LineString.
*/
GML3.prototype.readCurve_ = function(node, objectStack) {
/** @type {Array.<number>} */
@@ -573,7 +573,7 @@ GML3.prototype.SEGMENTS_PARSERS_ = {
/**
* @param {Node} node Node.
* @param {module:ol/geom/Point~Point} value Point geometry.
* @param {module:ol/geom/Point} value Point geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
@@ -631,7 +631,7 @@ GML3.prototype.getCoords_ = function(point, opt_srsName, opt_hasZ) {
/**
* @param {Node} node Node.
* @param {module:ol/geom/LineString~LineString|module:ol/geom/LinearRing~LinearRing} value Geometry.
* @param {module:ol/geom/LineString|module:ol/geom/LinearRing} value Geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
@@ -656,7 +656,7 @@ GML3.prototype.writePosList_ = function(node, value, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/geom/Point~Point} geometry Point geometry.
* @param {module:ol/geom/Point} geometry Point geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
@@ -695,7 +695,7 @@ GML3.prototype.writeEnvelope = function(node, extent, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/geom/LinearRing~LinearRing} geometry LinearRing geometry.
* @param {module:ol/geom/LinearRing} geometry LinearRing geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
@@ -732,7 +732,7 @@ GML3.prototype.RING_NODE_FACTORY_ = function(value, objectStack, opt_nodeName) {
/**
* @param {Node} node Node.
* @param {module:ol/geom/Polygon~Polygon} geometry Polygon geometry.
* @param {module:ol/geom/Polygon} geometry Polygon geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
@@ -761,7 +761,7 @@ GML3.prototype.writeSurfaceOrPolygon_ = function(node, geometry, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/geom/LineString~LineString} geometry LineString geometry.
* @param {module:ol/geom/LineString} geometry LineString geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
@@ -787,7 +787,7 @@ GML3.prototype.writeCurveOrLineString_ = function(node, geometry, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/geom/MultiPolygon~MultiPolygon} geometry MultiPolygon geometry.
* @param {module:ol/geom/MultiPolygon} geometry MultiPolygon geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
@@ -809,7 +809,7 @@ GML3.prototype.writeMultiSurfaceOrPolygon_ = function(node, geometry, objectStac
/**
* @param {Node} node Node.
* @param {module:ol/geom/MultiPoint~MultiPoint} geometry MultiPoint geometry.
* @param {module:ol/geom/MultiPoint} geometry MultiPoint geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
@@ -830,7 +830,7 @@ GML3.prototype.writeMultiPoint_ = function(node, geometry, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/geom/MultiLineString~MultiLineString} geometry MultiLineString geometry.
* @param {module:ol/geom/MultiLineString} geometry MultiLineString geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
@@ -852,7 +852,7 @@ GML3.prototype.writeMultiCurveOrLineString_ = function(node, geometry, objectSta
/**
* @param {Node} node Node.
* @param {module:ol/geom/LinearRing~LinearRing} ring LinearRing geometry.
* @param {module:ol/geom/LinearRing} ring LinearRing geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
@@ -865,7 +865,7 @@ GML3.prototype.writeRing_ = function(node, ring, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/geom/Polygon~Polygon} polygon Polygon geometry.
* @param {module:ol/geom/Polygon} polygon Polygon geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
@@ -881,7 +881,7 @@ GML3.prototype.writeSurfaceOrPolygonMember_ = function(node, polygon, objectStac
/**
* @param {Node} node Node.
* @param {module:ol/geom/Point~Point} point Point geometry.
* @param {module:ol/geom/Point} point Point geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
@@ -894,7 +894,7 @@ GML3.prototype.writePointMember_ = function(node, point, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/geom/LineString~LineString} line LineString geometry.
* @param {module:ol/geom/LineString} line LineString geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
@@ -909,7 +909,7 @@ GML3.prototype.writeLineStringOrCurveMember_ = function(node, line, objectStack)
/**
* @param {Node} node Node.
* @param {module:ol/geom/Polygon~Polygon} polygon Polygon geometry.
* @param {module:ol/geom/Polygon} polygon Polygon geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
@@ -922,7 +922,7 @@ GML3.prototype.writeSurfacePatches_ = function(node, polygon, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/geom/LineString~LineString} line LineString geometry.
* @param {module:ol/geom/LineString} line LineString geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
@@ -936,7 +936,7 @@ GML3.prototype.writeCurveSegments_ = function(node, line, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/geom/Geometry~Geometry|module:ol/extent~Extent} geometry Geometry.
* @param {module:ol/geom/Geometry|module:ol/extent~Extent} geometry Geometry.
* @param {Array.<*>} objectStack Node stack.
*/
GML3.prototype.writeGeometryElement = function(node, geometry, objectStack) {
@@ -952,7 +952,7 @@ GML3.prototype.writeGeometryElement = function(node, geometry, objectStack) {
value = geometry;
}
} else {
value = transformWithOptions(/** @type {module:ol/geom/Geometry~Geometry} */ (geometry), true, context);
value = transformWithOptions(/** @type {module:ol/geom/Geometry} */ (geometry), true, context);
}
pushSerializeAndPop(/** @type {module:ol/xml~NodeStackItem} */
(item), this.GEOMETRY_SERIALIZERS_,
@@ -963,7 +963,7 @@ GML3.prototype.writeGeometryElement = function(node, geometry, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/Feature~Feature} feature Feature.
* @param {module:ol/Feature} feature Feature.
* @param {Array.<*>} objectStack Node stack.
*/
GML3.prototype.writeFeatureElement = function(node, feature, objectStack) {
@@ -1010,7 +1010,7 @@ GML3.prototype.writeFeatureElement = function(node, feature, objectStack) {
/**
* @param {Node} node Node.
* @param {Array.<module:ol/Feature~Feature>} features Features.
* @param {Array.<module:ol/Feature>} features Features.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
@@ -1075,7 +1075,7 @@ GML3.prototype.GEOMETRY_NODE_FACTORY_ = function(value, objectStack, opt_nodeNam
const multiCurve = context['multiCurve'];
let nodeName;
if (!Array.isArray(value)) {
nodeName = /** @type {module:ol/geom/Geometry~Geometry} */ (value).getType();
nodeName = /** @type {module:ol/geom/Geometry} */ (value).getType();
if (nodeName === 'MultiPolygon' && multiSurface === true) {
nodeName = 'MultiSurface';
} else if (nodeName === 'Polygon' && surface === true) {
@@ -1096,7 +1096,7 @@ GML3.prototype.GEOMETRY_NODE_FACTORY_ = function(value, objectStack, opt_nodeNam
/**
* Encode a geometry in GML 3.1.1 Simple Features.
*
* @param {module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Options.
* @return {Node} Node.
* @override
@@ -1120,7 +1120,7 @@ GML3.prototype.writeGeometryNode = function(geometry, opt_options) {
* Encode an array of features in GML 3.1.1 Simple Features.
*
* @function
* @param {Array.<module:ol/Feature~Feature>} features Features.
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Options.
* @return {string} Result.
* @api
@@ -1131,7 +1131,7 @@ GML3.prototype.writeFeatures;
/**
* Encode an array of features in the GML 3.1.1 format as an XML node.
*
* @param {Array.<module:ol/Feature~Feature>} features Features.
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Options.
* @return {Node} Node.
* @override

34
src/ol/format/GMLBase.js
View File

@@ -74,7 +74,7 @@ export const GMLNS = 'http://www.opengis.net/gml';
* @abstract
* @param {module:ol/format/GMLBase~Options=} opt_options
* Optional configuration object.
* @extends {module:ol/format/XMLFeature~XMLFeature}
* @extends {module:ol/format/XMLFeature}
*/
const GMLBase = function(opt_options) {
const options = /** @type {module:ol/format/GMLBase~Options} */ (opt_options ? opt_options : {});
@@ -135,7 +135,7 @@ const ONLY_WHITESPACE_RE = /^[\s\xa0]*$/;
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {Array.<module:ol/Feature~Feature> | undefined} Features.
* @return {Array.<module:ol/Feature> | undefined} Features.
*/
GMLBase.prototype.readFeaturesInternal = function(node, objectStack) {
const localName = node.localName;
@@ -224,16 +224,18 @@ GMLBase.prototype.readFeaturesInternal = function(node, objectStack) {
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/geom/Geometry~Geometry|undefined} Geometry.
* @return {module:ol/geom/Geometry|undefined} Geometry.
*/
GMLBase.prototype.readGeometryElement = function(node, objectStack) {
const context = /** @type {Object} */ (objectStack[0]);
context['srsName'] = node.firstElementChild.getAttribute('srsName');
context['srsDimension'] = node.firstElementChild.getAttribute('srsDimension');
/** @type {module:ol/geom/Geometry~Geometry} */
/** @type {module:ol/geom/Geometry} */
const geometry = pushParseAndPop(null, this.GEOMETRY_PARSERS_, node, objectStack, this);
if (geometry) {
return /** @type {module:ol/geom/Geometry~Geometry} */ (transformWithOptions(geometry, false, context));
return (
/** @type {module:ol/geom/Geometry} */ (transformWithOptions(geometry, false, context))
);
} else {
return undefined;
}
@@ -243,7 +245,7 @@ GMLBase.prototype.readGeometryElement = function(node, objectStack) {
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/Feature~Feature} Feature.
* @return {module:ol/Feature} Feature.
*/
GMLBase.prototype.readFeatureElement = function(node, objectStack) {
let n;
@@ -285,7 +287,7 @@ GMLBase.prototype.readFeatureElement = function(node, objectStack) {
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/geom/Point~Point|undefined} Point.
* @return {module:ol/geom/Point|undefined} Point.
*/
GMLBase.prototype.readPoint = function(node, objectStack) {
const flatCoordinates = this.readFlatCoordinatesFromNode_(node, objectStack);
@@ -300,7 +302,7 @@ GMLBase.prototype.readPoint = function(node, objectStack) {
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/geom/MultiPoint~MultiPoint|undefined} MultiPoint.
* @return {module:ol/geom/MultiPoint|undefined} MultiPoint.
*/
GMLBase.prototype.readMultiPoint = function(node, objectStack) {
/** @type {Array.<Array.<number>>} */
@@ -317,10 +319,10 @@ GMLBase.prototype.readMultiPoint = function(node, objectStack) {
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/geom/MultiLineString~MultiLineString|undefined} MultiLineString.
* @return {module:ol/geom/MultiLineString|undefined} MultiLineString.
*/
GMLBase.prototype.readMultiLineString = function(node, objectStack) {
/** @type {Array.<module:ol/geom/LineString~LineString>} */
/** @type {Array.<module:ol/geom/LineString>} */
const lineStrings = pushParseAndPop([],
this.MULTILINESTRING_PARSERS_, node, objectStack, this);
if (lineStrings) {
@@ -336,10 +338,10 @@ GMLBase.prototype.readMultiLineString = function(node, objectStack) {
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/geom/MultiPolygon~MultiPolygon|undefined} MultiPolygon.
* @return {module:ol/geom/MultiPolygon|undefined} MultiPolygon.
*/
GMLBase.prototype.readMultiPolygon = function(node, objectStack) {
/** @type {Array.<module:ol/geom/Polygon~Polygon>} */
/** @type {Array.<module:ol/geom/Polygon>} */
const polygons = pushParseAndPop([], this.MULTIPOLYGON_PARSERS_, node, objectStack, this);
if (polygons) {
const multiPolygon = new MultiPolygon(null);
@@ -384,7 +386,7 @@ GMLBase.prototype.polygonMemberParser_ = function(node, objectStack) {
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/geom/LineString~LineString|undefined} LineString.
* @return {module:ol/geom/LineString|undefined} LineString.
*/
GMLBase.prototype.readLineString = function(node, objectStack) {
const flatCoordinates = this.readFlatCoordinatesFromNode_(node, objectStack);
@@ -419,7 +421,7 @@ GMLBase.prototype.readFlatLinearRing_ = function(node, objectStack) {
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/geom/LinearRing~LinearRing|undefined} LinearRing.
* @return {module:ol/geom/LinearRing|undefined} LinearRing.
*/
GMLBase.prototype.readLinearRing = function(node, objectStack) {
const flatCoordinates = this.readFlatCoordinatesFromNode_(node, objectStack);
@@ -436,7 +438,7 @@ GMLBase.prototype.readLinearRing = function(node, objectStack) {
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/geom/Polygon~Polygon|undefined} Polygon.
* @return {module:ol/geom/Polygon|undefined} Polygon.
*/
GMLBase.prototype.readPolygon = function(node, objectStack) {
/** @type {Array.<Array.<number>>} */
@@ -573,7 +575,7 @@ GMLBase.prototype.readGeometryFromNode = function(node, opt_options) {
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Options.
* @return {Array.<module:ol/Feature~Feature>} Features.
* @return {Array.<module:ol/Feature>} Features.
* @api
*/
GMLBase.prototype.readFeatures;

44
src/ol/format/GPX.js
View File

@@ -20,7 +20,7 @@ import {createElementNS, makeArrayPusher, makeArraySerializer, makeChildAppender
/**
* @typedef {Object} Options
* @property {function(module:ol/Feature~Feature, Node)} [readExtensions] Callback function
* @property {function(module:ol/Feature, Node)} [readExtensions] Callback function
* to process `extensions` nodes. To prevent memory leaks, this callback function must
* not store any references to the node. Note that the `extensions`
* node is not allowed in GPX 1.0. Moreover, only `extensions`
@@ -39,7 +39,7 @@ import {createElementNS, makeArrayPusher, makeArraySerializer, makeChildAppender
* Feature format for reading and writing data in the GPX format.
*
* @constructor
* @extends {module:ol/format/XMLFeature~XMLFeature}
* @extends {module:ol/format/XMLFeature}
* @param {module:ol/format/GPX~Options=} opt_options Options.
* @api
*/
@@ -55,7 +55,7 @@ const GPX = function(opt_options) {
this.defaultDataProjection = getProjection('EPSG:4326');
/**
* @type {function(module:ol/Feature~Feature, Node)|undefined}
* @type {function(module:ol/Feature, Node)|undefined}
* @private
*/
this.readExtensions_ = options.readExtensions;
@@ -85,7 +85,7 @@ const SCHEMA_LOCATION = 'http://www.topografix.com/GPX/1/1 ' +
/**
* @const
* @type {Object.<string, function(Node, Array.<*>): (module:ol/Feature~Feature|undefined)>}
* @type {Object.<string, function(Node, Array.<*>): (module:ol/Feature|undefined)>}
*/
const FEATURE_READER = {
'rte': readRte,
@@ -369,7 +369,7 @@ const GEOMETRY_TYPE_TO_NODENAME = {
* @return {Node|undefined} Node.
*/
function GPX_NODE_FACTORY(value, objectStack, opt_nodeName) {
const geometry = /** @type {module:ol/Feature~Feature} */ (value).getGeometry();
const geometry = /** @type {module:ol/Feature} */ (value).getGeometry();
if (geometry) {
const nodeName = GEOMETRY_TYPE_TO_NODENAME[geometry.getType()];
if (nodeName) {
@@ -536,7 +536,7 @@ function parseTrkSeg(node, objectStack) {
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/Feature~Feature|undefined} Track.
* @return {module:ol/Feature|undefined} Track.
*/
function readRte(node, objectStack) {
const options = /** @type {module:ol/format/Feature~ReadOptions} */ (objectStack[0]);
@@ -565,7 +565,7 @@ function readRte(node, objectStack) {
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/Feature~Feature|undefined} Track.
* @return {module:ol/Feature|undefined} Track.
*/
function readTrk(node, objectStack) {
const options = /** @type {module:ol/format/Feature~ReadOptions} */ (objectStack[0]);
@@ -597,7 +597,7 @@ function readTrk(node, objectStack) {
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/Feature~Feature|undefined} Waypoint.
* @return {module:ol/Feature|undefined} Waypoint.
*/
function readWpt(node, objectStack) {
const options = /** @type {module:ol/format/Feature~ReadOptions} */ (objectStack[0]);
@@ -617,7 +617,7 @@ function readWpt(node, objectStack) {
/**
* @param {Array.<module:ol/Feature~Feature>} features List of features.
* @param {Array.<module:ol/Feature>} features List of features.
* @private
*/
GPX.prototype.handleReadExtensions_ = function(features) {
@@ -643,7 +643,7 @@ GPX.prototype.handleReadExtensions_ = function(features) {
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/Feature~Feature} Feature.
* @return {module:ol/Feature} Feature.
* @api
*/
GPX.prototype.readFeature;
@@ -677,7 +677,7 @@ GPX.prototype.readFeatureFromNode = function(node, opt_options) {
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {Array.<module:ol/Feature~Feature>} Features.
* @return {Array.<module:ol/Feature>} Features.
* @api
*/
GPX.prototype.readFeatures;
@@ -691,7 +691,7 @@ GPX.prototype.readFeaturesFromNode = function(node, opt_options) {
return [];
}
if (node.localName == 'gpx') {
/** @type {Array.<module:ol/Feature~Feature>} */
/** @type {Array.<module:ol/Feature>} */
const features = pushParseAndPop([], GPX_PARSERS,
node, [this.getReadOptions(node, opt_options)]);
if (features) {
@@ -710,7 +710,7 @@ GPX.prototype.readFeaturesFromNode = function(node, opt_options) {
*
* @function
* @param {Document|Node|Object|string} source Source.
* @return {module:ol/proj/Projection~Projection} Projection.
* @return {module:ol/proj/Projection} Projection.
* @api
*/
GPX.prototype.readProjection;
@@ -781,7 +781,7 @@ function writeWptType(node, coordinate, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/Feature~Feature} feature Feature.
* @param {module:ol/Feature} feature Feature.
* @param {Array.<*>} objectStack Object stack.
*/
function writeRte(node, feature, objectStack) {
@@ -790,7 +790,7 @@ function writeRte(node, feature, objectStack) {
const context = {node: node, 'properties': properties};
let geometry = feature.getGeometry();
if (geometry) {
geometry = /** @type {module:ol/geom/LineString~LineString} */ (transformWithOptions(geometry, true, options));
geometry = /** @type {module:ol/geom/LineString} */ (transformWithOptions(geometry, true, options));
context['geometryLayout'] = geometry.getLayout();
properties['rtept'] = geometry.getCoordinates();
}
@@ -805,7 +805,7 @@ function writeRte(node, feature, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/Feature~Feature} feature Feature.
* @param {module:ol/Feature} feature Feature.
* @param {Array.<*>} objectStack Object stack.
*/
function writeTrk(node, feature, objectStack) {
@@ -815,7 +815,7 @@ function writeTrk(node, feature, objectStack) {
const context = {node: node, 'properties': properties};
let geometry = feature.getGeometry();
if (geometry) {
geometry = /** @type {module:ol/geom/MultiLineString~MultiLineString} */
geometry = /** @type {module:ol/geom/MultiLineString} */
(transformWithOptions(geometry, true, options));
properties['trkseg'] = geometry.getLineStrings();
}
@@ -830,7 +830,7 @@ function writeTrk(node, feature, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/geom/LineString~LineString} lineString LineString.
* @param {module:ol/geom/LineString} lineString LineString.
* @param {Array.<*>} objectStack Object stack.
*/
function writeTrkSeg(node, lineString, objectStack) {
@@ -845,7 +845,7 @@ function writeTrkSeg(node, lineString, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/Feature~Feature} feature Feature.
* @param {module:ol/Feature} feature Feature.
* @param {Array.<*>} objectStack Object stack.
*/
function writeWpt(node, feature, objectStack) {
@@ -854,7 +854,7 @@ function writeWpt(node, feature, objectStack) {
context['properties'] = feature.getProperties();
let geometry = feature.getGeometry();
if (geometry) {
geometry = /** @type {module:ol/geom/Point~Point} */
geometry = /** @type {module:ol/geom/Point} */
(transformWithOptions(geometry, true, options));
context['geometryLayout'] = geometry.getLayout();
writeWptType(node, geometry.getCoordinates(), objectStack);
@@ -868,7 +868,7 @@ function writeWpt(node, feature, objectStack) {
* as tracks (`<trk>`).
*
* @function
* @param {Array.<module:ol/Feature~Feature>} features Features.
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} Result.
* @api
@@ -881,7 +881,7 @@ GPX.prototype.writeFeatures;
* LineString geometries are output as routes (`<rte>`), and MultiLineString
* as tracks (`<trk>`).
*
* @param {Array.<module:ol/Feature~Feature>} features Features.
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Options.
* @return {Node} Node.
* @override

76
src/ol/format/GeoJSON.js
View File

@@ -38,7 +38,7 @@ import {get as getProjection} from '../proj.js';
* Feature format for reading and writing data in the GeoJSON format.
*
* @constructor
* @extends {module:ol/format/JSONFeature~JSONFeature}
* @extends {module:ol/format/JSONFeature}
* @param {module:ol/format/GeoJSON~Options=} opt_options Options.
* @api
*/
@@ -81,7 +81,7 @@ inherits(GeoJSON, JSONFeature);
/**
* @const
* @type {Object.<string, function(GeoJSONObject): module:ol/geom/Geometry~Geometry>}
* @type {Object.<string, function(GeoJSONObject): module:ol/geom/Geometry>}
*/
const GEOMETRY_READERS = {
'Point': readPointGeometry,
@@ -96,7 +96,7 @@ const GEOMETRY_READERS = {
/**
* @const
* @type {Object.<string, function(module:ol/geom/Geometry~Geometry, module:ol/format/Feature~WriteOptions=): (GeoJSONGeometry|GeoJSONGeometryCollection)>}
* @type {Object.<string, function(module:ol/geom/Geometry, module:ol/format/Feature~WriteOptions=): (GeoJSONGeometry|GeoJSONGeometryCollection)>}
*/
const GEOMETRY_WRITERS = {
'Point': writePointGeometry,
@@ -113,15 +113,15 @@ const GEOMETRY_WRITERS = {
/**
* @param {GeoJSONGeometry|GeoJSONGeometryCollection} object Object.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/geom/Geometry~Geometry} Geometry.
* @return {module:ol/geom/Geometry} Geometry.
*/
function readGeometry(object, opt_options) {
if (!object) {
return null;
}
const geometryReader = GEOMETRY_READERS[object.type];
return /** @type {module:ol/geom/Geometry~Geometry} */ (transformWithOptions(
geometryReader(object), false, opt_options)
return (
/** @type {module:ol/geom/Geometry} */ (transformWithOptions(geometryReader(object), false, opt_options))
);
}
@@ -129,13 +129,13 @@ function readGeometry(object, opt_options) {
/**
* @param {GeoJSONGeometryCollection} object Object.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/geom/GeometryCollection~GeometryCollection} Geometry collection.
* @return {module:ol/geom/GeometryCollection} Geometry collection.
*/
function readGeometryCollectionGeometry(object, opt_options) {
const geometries = object.geometries.map(
/**
* @param {GeoJSONGeometry} geometry Geometry.
* @return {module:ol/geom/Geometry~Geometry} geometry Geometry.
* @return {module:ol/geom/Geometry} geometry Geometry.
*/
function(geometry) {
return readGeometry(geometry, opt_options);
@@ -146,7 +146,7 @@ function readGeometryCollectionGeometry(object, opt_options) {
/**
* @param {GeoJSONGeometry} object Object.
* @return {module:ol/geom/Point~Point} Point.
* @return {module:ol/geom/Point} Point.
*/
function readPointGeometry(object) {
return new Point(object.coordinates);
@@ -155,7 +155,7 @@ function readPointGeometry(object) {
/**
* @param {GeoJSONGeometry} object Object.
* @return {module:ol/geom/LineString~LineString} LineString.
* @return {module:ol/geom/LineString} LineString.
*/
function readLineStringGeometry(object) {
return new LineString(object.coordinates);
@@ -164,7 +164,7 @@ function readLineStringGeometry(object) {
/**
* @param {GeoJSONGeometry} object Object.
* @return {module:ol/geom/MultiLineString~MultiLineString} MultiLineString.
* @return {module:ol/geom/MultiLineString} MultiLineString.
*/
function readMultiLineStringGeometry(object) {
return new MultiLineString(object.coordinates);
@@ -173,7 +173,7 @@ function readMultiLineStringGeometry(object) {
/**
* @param {GeoJSONGeometry} object Object.
* @return {module:ol/geom/MultiPoint~MultiPoint} MultiPoint.
* @return {module:ol/geom/MultiPoint} MultiPoint.
*/
function readMultiPointGeometry(object) {
return new MultiPoint(object.coordinates);
@@ -182,7 +182,7 @@ function readMultiPointGeometry(object) {
/**
* @param {GeoJSONGeometry} object Object.
* @return {module:ol/geom/MultiPolygon~MultiPolygon} MultiPolygon.
* @return {module:ol/geom/MultiPolygon} MultiPolygon.
*/
function readMultiPolygonGeometry(object) {
return new MultiPolygon(object.coordinates);
@@ -191,7 +191,7 @@ function readMultiPolygonGeometry(object) {
/**
* @param {GeoJSONGeometry} object Object.
* @return {module:ol/geom/Polygon~Polygon} Polygon.
* @return {module:ol/geom/Polygon} Polygon.
*/
function readPolygonGeometry(object) {
return new Polygon(object.coordinates);
@@ -199,19 +199,19 @@ function readPolygonGeometry(object) {
/**
* @param {module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {GeoJSONGeometry|GeoJSONGeometryCollection} GeoJSON geometry.
*/
function writeGeometry(geometry, opt_options) {
const geometryWriter = GEOMETRY_WRITERS[geometry.getType()];
return geometryWriter(/** @type {module:ol/geom/Geometry~Geometry} */ (
return geometryWriter(/** @type {module:ol/geom/Geometry} */ (
transformWithOptions(geometry, true, opt_options)), opt_options);
}
/**
* @param {module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {module:ol/geom/Geometry} geometry Geometry.
* @return {GeoJSONGeometryCollection} Empty GeoJSON geometry collection.
*/
function writeEmptyGeometryCollectionGeometry(geometry) {
@@ -223,7 +223,7 @@ function writeEmptyGeometryCollectionGeometry(geometry) {
/**
* @param {module:ol/geom/GeometryCollection~GeometryCollection} geometry Geometry.
* @param {module:ol/geom/GeometryCollection} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {GeoJSONGeometryCollection} GeoJSON geometry collection.
*/
@@ -241,7 +241,7 @@ function writeGeometryCollectionGeometry(geometry, opt_options) {
/**
* @param {module:ol/geom/LineString~LineString} geometry Geometry.
* @param {module:ol/geom/LineString} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {GeoJSONGeometry} GeoJSON geometry.
*/
@@ -254,7 +254,7 @@ function writeLineStringGeometry(geometry, opt_options) {
/**
* @param {module:ol/geom/MultiLineString~MultiLineString} geometry Geometry.
* @param {module:ol/geom/MultiLineString} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {GeoJSONGeometry} GeoJSON geometry.
*/
@@ -267,7 +267,7 @@ function writeMultiLineStringGeometry(geometry, opt_options) {
/**
* @param {module:ol/geom/MultiPoint~MultiPoint} geometry Geometry.
* @param {module:ol/geom/MultiPoint} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {GeoJSONGeometry} GeoJSON geometry.
*/
@@ -280,7 +280,7 @@ function writeMultiPointGeometry(geometry, opt_options) {
/**
* @param {module:ol/geom/MultiPolygon~MultiPolygon} geometry Geometry.
* @param {module:ol/geom/MultiPolygon} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {GeoJSONGeometry} GeoJSON geometry.
*/
@@ -297,7 +297,7 @@ function writeMultiPolygonGeometry(geometry, opt_options) {
/**
* @param {module:ol/geom/Point~Point} geometry Geometry.
* @param {module:ol/geom/Point} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {GeoJSONGeometry} GeoJSON geometry.
*/
@@ -310,7 +310,7 @@ function writePointGeometry(geometry, opt_options) {
/**
* @param {module:ol/geom/Polygon~Polygon} geometry Geometry.
* @param {module:ol/geom/Polygon} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {GeoJSONGeometry} GeoJSON geometry.
*/
@@ -330,12 +330,12 @@ function writePolygonGeometry(geometry, opt_options) {
* Read a feature from a GeoJSON Feature source. Only works for Feature or
* geometry types. Use {@link ol.format.GeoJSON#readFeatures} to read
* FeatureCollection source. If feature at source has an id, it will be used
* as Feature id by calling {@link module:ol/Feature~Feature#setId} internally.
* as Feature id by calling {@link module:ol/Feature#setId} internally.
*
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/Feature~Feature} Feature.
* @return {module:ol/Feature} Feature.
* @api
*/
GeoJSON.prototype.readFeature;
@@ -349,7 +349,7 @@ GeoJSON.prototype.readFeature;
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {Array.<module:ol/Feature~Feature>} Features.
* @return {Array.<module:ol/Feature>} Features.
* @api
*/
GeoJSON.prototype.readFeatures;
@@ -395,7 +395,7 @@ GeoJSON.prototype.readFeatureFromObject = function(object, opt_options) {
*/
GeoJSON.prototype.readFeaturesFromObject = function(object, opt_options) {
const geoJSONObject = /** @type {GeoJSONObject} */ (object);
/** @type {Array.<module:ol/Feature~Feature>} */
/** @type {Array.<module:ol/Feature>} */
let features = null;
if (geoJSONObject.type === 'FeatureCollection') {
const geoJSONFeatureCollection = /** @type {GeoJSONFeatureCollection} */ (object);
@@ -417,7 +417,7 @@ GeoJSON.prototype.readFeaturesFromObject = function(object, opt_options) {
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/geom/Geometry~Geometry} Geometry.
* @return {module:ol/geom/Geometry} Geometry.
* @api
*/
GeoJSON.prototype.readGeometry;
@@ -436,7 +436,7 @@ GeoJSON.prototype.readGeometryFromObject = function(object, opt_options) {
*
* @function
* @param {Document|Node|Object|string} source Source.
* @return {module:ol/proj/Projection~Projection} Projection.
* @return {module:ol/proj/Projection} Projection.
* @api
*/
GeoJSON.prototype.readProjection;
@@ -458,7 +458,9 @@ GeoJSON.prototype.readProjectionFromObject = function(object) {
} else {
projection = this.defaultDataProjection;
}
return /** @type {module:ol/proj/Projection~Projection} */ (projection);
return (
/** @type {module:ol/proj/Projection} */ (projection)
);
};
@@ -466,7 +468,7 @@ GeoJSON.prototype.readProjectionFromObject = function(object) {
* Encode a feature as a GeoJSON Feature string.
*
* @function
* @param {module:ol/Feature~Feature} feature Feature.
* @param {module:ol/Feature} feature Feature.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} GeoJSON.
* @override
@@ -478,7 +480,7 @@ GeoJSON.prototype.writeFeature;
/**
* Encode a feature as a GeoJSON Feature object.
*
* @param {module:ol/Feature~Feature} feature Feature.
* @param {module:ol/Feature} feature Feature.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {GeoJSONFeature} Object.
* @override
@@ -515,7 +517,7 @@ GeoJSON.prototype.writeFeatureObject = function(feature, opt_options) {
* Encode an array of features as GeoJSON.
*
* @function
* @param {Array.<module:ol/Feature~Feature>} features Features.
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} GeoJSON.
* @api
@@ -526,7 +528,7 @@ GeoJSON.prototype.writeFeatures;
/**
* Encode an array of features as a GeoJSON object.
*
* @param {Array.<module:ol/Feature~Feature>} features Features.
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {GeoJSONFeatureCollection} GeoJSON Object.
* @override
@@ -549,7 +551,7 @@ GeoJSON.prototype.writeFeaturesObject = function(features, opt_options) {
* Encode a geometry as a GeoJSON string.
*
* @function
* @param {module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} GeoJSON.
* @api
@@ -560,7 +562,7 @@ GeoJSON.prototype.writeGeometry;
/**
* Encode a geometry as a GeoJSON object.
*
* @param {module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {GeoJSONGeometry|GeoJSONGeometryCollection} Object.
* @override

8
src/ol/format/IGC.js
View File

@@ -32,7 +32,7 @@ const IGCZ = {
* Feature format for `*.igc` flight recording files.
*
* @constructor
* @extends {module:ol/format/TextFeature~TextFeature}
* @extends {module:ol/format/TextFeature}
* @param {module:ol/format/IGC~Options=} opt_options Options.
* @api
*/
@@ -94,7 +94,7 @@ const NEWLINE_RE = /\r\n|\r|\n/;
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/Feature~Feature} Feature.
* @return {module:ol/Feature} Feature.
* @api
*/
IGC.prototype.readFeature;
@@ -184,7 +184,7 @@ IGC.prototype.readFeatureFromText = function(text, opt_options) {
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {Array.<module:ol/Feature~Feature>} Features.
* @return {Array.<module:ol/Feature>} Features.
* @api
*/
IGC.prototype.readFeatures;
@@ -208,7 +208,7 @@ IGC.prototype.readFeaturesFromText = function(text, opt_options) {
*
* @function
* @param {Document|Node|Object|string} source Source.
* @return {module:ol/proj/Projection~Projection} Projection.
* @return {module:ol/proj/Projection} Projection.
* @api
*/
IGC.prototype.readProjection;

16
src/ol/format/JSONFeature.js
View File

@@ -13,7 +13,7 @@ import FormatType from '../format/FormatType.js';
*
* @constructor
* @abstract
* @extends {module:ol/format/Feature~FeatureFormat}
* @extends {module:ol/format/Feature}
*/
const JSONFeature = function() {
FeatureFormat.call(this);
@@ -69,7 +69,7 @@ JSONFeature.prototype.readFeatures = function(source, opt_options) {
* @param {Object} object Object.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @protected
* @return {module:ol/Feature~Feature} Feature.
* @return {module:ol/Feature} Feature.
*/
JSONFeature.prototype.readFeatureFromObject = function(object, opt_options) {};
@@ -79,7 +79,7 @@ JSONFeature.prototype.readFeatureFromObject = function(object, opt_options) {};
* @param {Object} object Object.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @protected
* @return {Array.<module:ol/Feature~Feature>} Features.
* @return {Array.<module:ol/Feature>} Features.
*/
JSONFeature.prototype.readFeaturesFromObject = function(object, opt_options) {};
@@ -98,7 +98,7 @@ JSONFeature.prototype.readGeometry = function(source, opt_options) {
* @param {Object} object Object.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @protected
* @return {module:ol/geom/Geometry~Geometry} Geometry.
* @return {module:ol/geom/Geometry} Geometry.
*/
JSONFeature.prototype.readGeometryFromObject = function(object, opt_options) {};
@@ -115,7 +115,7 @@ JSONFeature.prototype.readProjection = function(source) {
* @abstract
* @param {Object} object Object.
* @protected
* @return {module:ol/proj/Projection~Projection} Projection.
* @return {module:ol/proj/Projection} Projection.
*/
JSONFeature.prototype.readProjectionFromObject = function(object) {};
@@ -130,7 +130,7 @@ JSONFeature.prototype.writeFeature = function(feature, opt_options) {
/**
* @abstract
* @param {module:ol/Feature~Feature} feature Feature.
* @param {module:ol/Feature} feature Feature.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {Object} Object.
*/
@@ -147,7 +147,7 @@ JSONFeature.prototype.writeFeatures = function(features, opt_options) {
/**
* @abstract
* @param {Array.<module:ol/Feature~Feature>} features Features.
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {Object} Object.
*/
@@ -164,7 +164,7 @@ JSONFeature.prototype.writeGeometry = function(geometry, opt_options) {
/**
* @abstract
* @param {module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {Object} Object.
*/

152
src/ol/format/KML.js
View File

@@ -54,13 +54,13 @@ import {createElementNS, getAllTextContent, isDocument, isNode, makeArrayExtende
let DEFAULT_COLOR;
/**
* @type {module:ol/style/Fill~Fill}
* @type {module:ol/style/Fill}
*/
let DEFAULT_FILL_STYLE = null;
/**
* Get the default fill style (or null if not yet set).
* @return {module:ol/style/Fill~Fill} The default fill style.
* @return {module:ol/style/Fill} The default fill style.
*/
export function getDefaultFillStyle() {
return DEFAULT_FILL_STYLE;
@@ -97,13 +97,13 @@ let DEFAULT_IMAGE_STYLE_SRC;
let DEFAULT_IMAGE_SCALE_MULTIPLIER;
/**
* @type {module:ol/style/Image~ImageStyle}
* @type {module:ol/style/Image}
*/
let DEFAULT_IMAGE_STYLE = null;
/**
* Get the default image style (or null if not yet set).
* @return {module:ol/style/Image~ImageStyle} The default image style.
* @return {module:ol/style/Image} The default image style.
*/
export function getDefaultImageStyle() {
return DEFAULT_IMAGE_STYLE;
@@ -115,57 +115,57 @@ export function getDefaultImageStyle() {
let DEFAULT_NO_IMAGE_STYLE;
/**
* @type {module:ol/style/Stroke~Stroke}
* @type {module:ol/style/Stroke}
*/
let DEFAULT_STROKE_STYLE = null;
/**
* Get the default stroke style (or null if not yet set).
* @return {module:ol/style/Stroke~Stroke} The default stroke style.
* @return {module:ol/style/Stroke} The default stroke style.
*/
export function getDefaultStrokeStyle() {
return DEFAULT_STROKE_STYLE;
}
/**
* @type {module:ol/style/Stroke~Stroke}
* @type {module:ol/style/Stroke}
*/
let DEFAULT_TEXT_STROKE_STYLE;
/**
* @type {module:ol/style/Text~Text}
* @type {module:ol/style/Text}
*/
let DEFAULT_TEXT_STYLE = null;
/**
* Get the default text style (or null if not yet set).
* @return {module:ol/style/Text~Text} The default text style.
* @return {module:ol/style/Text} The default text style.
*/
export function getDefaultTextStyle() {
return DEFAULT_TEXT_STYLE;
}
/**
* @type {module:ol/style/Style~Style}
* @type {module:ol/style/Style}
*/
let DEFAULT_STYLE = null;
/**
* Get the default style (or null if not yet set).
* @return {module:ol/style/Style~Style} The default style.
* @return {module:ol/style/Style} The default style.
*/
export function getDefaultStyle() {
return DEFAULT_STYLE;
}
/**
* @type {Array.<module:ol/style/Style~Style>}
* @type {Array.<module:ol/style/Style>}
*/
let DEFAULT_STYLE_ARRAY = null;
/**
* Get the default style array (or null if not yet set).
* @return {Array.<module:ol/style/Style~Style>} The default style.
* @return {Array.<module:ol/style/Style>} The default style.
*/
export function getDefaultStyleArray() {
return DEFAULT_STYLE_ARRAY;
@@ -234,7 +234,7 @@ function createStyleDefaults() {
/**
* @const
* @type {Array.<module:ol/style/Style~Style>}
* @type {Array.<module:ol/style/Style>}
* @private
*/
DEFAULT_STYLE_ARRAY = [DEFAULT_STYLE];
@@ -246,7 +246,7 @@ function createStyleDefaults() {
* @typedef {Object} Options
* @property {boolean} [extractStyles=true] Extract styles from the KML.
* @property {boolean} [showPointNames=true] Show names as labels for placemarks which contain points.
* @property {Array.<module:ol/style/Style~Style>} [defaultStyle] Default style. The
* @property {Array.<module:ol/style/Style>} [defaultStyle] Default style. The
* default default style is the same as Google Earth.
* @property {boolean} [writeStyles=true] Write styles into KML.
*/
@@ -260,7 +260,7 @@ function createStyleDefaults() {
* which do not support this will need a URL polyfill to be loaded before use.
*
* @constructor
* @extends {module:ol/format/XMLFeature~XMLFeature}
* @extends {module:ol/format/XMLFeature}
* @param {module:ol/format/KML~Options=} opt_options Options.
* @api
*/
@@ -281,7 +281,7 @@ const KML = function(opt_options) {
/**
* @private
* @type {Array.<module:ol/style/Style~Style>}
* @type {Array.<module:ol/style/Style>}
*/
this.defaultStyle_ = options.defaultStyle ?
options.defaultStyle : DEFAULT_STYLE_ARRAY;
@@ -302,7 +302,7 @@ const KML = function(opt_options) {
/**
* @private
* @type {!Object.<string, (Array.<module:ol/style/Style~Style>|string)>}
* @type {!Object.<string, (Array.<module:ol/style/Style>|string)>}
*/
this.sharedStyles_ = {};
@@ -359,9 +359,9 @@ const ICON_ANCHOR_UNITS_MAP = {
/**
* @param {module:ol/style/Style~Style|undefined} foundStyle Style.
* @param {module:ol/style/Style|undefined} foundStyle Style.
* @param {string} name Name.
* @return {module:ol/style/Style~Style} style Style.
* @return {module:ol/style/Style} style Style.
*/
function createNameStyleFunction(foundStyle, name) {
let textStyle = null;
@@ -406,10 +406,10 @@ function createNameStyleFunction(foundStyle, name) {
/**
* @param {Array.<module:ol/style/Style~Style>|undefined} style Style.
* @param {Array.<module:ol/style/Style>|undefined} style Style.
* @param {string} styleUrl Style URL.
* @param {Array.<module:ol/style/Style~Style>} defaultStyle Default style.
* @param {!Object.<string, (Array.<module:ol/style/Style~Style>|string)>} sharedStyles Shared styles.
* @param {Array.<module:ol/style/Style>} defaultStyle Default style.
* @param {!Object.<string, (Array.<module:ol/style/Style>|string)>} sharedStyles Shared styles.
* @param {boolean|undefined} showPointNames true to show names for point placemarks.
* @return {module:ol/style~StyleFunction} Feature style function.
*/
@@ -417,13 +417,13 @@ function createFeatureStyleFunction(style, styleUrl, defaultStyle, sharedStyles,
return (
/**
* @param {module:ol/Feature~Feature} feature feature.
* @param {module:ol/Feature} feature feature.
* @param {number} resolution Resolution.
* @return {Array.<module:ol/style/Style~Style>} Style.
* @return {Array.<module:ol/style/Style>} Style.
*/
function(feature, resolution) {
let drawName = showPointNames;
/** @type {module:ol/style/Style~Style|undefined} */
/** @type {module:ol/style/Style|undefined} */
let nameStyle;
let name = '';
if (drawName) {
@@ -464,11 +464,11 @@ function createFeatureStyleFunction(style, styleUrl, defaultStyle, sharedStyles,
/**
* @param {Array.<module:ol/style/Style~Style>|string|undefined} styleValue Style value.
* @param {Array.<module:ol/style/Style~Style>} defaultStyle Default style.
* @param {!Object.<string, (Array.<module:ol/style/Style~Style>|string)>} sharedStyles
* @param {Array.<module:ol/style/Style>|string|undefined} styleValue Style value.
* @param {Array.<module:ol/style/Style>} defaultStyle Default style.
* @param {!Object.<string, (Array.<module:ol/style/Style>|string)>} sharedStyles
* Shared styles.
* @return {Array.<module:ol/style/Style~Style>} Style.
* @return {Array.<module:ol/style/Style>} Style.
*/
function findStyle(styleValue, defaultStyle, sharedStyles) {
if (Array.isArray(styleValue)) {
@@ -609,7 +609,7 @@ const STYLE_MAP_PARSERS = makeStructureNS(
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {Array.<module:ol/style/Style~Style>|string|undefined} StyleMap.
* @return {Array.<module:ol/style/Style>|string|undefined} StyleMap.
*/
function readStyleMapValue(node, objectStack) {
return pushParseAndPop(undefined,
@@ -901,7 +901,7 @@ const GX_MULTITRACK_GEOMETRY_PARSERS = makeStructureNS(
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/geom/MultiLineString~MultiLineString|undefined} MultiLineString.
* @return {module:ol/geom/MultiLineString|undefined} MultiLineString.
*/
function readGxMultiTrack(node, objectStack) {
const lineStrings = pushParseAndPop([],
@@ -931,7 +931,7 @@ const GX_TRACK_PARSERS = makeStructureNS(
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/geom/LineString~LineString|undefined} LineString.
* @return {module:ol/geom/LineString|undefined} LineString.
*/
function readGxTrack(node, objectStack) {
const gxTrackObject = pushParseAndPop(
@@ -1021,7 +1021,7 @@ const EXTRUDE_AND_ALTITUDE_MODE_PARSERS = makeStructureNS(
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/geom/LineString~LineString|undefined} LineString.
* @return {module:ol/geom/LineString|undefined} LineString.
*/
function readLineString(node, objectStack) {
const properties = pushParseAndPop({},
@@ -1043,7 +1043,7 @@ function readLineString(node, objectStack) {
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/geom/Polygon~Polygon|undefined} Polygon.
* @return {module:ol/geom/Polygon|undefined} Polygon.
*/
function readLinearRing(node, objectStack) {
const properties = pushParseAndPop({},
@@ -1080,7 +1080,7 @@ const MULTI_GEOMETRY_PARSERS = makeStructureNS(
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/geom/Geometry~Geometry} Geometry.
* @return {module:ol/geom/Geometry} Geometry.
*/
function readMultiGeometry(node, objectStack) {
const geometries = pushParseAndPop([],
@@ -1091,7 +1091,7 @@ function readMultiGeometry(node, objectStack) {
if (geometries.length === 0) {
return new GeometryCollection(geometries);
}
/** @type {module:ol/geom/Geometry~Geometry} */
/** @type {module:ol/geom/Geometry} */
let multiGeometry;
let homogeneous = true;
const type = geometries[0].getType();
@@ -1133,14 +1133,16 @@ function readMultiGeometry(node, objectStack) {
} else {
multiGeometry = new GeometryCollection(geometries);
}
return /** @type {module:ol/geom/Geometry~Geometry} */ (multiGeometry);
return (
/** @type {module:ol/geom/Geometry} */ (multiGeometry)
);
}
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/geom/Point~Point|undefined} Point.
* @return {module:ol/geom/Point|undefined} Point.
*/
function readPoint(node, objectStack) {
const properties = pushParseAndPop({},
@@ -1173,7 +1175,7 @@ const FLAT_LINEAR_RINGS_PARSERS = makeStructureNS(
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/geom/Polygon~Polygon|undefined} Polygon.
* @return {module:ol/geom/Polygon|undefined} Polygon.
*/
function readPolygon(node, objectStack) {
const properties = pushParseAndPop(/** @type {Object<string,*>} */ ({}),
@@ -1214,7 +1216,7 @@ const STYLE_PARSERS = makeStructureNS(
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {Array.<module:ol/style/Style~Style>} Style.
* @return {Array.<module:ol/style/Style>} Style.
*/
function readStyle(node, objectStack) {
const styleObject = pushParseAndPop(
@@ -1222,23 +1224,23 @@ function readStyle(node, objectStack) {
if (!styleObject) {
return null;
}
let fillStyle = /** @type {module:ol/style/Fill~Fill} */
let fillStyle = /** @type {module:ol/style/Fill} */
('fillStyle' in styleObject ?
styleObject['fillStyle'] : DEFAULT_FILL_STYLE);
const fill = /** @type {boolean|undefined} */ (styleObject['fill']);
if (fill !== undefined && !fill) {
fillStyle = null;
}
let imageStyle = /** @type {module:ol/style/Image~ImageStyle} */
let imageStyle = /** @type {module:ol/style/Image} */
('imageStyle' in styleObject ?
styleObject['imageStyle'] : DEFAULT_IMAGE_STYLE);
if (imageStyle == DEFAULT_NO_IMAGE_STYLE) {
imageStyle = undefined;
}
const textStyle = /** @type {module:ol/style/Text~Text} */
const textStyle = /** @type {module:ol/style/Text} */
('textStyle' in styleObject ?
styleObject['textStyle'] : DEFAULT_TEXT_STYLE);
let strokeStyle = /** @type {module:ol/style/Stroke~Stroke} */
let strokeStyle = /** @type {module:ol/style/Stroke} */
('strokeStyle' in styleObject ?
styleObject['strokeStyle'] : DEFAULT_STROKE_STYLE);
const outline = /** @type {boolean|undefined} */
@@ -1259,9 +1261,9 @@ function readStyle(node, objectStack) {
/**
* Reads an array of geometries and creates arrays for common geometry
* properties. Then sets them to the multi geometry.
* @param {module:ol/geom/MultiPoint~MultiPoint|module:ol/geom/MultiLineString~MultiLineString|module:ol/geom/MultiPolygon~MultiPolygon}
* @param {module:ol/geom/MultiPoint|module:ol/geom/MultiLineString|module:ol/geom/MultiPolygon}
* multiGeometry A multi-geometry.
* @param {Array.<module:ol/geom/Geometry~Geometry>} geometries List of geometries.
* @param {Array.<module:ol/geom/Geometry>} geometries List of geometries.
*/
function setCommonGeometryProperties(multiGeometry, geometries) {
const ii = geometries.length;
@@ -1387,7 +1389,7 @@ function pairDataParser(node, objectStack) {
if (styleUrl) {
objectStack[objectStack.length - 1] = styleUrl;
}
const Style = /** @type {module:ol/style/Style~Style} */
const Style = /** @type {module:ol/style/Style} */
(pairObject['Style']);
if (Style) {
objectStack[objectStack.length - 1] = Style;
@@ -1662,7 +1664,7 @@ const PLACEMARK_PARSERS = makeStructureNS(
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @private
* @return {Array.<module:ol/Feature~Feature>|undefined} Features.
* @return {Array.<module:ol/Feature>|undefined} Features.
*/
KML.prototype.readDocumentOrFolder_ = function(node, objectStack) {
// FIXME use scope somehow
@@ -1674,7 +1676,7 @@ KML.prototype.readDocumentOrFolder_ = function(node, objectStack) {
'Style': this.readSharedStyle_.bind(this),
'StyleMap': this.readSharedStyleMap_.bind(this)
});
/** @type {Array.<module:ol/Feature~Feature>} */
/** @type {Array.<module:ol/Feature>} */
const features = pushParseAndPop([], parsersNS, node, objectStack, this);
if (features) {
return features;
@@ -1688,7 +1690,7 @@ KML.prototype.readDocumentOrFolder_ = function(node, objectStack) {
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @private
* @return {module:ol/Feature~Feature|undefined} Feature.
* @return {module:ol/Feature|undefined} Feature.
*/
KML.prototype.readPlacemark_ = function(node, objectStack) {
const object = pushParseAndPop({'geometry': null},
@@ -1792,7 +1794,7 @@ KML.prototype.readSharedStyleMap_ = function(node, objectStack) {
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/Feature~Feature} Feature.
* @return {module:ol/Feature} Feature.
* @api
*/
KML.prototype.readFeature;
@@ -1823,7 +1825,7 @@ KML.prototype.readFeatureFromNode = function(node, opt_options) {
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {Array.<module:ol/Feature~Feature>} Features.
* @return {Array.<module:ol/Feature>} Features.
* @api
*/
KML.prototype.readFeatures;
@@ -2071,7 +2073,7 @@ KML.prototype.readRegionFromNode = function(node) {
*
* @function
* @param {Document|Node|Object|string} source Source.
* @return {module:ol/proj/Projection~Projection} Projection.
* @return {module:ol/proj/Projection} Projection.
* @api
*/
KML.prototype.readProjection;
@@ -2215,9 +2217,9 @@ const DOCUMENT_NODE_FACTORY = function(value, objectStack, opt_nodeName) {
/**
* @param {Node} node Node.
* @param {Array.<module:ol/Feature~Feature>} features Features.
* @param {Array.<module:ol/Feature>} features Features.
* @param {Array.<*>} objectStack Object stack.
* @this {module:ol/format/KML~KML}
* @this {module:ol/format/KML}
*/
function writeDocument(node, features, objectStack) {
const /** @type {module:ol/xml~NodeStackItem} */ context = {node: node};
@@ -2341,7 +2343,7 @@ const ICON_STYLE_SERIALIZERS = makeStructureNS(
/**
* @param {Node} node Node.
* @param {module:ol/style/Icon~Icon} style Icon style.
* @param {module:ol/style/Icon} style Icon style.
* @param {Array.<*>} objectStack Object stack.
*/
function writeIconStyle(node, style, objectStack) {
@@ -2419,7 +2421,7 @@ const LABEL_STYLE_SERIALIZERS = makeStructureNS(
/**
* @param {Node} node Node.
* @param {module:ol/style/Text~Text} style style.
* @param {module:ol/style/Text} style style.
* @param {Array.<*>} objectStack Object stack.
*/
function writeLabelStyle(node, style, objectStack) {
@@ -2465,7 +2467,7 @@ const LINE_STYLE_SERIALIZERS = makeStructureNS(
/**
* @param {Node} node Node.
* @param {module:ol/style/Stroke~Stroke} style style.
* @param {module:ol/style/Stroke} style style.
* @param {Array.<*>} objectStack Object stack.
*/
function writeLineStyle(node, style, objectStack) {
@@ -2509,7 +2511,7 @@ const GEOMETRY_NODE_FACTORY = function(value, objectStack, opt_nodeName) {
if (value) {
const parentNode = objectStack[objectStack.length - 1].node;
return createElementNS(parentNode.namespaceURI,
GEOMETRY_TYPE_TO_NODENAME[/** @type {module:ol/geom/Geometry~Geometry} */ (value).getType()]);
GEOMETRY_TYPE_TO_NODENAME[/** @type {module:ol/geom/Geometry} */ (value).getType()]);
}
};
@@ -2564,30 +2566,30 @@ const MULTI_GEOMETRY_SERIALIZERS = makeStructureNS(
/**
* @param {Node} node Node.
* @param {module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {Array.<*>} objectStack Object stack.
*/
function writeMultiGeometry(node, geometry, objectStack) {
/** @type {module:ol/xml~NodeStackItem} */
const context = {node: node};
const type = geometry.getType();
/** @type {Array.<module:ol/geom/Geometry~Geometry>} */
/** @type {Array.<module:ol/geom/Geometry>} */
let geometries;
/** @type {function(*, Array.<*>, string=): (Node|undefined)} */
let factory;
if (type == GeometryType.GEOMETRY_COLLECTION) {
geometries = /** @type {module:ol/geom/GeometryCollection~GeometryCollection} */ (geometry).getGeometries();
geometries = /** @type {module:ol/geom/GeometryCollection} */ (geometry).getGeometries();
factory = GEOMETRY_NODE_FACTORY;
} else if (type == GeometryType.MULTI_POINT) {
geometries = /** @type {module:ol/geom/MultiPoint~MultiPoint} */ (geometry).getPoints();
geometries = /** @type {module:ol/geom/MultiPoint} */ (geometry).getPoints();
factory = POINT_NODE_FACTORY;
} else if (type == GeometryType.MULTI_LINE_STRING) {
geometries =
(/** @type {module:ol/geom/MultiLineString~MultiLineString} */ (geometry)).getLineStrings();
(/** @type {module:ol/geom/MultiLineString} */ (geometry)).getLineStrings();
factory = LINE_STRING_NODE_FACTORY;
} else if (type == GeometryType.MULTI_POLYGON) {
geometries =
(/** @type {module:ol/geom/MultiPolygon~MultiPolygon} */ (geometry)).getPolygons();
(/** @type {module:ol/geom/MultiPolygon} */ (geometry)).getPolygons();
factory = POLYGON_NODE_FACTORY;
} else {
assert(false, 39); // Unknown geometry type
@@ -2611,7 +2613,7 @@ const BOUNDARY_IS_SERIALIZERS = makeStructureNS(
/**
* @param {Node} node Node.
* @param {module:ol/geom/LinearRing~LinearRing} linearRing Linear ring.
* @param {module:ol/geom/LinearRing} linearRing Linear ring.
* @param {Array.<*>} objectStack Object stack.
*/
function writeBoundaryIs(node, linearRing, objectStack) {
@@ -2668,9 +2670,9 @@ const EXTENDEDDATA_NODE_FACTORY = makeSimpleNodeFactory('ExtendedData');
* FIXME currently we do serialize arbitrary/custom feature properties
* (ExtendedData).
* @param {Node} node Node.
* @param {module:ol/Feature~Feature} feature Feature.
* @param {module:ol/Feature} feature Feature.
* @param {Array.<*>} objectStack Object stack.
* @this {module:ol/format/KML~KML}
* @this {module:ol/format/KML}
*/
function writePlacemark(node, feature, objectStack) {
const /** @type {module:ol/xml~NodeStackItem} */ context = {node: node};
@@ -2756,7 +2758,7 @@ const PRIMITIVE_GEOMETRY_SERIALIZERS = makeStructureNS(
/**
* @param {Node} node Node.
* @param {module:ol/geom/SimpleGeometry~SimpleGeometry} geometry Geometry.
* @param {module:ol/geom/SimpleGeometry} geometry Geometry.
* @param {Array.<*>} objectStack Object stack.
*/
function writePrimitiveGeometry(node, geometry, objectStack) {
@@ -2808,7 +2810,7 @@ const OUTER_BOUNDARY_NODE_FACTORY = makeSimpleNodeFactory('outerBoundaryIs');
/**
* @param {Node} node Node.
* @param {module:ol/geom/Polygon~Polygon} polygon Polygon.
* @param {module:ol/geom/Polygon} polygon Polygon.
* @param {Array.<*>} objectStack Object stack.
*/
function writePolygon(node, polygon, objectStack) {
@@ -2848,7 +2850,7 @@ const COLOR_NODE_FACTORY = makeSimpleNodeFactory('color');
/**
* @param {Node} node Node.
* @param {module:ol/style/Fill~Fill} style Style.
* @param {module:ol/style/Fill} style Style.
* @param {Array.<*>} objectStack Object stack.
*/
function writePolyStyle(node, style, objectStack) {
@@ -2894,7 +2896,7 @@ const STYLE_SERIALIZERS = makeStructureNS(
/**
* @param {Node} node Node.
* @param {module:ol/style/Style~Style} style Style.
* @param {module:ol/style/Style} style Style.
* @param {Array.<*>} objectStack Object stack.
*/
function writeStyle(node, style, objectStack) {
@@ -2962,7 +2964,7 @@ const KML_SERIALIZERS = makeStructureNS(
* MultiLineStrings, and MultiPolygons are output as MultiGeometries.
*
* @function
* @param {Array.<module:ol/Feature~Feature>} features Features.
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Options.
* @return {string} Result.
* @api
@@ -2974,7 +2976,7 @@ KML.prototype.writeFeatures;
* Encode an array of features in the KML format as an XML node. GeometryCollections,
* MultiPoints, MultiLineStrings, and MultiPolygons are output as MultiGeometries.
*
* @param {Array.<module:ol/Feature~Feature>} features Features.
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Options.
* @return {Node} Node.
* @override

12
src/ol/format/MVT.js
View File

@@ -24,7 +24,7 @@ import RenderFeature from '../render/Feature.js';
/**
* @typedef {Object} Options
* @property {function((module:ol/geom/Geometry~Geometry|Object.<string,*>)=)|function(module:ol/geom/GeometryType,Array.<number>,(Array.<number>|Array.<Array.<number>>),Object.<string,*>,number)} [featureClass]
* @property {function((module:ol/geom/Geometry|Object.<string,*>)=)|function(module: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 module:ol/Feature~Feature} to get full editing and geometry support at the cost of
* decreased rendering performance. The default is {@link module:ol/render/Feature~RenderFeature},
@@ -43,7 +43,7 @@ import RenderFeature from '../render/Feature.js';
* Feature format for reading data in the Mapbox MVT format.
*
* @constructor
* @extends {module:ol/format/Feature~FeatureFormat}
* @extends {module:ol/format/Feature}
* @param {module:ol/format/MVT~Options=} opt_options Options.
* @api
*/
@@ -54,7 +54,7 @@ const MVT = function(opt_options) {
const options = opt_options ? opt_options : {};
/**
* @type {module:ol/proj/Projection~Projection}
* @type {module:ol/proj/Projection}
*/
this.defaultDataProjection = new Projection({
code: '',
@@ -63,7 +63,7 @@ const MVT = function(opt_options) {
/**
* @private
* @type {function((module:ol/geom/Geometry~Geometry|Object.<string,*>)=)|
* @type {function((module:ol/geom/Geometry|Object.<string,*>)=)|
* function(module:ol/geom/GeometryType,Array.<number>,
* (Array.<number>|Array.<Array.<number>>),Object.<string,*>,number)}
*/
@@ -297,7 +297,7 @@ function getGeometryType(type, numEnds) {
* @param {ol.ext.PBF} pbf PBF
* @param {Object} rawFeature Raw Mapbox feature.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} Feature.
* @return {module:ol/Feature|module:ol/render/Feature} Feature.
*/
MVT.prototype.createFeature_ = function(pbf, rawFeature, opt_options) {
const type = rawFeature.type;
@@ -387,7 +387,7 @@ MVT.prototype.readFeatures = function(source, opt_options) {
const pbf = new PBF(/** @type {ArrayBuffer} */ (source));
const pbfLayers = pbf.readFields(layersPBFReader, {});
/** @type {Array.<module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature>} */
/** @type {Array.<module:ol/Feature|module:ol/render/Feature>} */
const features = [];
for (const name in pbfLayers) {
if (layers && layers.indexOf(name) == -1) {

6
src/ol/format/OSMXML.js
View File

@@ -21,7 +21,7 @@ import {pushParseAndPop, makeStructureNS} from '../xml.js';
* [OSMXML format](http://wiki.openstreetmap.org/wiki/OSM_XML).
*
* @constructor
* @extends {module:ol/format/XMLFeature~XMLFeature}
* @extends {module:ol/format/XMLFeature}
* @api
*/
const OSMXML = function() {
@@ -146,7 +146,7 @@ function readTag(node, objectStack) {
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {Array.<module:ol/Feature~Feature>} Features.
* @return {Array.<module:ol/Feature>} Features.
* @api
*/
OSMXML.prototype.readFeatures;
@@ -201,7 +201,7 @@ OSMXML.prototype.readFeaturesFromNode = function(node, opt_options) {
*
* @function
* @param {Document|Node|Object|string} source Source.
* @return {module:ol/proj/Projection~Projection} Projection.
* @return {module:ol/proj/Projection} Projection.
* @api
*/
OSMXML.prototype.readProjection;

2
src/ol/format/OWS.js
View File

@@ -9,7 +9,7 @@ import {makeObjectPropertyPusher, makeObjectPropertySetter, makeStructureNS, pus
/**
* @constructor
* @extends {module:ol/format/XML~XML}
* @extends {module:ol/format/XML}
*/
const OWS = function() {
XML.call(this);

23
src/ol/format/Polyline.js
View File

@@ -28,7 +28,7 @@ import {get as getProjection} from '../proj.js';
* Polyline Algorithm Format.
*
* @constructor
* @extends {module:ol/format/TextFeature~TextFeature}
* @extends {module:ol/format/TextFeature}
* @param {module:ol/format/Polyline~Options=} opt_options Optional configuration object.
* @api
*/
@@ -271,7 +271,7 @@ export function encodeUnsignedInteger(num) {
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/Feature~Feature} Feature.
* @return {module:ol/Feature} Feature.
* @api
*/
Polyline.prototype.readFeature;
@@ -293,7 +293,7 @@ Polyline.prototype.readFeatureFromText = function(text, opt_options) {
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {Array.<module:ol/Feature~Feature>} Features.
* @return {Array.<module:ol/Feature>} Features.
* @api
*/
Polyline.prototype.readFeatures;
@@ -314,7 +314,7 @@ Polyline.prototype.readFeaturesFromText = function(text, opt_options) {
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/geom/Geometry~Geometry} Geometry.
* @return {module:ol/geom/Geometry} Geometry.
* @api
*/
Polyline.prototype.readGeometry;
@@ -329,9 +329,12 @@ Polyline.prototype.readGeometryFromText = function(text, opt_options) {
flipXY(flatCoordinates, 0, flatCoordinates.length, stride, flatCoordinates);
const coordinates = inflateCoordinates(flatCoordinates, 0, flatCoordinates.length, stride);
return /** @type {module:ol/geom/Geometry~Geometry} */ (transformWithOptions(
new LineString(coordinates, this.geometryLayout_), false,
this.adaptOptions(opt_options))
return (
/** @type {module:ol/geom/Geometry} */ (transformWithOptions(
new LineString(coordinates, this.geometryLayout_),
false,
this.adaptOptions(opt_options)
))
);
};
@@ -341,7 +344,7 @@ Polyline.prototype.readGeometryFromText = function(text, opt_options) {
*
* @function
* @param {Document|Node|Object|string} source Source.
* @return {module:ol/proj/Projection~Projection} Projection.
* @return {module:ol/proj/Projection} Projection.
* @api
*/
Polyline.prototype.readProjection;
@@ -373,7 +376,7 @@ Polyline.prototype.writeFeaturesText = function(features, opt_options) {
* Write a single geometry in Polyline format.
*
* @function
* @param {module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} Geometry.
* @api
@@ -385,7 +388,7 @@ Polyline.prototype.writeGeometry;
* @inheritDoc
*/
Polyline.prototype.writeGeometryText = function(geometry, opt_options) {
geometry = /** @type {module:ol/geom/LineString~LineString} */
geometry = /** @type {module:ol/geom/LineString} */
(transformWithOptions(geometry, true, this.adaptOptions(opt_options)));
const flatCoordinates = geometry.getFlatCoordinates();
const stride = geometry.getStride();

16
src/ol/format/TextFeature.js
View File

@@ -13,7 +13,7 @@ import FormatType from '../format/FormatType.js';
*
* @constructor
* @abstract
* @extends {module:ol/format/Feature~FeatureFormat}
* @extends {module:ol/format/Feature}
*/
const TextFeature = function() {
FeatureFormat.call(this);
@@ -56,7 +56,7 @@ TextFeature.prototype.readFeature = function(source, opt_options) {
* @param {string} text Text.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @protected
* @return {module:ol/Feature~Feature} Feature.
* @return {module:ol/Feature} Feature.
*/
TextFeature.prototype.readFeatureFromText = function(text, opt_options) {};
@@ -74,7 +74,7 @@ TextFeature.prototype.readFeatures = function(source, opt_options) {
* @param {string} text Text.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @protected
* @return {Array.<module:ol/Feature~Feature>} Features.
* @return {Array.<module:ol/Feature>} Features.
*/
TextFeature.prototype.readFeaturesFromText = function(text, opt_options) {};
@@ -92,7 +92,7 @@ TextFeature.prototype.readGeometry = function(source, opt_options) {
* @param {string} text Text.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @protected
* @return {module:ol/geom/Geometry~Geometry} Geometry.
* @return {module:ol/geom/Geometry} Geometry.
*/
TextFeature.prototype.readGeometryFromText = function(text, opt_options) {};
@@ -108,7 +108,7 @@ TextFeature.prototype.readProjection = function(source) {
/**
* @param {string} text Text.
* @protected
* @return {module:ol/proj/Projection~Projection} Projection.
* @return {module:ol/proj/Projection} Projection.
*/
TextFeature.prototype.readProjectionFromText = function(text) {
return this.defaultDataProjection;
@@ -125,7 +125,7 @@ TextFeature.prototype.writeFeature = function(feature, opt_options) {
/**
* @abstract
* @param {module:ol/Feature~Feature} feature Features.
* @param {module:ol/Feature} feature Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @protected
* @return {string} Text.
@@ -143,7 +143,7 @@ TextFeature.prototype.writeFeatures = function(features, opt_options) {
/**
* @abstract
* @param {Array.<module:ol/Feature~Feature>} features Features.
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @protected
* @return {string} Text.
@@ -161,7 +161,7 @@ TextFeature.prototype.writeGeometry = function(geometry, opt_options) {
/**
* @abstract
* @param {module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @protected
* @return {string} Text.

28
src/ol/format/TopoJSON.js
View File

@@ -44,7 +44,7 @@ import {get as getProjection} from '../proj.js';
* Feature format for reading data in the TopoJSON format.
*
* @constructor
* @extends {module:ol/format/JSONFeature~JSONFeature}
* @extends {module:ol/format/JSONFeature}
* @param {module:ol/format/TopoJSON~Options=} opt_options Options.
* @api
*/
@@ -80,7 +80,7 @@ inherits(TopoJSON, JSONFeature);
/**
* @const
* @type {Object.<string, function(TopoJSONGeometry, Array, ...Array): module:ol/geom/Geometry~Geometry>}
* @type {Object.<string, function(TopoJSONGeometry, Array, ...Array): module:ol/geom/Geometry>}
*/
const GEOMETRY_READERS = {
'Point': readPointGeometry,
@@ -133,7 +133,7 @@ function concatenateArcs(indices, arcs) {
* @param {TopoJSONGeometry} object TopoJSON object.
* @param {Array.<number>} scale Scale for each dimension.
* @param {Array.<number>} translate Translation for each dimension.
* @return {module:ol/geom/Point~Point} Geometry.
* @return {module:ol/geom/Point} Geometry.
*/
function readPointGeometry(object, scale, translate) {
const coordinates = object.coordinates;
@@ -150,7 +150,7 @@ function readPointGeometry(object, scale, translate) {
* @param {TopoJSONGeometry} object TopoJSON object.
* @param {Array.<number>} scale Scale for each dimension.
* @param {Array.<number>} translate Translation for each dimension.
* @return {module:ol/geom/MultiPoint~MultiPoint} Geometry.
* @return {module:ol/geom/MultiPoint} Geometry.
*/
function readMultiPointGeometry(object, scale, translate) {
const coordinates = object.coordinates;
@@ -168,7 +168,7 @@ function readMultiPointGeometry(object, scale, translate) {
*
* @param {TopoJSONGeometry} object TopoJSON object.
* @param {Array.<Array.<module:ol/coordinate~Coordinate>>} arcs Array of arcs.
* @return {module:ol/geom/LineString~LineString} Geometry.
* @return {module:ol/geom/LineString} Geometry.
*/
function readLineStringGeometry(object, arcs) {
const coordinates = concatenateArcs(object.arcs, arcs);
@@ -181,7 +181,7 @@ function readLineStringGeometry(object, arcs) {
*
* @param {TopoJSONGeometry} object TopoJSON object.
* @param {Array.<Array.<module:ol/coordinate~Coordinate>>} arcs Array of arcs.
* @return {module:ol/geom/MultiLineString~MultiLineString} Geometry.
* @return {module:ol/geom/MultiLineString} Geometry.
*/
function readMultiLineStringGeometry(object, arcs) {
const coordinates = [];
@@ -197,7 +197,7 @@ function readMultiLineStringGeometry(object, arcs) {
*
* @param {TopoJSONGeometry} object TopoJSON object.
* @param {Array.<Array.<module:ol/coordinate~Coordinate>>} arcs Array of arcs.
* @return {module:ol/geom/Polygon~Polygon} Geometry.
* @return {module:ol/geom/Polygon} Geometry.
*/
function readPolygonGeometry(object, arcs) {
const coordinates = [];
@@ -213,7 +213,7 @@ function readPolygonGeometry(object, arcs) {
*
* @param {TopoJSONGeometry} object TopoJSON object.
* @param {Array.<Array.<module:ol/coordinate~Coordinate>>} arcs Array of arcs.
* @return {module:ol/geom/MultiPolygon~MultiPolygon} Geometry.
* @return {module:ol/geom/MultiPolygon} Geometry.
*/
function readMultiPolygonGeometry(object, arcs) {
const coordinates = [];
@@ -243,7 +243,7 @@ function readMultiPolygonGeometry(object, arcs) {
* object to.
* @param {string} name Name of the `Topology`'s child object.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {Array.<module:ol/Feature~Feature>} Array of features.
* @return {Array.<module:ol/Feature>} Array of features.
*/
function readFeaturesFromGeometryCollection(collection, arcs, scale, translate, property, name, opt_options) {
const geometries = collection.geometries;
@@ -267,7 +267,7 @@ function readFeaturesFromGeometryCollection(collection, arcs, scale, translate,
* object to.
* @param {string} name Name of the `Topology`'s child object.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/Feature~Feature} Feature.
* @return {module:ol/Feature} Feature.
*/
function readFeatureFromGeometry(object, arcs, scale, translate, property, name, opt_options) {
let geometry;
@@ -279,7 +279,7 @@ function readFeatureFromGeometry(object, arcs, scale, translate, property, name,
geometry = geometryReader(object, arcs);
}
const feature = new Feature();
feature.setGeometry(/** @type {module:ol/geom/Geometry~Geometry} */ (
feature.setGeometry(/** @type {module:ol/geom/Geometry} */ (
transformWithOptions(geometry, false, opt_options)));
if (object.id !== undefined) {
feature.setId(object.id);
@@ -303,7 +303,7 @@ function readFeatureFromGeometry(object, arcs, scale, translate, property, name,
*
* @function
* @param {Document|Node|Object|string} source Source.
* @return {Array.<module:ol/Feature~Feature>} Features.
* @return {Array.<module:ol/Feature>} Features.
* @api
*/
TopoJSON.prototype.readFeatures;
@@ -325,7 +325,7 @@ TopoJSON.prototype.readFeaturesFromObject = function(object, opt_options) {
if (transform) {
transformArcs(arcs, scale, translate);
}
/** @type {Array.<module:ol/Feature~Feature>} */
/** @type {Array.<module:ol/Feature>} */
const features = [];
const topoJSONFeatures = topoJSONTopology.objects;
const property = this.layerName_;
@@ -405,7 +405,7 @@ function transformVertex(vertex, scale, translate) {
* Read the projection from a TopoJSON source.
*
* @param {Document|Node|Object|string} object Source.
* @return {module:ol/proj/Projection~Projection} Projection.
* @return {module:ol/proj/Projection} Projection.
* @override
* @api
*/

50
src/ol/format/WFS.js
View File

@@ -21,7 +21,7 @@ import {createElementNS, isDocument, isNode, makeArrayPusher, makeChildAppender,
* @typedef {Object} Options
* @property {Object.<string, string>|string} [featureNS] The namespace URI used for features.
* @property {Array.<string>|string} [featureType] The feature type to parse. Only used for read operations.
* @property {module:ol/format/GMLBase~GMLBase} [gmlFormat] The GML format to use to parse the response. Default is `ol.format.GML3`.
* @property {module:ol/format/GMLBase} [gmlFormat] The GML format to use to parse the response. Default is `ol.format.GML3`.
* @property {string} [schemaLocation] Optional schemaLocation to use for serialization, this will override the default.
*/
@@ -44,7 +44,7 @@ import {createElementNS, isDocument, isNode, makeArrayPusher, makeChildAppender,
* WFS 2.0 feature backported to WFS 1.1.0 by some Web Feature Services. Please note that some
* Web Feature Services have repurposed `maxfeatures` instead.
* @property {module:ol/extent~Extent} [bbox] Extent to use for the BBOX filter.
* @property {module:ol/format/filter/Filter~Filter} [filter] Filter condition. See
* @property {module:ol/format/filter/Filter} [filter] Filter condition. See
* {@link ol.format.filter} for more information.
* @property {string} [resultType] Indicates what response should be returned,
* E.g. `hits` only includes the `numberOfFeatures` attribute in the response and no features.
@@ -140,7 +140,7 @@ const DEFAULT_VERSION = '1.1.0';
*
* @constructor
* @param {module:ol/format/WFS~Options=} opt_options Optional configuration object.
* @extends {module:ol/format/XMLFeature~XMLFeature}
* @extends {module:ol/format/XMLFeature}
* @api
*/
const WFS = function(opt_options) {
@@ -160,7 +160,7 @@ const WFS = function(opt_options) {
/**
* @private
* @type {module:ol/format/GMLBase~GMLBase}
* @type {module:ol/format/GMLBase}
*/
this.gmlFormat_ = options.gmlFormat ?
options.gmlFormat : new GML3();
@@ -200,7 +200,7 @@ WFS.prototype.setFeatureType = function(featureType) {
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {Array.<module:ol/Feature~Feature>} Features.
* @return {Array.<module:ol/Feature>} Features.
* @api
*/
WFS.prototype.readFeatures;
@@ -437,7 +437,7 @@ const QUERY_SERIALIZERS = {
/**
* @param {Node} node Node.
* @param {module:ol/Feature~Feature} feature Feature.
* @param {module:ol/Feature} feature Feature.
* @param {Array.<*>} objectStack Node stack.
*/
function writeFeature(node, feature, objectStack) {
@@ -488,7 +488,7 @@ function getTypeName(featurePrefix, featureType) {
/**
* @param {Node} node Node.
* @param {module:ol/Feature~Feature} feature Feature.
* @param {module:ol/Feature} feature Feature.
* @param {Array.<*>} objectStack Node stack.
*/
function writeDelete(node, feature, objectStack) {
@@ -523,7 +523,7 @@ const TRANSACTION_SERIALIZERS = {
/**
* @param {Node} node Node.
* @param {module:ol/Feature~Feature} feature Feature.
* @param {module:ol/Feature} feature Feature.
* @param {Array.<*>} objectStack Node stack.
*/
function writeUpdate(node, feature, objectStack) {
@@ -680,7 +680,7 @@ function writeQuery(node, featureType, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/format/filter/Filter~Filter} filter Filter.
* @param {module:ol/format/filter/Filter} filter Filter.
* @param {Array.<*>} objectStack Node stack.
*/
function writeFilterCondition(node, filter, objectStack) {
@@ -695,7 +695,7 @@ function writeFilterCondition(node, filter, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/format/filter/Bbox~Bbox} filter Filter.
* @param {module:ol/format/filter/Bbox} filter Filter.
* @param {Array.<*>} objectStack Node stack.
*/
function writeBboxFilter(node, filter, objectStack) {
@@ -709,7 +709,7 @@ function writeBboxFilter(node, filter, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/format/filter/Contains~Contains} filter Filter.
* @param {module:ol/format/filter/Contains} filter Filter.
* @param {Array.<*>} objectStack Node stack.
*/
function writeContainsFilter(node, filter, objectStack) {
@@ -723,7 +723,7 @@ function writeContainsFilter(node, filter, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/format/filter/Intersects~Intersects} filter Filter.
* @param {module:ol/format/filter/Intersects} filter Filter.
* @param {Array.<*>} objectStack Node stack.
*/
function writeIntersectsFilter(node, filter, objectStack) {
@@ -737,7 +737,7 @@ function writeIntersectsFilter(node, filter, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/format/filter/Within~Within} filter Filter.
* @param {module:ol/format/filter/Within} filter Filter.
* @param {Array.<*>} objectStack Node stack.
*/
function writeWithinFilter(node, filter, objectStack) {
@@ -751,7 +751,7 @@ function writeWithinFilter(node, filter, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/format/filter/During~During} filter Filter.
* @param {module:ol/format/filter/During} filter Filter.
* @param {Array.<*>} objectStack Node stack.
*/
function writeDuringFilter(node, filter, objectStack) {
@@ -776,7 +776,7 @@ function writeDuringFilter(node, filter, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/format/filter/LogicalNary~LogicalNary} filter Filter.
* @param {module:ol/format/filter/LogicalNary} filter Filter.
* @param {Array.<*>} objectStack Node stack.
*/
function writeLogicalFilter(node, filter, objectStack) {
@@ -795,7 +795,7 @@ function writeLogicalFilter(node, filter, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/format/filter/Not~Not} filter Filter.
* @param {module:ol/format/filter/Not} filter Filter.
* @param {Array.<*>} objectStack Node stack.
*/
function writeNotFilter(node, filter, objectStack) {
@@ -811,7 +811,7 @@ function writeNotFilter(node, filter, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/format/filter/ComparisonBinary~ComparisonBinary} filter Filter.
* @param {module:ol/format/filter/ComparisonBinary} filter Filter.
* @param {Array.<*>} objectStack Node stack.
*/
function writeComparisonFilter(node, filter, objectStack) {
@@ -825,7 +825,7 @@ function writeComparisonFilter(node, filter, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/format/filter/IsNull~IsNull} filter Filter.
* @param {module:ol/format/filter/IsNull} filter Filter.
* @param {Array.<*>} objectStack Node stack.
*/
function writeIsNullFilter(node, filter, objectStack) {
@@ -835,7 +835,7 @@ function writeIsNullFilter(node, filter, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/format/filter/IsBetween~IsBetween} filter Filter.
* @param {module:ol/format/filter/IsBetween} filter Filter.
* @param {Array.<*>} objectStack Node stack.
*/
function writeIsBetweenFilter(node, filter, objectStack) {
@@ -853,7 +853,7 @@ function writeIsBetweenFilter(node, filter, objectStack) {
/**
* @param {Node} node Node.
* @param {module:ol/format/filter/IsLike~IsLike} filter Filter.
* @param {module:ol/format/filter/IsLike} filter Filter.
* @param {Array.<*>} objectStack Node stack.
*/
function writeIsLikeFilter(node, filter, objectStack) {
@@ -915,7 +915,7 @@ function writeTimeInstant(node, time) {
/**
* Encode filter as WFS `Filter` and return the Node.
*
* @param {module:ol/format/filter/Filter~Filter} filter Filter.
* @param {module:ol/format/filter/Filter} filter Filter.
* @return {Node} Result.
* @api
*/
@@ -1008,9 +1008,9 @@ WFS.prototype.writeGetFeature = function(options) {
/**
* Encode format as WFS `Transaction` and return the Node.
*
* @param {Array.<module:ol/Feature~Feature>} inserts The features to insert.
* @param {Array.<module:ol/Feature~Feature>} updates The features to update.
* @param {Array.<module:ol/Feature~Feature>} deletes The features to delete.
* @param {Array.<module:ol/Feature>} inserts The features to insert.
* @param {Array.<module:ol/Feature>} updates The features to update.
* @param {Array.<module:ol/Feature>} deletes The features to delete.
* @param {module:ol/format/WFS~WriteTransactionOptions} options Write options.
* @return {Node} Result.
* @api
@@ -1079,7 +1079,7 @@ WFS.prototype.writeTransaction = function(inserts, updates, deletes, options) {
*
* @function
* @param {Document|Node|Object|string} source Source.
* @return {?module:ol/proj/Projection~Projection} Projection.
* @return {?module:ol/proj/Projection} Projection.
* @api
*/
WFS.prototype.readProjection;

52
src/ol/format/WKT.js
View File

@@ -271,7 +271,7 @@ Parser.prototype.match = function(type) {
/**
* Try to parse the tokens provided by the lexer.
* @return {module:ol/geom/Geometry~Geometry} The geometry.
* @return {module:ol/geom/Geometry} The geometry.
*/
Parser.prototype.parse = function() {
this.consume_();
@@ -306,7 +306,7 @@ Parser.prototype.parseGeometryLayout_ = function() {
/**
* @return {!Array.<module:ol/geom/Geometry~Geometry>} A collection of geometries.
* @return {!Array.<module:ol/geom/Geometry>} A collection of geometries.
* @private
*/
Parser.prototype.parseGeometryCollectionText_ = function() {
@@ -538,7 +538,7 @@ Parser.prototype.formatErrorMessage_ = function() {
* format.
*
* @constructor
* @extends {module:ol/format/TextFeature~TextFeature}
* @extends {module:ol/format/TextFeature}
* @param {module:ol/format/WKT~Options=} opt_options Options.
* @api
*/
@@ -562,7 +562,7 @@ inherits(WKT, TextFeature);
/**
* @param {module:ol/geom/Point~Point} geom Point geometry.
* @param {module:ol/geom/Point} geom Point geometry.
* @return {string} Coordinates part of Point as WKT.
*/
function encodePointGeometry(geom) {
@@ -575,7 +575,7 @@ function encodePointGeometry(geom) {
/**
* @param {module:ol/geom/MultiPoint~MultiPoint} geom MultiPoint geometry.
* @param {module:ol/geom/MultiPoint} geom MultiPoint geometry.
* @return {string} Coordinates part of MultiPoint as WKT.
*/
function encodeMultiPointGeometry(geom) {
@@ -589,7 +589,7 @@ function encodeMultiPointGeometry(geom) {
/**
* @param {module:ol/geom/GeometryCollection~GeometryCollection} geom GeometryCollection geometry.
* @param {module:ol/geom/GeometryCollection} geom GeometryCollection geometry.
* @return {string} Coordinates part of GeometryCollection as WKT.
*/
function encodeGeometryCollectionGeometry(geom) {
@@ -603,7 +603,7 @@ function encodeGeometryCollectionGeometry(geom) {
/**
* @param {module:ol/geom/LineString~LineString|module:ol/geom/LinearRing~LinearRing} geom LineString geometry.
* @param {module:ol/geom/LineString|module:ol/geom/LinearRing} geom LineString geometry.
* @return {string} Coordinates part of LineString as WKT.
*/
function encodeLineStringGeometry(geom) {
@@ -617,7 +617,7 @@ function encodeLineStringGeometry(geom) {
/**
* @param {module:ol/geom/MultiLineString~MultiLineString} geom MultiLineString geometry.
* @param {module:ol/geom/MultiLineString} geom MultiLineString geometry.
* @return {string} Coordinates part of MultiLineString as WKT.
*/
function encodeMultiLineStringGeometry(geom) {
@@ -631,7 +631,7 @@ function encodeMultiLineStringGeometry(geom) {
/**
* @param {module:ol/geom/Polygon~Polygon} geom Polygon geometry.
* @param {module:ol/geom/Polygon} geom Polygon geometry.
* @return {string} Coordinates part of Polygon as WKT.
*/
function encodePolygonGeometry(geom) {
@@ -645,7 +645,7 @@ function encodePolygonGeometry(geom) {
/**
* @param {module:ol/geom/MultiPolygon~MultiPolygon} geom MultiPolygon geometry.
* @param {module:ol/geom/MultiPolygon} geom MultiPolygon geometry.
* @return {string} Coordinates part of MultiPolygon as WKT.
*/
function encodeMultiPolygonGeometry(geom) {
@@ -658,7 +658,7 @@ function encodeMultiPolygonGeometry(geom) {
}
/**
* @param {module:ol/geom/SimpleGeometry~SimpleGeometry} geom SimpleGeometry geometry.
* @param {module:ol/geom/SimpleGeometry} geom SimpleGeometry geometry.
* @return {string} Potential dimensional information for WKT type.
*/
function encodeGeometryLayout(geom) {
@@ -676,7 +676,7 @@ function encodeGeometryLayout(geom) {
/**
* @const
* @type {Object.<string, function(module:ol/geom/Geometry~Geometry): string>}
* @type {Object.<string, function(module:ol/geom/Geometry): string>}
*/
const GeometryEncoder = {
'Point': encodePointGeometry,
@@ -691,7 +691,7 @@ const GeometryEncoder = {
/**
* Encode a geometry as WKT.
* @param {module:ol/geom/Geometry~Geometry} geom The geometry to encode.
* @param {module:ol/geom/Geometry} geom The geometry to encode.
* @return {string} WKT string for the geometry.
*/
function encode(geom) {
@@ -715,7 +715,7 @@ function encode(geom) {
/**
* Parse a WKT string.
* @param {string} wkt WKT string.
* @return {module:ol/geom/Geometry~Geometry|undefined}
* @return {module:ol/geom/Geometry|undefined}
* The geometry created.
* @private
*/
@@ -732,7 +732,7 @@ WKT.prototype.parse_ = function(wkt) {
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/Feature~Feature} Feature.
* @return {module:ol/Feature} Feature.
* @api
*/
WKT.prototype.readFeature;
@@ -758,7 +758,7 @@ WKT.prototype.readFeatureFromText = function(text, opt_options) {
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {Array.<module:ol/Feature~Feature>} Features.
* @return {Array.<module:ol/Feature>} Features.
* @api
*/
WKT.prototype.readFeatures;
@@ -772,7 +772,7 @@ WKT.prototype.readFeaturesFromText = function(text, opt_options) {
const geometry = this.readGeometryFromText(text, opt_options);
if (this.splitCollection_ &&
geometry.getType() == GeometryType.GEOMETRY_COLLECTION) {
geometries = (/** @type {module:ol/geom/GeometryCollection~GeometryCollection} */ (geometry))
geometries = (/** @type {module:ol/geom/GeometryCollection} */ (geometry))
.getGeometriesArray();
} else {
geometries = [geometry];
@@ -793,7 +793,7 @@ WKT.prototype.readFeaturesFromText = function(text, opt_options) {
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/geom/Geometry~Geometry} Geometry.
* @return {module:ol/geom/Geometry} Geometry.
* @api
*/
WKT.prototype.readGeometry;
@@ -805,7 +805,9 @@ WKT.prototype.readGeometry;
WKT.prototype.readGeometryFromText = function(text, opt_options) {
const geometry = this.parse_(text);
if (geometry) {
return /** @type {module:ol/geom/Geometry~Geometry} */ (transformWithOptions(geometry, false, opt_options));
return (
/** @type {module:ol/geom/Geometry} */ (transformWithOptions(geometry, false, opt_options))
);
} else {
return null;
}
@@ -813,7 +815,7 @@ WKT.prototype.readGeometryFromText = function(text, opt_options) {
/**
* @enum {function (new:module:ol/geom/Geometry~Geometry, Array, module:ol/geom/GeometryLayout~GeometryLayout)}
* @enum {function (new:module:ol/geom/Geometry, Array, module:ol/geom/GeometryLayout~GeometryLayout)}
*/
const GeometryConstructor = {
'POINT': Point,
@@ -839,7 +841,7 @@ const GeometryParser = {
/**
* @return {!module:ol/geom/Geometry~Geometry} The geometry.
* @return {!module:ol/geom/Geometry} The geometry.
* @private
*/
Parser.prototype.parseGeometry_ = function() {
@@ -868,7 +870,7 @@ Parser.prototype.parseGeometry_ = function() {
* Encode a feature as a WKT string.
*
* @function
* @param {module:ol/Feature~Feature} feature Feature.
* @param {module:ol/Feature} feature Feature.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} WKT string.
* @api
@@ -892,7 +894,7 @@ WKT.prototype.writeFeatureText = function(feature, opt_options) {
* Encode an array of features as a WKT string.
*
* @function
* @param {Array.<module:ol/Feature~Feature>} features Features.
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} WKT string.
* @api
@@ -920,7 +922,7 @@ WKT.prototype.writeFeaturesText = function(features, opt_options) {
* Write a single geometry as a WKT string.
*
* @function
* @param {module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} WKT string.
* @api
@@ -932,7 +934,7 @@ WKT.prototype.writeGeometry;
* @inheritDoc
*/
WKT.prototype.writeGeometryText = function(geometry, opt_options) {
return encode(/** @type {module:ol/geom/Geometry~Geometry} */ (
return encode(/** @type {module:ol/geom/Geometry} */ (
transformWithOptions(geometry, true, opt_options)));
};

2
src/ol/format/WMSCapabilities.js
View File

@@ -14,7 +14,7 @@ import {makeArrayPusher, makeObjectPropertyPusher, makeObjectPropertySetter,
* Format for reading WMS capabilities data
*
* @constructor
* @extends {module:ol/format/XML~XML}
* @extends {module:ol/format/XML}
* @api
*/
const WMSCapabilities = function() {

10
src/ol/format/WMSGetFeatureInfo.js
View File

@@ -21,7 +21,7 @@ import {makeArrayPusher, makeStructureNS, pushParseAndPop} from '../xml.js';
* {@link module:ol/format/GML2~GML2} to read features.
*
* @constructor
* @extends {module:ol/format/XMLFeature~XMLFeature}
* @extends {module:ol/format/XMLFeature}
* @param {module:ol/format/WMSGetFeatureInfo~Options=} opt_options Options.
* @api
*/
@@ -38,7 +38,7 @@ const WMSGetFeatureInfo = function(opt_options) {
/**
* @private
* @type {module:ol/format/GML2~GML2}
* @type {module:ol/format/GML2}
*/
this.gmlFormat_ = new GML2();
@@ -88,13 +88,13 @@ WMSGetFeatureInfo.prototype.setLayers = function(layers) {
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {Array.<module:ol/Feature~Feature>} Features.
* @return {Array.<module:ol/Feature>} Features.
* @private
*/
WMSGetFeatureInfo.prototype.readFeatures_ = function(node, objectStack) {
node.setAttribute('namespaceURI', this.featureNS_);
const localName = node.localName;
/** @type {Array.<module:ol/Feature~Feature>} */
/** @type {Array.<module:ol/Feature>} */
let features = [];
if (node.childNodes.length === 0) {
return features;
@@ -151,7 +151,7 @@ WMSGetFeatureInfo.prototype.readFeatures_ = function(node, objectStack) {
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Options.
* @return {Array.<module:ol/Feature~Feature>} Features.
* @return {Array.<module:ol/Feature>} Features.
* @api
*/
WMSGetFeatureInfo.prototype.readFeatures;

4
src/ol/format/WMTSCapabilities.js
View File

@@ -15,14 +15,14 @@ import {pushParseAndPop, makeStructureNS,
* Format for reading WMTS capabilities data.
*
* @constructor
* @extends {module:ol/format/XML~XML}
* @extends {module:ol/format/XML}
* @api
*/
const WMTSCapabilities = function() {
XML.call(this);
/**
* @type {module:ol/format/OWS~OWS}
* @type {module:ol/format/OWS}
* @private
*/
this.owsParser_ = new OWS();

26
src/ol/format/XMLFeature.js
View File

@@ -15,7 +15,7 @@ import {isDocument, isNode, parse} from '../xml.js';
*
* @constructor
* @abstract
* @extends {module:ol/format/Feature~FeatureFormat}
* @extends {module:ol/format/Feature}
*/
const XMLFeature = function() {
@@ -59,7 +59,7 @@ XMLFeature.prototype.readFeature = function(source, opt_options) {
/**
* @param {Document} doc Document.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Options.
* @return {module:ol/Feature~Feature} Feature.
* @return {module:ol/Feature} Feature.
*/
XMLFeature.prototype.readFeatureFromDocument = function(doc, opt_options) {
const features = this.readFeaturesFromDocument(doc, opt_options);
@@ -74,7 +74,7 @@ XMLFeature.prototype.readFeatureFromDocument = function(doc, opt_options) {
/**
* @param {Node} node Node.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Options.
* @return {module:ol/Feature~Feature} Feature.
* @return {module:ol/Feature} Feature.
*/
XMLFeature.prototype.readFeatureFromNode = function(node, opt_options) {
return null; // not implemented
@@ -103,10 +103,10 @@ XMLFeature.prototype.readFeatures = function(source, opt_options) {
* @param {Document} doc Document.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Options.
* @protected
* @return {Array.<module:ol/Feature~Feature>} Features.
* @return {Array.<module:ol/Feature>} Features.
*/
XMLFeature.prototype.readFeaturesFromDocument = function(doc, opt_options) {
/** @type {Array.<module:ol/Feature~Feature>} */
/** @type {Array.<module:ol/Feature>} */
const features = [];
for (let n = doc.firstChild; n; n = n.nextSibling) {
if (n.nodeType == Node.ELEMENT_NODE) {
@@ -122,7 +122,7 @@ XMLFeature.prototype.readFeaturesFromDocument = function(doc, opt_options) {
* @param {Node} node Node.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Options.
* @protected
* @return {Array.<module:ol/Feature~Feature>} Features.
* @return {Array.<module:ol/Feature>} Features.
*/
XMLFeature.prototype.readFeaturesFromNode = function(node, opt_options) {};
@@ -149,7 +149,7 @@ XMLFeature.prototype.readGeometry = function(source, opt_options) {
* @param {Document} doc Document.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Options.
* @protected
* @return {module:ol/geom/Geometry~Geometry} Geometry.
* @return {module:ol/geom/Geometry} Geometry.
*/
XMLFeature.prototype.readGeometryFromDocument = function(doc, opt_options) {
return null; // not implemented
@@ -160,7 +160,7 @@ XMLFeature.prototype.readGeometryFromDocument = function(doc, opt_options) {
* @param {Node} node Node.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Options.
* @protected
* @return {module:ol/geom/Geometry~Geometry} Geometry.
* @return {module:ol/geom/Geometry} Geometry.
*/
XMLFeature.prototype.readGeometryFromNode = function(node, opt_options) {
return null; // not implemented
@@ -187,7 +187,7 @@ XMLFeature.prototype.readProjection = function(source) {
/**
* @param {Document} doc Document.
* @protected
* @return {module:ol/proj/Projection~Projection} Projection.
* @return {module:ol/proj/Projection} Projection.
*/
XMLFeature.prototype.readProjectionFromDocument = function(doc) {
return this.defaultDataProjection;
@@ -197,7 +197,7 @@ XMLFeature.prototype.readProjectionFromDocument = function(doc) {
/**
* @param {Node} node Node.
* @protected
* @return {module:ol/proj/Projection~Projection} Projection.
* @return {module:ol/proj/Projection} Projection.
*/
XMLFeature.prototype.readProjectionFromNode = function(node) {
return this.defaultDataProjection;
@@ -214,7 +214,7 @@ XMLFeature.prototype.writeFeature = function(feature, opt_options) {
/**
* @param {module:ol/Feature~Feature} feature Feature.
* @param {module:ol/Feature} feature Feature.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Options.
* @protected
* @return {Node} Node.
@@ -234,7 +234,7 @@ XMLFeature.prototype.writeFeatures = function(features, opt_options) {
/**
* @param {Array.<module:ol/Feature~Feature>} features Features.
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Options.
* @return {Node} Node.
*/
@@ -253,7 +253,7 @@ XMLFeature.prototype.writeGeometry = function(geometry, opt_options) {
/**
* @param {module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Options.
* @return {Node} Node.
*/

46
src/ol/format/filter.js
View File

@@ -23,8 +23,8 @@ import Within from '../format/filter/Within.js';
/**
* Create a logical `<And>` operator between two or more filter conditions.
*
* @param {...module:ol/format/filter/Filter~Filter} conditions Filter conditions.
* @returns {!module:ol/format/filter/And~And} `<And>` operator.
* @param {...module:ol/format/filter/Filter} conditions Filter conditions.
* @returns {!module:ol/format/filter/And} `<And>` operator.
* @api
*/
export function and(conditions) {
@@ -36,8 +36,8 @@ export function and(conditions) {
/**
* Create a logical `<Or>` operator between two or more filter conditions.
*
* @param {...module:ol/format/filter/Filter~Filter} conditions Filter conditions.
* @returns {!module:ol/format/filter/Or~Or} `<Or>` operator.
* @param {...module:ol/format/filter/Filter} conditions Filter conditions.
* @returns {!module:ol/format/filter/Or} `<Or>` operator.
* @api
*/
export function or(conditions) {
@@ -49,8 +49,8 @@ export function or(conditions) {
/**
* Represents a logical `<Not>` operator for a filter condition.
*
* @param {!module:ol/format/filter/Filter~Filter} condition Filter condition.
* @returns {!module:ol/format/filter/Not~Not} `<Not>` operator.
* @param {!module:ol/format/filter/Filter} condition Filter condition.
* @returns {!module:ol/format/filter/Not} `<Not>` operator.
* @api
*/
export function not(condition) {
@@ -66,7 +66,7 @@ export function not(condition) {
* @param {!module:ol/extent~Extent} extent Extent.
* @param {string=} opt_srsName SRS name. No srsName attribute will be
* set on geometries when this is not provided.
* @returns {!module:ol/format/filter/Bbox~Bbox} `<BBOX>` operator.
* @returns {!module:ol/format/filter/Bbox} `<BBOX>` operator.
* @api
*/
export function bbox(geometryName, extent, opt_srsName) {
@@ -78,10 +78,10 @@ export function bbox(geometryName, extent, opt_srsName) {
* contains a given geometry.
*
* @param {!string} geometryName Geometry name to use.
* @param {!module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {!module:ol/geom/Geometry} geometry Geometry.
* @param {string=} opt_srsName SRS name. No srsName attribute will be
* set on geometries when this is not provided.
* @returns {!module:ol/format/filter/Contains~Contains} `<Contains>` operator.
* @returns {!module:ol/format/filter/Contains} `<Contains>` operator.
* @api
*/
export function contains(geometryName, geometry, opt_srsName) {
@@ -93,10 +93,10 @@ export function contains(geometryName, geometry, opt_srsName) {
* intersects a given geometry.
*
* @param {!string} geometryName Geometry name to use.
* @param {!module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {!module:ol/geom/Geometry} geometry Geometry.
* @param {string=} opt_srsName SRS name. No srsName attribute will be
* set on geometries when this is not provided.
* @returns {!module:ol/format/filter/Intersects~Intersects} `<Intersects>` operator.
* @returns {!module:ol/format/filter/Intersects} `<Intersects>` operator.
* @api
*/
export function intersects(geometryName, geometry, opt_srsName) {
@@ -108,10 +108,10 @@ export function intersects(geometryName, geometry, opt_srsName) {
* is within a given geometry.
*
* @param {!string} geometryName Geometry name to use.
* @param {!module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {!module:ol/geom/Geometry} geometry Geometry.
* @param {string=} opt_srsName SRS name. No srsName attribute will be
* set on geometries when this is not provided.
* @returns {!module:ol/format/filter/Within~Within} `<Within>` operator.
* @returns {!module:ol/format/filter/Within} `<Within>` operator.
* @api
*/
export function within(geometryName, geometry, opt_srsName) {
@@ -125,7 +125,7 @@ export function within(geometryName, geometry, opt_srsName) {
* @param {!string} propertyName Name of the context property to compare.
* @param {!(string|number)} expression The value to compare.
* @param {boolean=} opt_matchCase Case-sensitive?
* @returns {!module:ol/format/filter/EqualTo~EqualTo} `<PropertyIsEqualTo>` operator.
* @returns {!module:ol/format/filter/EqualTo} `<PropertyIsEqualTo>` operator.
* @api
*/
export function equalTo(propertyName, expression, opt_matchCase) {
@@ -139,7 +139,7 @@ export function equalTo(propertyName, expression, opt_matchCase) {
* @param {!string} propertyName Name of the context property to compare.
* @param {!(string|number)} expression The value to compare.
* @param {boolean=} opt_matchCase Case-sensitive?
* @returns {!module:ol/format/filter/NotEqualTo~NotEqualTo} `<PropertyIsNotEqualTo>` operator.
* @returns {!module:ol/format/filter/NotEqualTo} `<PropertyIsNotEqualTo>` operator.
* @api
*/
export function notEqualTo(propertyName, expression, opt_matchCase) {
@@ -152,7 +152,7 @@ export function notEqualTo(propertyName, expression, opt_matchCase) {
*
* @param {!string} propertyName Name of the context property to compare.
* @param {!number} expression The value to compare.
* @returns {!module:ol/format/filter/LessThan~LessThan} `<PropertyIsLessThan>` operator.
* @returns {!module:ol/format/filter/LessThan} `<PropertyIsLessThan>` operator.
* @api
*/
export function lessThan(propertyName, expression) {
@@ -165,7 +165,7 @@ export function lessThan(propertyName, expression) {
*
* @param {!string} propertyName Name of the context property to compare.
* @param {!number} expression The value to compare.
* @returns {!module:ol/format/filter/LessThanOrEqualTo~LessThanOrEqualTo} `<PropertyIsLessThanOrEqualTo>` operator.
* @returns {!module:ol/format/filter/LessThanOrEqualTo} `<PropertyIsLessThanOrEqualTo>` operator.
* @api
*/
export function lessThanOrEqualTo(propertyName, expression) {
@@ -178,7 +178,7 @@ export function lessThanOrEqualTo(propertyName, expression) {
*
* @param {!string} propertyName Name of the context property to compare.
* @param {!number} expression The value to compare.
* @returns {!module:ol/format/filter/GreaterThan~GreaterThan} `<PropertyIsGreaterThan>` operator.
* @returns {!module:ol/format/filter/GreaterThan} `<PropertyIsGreaterThan>` operator.
* @api
*/
export function greaterThan(propertyName, expression) {
@@ -191,7 +191,7 @@ export function greaterThan(propertyName, expression) {
*
* @param {!string} propertyName Name of the context property to compare.
* @param {!number} expression The value to compare.
* @returns {!module:ol/format/filter/GreaterThanOrEqualTo~GreaterThanOrEqualTo} `<PropertyIsGreaterThanOrEqualTo>` operator.
* @returns {!module:ol/format/filter/GreaterThanOrEqualTo} `<PropertyIsGreaterThanOrEqualTo>` operator.
* @api
*/
export function greaterThanOrEqualTo(propertyName, expression) {
@@ -204,7 +204,7 @@ export function greaterThanOrEqualTo(propertyName, expression) {
* is null.
*
* @param {!string} propertyName Name of the context property to compare.
* @returns {!module:ol/format/filter/IsNull~IsNull} `<PropertyIsNull>` operator.
* @returns {!module:ol/format/filter/IsNull} `<PropertyIsNull>` operator.
* @api
*/
export function isNull(propertyName) {
@@ -219,7 +219,7 @@ export function isNull(propertyName) {
* @param {!string} propertyName Name of the context property to compare.
* @param {!number} lowerBoundary The lower bound of the range.
* @param {!number} upperBoundary The upper bound of the range.
* @returns {!module:ol/format/filter/IsBetween~IsBetween} `<PropertyIsBetween>` operator.
* @returns {!module:ol/format/filter/IsBetween} `<PropertyIsBetween>` operator.
* @api
*/
export function between(propertyName, lowerBoundary, upperBoundary) {
@@ -240,7 +240,7 @@ export function between(propertyName, lowerBoundary, upperBoundary) {
* @param {string=} opt_escapeChar Escape character which can be used to escape
* the pattern characters. Default is '!'.
* @param {boolean=} opt_matchCase Case-sensitive?
* @returns {!module:ol/format/filter/IsLike~IsLike} `<PropertyIsLike>` operator.
* @returns {!module:ol/format/filter/IsLike} `<PropertyIsLike>` operator.
* @api
*/
export function like(propertyName, pattern,
@@ -256,7 +256,7 @@ export function like(propertyName, pattern,
* @param {!string} propertyName Name of the context property to compare.
* @param {!string} begin The begin date in ISO-8601 format.
* @param {!string} end The end date in ISO-8601 format.
* @returns {!module:ol/format/filter/During~During} `<During>` operator.
* @returns {!module:ol/format/filter/During} `<During>` operator.
* @api
*/
export function during(propertyName, begin, end) {

4
src/ol/format/filter/And.js
View File

@@ -10,8 +10,8 @@ import LogicalNary from '../filter/LogicalNary.js';
*
* @constructor
* @abstract
* @param {...module:ol/format/filter/Filter~Filter} conditions Conditions.
* @extends {module:ol/format/filter/LogicalNary~LogicalNary}
* @param {...module:ol/format/filter/Filter} conditions Conditions.
* @extends {module:ol/format/filter/LogicalNary}
*/
const And = function(conditions) {
const params = ['And'].concat(Array.prototype.slice.call(arguments));

2
src/ol/format/filter/Bbox.js
View File

@@ -14,7 +14,7 @@ import Filter from '../filter/Filter.js';
* @param {!module:ol/extent~Extent} extent Extent.
* @param {string=} opt_srsName SRS name. No srsName attribute will be
* set on geometries when this is not provided.
* @extends {module:ol/format/filter/Filter~Filter}
* @extends {module:ol/format/filter/Filter}
* @api
*/
const Bbox = function(geometryName, extent, opt_srsName) {

2
src/ol/format/filter/Comparison.js
View File

@@ -13,7 +13,7 @@ import Filter from '../filter/Filter.js';
* @abstract
* @param {!string} tagName The XML tag name for this filter.
* @param {!string} propertyName Name of the context property to compare.
* @extends {module:ol/format/filter/Filter~Filter}
* @extends {module:ol/format/filter/Filter}
*/
const Comparison = function(tagName, propertyName) {

2
src/ol/format/filter/ComparisonBinary.js
View File

@@ -15,7 +15,7 @@ import Comparison from '../filter/Comparison.js';
* @param {!string} propertyName Name of the context property to compare.
* @param {!(string|number)} expression The value to compare.
* @param {boolean=} opt_matchCase Case-sensitive?
* @extends {module:ol/format/filter/Comparison~Comparison}
* @extends {module:ol/format/filter/Comparison}
*/
const ComparisonBinary = function(tagName, propertyName, expression, opt_matchCase) {

4
src/ol/format/filter/Contains.js
View File

@@ -11,10 +11,10 @@ import Spatial from '../filter/Spatial.js';
*
* @constructor
* @param {!string} geometryName Geometry name to use.
* @param {!module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {!module:ol/geom/Geometry} geometry Geometry.
* @param {string=} opt_srsName SRS name. No srsName attribute will be
* set on geometries when this is not provided.
* @extends {module:ol/format/filter/Spatial~Spatial}
* @extends {module:ol/format/filter/Spatial}
* @api
*/
const Contains = function(geometryName, geometry, opt_srsName) {

2
src/ol/format/filter/During.js
View File

@@ -12,7 +12,7 @@ import Comparison from '../filter/Comparison.js';
* @param {!string} propertyName Name of the context property to compare.
* @param {!string} begin The begin date in ISO-8601 format.
* @param {!string} end The end date in ISO-8601 format.
* @extends {module:ol/format/filter/Comparison~Comparison}
* @extends {module:ol/format/filter/Comparison}
* @api
*/
const During = function(propertyName, begin, end) {

2
src/ol/format/filter/EqualTo.js
View File

@@ -12,7 +12,7 @@ import ComparisonBinary from '../filter/ComparisonBinary.js';
* @param {!string} propertyName Name of the context property to compare.
* @param {!(string|number)} expression The value to compare.
* @param {boolean=} opt_matchCase Case-sensitive?
* @extends {module:ol/format/filter/ComparisonBinary~ComparisonBinary}
* @extends {module:ol/format/filter/ComparisonBinary}
* @api
*/
const EqualTo = function(propertyName, expression, opt_matchCase) {

2
src/ol/format/filter/GreaterThan.js
View File

@@ -11,7 +11,7 @@ import ComparisonBinary from '../filter/ComparisonBinary.js';
* @constructor
* @param {!string} propertyName Name of the context property to compare.
* @param {!number} expression The value to compare.
* @extends {module:ol/format/filter/ComparisonBinary~ComparisonBinary}
* @extends {module:ol/format/filter/ComparisonBinary}
* @api
*/
const GreaterThan = function(propertyName, expression) {

2
src/ol/format/filter/GreaterThanOrEqualTo.js
View File

@@ -11,7 +11,7 @@ import ComparisonBinary from '../filter/ComparisonBinary.js';
* @constructor
* @param {!string} propertyName Name of the context property to compare.
* @param {!number} expression The value to compare.
* @extends {module:ol/format/filter/ComparisonBinary~ComparisonBinary}
* @extends {module:ol/format/filter/ComparisonBinary}
* @api
*/
const GreaterThanOrEqualTo = function(propertyName, expression) {

4
src/ol/format/filter/Intersects.js
View File

@@ -11,10 +11,10 @@ import Spatial from '../filter/Spatial.js';
*
* @constructor
* @param {!string} geometryName Geometry name to use.
* @param {!module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {!module:ol/geom/Geometry} geometry Geometry.
* @param {string=} opt_srsName SRS name. No srsName attribute will be
* set on geometries when this is not provided.
* @extends {module:ol/format/filter/Spatial~Spatial}
* @extends {module:ol/format/filter/Spatial}
* @api
*/
const Intersects = function(geometryName, geometry, opt_srsName) {

2
src/ol/format/filter/IsBetween.js
View File

@@ -12,7 +12,7 @@ import Comparison from '../filter/Comparison.js';
* @param {!string} propertyName Name of the context property to compare.
* @param {!number} lowerBoundary The lower bound of the range.
* @param {!number} upperBoundary The upper bound of the range.
* @extends {module:ol/format/filter/Comparison~Comparison}
* @extends {module:ol/format/filter/Comparison}
* @api
*/
const IsBetween = function(propertyName, lowerBoundary, upperBoundary) {

2
src/ol/format/filter/IsLike.js
View File

@@ -18,7 +18,7 @@ import Comparison from '../filter/Comparison.js';
* @param {string=} opt_escapeChar Escape character which can be used to escape
* the pattern characters. Default is '!'.
* @param {boolean=} opt_matchCase Case-sensitive?
* @extends {module:ol/format/filter/Comparison~Comparison}
* @extends {module:ol/format/filter/Comparison}
* @api
*/
const IsLike = function(propertyName, pattern, opt_wildCard, opt_singleChar, opt_escapeChar, opt_matchCase) {

2
src/ol/format/filter/IsNull.js
View File

@@ -10,7 +10,7 @@ import Comparison from '../filter/Comparison.js';
*
* @constructor
* @param {!string} propertyName Name of the context property to compare.
* @extends {module:ol/format/filter/Comparison~Comparison}
* @extends {module:ol/format/filter/Comparison}
* @api
*/
const IsNull = function(propertyName) {

2
src/ol/format/filter/LessThan.js
View File

@@ -11,7 +11,7 @@ import ComparisonBinary from '../filter/ComparisonBinary.js';
* @constructor
* @param {!string} propertyName Name of the context property to compare.
* @param {!number} expression The value to compare.
* @extends {module:ol/format/filter/ComparisonBinary~ComparisonBinary}
* @extends {module:ol/format/filter/ComparisonBinary}
* @api
*/
const LessThan = function(propertyName, expression) {

2
src/ol/format/filter/LessThanOrEqualTo.js
View File

@@ -11,7 +11,7 @@ import ComparisonBinary from '../filter/ComparisonBinary.js';
* @constructor
* @param {!string} propertyName Name of the context property to compare.
* @param {!number} expression The value to compare.
* @extends {module:ol/format/filter/ComparisonBinary~ComparisonBinary}
* @extends {module:ol/format/filter/ComparisonBinary}
* @api
*/
const LessThanOrEqualTo = function(propertyName, expression) {

6
src/ol/format/filter/LogicalNary.js
View File

@@ -13,15 +13,15 @@ import Filter from '../filter/Filter.js';
* @constructor
* @abstract
* @param {!string} tagName The XML tag name for this filter.
* @param {...module:ol/format/filter/Filter~Filter} conditions Conditions.
* @extends {module:ol/format/filter/Filter~Filter}
* @param {...module:ol/format/filter/Filter} conditions Conditions.
* @extends {module:ol/format/filter/Filter}
*/
const LogicalNary = function(tagName, conditions) {
Filter.call(this, tagName);
/**
* @type {Array.<module:ol/format/filter/Filter~Filter>}
* @type {Array.<module:ol/format/filter/Filter>}
*/
this.conditions = Array.prototype.slice.call(arguments, 1);
assert(this.conditions.length >= 2, 57); // At least 2 conditions are required.

6
src/ol/format/filter/Not.js
View File

@@ -9,8 +9,8 @@ import Filter from '../filter/Filter.js';
* Represents a logical `<Not>` operator for a filter condition.
*
* @constructor
* @param {!module:ol/format/filter/Filter~Filter} condition Filter condition.
* @extends {module:ol/format/filter/Filter~Filter}
* @param {!module:ol/format/filter/Filter} condition Filter condition.
* @extends {module:ol/format/filter/Filter}
* @api
*/
const Not = function(condition) {
@@ -18,7 +18,7 @@ const Not = function(condition) {
Filter.call(this, 'Not');
/**
* @type {!module:ol/format/filter/Filter~Filter}
* @type {!module:ol/format/filter/Filter}
*/
this.condition = condition;
};

2
src/ol/format/filter/NotEqualTo.js
View File

@@ -12,7 +12,7 @@ import ComparisonBinary from '../filter/ComparisonBinary.js';
* @param {!string} propertyName Name of the context property to compare.
* @param {!(string|number)} expression The value to compare.
* @param {boolean=} opt_matchCase Case-sensitive?
* @extends {module:ol/format/filter/ComparisonBinary~ComparisonBinary}
* @extends {module:ol/format/filter/ComparisonBinary}
* @api
*/
const NotEqualTo = function(propertyName, expression, opt_matchCase) {

4
src/ol/format/filter/Or.js
View File

@@ -9,8 +9,8 @@ import LogicalNary from '../filter/LogicalNary.js';
* Represents a logical `<Or>` operator between two ore more filter conditions.
*
* @constructor
* @param {...module:ol/format/filter/Filter~Filter} conditions Conditions.
* @extends {module:ol/format/filter/LogicalNary~LogicalNary}
* @param {...module:ol/format/filter/Filter} conditions Conditions.
* @extends {module:ol/format/filter/LogicalNary}
* @api
*/
const Or = function(conditions) {

6
src/ol/format/filter/Spatial.js
View File

@@ -14,10 +14,10 @@ import Filter from '../filter/Filter.js';
* @abstract
* @param {!string} tagName The XML tag name for this filter.
* @param {!string} geometryName Geometry name to use.
* @param {!module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {!module:ol/geom/Geometry} geometry Geometry.
* @param {string=} opt_srsName SRS name. No srsName attribute will be
* set on geometries when this is not provided.
* @extends {module:ol/format/filter/Filter~Filter}
* @extends {module:ol/format/filter/Filter}
*/
const Spatial = function(tagName, geometryName, geometry, opt_srsName) {
@@ -29,7 +29,7 @@ const Spatial = function(tagName, geometryName, geometry, opt_srsName) {
this.geometryName = geometryName || 'the_geom';
/**
* @type {module:ol/geom/Geometry~Geometry}
* @type {module:ol/geom/Geometry}
*/
this.geometry = geometry;

4
src/ol/format/filter/Within.js
View File

@@ -11,10 +11,10 @@ import Spatial from '../filter/Spatial.js';
*
* @constructor
* @param {!string} geometryName Geometry name to use.
* @param {!module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {!module:ol/geom/Geometry} geometry Geometry.
* @param {string=} opt_srsName SRS name. No srsName attribute will be
* set on geometries when this is not provided.
* @extends {module:ol/format/filter/Spatial~Spatial}
* @extends {module:ol/format/filter/Spatial}
* @api
*/
const Within = function(geometryName, geometry, opt_srsName) {