Move GPX typedefs out of src/ol/typedefs.js

This commit is contained in:
Frederic Junod
2018-03-22 16:58:02 +01:00
parent 13ca7bc52e
commit c34e7e2246
2 changed files with 12 additions and 13 deletions
+12 -7
View File
@@ -28,6 +28,11 @@ import {createElementNS, makeArrayPusher, makeArraySerializer, makeChildAppender
* directly mapped to a feature. * directly mapped to a feature.
*/ */
/**
* @typedef {Object} LayoutOptions
* @property {boolean} [hasZ]
* @property {boolean} [hasM]
*/
/** /**
* @classdesc * @classdesc
@@ -389,7 +394,7 @@ const GPX_SERIALIZERS = makeStructureNS(
/** /**
* @param {Array.<number>} flatCoordinates Flat coordinates. * @param {Array.<number>} flatCoordinates Flat coordinates.
* @param {ol.LayoutOptions} layoutOptions Layout options. * @param {module:ol/format/GPX~LayoutOptions} layoutOptions Layout options.
* @param {Node} node Node. * @param {Node} node Node.
* @param {!Object} values Values. * @param {!Object} values Values.
* @return {Array.<number>} Flat coordinates. * @return {Array.<number>} Flat coordinates.
@@ -420,7 +425,7 @@ function appendCoordinate(flatCoordinates, layoutOptions, node, values) {
* Choose GeometryLayout based on flags in layoutOptions and adjust flatCoordinates * Choose GeometryLayout based on flags in layoutOptions and adjust flatCoordinates
* and ends arrays by shrinking them accordingly (removing unused zero entries). * and ends arrays by shrinking them accordingly (removing unused zero entries).
* *
* @param {ol.LayoutOptions} layoutOptions Layout options. * @param {module:ol/format/GPX~LayoutOptions} layoutOptions Layout options.
* @param {Array.<number>} flatCoordinates Flat coordinates. * @param {Array.<number>} flatCoordinates Flat coordinates.
* @param {Array.<number>=} ends Ends. * @param {Array.<number>=} ends Ends.
* @return {module:ol/geom/GeometryLayout~GeometryLayout} Layout. * @return {module:ol/geom/GeometryLayout~GeometryLayout} Layout.
@@ -493,7 +498,7 @@ function parseRtePt(node, objectStack) {
if (values) { if (values) {
const rteValues = /** @type {!Object} */ (objectStack[objectStack.length - 1]); const rteValues = /** @type {!Object} */ (objectStack[objectStack.length - 1]);
const flatCoordinates = /** @type {Array.<number>} */ (rteValues['flatCoordinates']); const flatCoordinates = /** @type {Array.<number>} */ (rteValues['flatCoordinates']);
const layoutOptions = /** @type {ol.LayoutOptions} */ (rteValues['layoutOptions']); const layoutOptions = /** @type {module:ol/format/GPX~LayoutOptions} */ (rteValues['layoutOptions']);
appendCoordinate(flatCoordinates, layoutOptions, node, values); appendCoordinate(flatCoordinates, layoutOptions, node, values);
} }
} }
@@ -508,7 +513,7 @@ function parseTrkPt(node, objectStack) {
if (values) { if (values) {
const trkValues = /** @type {!Object} */ (objectStack[objectStack.length - 1]); const trkValues = /** @type {!Object} */ (objectStack[objectStack.length - 1]);
const flatCoordinates = /** @type {Array.<number>} */ (trkValues['flatCoordinates']); const flatCoordinates = /** @type {Array.<number>} */ (trkValues['flatCoordinates']);
const layoutOptions = /** @type {ol.LayoutOptions} */ (trkValues['layoutOptions']); const layoutOptions = /** @type {module:ol/format/GPX~LayoutOptions} */ (trkValues['layoutOptions']);
appendCoordinate(flatCoordinates, layoutOptions, node, values); appendCoordinate(flatCoordinates, layoutOptions, node, values);
} }
} }
@@ -545,7 +550,7 @@ function readRte(node, objectStack) {
const flatCoordinates = /** @type {Array.<number>} */ const flatCoordinates = /** @type {Array.<number>} */
(values['flatCoordinates']); (values['flatCoordinates']);
delete values['flatCoordinates']; delete values['flatCoordinates'];
const layoutOptions = /** @type {ol.LayoutOptions} */ (values['layoutOptions']); const layoutOptions = /** @type {module:ol/format/GPX~LayoutOptions} */ (values['layoutOptions']);
delete values['layoutOptions']; delete values['layoutOptions'];
const layout = applyLayoutOptions(layoutOptions, flatCoordinates); const layout = applyLayoutOptions(layoutOptions, flatCoordinates);
const geometry = new LineString(null); const geometry = new LineString(null);
@@ -577,7 +582,7 @@ function readTrk(node, objectStack) {
delete values['flatCoordinates']; delete values['flatCoordinates'];
const ends = /** @type {Array.<number>} */ (values['ends']); const ends = /** @type {Array.<number>} */ (values['ends']);
delete values['ends']; delete values['ends'];
const layoutOptions = /** @type {ol.LayoutOptions} */ (values['layoutOptions']); const layoutOptions = /** @type {module:ol/format/GPX~LayoutOptions} */ (values['layoutOptions']);
delete values['layoutOptions']; delete values['layoutOptions'];
const layout = applyLayoutOptions(layoutOptions, flatCoordinates, ends); const layout = applyLayoutOptions(layoutOptions, flatCoordinates, ends);
const geometry = new MultiLineString(null); const geometry = new MultiLineString(null);
@@ -600,7 +605,7 @@ function readWpt(node, objectStack) {
if (!values) { if (!values) {
return undefined; return undefined;
} }
const layoutOptions = /** @type {ol.LayoutOptions} */ ({}); const layoutOptions = /** @type {module:ol/format/GPX~LayoutOptions} */ ({});
const coordinates = appendCoordinate([], layoutOptions, node, values); const coordinates = appendCoordinate([], layoutOptions, node, values);
const layout = applyLayoutOptions(layoutOptions, coordinates); const layout = applyLayoutOptions(layoutOptions, coordinates);
const geometry = new Point(coordinates, layout); const geometry = new Point(coordinates, layout);
-6
View File
@@ -127,12 +127,6 @@ ol.CircleRenderOptions;
ol.DeclutterGroup; ol.DeclutterGroup;
/**
* @typedef {{hasZ: (boolean|undefined), hasM: (boolean|undefined)}}
*/
ol.LayoutOptions;
/** /**
* @typedef {{prev: (ol.LinkedListItem|undefined), * @typedef {{prev: (ol.LinkedListItem|undefined),
* next: (ol.LinkedListItem|undefined), * next: (ol.LinkedListItem|undefined),