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

Merge pull request #8385 from openlayers/class

Browse Source 
Use class syntax
This commit is contained in:
Tim Schaub
2018-07-18 09:16:27 -07:00
committed by GitHub
parent 60e85e7d89 4cdab30201
commit b4ce8e4b3d
248 changed files with 42112 additions and 44134 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.gitignore
-2
View File
@@ -2,5 +2,3 @@
/coverage/
/dist/
node_modules/
src/index.js
src/ol/package.json
config/rollup.js
+1 -1
View File
@@ -7,7 +7,7 @@ import buble from 'rollup-plugin-buble';
import sourcemaps from 'rollup-plugin-sourcemaps';
export default {
input: 'src/index.js',
input: 'build/index.js',
output: [
{file: 'build/ol.js', format: 'iife', sourcemap: true}
],
package.json
+9 -16
View File
@@ -1,5 +1,5 @@
{
"name": "openlayers",
"name": "ol",
"version": "5.0.3",
"description": "OpenLayers mapping library",
"keywords": [
@@ -7,6 +7,7 @@
"mapping",
"ol"
],
"private": true,
"homepage": "https://openlayers.org/",
"scripts": {
"lint": "eslint tasks test src/ol examples config",
@@ -15,18 +16,13 @@
"karma": "karma start test/karma.config.js",
"serve-examples": "webpack-dev-server --config examples/webpack/config.js --mode development --watch",
"build-examples": "webpack --config examples/webpack/config.js --mode production",
"build-index": "node tasks/generate-index",
"prepare-package": "node tasks/prepare-package",
"prebuild": "npm run prepare-package && npm run build-index",
"prepare": "npm run prepare-package",
"build": "rollup --config config/rollup.js && cleancss --source-map src/ol/ol.css -o build/ol.css",
"presrc-closure": "npm run prebuild",
"src-closure": "node tasks/transform-types",
"pretypecheck": "npm run src-closure",
"typecheck": "node tasks/typecheck",
"build-package": "npm run transpile && node tasks/prepare-package",
"build-index": "npm run build-package && node tasks/generate-index",
"build-legacy": "rm -rf build && npm run build-index && rollup --config config/rollup.js && cleancss --source-map src/ol/ol.css -o build/ol.css",
"transpile": "rm -rf build/ol && mkdir -p build && buble --input src/ol --output build/ol --no modules --sourcemap",
"apidoc": "jsdoc config/jsdoc/api/index.md -c config/jsdoc/api/conf.json -P package.json -d build/apidoc"
},
"main": "src/ol/index.js",
"main": "index.js",
"repository": {
"type": "git",
"url": "git://github.com/openlayers/openlayers.git"
@@ -41,20 +37,18 @@
"rbush": "2.0.2"
},
"devDependencies": {
"babel-core": "^6.26.3",
"babel-plugin-jsdoc-closure": "1.5.1",
"buble": "^0.19.3",
"buble-loader": "^0.5.1",
"chaikin-smooth": "^1.0.4",
"clean-css-cli": "4.1.11",
"copy-webpack-plugin": "^4.4.1",
"coveralls": "3.0.1",
"eslint": "5.0.1",
"eslint-config-openlayers": "^9.2.0",
"eslint-config-openlayers": "^10.0.0",
"expect.js": "0.3.1",
"front-matter": "^2.1.2",
"fs-extra": "^6.0.0",
"glob": "^7.1.2",
"google-closure-compiler": "20180610.0.2",
"handlebars": "4.0.11",
"istanbul": "0.4.5",
"jquery": "3.3.1",
@@ -72,7 +66,6 @@
"mustache": "^2.3.0",
"pixelmatch": "^4.0.2",
"proj4": "2.4.4",
"recast": "0.15.2",
"rollup": "0.62.0",
"rollup-plugin-buble": "0.19.2",
"rollup-plugin-commonjs": "9.1.3",
src/ol/AssertionError.js
+15 -11
View File
@@ -1,26 +1,25 @@
/**
* @module ol/AssertionError
*/
import {VERSION, inherits} from './util.js';
import {VERSION} from './util.js';
/**
* Error object thrown when an assertion failed. This is an ECMA-262 Error,
* extended with a `code` property.
* @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error}
* @constructor
* @extends {Error}
* @param {number} code Error code.
*/
const AssertionError = function(code) {
const path = VERSION.split('-')[0];
class AssertionError extends Error {
/**
* @type {string}
* @param {number} code Error code.
*/
this.message = 'Assertion failed. See https://openlayers.org/en/' + path +
constructor(code) {
const path = VERSION.split('-')[0];
const message = 'Assertion failed. See https://openlayers.org/en/' + path +
'/doc/errors/#' + code + ' for details.';
super(message);
/**
* Error code. The meaning of the code can be found on
* {@link https://openlayers.org/en/latest/doc/errors/} (replace `latest` with
@@ -31,10 +30,15 @@ const AssertionError = function(code) {
*/
this.code = code;
/**
* @type {string}
*/
this.name = 'AssertionError';
};
// Re-assign message, see https://github.com/Rich-Harris/buble/issues/40
this.message = message;
}
inherits(AssertionError, Error);
}
export default AssertionError;
src/ol/Collection.js
+60 -74
View File
@@ -1,7 +1,6 @@
/**
* @module ol/Collection
*/
import {inherits} from './util.js';
import AssertionError from './AssertionError.js';
import CollectionEventType from './CollectionEventType.js';
import BaseObject from './Object.js';
@@ -21,15 +20,15 @@ const Property = {
* @classdesc
* Events emitted by {@link module:ol/Collection~Collection} instances are instances of this
* type.
*
* @constructor
* @extends {module:ol/events/Event}
*/
export class CollectionEvent extends Event {
/**
* @param {module:ol/CollectionEventType} type Type.
* @param {*=} opt_element Element.
*/
export const CollectionEvent = function(type, opt_element) {
Event.call(this, type);
constructor(type, opt_element) {
super(type);
/**
* The element that is added to or removed from the collection.
@@ -38,9 +37,9 @@ export const CollectionEvent = function(type, opt_element) {
*/
this.element = opt_element;
};
}
inherits(CollectionEvent, Event);
}
/**
@@ -57,17 +56,18 @@ inherits(CollectionEvent, Event);
* Collection; they trigger events on the appropriate object, not on the
* Collection as a whole.
*
* @constructor
* @extends {module:ol/Object}
* @fires module:ol/Collection~CollectionEvent
* @api
*/
class Collection extends BaseObject {
/**
* @param {Array.<T>=} opt_array Array.
* @param {module:ol/Collection~Options=} opt_options Collection options.
* @template T
* @api
*/
const Collection = function(opt_array, opt_options) {
constructor(opt_array, opt_options) {
BaseObject.call(this);
super();
const options = opt_options || {};
@@ -91,53 +91,47 @@ const Collection = function(opt_array, opt_options) {
this.updateLength_();
};
}
inherits(Collection, BaseObject);
/**
/**
* Remove all elements from the collection.
* @api
*/
Collection.prototype.clear = function() {
clear() {
while (this.getLength() > 0) {
this.pop();
}
};
}
/**
/**
* Add elements to the collection. This pushes each item in the provided array
* to the end of the collection.
* @param {!Array.<T>} arr Array.
* @return {module:ol/Collection.<T>} This collection.
* @api
*/
Collection.prototype.extend = function(arr) {
extend(arr) {
for (let i = 0, ii = arr.length; i < ii; ++i) {
this.push(arr[i]);
}
return this;
};
}
/**
/**
* Iterate over each element, calling the provided callback.
* @param {function(T, number, Array.<T>): *} f The function to call
* for every element. This function takes 3 arguments (the element, the
* index and the array). The return value is ignored.
* @api
*/
Collection.prototype.forEach = function(f) {
forEach(f) {
const array = this.array_;
for (let i = 0, ii = array.length; i < ii; ++i) {
f(array[i], i, array);
}
};
}
/**
/**
* Get a reference to the underlying Array object. Warning: if the array
* is mutated, no events will be dispatched by the collection, and the
* collection's "length" property won't be in sync with the actual length
@@ -145,40 +139,37 @@ Collection.prototype.forEach = function(f) {
* @return {!Array.<T>} Array.
* @api
*/
Collection.prototype.getArray = function() {
getArray() {
return this.array_;
};
}
/**
/**
* Get the element at the provided index.
* @param {number} index Index.
* @return {T} Element.
* @api
*/
Collection.prototype.item = function(index) {
item(index) {
return this.array_[index];
};
}
/**
/**
* Get the length of this collection.
* @return {number} The length of the array.
* @observable
* @api
*/
Collection.prototype.getLength = function() {
getLength() {
return /** @type {number} */ (this.get(Property.LENGTH));
};
}
/**
/**
* Insert an element at the provided index.
* @param {number} index Index.
* @param {T} elem Element.
* @api
*/
Collection.prototype.insertAt = function(index, elem) {
insertAt(index, elem) {
if (this.unique_) {
this.assertUnique_(elem);
}
@@ -186,43 +177,40 @@ Collection.prototype.insertAt = function(index, elem) {
this.updateLength_();
this.dispatchEvent(
new CollectionEvent(CollectionEventType.ADD, elem));
};
}
/**
/**
* Remove the last element of the collection and return it.
* Return `undefined` if the collection is empty.
* @return {T|undefined} Element.
* @api
*/
Collection.prototype.pop = function() {
pop() {
return this.removeAt(this.getLength() - 1);
};
}
/**
/**
* Insert the provided element at the end of the collection.
* @param {T} elem Element.
* @return {number} New length of the collection.
* @api
*/
Collection.prototype.push = function(elem) {
push(elem) {
if (this.unique_) {
this.assertUnique_(elem);
}
const n = this.getLength();
this.insertAt(n, elem);
return this.getLength();
};
}
/**
/**
* Remove the first occurrence of an element from the collection.
* @param {T} elem Element.
* @return {T|undefined} The removed element or undefined if none found.
* @api
*/
Collection.prototype.remove = function(elem) {
remove(elem) {
const arr = this.array_;
for (let i = 0, ii = arr.length; i < ii; ++i) {
if (arr[i] === elem) {
@@ -230,32 +218,30 @@ Collection.prototype.remove = function(elem) {
}
}
return undefined;
};
}
/**
/**
* Remove the element at the provided index and return it.
* Return `undefined` if the collection does not contain this index.
* @param {number} index Index.
* @return {T|undefined} Value.
* @api
*/
Collection.prototype.removeAt = function(index) {
removeAt(index) {
const prev = this.array_[index];
this.array_.splice(index, 1);
this.updateLength_();
this.dispatchEvent(new CollectionEvent(CollectionEventType.REMOVE, prev));
return prev;
};
}
/**
/**
* Set the element at the provided index.
* @param {number} index Index.
* @param {T} elem Element.
* @api
*/
Collection.prototype.setAt = function(index, elem) {
setAt(index, elem) {
const n = this.getLength();
if (index < n) {
if (this.unique_) {
@@ -273,28 +259,28 @@ Collection.prototype.setAt = function(index, elem) {
}
this.insertAt(index, elem);
}
};
}
/**
/**
* @private
*/
Collection.prototype.updateLength_ = function() {
updateLength_() {
this.set(Property.LENGTH, this.array_.length);
};
}
/**
/**
* @private
* @param {T} elem Element.
* @param {number=} opt_except Optional index to ignore.
*/
Collection.prototype.assertUnique_ = function(elem, opt_except) {
assertUnique_(elem, opt_except) {
for (let i = 0, ii = this.array_.length; i < ii; ++i) {
if (this.array_[i] === elem && i !== opt_except) {
throw new AssertionError(58);
}
}
};
}
}
export default Collection;
src/ol/Disposable.js
+11 -12
View File
@@ -5,9 +5,18 @@ import {UNDEFINED} from './functions.js';
/**
* Objects that need to clean up after themselves.
* @constructor
*/
const Disposable = function() {};
class Disposable {
/**
* Clean up.
*/
dispose() {
if (!this.disposed_) {
this.disposed_ = true;
this.disposeInternal();
}
}
}
/**
* The object has already been disposed.
@@ -16,16 +25,6 @@ const Disposable = function() {};
*/
Disposable.prototype.disposed_ = false;
/**
* Clean up.
*/
Disposable.prototype.dispose = function() {
if (!this.disposed_) {
this.disposed_ = true;
this.disposeInternal();
}
};
/**
* Extension point for disposable objects.
* @protected
src/ol/Feature.js
+45 -57
View File
@@ -4,7 +4,6 @@
import {assert} from './asserts.js';
import {listen, unlisten, unlistenByKey} from './events.js';
import EventType from './events/EventType.js';
import {inherits} from './util.js';
import BaseObject, {getChangeEventType} from './Object.js';
import Geometry from './geom/Geometry.js';
import Style from './style/Style.js';
@@ -51,17 +50,19 @@ import Style from './style/Style.js';
* var point = feature.getGeometry();
* ```
*
* @constructor
* @extends {module:ol/Object}
* @api
*/
class Feature extends BaseObject {
/**
* @param {module:ol/geom/Geometry|Object.<string, *>=} opt_geometryOrProperties
* You may pass a Geometry object directly, or an object literal containing
* properties. If you pass an object literal, you may include a Geometry
* associated with a `geometry` key.
* @api
*/
const Feature = function(opt_geometryOrProperties) {
constructor(opt_geometryOrProperties) {
BaseObject.call(this);
super();
/**
* @private
@@ -109,18 +110,15 @@ const Feature = function(opt_geometryOrProperties) {
this.setProperties(properties);
}
}
};
}
inherits(Feature, BaseObject);
/**
/**
* Clone this feature. If the original feature has a geometry it
* is also cloned. The feature id is not set in the clone.
* @return {module:ol/Feature} The clone.
* @api
*/
Feature.prototype.clone = function() {
clone() {
const clone = new Feature(this.getProperties());
clone.setGeometryName(this.getGeometryName());
const geometry = this.getGeometry();
@@ -132,10 +130,9 @@ Feature.prototype.clone = function() {
clone.setStyle(style);
}
return clone;
};
}
/**
/**
* Get the feature's default geometry. A feature may have any number of named
* geometries. The "default" geometry (the one that is rendered by default) is
* set when calling {@link module:ol/Feature~Feature#setGeometry}.
@@ -143,71 +140,65 @@ Feature.prototype.clone = function() {
* @api
* @observable
*/
Feature.prototype.getGeometry = function() {
getGeometry() {
return (
/** @type {module:ol/geom/Geometry|undefined} */ (this.get(this.geometryName_))
);
};
}
/**
/**
* Get the feature identifier. This is a stable identifier for the feature and
* is either set when reading data from a remote source or set explicitly by
* calling {@link module:ol/Feature~Feature#setId}.
* @return {number|string|undefined} Id.
* @api
*/
Feature.prototype.getId = function() {
getId() {
return this.id_;
};
}
/**
/**
* Get the name of the feature's default geometry. By default, the default
* geometry is named `geometry`.
* @return {string} Get the property name associated with the default geometry
* for this feature.
* @api
*/
Feature.prototype.getGeometryName = function() {
getGeometryName() {
return this.geometryName_;
};
}
/**
/**
* Get the feature's style. Will return what was provided to the
* {@link module:ol/Feature~Feature#setStyle} method.
* @return {module:ol/style/Style|Array.<module:ol/style/Style>|module:ol/style/Style~StyleFunction} The feature style.
* @api
*/
Feature.prototype.getStyle = function() {
getStyle() {
return this.style_;
};
}
/**
/**
* Get the feature's style function.
* @return {module:ol/style/Style~StyleFunction|undefined} Return a function
* representing the current style of this feature.
* @api
*/
Feature.prototype.getStyleFunction = function() {
getStyleFunction() {
return this.styleFunction_;
};
}
/**
/**
* @private
*/
Feature.prototype.handleGeometryChange_ = function() {
handleGeometryChange_() {
this.changed();
};
}
/**
/**
* @private
*/
Feature.prototype.handleGeometryChanged_ = function() {
handleGeometryChanged_() {
if (this.geometryChangeKey_) {
unlistenByKey(this.geometryChangeKey_);
this.geometryChangeKey_ = null;
@@ -218,22 +209,20 @@ Feature.prototype.handleGeometryChanged_ = function() {
EventType.CHANGE, this.handleGeometryChange_, this);
}
this.changed();
};
}
/**
/**
* Set the default geometry for the feature. This will update the property
* with the name returned by {@link module:ol/Feature~Feature#getGeometryName}.
* @param {module:ol/geom/Geometry|undefined} geometry The new geometry.
* @api
* @observable
*/
Feature.prototype.setGeometry = function(geometry) {
setGeometry(geometry) {
this.set(this.geometryName_, geometry);
};
}
/**
/**
* Set the style for the feature. This can be a single style object, an array
* of styles, or a function that takes a resolution and returns an array of
* styles. If it is `null` the feature has no style (a `null` style).
@@ -241,14 +230,13 @@ Feature.prototype.setGeometry = function(geometry) {
* @api
* @fires module:ol/events/Event~Event#event:change
*/
Feature.prototype.setStyle = function(style) {
setStyle(style) {
this.style_ = style;
this.styleFunction_ = !style ? undefined : createStyleFunction(style);
this.changed();
};
}
/**
/**
* Set the feature id. The feature id is considered stable and may be used when
* requesting features or comparing identifiers returned from a remote source.
* The feature id can be used with the
@@ -257,20 +245,19 @@ Feature.prototype.setStyle = function(style) {
* @api
* @fires module:ol/events/Event~Event#event:change
*/
Feature.prototype.setId = function(id) {
setId(id) {
this.id_ = id;
this.changed();
};
}
/**
/**
* Set the property name to be used when getting the feature's default geometry.
* When calling {@link module:ol/Feature~Feature#getGeometry}, the value of the property with
* this name will be returned.
* @param {string} name The property name of the default geometry.
* @api
*/
Feature.prototype.setGeometryName = function(name) {
setGeometryName(name) {
unlisten(
this, getChangeEventType(this.geometryName_),
this.handleGeometryChanged_, this);
@@ -279,7 +266,8 @@ Feature.prototype.setGeometryName = function(name) {
this, getChangeEventType(this.geometryName_),
this.handleGeometryChanged_, this);
this.handleGeometryChanged_();
};
}
}
/**
src/ol/Geolocation.js
+67 -82
View File
@@ -1,7 +1,6 @@
/**
* @module ol/Geolocation
*/
import {inherits} from './util.js';
import GeolocationProperty from './GeolocationProperty.js';
import BaseObject, {getChangeEventType} from './Object.js';
import {listen} from './events.js';
@@ -44,14 +43,16 @@ import {get as getProjection, getTransformFromProjections, identityTransform} fr
* });
*
* @fires error
* @constructor
* @extends {module:ol/Object}
* @param {module:ol/Geolocation~Options=} opt_options Options.
* @api
*/
const Geolocation = function(opt_options) {
class Geolocation extends BaseObject {
BaseObject.call(this);
/**
* @param {module:ol/Geolocation~Options=} opt_options Options.
*/
constructor(opt_options) {
super();
const options = opt_options || {};
@@ -90,24 +91,20 @@ const Geolocation = function(opt_options) {
this.setTracking(options.tracking !== undefined ? options.tracking : false);
};
}
inherits(Geolocation, BaseObject);
/**
/**
* @inheritDoc
*/
Geolocation.prototype.disposeInternal = function() {
disposeInternal() {
this.setTracking(false);
BaseObject.prototype.disposeInternal.call(this);
};
super.disposeInternal();
}
/**
/**
* @private
*/
Geolocation.prototype.handleProjectionChanged_ = function() {
handleProjectionChanged_() {
const projection = this.getProjection();
if (projection) {
this.transform_ = getTransformFromProjections(
@@ -116,13 +113,12 @@ Geolocation.prototype.handleProjectionChanged_ = function() {
this.set(GeolocationProperty.POSITION, this.transform_(this.position_));
}
}
};
}
/**
/**
* @private
*/
Geolocation.prototype.handleTrackingChanged_ = function() {
handleTrackingChanged_() {
if (GEOLOCATION) {
const tracking = this.getTracking();
if (tracking && this.watchId_ === undefined) {
@@ -135,14 +131,13 @@ Geolocation.prototype.handleTrackingChanged_ = function() {
this.watchId_ = undefined;
}
}
};
}
/**
/**
* @private
* @param {GeolocationPosition} position position event.
*/
Geolocation.prototype.positionChange_ = function(position) {
positionChange_(position) {
const coords = position.coords;
this.set(GeolocationProperty.ACCURACY, coords.accuracy);
this.set(GeolocationProperty.ALTITUDE,
@@ -166,75 +161,70 @@ Geolocation.prototype.positionChange_ = function(position) {
geometry.applyTransform(this.transform_);
this.set(GeolocationProperty.ACCURACY_GEOMETRY, geometry);
this.changed();
};
}
/**
/**
* Triggered when the Geolocation returns an error.
* @event error
* @api
*/
/**
/**
* @private
* @param {GeolocationPositionError} error error object.
*/
Geolocation.prototype.positionError_ = function(error) {
positionError_(error) {
error.type = EventType.ERROR;
this.setTracking(false);
this.dispatchEvent(/** @type {{type: string, target: undefined}} */ (error));
};
}
/**
/**
* Get the accuracy of the position in meters.
* @return {number|undefined} The accuracy of the position measurement in
* meters.
* @observable
* @api
*/
Geolocation.prototype.getAccuracy = function() {
getAccuracy() {
return /** @type {number|undefined} */ (this.get(GeolocationProperty.ACCURACY));
};
}
/**
/**
* Get a geometry of the position accuracy.
* @return {?module:ol/geom/Polygon} A geometry of the position accuracy.
* @observable
* @api
*/
Geolocation.prototype.getAccuracyGeometry = function() {
getAccuracyGeometry() {
return (
/** @type {?module:ol/geom/Polygon} */ (this.get(GeolocationProperty.ACCURACY_GEOMETRY) || null)
);
};
}
/**
/**
* Get the altitude associated with the position.
* @return {number|undefined} The altitude of the position in meters above mean
* sea level.
* @observable
* @api
*/
Geolocation.prototype.getAltitude = function() {
getAltitude() {
return /** @type {number|undefined} */ (this.get(GeolocationProperty.ALTITUDE));
};
}
/**
/**
* Get the altitude accuracy of the position.
* @return {number|undefined} The accuracy of the altitude measurement in
* meters.
* @observable
* @api
*/
Geolocation.prototype.getAltitudeAccuracy = function() {
getAltitudeAccuracy() {
return /** @type {number|undefined} */ (this.get(GeolocationProperty.ALTITUDE_ACCURACY));
};
}
/**
/**
* Get the heading as radians clockwise from North.
* Note: depending on the browser, the heading is only defined if the `enableHighAccuracy`
* is set to `true` in the tracking options.
@@ -242,63 +232,58 @@ Geolocation.prototype.getAltitudeAccuracy = function() {
* @observable
* @api
*/
Geolocation.prototype.getHeading = function() {
getHeading() {
return /** @type {number|undefined} */ (this.get(GeolocationProperty.HEADING));
};
}
/**
/**
* Get the position of the device.
* @return {module:ol/coordinate~Coordinate|undefined} The current position of the device reported
* in the current projection.
* @observable
* @api
*/
Geolocation.prototype.getPosition = function() {
getPosition() {
return (
/** @type {module:ol/coordinate~Coordinate|undefined} */ (this.get(GeolocationProperty.POSITION))
);
};
}
/**
/**
* Get the projection associated with the position.
* @return {module:ol/proj/Projection|undefined} The projection the position is
* reported in.
* @observable
* @api
*/
Geolocation.prototype.getProjection = function() {
getProjection() {
return (
/** @type {module:ol/proj/Projection|undefined} */ (this.get(GeolocationProperty.PROJECTION))
);
};
}
/**
/**
* Get the speed in meters per second.
* @return {number|undefined} The instantaneous speed of the device in meters
* per second.
* @observable
* @api
*/
Geolocation.prototype.getSpeed = function() {
getSpeed() {
return /** @type {number|undefined} */ (this.get(GeolocationProperty.SPEED));
};
}
/**
/**
* Determine if the device location is being tracked.
* @return {boolean} The device location is being tracked.
* @observable
* @api
*/
Geolocation.prototype.getTracking = function() {
getTracking() {
return /** @type {boolean} */ (this.get(GeolocationProperty.TRACKING));
};
}
/**
/**
* Get the tracking options.
* @see http://www.w3.org/TR/geolocation-API/#position-options
* @return {GeolocationPositionOptions|undefined} PositionOptions as defined by
@@ -307,35 +292,32 @@ Geolocation.prototype.getTracking = function() {
* @observable
* @api
*/
Geolocation.prototype.getTrackingOptions = function() {
getTrackingOptions() {
return /** @type {GeolocationPositionOptions|undefined} */ (this.get(GeolocationProperty.TRACKING_OPTIONS));
};
}
/**
/**
* Set the projection to use for transforming the coordinates.
* @param {module:ol/proj~ProjectionLike} projection The projection the position is
* reported in.
* @observable
* @api
*/
Geolocation.prototype.setProjection = function(projection) {
setProjection(projection) {
this.set(GeolocationProperty.PROJECTION, getProjection(projection));
};
}
/**
/**
* Enable or disable tracking.
* @param {boolean} tracking Enable tracking.
* @observable
* @api
*/
Geolocation.prototype.setTracking = function(tracking) {
setTracking(tracking) {
this.set(GeolocationProperty.TRACKING, tracking);
};
}
/**
/**
* Set the tracking options.
* @see http://www.w3.org/TR/geolocation-API/#position-options
* @param {GeolocationPositionOptions} options PositionOptions as defined by the
@@ -344,7 +326,10 @@ Geolocation.prototype.setTracking = function(tracking) {
* @observable
* @api
*/
Geolocation.prototype.setTrackingOptions = function(options) {
setTrackingOptions(options) {
this.set(GeolocationProperty.TRACKING_OPTIONS, options);
};
}
}
export default Geolocation;
src/ol/Graticule.js
+51 -59
View File
@@ -112,11 +112,14 @@ const INTERVALS = [
/**
* Render a grid for a coordinate system on a map.
* @constructor
* @param {module:ol/Graticule~Options=} opt_options Options.
* @api
*/
const Graticule = function(opt_options) {
class Graticule {
/**
* @param {module:ol/Graticule~Options=} opt_options Options.
*/
constructor(opt_options) {
const options = opt_options || {};
/**
@@ -317,10 +320,9 @@ const Graticule = function(opt_options) {
}
this.setMap(options.map !== undefined ? options.map : null);
};
}
/**
/**
* @param {number} lon Longitude.
* @param {number} minLat Minimal latitude.
* @param {number} maxLat Maximal latitude.
@@ -330,7 +332,7 @@ const Graticule = function(opt_options) {
* @return {number} Index.
* @private
*/
Graticule.prototype.addMeridian_ = function(lon, minLat, maxLat, squaredTolerance, extent, index) {
addMeridian_(lon, minLat, maxLat, squaredTolerance, extent, index) {
const lineString = this.getMeridian_(lon, minLat, maxLat, squaredTolerance, index);
if (intersects(lineString.getExtent(), extent)) {
if (this.meridiansLabels_) {
@@ -343,16 +345,16 @@ Graticule.prototype.addMeridian_ = function(lon, minLat, maxLat, squaredToleranc
this.meridians_[index++] = lineString;
}
return index;
};
}
/**
/**
* @param {module:ol/geom/LineString} lineString Meridian
* @param {module:ol/extent~Extent} extent Extent.
* @param {number} index Index.
* @return {module:ol/geom/Point} Meridian point.
* @private
*/
Graticule.prototype.getMeridianPoint_ = function(lineString, extent, index) {
getMeridianPoint_(lineString, extent, index) {
const flatCoordinates = lineString.getFlatCoordinates();
const clampedBottom = Math.max(extent[1], flatCoordinates[1]);
const clampedTop = Math.min(extent[3], flatCoordinates[flatCoordinates.length - 1]);
@@ -368,10 +370,9 @@ Graticule.prototype.getMeridianPoint_ = function(lineString, extent, index) {
point = new Point(coordinate);
}
return point;
};
}
/**
/**
* @param {number} lat Latitude.
* @param {number} minLon Minimal longitude.
* @param {number} maxLon Maximal longitude.
@@ -381,7 +382,7 @@ Graticule.prototype.getMeridianPoint_ = function(lineString, extent, index) {
* @return {number} Index.
* @private
*/
Graticule.prototype.addParallel_ = function(lat, minLon, maxLon, squaredTolerance, extent, index) {
addParallel_(lat, minLon, maxLon, squaredTolerance, extent, index) {
const lineString = this.getParallel_(lat, minLon, maxLon, squaredTolerance, index);
if (intersects(lineString.getExtent(), extent)) {
if (this.parallelsLabels_) {
@@ -394,17 +395,16 @@ Graticule.prototype.addParallel_ = function(lat, minLon, maxLon, squaredToleranc
this.parallels_[index++] = lineString;
}
return index;
};
}
/**
/**
* @param {module:ol/geom/LineString} lineString Parallels.
* @param {module:ol/extent~Extent} extent Extent.
* @param {number} index Index.
* @return {module:ol/geom/Point} Parallel point.
* @private
*/
Graticule.prototype.getParallelPoint_ = function(lineString, extent, index) {
getParallelPoint_(lineString, extent, index) {
const flatCoordinates = lineString.getFlatCoordinates();
const clampedLeft = Math.max(extent[0], flatCoordinates[0]);
const clampedRight = Math.min(extent[2], flatCoordinates[flatCoordinates.length - 2]);
@@ -420,17 +420,16 @@ Graticule.prototype.getParallelPoint_ = function(lineString, extent, index) {
point = new Point(coordinate);
}
return point;
};
}
/**
/**
* @param {module:ol/extent~Extent} extent Extent.
* @param {module:ol/coordinate~Coordinate} center Center.
* @param {number} resolution Resolution.
* @param {number} squaredTolerance Squared tolerance.
* @private
*/
Graticule.prototype.createGraticule_ = function(extent, center, resolution, squaredTolerance) {
createGraticule_(extent, center, resolution, squaredTolerance) {
const interval = this.getInterval_(resolution);
if (interval == -1) {
@@ -515,15 +514,14 @@ Graticule.prototype.createGraticule_ = function(extent, center, resolution, squa
this.parallelsLabels_.length = idx;
}
};
}
/**
/**
* @param {number} resolution Resolution.
* @return {number} The interval in degrees.
* @private
*/
Graticule.prototype.getInterval_ = function(resolution) {
getInterval_(resolution) {
const centerLon = this.projectionCenterLonLat_[0];
const centerLat = this.projectionCenterLonLat_[1];
let interval = -1;
@@ -547,20 +545,18 @@ Graticule.prototype.getInterval_ = function(resolution) {
interval = INTERVALS[i];
}
return interval;
};
}
/**
/**
* Get the map associated with this graticule.
* @return {module:ol/PluggableMap} The map.
* @api
*/
Graticule.prototype.getMap = function() {
getMap() {
return this.map_;
};
}
/**
/**
* @param {number} lon Longitude.
* @param {number} minLat Minimal latitude.
* @param {number} maxLat Maximal latitude.
@@ -569,7 +565,7 @@ Graticule.prototype.getMap = function() {
* @param {number} index Index.
* @private
*/
Graticule.prototype.getMeridian_ = function(lon, minLat, maxLat, squaredTolerance, index) {
getMeridian_(lon, minLat, maxLat, squaredTolerance, index) {
const flatCoordinates = meridian(lon, minLat, maxLat, this.projection_, squaredTolerance);
let lineString = this.meridians_[index];
if (!lineString) {
@@ -579,20 +575,18 @@ Graticule.prototype.getMeridian_ = function(lon, minLat, maxLat, squaredToleranc
lineString.changed();
}
return lineString;
};
}
/**
/**
* Get the list of meridians. Meridians are lines of equal longitude.
* @return {Array.<module:ol/geom/LineString>} The meridians.
* @api
*/
Graticule.prototype.getMeridians = function() {
getMeridians() {
return this.meridians_;
};
}
/**
/**
* @param {number} lat Latitude.
* @param {number} minLon Minimal longitude.
* @param {number} maxLon Maximal longitude.
@@ -601,7 +595,7 @@ Graticule.prototype.getMeridians = function() {
* @param {number} index Index.
* @private
*/
Graticule.prototype.getParallel_ = function(lat, minLon, maxLon, squaredTolerance, index) {
getParallel_(lat, minLon, maxLon, squaredTolerance, index) {
const flatCoordinates = parallel(lat, minLon, maxLon, this.projection_, squaredTolerance);
let lineString = this.parallels_[index];
if (!lineString) {
@@ -611,24 +605,22 @@ Graticule.prototype.getParallel_ = function(lat, minLon, maxLon, squaredToleranc
lineString.changed();
}
return lineString;
};
}
/**
/**
* Get the list of parallels. Parallels are lines of equal latitude.
* @return {Array.<module:ol/geom/LineString>} The parallels.
* @api
*/
Graticule.prototype.getParallels = function() {
getParallels() {
return this.parallels_;
};
}
/**
/**
* @param {module:ol/render/Event} e Event.
* @private
*/
Graticule.prototype.handlePostCompose_ = function(e) {
handlePostCompose_(e) {
const vectorContext = e.vectorContext;
const frameState = e.frameState;
const extent = frameState.extent;
@@ -677,14 +669,13 @@ Graticule.prototype.handlePostCompose_ = function(e) {
vectorContext.drawGeometry(labelData.geom);
}
}
};
}
/**
/**
* @param {module:ol/proj/Projection} projection Projection.
* @private
*/
Graticule.prototype.updateProjectionInfo_ = function(projection) {
updateProjectionInfo_(projection) {
const epsg4326Projection = getProjection('EPSG:4326');
const worldExtent = projection.getWorldExtent();
@@ -707,16 +698,15 @@ Graticule.prototype.updateProjectionInfo_ = function(projection) {
this.projectionCenterLonLat_ = this.toLonLatTransform_(getCenter(projection.getExtent()));
this.projection_ = projection;
};
}
/**
/**
* Set the map for this graticule. The graticule will be rendered on the
* provided map.
* @param {module:ol/PluggableMap} map Map.
* @api
*/
Graticule.prototype.setMap = function(map) {
setMap(map) {
if (this.map_) {
unlistenByKey(this.postcomposeListenerKey_);
this.postcomposeListenerKey_ = null;
@@ -727,5 +717,7 @@ Graticule.prototype.setMap = function(map) {
map.render();
}
this.map_ = map;
};
}
}
export default Graticule;
src/ol/Image.js
+26 -33
View File
@@ -1,7 +1,6 @@
/**
* @module ol/Image
*/
import {inherits} from './util.js';
import ImageBase from './ImageBase.js';
import ImageState from './ImageState.js';
import {listenOnce, unlistenByKey} from './events.js';
@@ -28,9 +27,9 @@ import {getHeight} from './extent.js';
*/
/**
* @constructor
* @extends {module:ol/ImageBase}
class ImageWrapper extends ImageBase {
/**
* @param {module:ol/extent~Extent} extent Extent.
* @param {number|undefined} resolution Resolution.
* @param {number} pixelRatio Pixel ratio.
@@ -38,9 +37,9 @@ import {getHeight} from './extent.js';
* @param {?string} crossOrigin Cross origin.
* @param {module:ol/Image~LoadFunction} imageLoadFunction Image load function.
*/
const ImageWrapper = function(extent, resolution, pixelRatio, src, crossOrigin, imageLoadFunction) {
constructor(extent, resolution, pixelRatio, src, crossOrigin, imageLoadFunction) {
ImageBase.call(this, extent, resolution, pixelRatio, ImageState.IDLE);
super(extent, resolution, pixelRatio, ImageState.IDLE);
/**
* @private
@@ -75,55 +74,49 @@ const ImageWrapper = function(extent, resolution, pixelRatio, src, crossOrigin,
*/
this.imageLoadFunction_ = imageLoadFunction;
};
}
inherits(ImageWrapper, ImageBase);
/**
/**
* @inheritDoc
* @api
*/
ImageWrapper.prototype.getImage = function() {
getImage() {
return this.image_;
};
}
/**
/**
* Tracks loading or read errors.
*
* @private
*/
ImageWrapper.prototype.handleImageError_ = function() {
handleImageError_() {
this.state = ImageState.ERROR;
this.unlistenImage_();
this.changed();
};
}
/**
/**
* Tracks successful image load.
*
* @private
*/
ImageWrapper.prototype.handleImageLoad_ = function() {
handleImageLoad_() {
if (this.resolution === undefined) {
this.resolution = getHeight(this.extent) / this.image_.height;
}
this.state = ImageState.LOADED;
this.unlistenImage_();
this.changed();
};
}
/**
/**
* Load the image or retry if loading previously failed.
* Loading is taken care of by the tile queue, and calling this method is
* only needed for preloading or for reloading in case of an error.
* @override
* @api
*/
ImageWrapper.prototype.load = function() {
load() {
if (this.state == ImageState.IDLE || this.state == ImageState.ERROR) {
this.state = ImageState.LOADING;
this.changed();
@@ -135,25 +128,25 @@ ImageWrapper.prototype.load = function() {
];
this.imageLoadFunction_(this, this.src_);
}
};
}
/**
/**
* @param {HTMLCanvasElement|HTMLImageElement|HTMLVideoElement} image Image.
*/
ImageWrapper.prototype.setImage = function(image) {
setImage(image) {
this.image_ = image;
};
}
/**
/**
* Discards event handlers which listen for load completion or errors.
*
* @private
*/
ImageWrapper.prototype.unlistenImage_ = function() {
unlistenImage_() {
this.imageListenerKeys_.forEach(unlistenByKey);
this.imageListenerKeys_ = null;
};
}
}
export default ImageWrapper;
src/ol/ImageBase.js
+28 -34
View File
@@ -1,22 +1,23 @@
/**
* @module ol/ImageBase
*/
import {inherits} from './util.js';
import EventTarget from './events/EventTarget.js';
import EventType from './events/EventType.js';
/**
* @constructor
* @abstract
* @extends {module:ol/events/EventTarget}
*/
class ImageBase extends EventTarget {
/**
* @param {module:ol/extent~Extent} extent Extent.
* @param {number|undefined} resolution Resolution.
* @param {number} pixelRatio Pixel ratio.
* @param {module:ol/ImageState} state State.
*/
const ImageBase = function(extent, resolution, pixelRatio, state) {
constructor(extent, resolution, pixelRatio, state) {
EventTarget.call(this);
super();
/**
* @protected
@@ -42,62 +43,55 @@ const ImageBase = function(extent, resolution, pixelRatio, state) {
*/
this.state = state;
};
}
inherits(ImageBase, EventTarget);
/**
/**
* @protected
*/
ImageBase.prototype.changed = function() {
changed() {
this.dispatchEvent(EventType.CHANGE);
};
}
/**
/**
* @return {module:ol/extent~Extent} Extent.
*/
ImageBase.prototype.getExtent = function() {
getExtent() {
return this.extent;
};
}
/**
/**
* @abstract
* @return {HTMLCanvasElement|HTMLImageElement|HTMLVideoElement} Image.
*/
ImageBase.prototype.getImage = function() {};
getImage() {}
/**
/**
* @return {number} PixelRatio.
*/
ImageBase.prototype.getPixelRatio = function() {
getPixelRatio() {
return this.pixelRatio_;
};
}
/**
/**
* @return {number} Resolution.
*/
ImageBase.prototype.getResolution = function() {
getResolution() {
return /** @type {number} */ (this.resolution);
};
}
/**
/**
* @return {module:ol/ImageState} State.
*/
ImageBase.prototype.getState = function() {
getState() {
return this.state;
};
}
/**
/**
* Load not yet loaded URI.
* @abstract
*/
ImageBase.prototype.load = function() {};
load() {}
}
export default ImageBase;
src/ol/ImageCanvas.js
+24 -28
View File
@@ -1,7 +1,6 @@
/**
* @module ol/ImageCanvas
*/
import {inherits} from './util.js';
import ImageBase from './ImageBase.js';
import ImageState from './ImageState.js';
@@ -16,9 +15,9 @@ import ImageState from './ImageState.js';
*/
/**
* @constructor
* @extends {module:ol/ImageBase}
class ImageCanvas extends ImageBase {
/**
* @param {module:ol/extent~Extent} extent Extent.
* @param {number} resolution Resolution.
* @param {number} pixelRatio Pixel ratio.
@@ -26,7 +25,11 @@ import ImageState from './ImageState.js';
* @param {module:ol/ImageCanvas~Loader=} opt_loader Optional loader function to
* support asynchronous canvas drawing.
*/
const ImageCanvas = function(extent, resolution, pixelRatio, canvas, opt_loader) {
constructor(extent, resolution, pixelRatio, canvas, opt_loader) {
const state = opt_loader !== undefined ? ImageState.IDLE : ImageState.LOADED;
super(extent, resolution, pixelRatio, state);
/**
* Optional canvas loader function.
@@ -35,10 +38,6 @@ const ImageCanvas = function(extent, resolution, pixelRatio, canvas, opt_loader)
*/
this.loader_ = opt_loader !== undefined ? opt_loader : null;
const state = opt_loader !== undefined ? ImageState.IDLE : ImageState.LOADED;
ImageBase.call(this, extent, resolution, pixelRatio, state);
/**
* @private
* @type {HTMLCanvasElement}
@@ -51,26 +50,22 @@ const ImageCanvas = function(extent, resolution, pixelRatio, canvas, opt_loader)
*/
this.error_ = null;
};
}
inherits(ImageCanvas, ImageBase);
/**
/**
* Get any error associated with asynchronous rendering.
* @return {Error} Any error that occurred during rendering.
*/
ImageCanvas.prototype.getError = function() {
getError() {
return this.error_;
};
}
/**
/**
* Handle async drawing complete.
* @param {Error} err Any error during drawing.
* @private
*/
ImageCanvas.prototype.handleLoad_ = function(err) {
handleLoad_(err) {
if (err) {
this.error_ = err;
this.state = ImageState.ERROR;
@@ -78,25 +73,26 @@ ImageCanvas.prototype.handleLoad_ = function(err) {
this.state = ImageState.LOADED;
}
this.changed();
};
}
/**
/**
* @inheritDoc
*/
ImageCanvas.prototype.load = function() {
load() {
if (this.state == ImageState.IDLE) {
this.state = ImageState.LOADING;
this.changed();
this.loader_(this.handleLoad_.bind(this));
}
};
}
/**
/**
* @return {HTMLCanvasElement} Canvas element.
*/
ImageCanvas.prototype.getImage = function() {
getImage() {
return this.canvas_;
};
}
}
export default ImageCanvas;
src/ol/ImageTile.js
+29 -38
View File
@@ -1,7 +1,6 @@
/**
* @module ol/ImageTile
*/
import {inherits} from './util.js';
import Tile from './Tile.js';
import TileState from './TileState.js';
import {createCanvasContext2D} from './dom.js';
@@ -14,9 +13,9 @@ import EventType from './events/EventType.js';
* @api
*/
/**
* @constructor
* @extends {module:ol/Tile}
class ImageTile extends Tile {
/**
* @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate.
* @param {module:ol/TileState} state State.
* @param {string} src Image source URI.
@@ -24,9 +23,9 @@ import EventType from './events/EventType.js';
* @param {module:ol/Tile~LoadFunction} tileLoadFunction Tile load function.
* @param {module:ol/Tile~Options=} opt_options Tile options.
*/
const ImageTile = function(tileCoord, state, src, crossOrigin, tileLoadFunction, opt_options) {
constructor(tileCoord, state, src, crossOrigin, tileLoadFunction, opt_options) {
Tile.call(this, tileCoord, state, opt_options);
super(tileCoord, state, opt_options);
/**
* @private
@@ -63,15 +62,12 @@ const ImageTile = function(tileCoord, state, src, crossOrigin, tileLoadFunction,
*/
this.tileLoadFunction_ = tileLoadFunction;
};
}
inherits(ImageTile, Tile);
/**
/**
* @inheritDoc
*/
ImageTile.prototype.disposeInternal = function() {
disposeInternal() {
if (this.state == TileState.LOADING) {
this.unlistenImage_();
this.image_ = getBlankImage();
@@ -81,47 +77,43 @@ ImageTile.prototype.disposeInternal = function() {
}
this.state = TileState.ABORT;
this.changed();
Tile.prototype.disposeInternal.call(this);
};
super.disposeInternal();
}
/**
/**
* Get the HTML image element for this tile (may be a Canvas, Image, or Video).
* @return {HTMLCanvasElement|HTMLImageElement|HTMLVideoElement} Image.
* @api
*/
ImageTile.prototype.getImage = function() {
getImage() {
return this.image_;
};
}
/**
/**
* @inheritDoc
*/
ImageTile.prototype.getKey = function() {
getKey() {
return this.src_;
};
}
/**
/**
* Tracks loading or read errors.
*
* @private
*/
ImageTile.prototype.handleImageError_ = function() {
handleImageError_() {
this.state = TileState.ERROR;
this.unlistenImage_();
this.image_ = getBlankImage();
this.changed();
};
}
/**
/**
* Tracks successful image load.
*
* @private
*/
ImageTile.prototype.handleImageLoad_ = function() {
handleImageLoad_() {
if (this.image_.naturalWidth && this.image_.naturalHeight) {
this.state = TileState.LOADED;
} else {
@@ -129,14 +121,13 @@ ImageTile.prototype.handleImageLoad_ = function() {
}
this.unlistenImage_();
this.changed();
};
}
/**
/**
* @inheritDoc
* @api
*/
ImageTile.prototype.load = function() {
load() {
if (this.state == TileState.ERROR) {
this.state = TileState.IDLE;
this.image_ = new Image();
@@ -155,18 +146,18 @@ ImageTile.prototype.load = function() {
];
this.tileLoadFunction_(this, this.src_);
}
};
}
/**
/**
* Discards event handlers which listen for load completion or errors.
*
* @private
*/
ImageTile.prototype.unlistenImage_ = function() {
unlistenImage_() {
this.imageListenerKeys_.forEach(unlistenByKey);
this.imageListenerKeys_ = null;
};
}
}
/**
src/ol/Kinetic.js
+24 -25
View File
@@ -6,15 +6,17 @@
* @classdesc
* Implementation of inertial deceleration for map movement.
*
* @constructor
* @api
*/
class Kinetic {
/**
* @param {number} decay Rate of decay (must be negative).
* @param {number} minVelocity Minimum velocity (pixels/millisecond).
* @param {number} delay Delay to consider to calculate the kinetic
* initial values (milliseconds).
* @struct
* @api
*/
const Kinetic = function(decay, minVelocity, delay) {
constructor(decay, minVelocity, delay) {
/**
* @private
@@ -51,32 +53,29 @@ const Kinetic = function(decay, minVelocity, delay) {
* @type {number}
*/
this.initialVelocity_ = 0;
};
}
/**
/**
* FIXME empty description for jsdoc
*/
Kinetic.prototype.begin = function() {
begin() {
this.points_.length = 0;
this.angle_ = 0;
this.initialVelocity_ = 0;
};
}
/**
/**
* @param {number} x X.
* @param {number} y Y.
*/
Kinetic.prototype.update = function(x, y) {
update(x, y) {
this.points_.push(x, y, Date.now());
};
}
/**
/**
* @return {boolean} Whether we should do kinetic animation.
*/
Kinetic.prototype.end = function() {
end() {
if (this.points_.length < 6) {
// at least 2 points are required (i.e. there must be at least 6 elements
// in the array)
@@ -109,21 +108,21 @@ Kinetic.prototype.end = function() {
this.angle_ = Math.atan2(dy, dx);
this.initialVelocity_ = Math.sqrt(dx * dx + dy * dy) / duration;
return this.initialVelocity_ > this.minVelocity_;
};
}
/**
/**
* @return {number} Total distance travelled (pixels).
*/
Kinetic.prototype.getDistance = function() {
getDistance() {
return (this.minVelocity_ - this.initialVelocity_) / this.decay_;
};
}
/**
/**
* @return {number} Angle of the kinetic panning animation (radians).
*/
Kinetic.prototype.getAngle = function() {
getAngle() {
return this.angle_;
};
}
}
export default Kinetic;
src/ol/Map.js
+12 -11
View File
@@ -1,7 +1,6 @@
/**
* @module ol/Map
*/
import {inherits} from './util.js';
import PluggableMap from './PluggableMap.js';
import {defaults as defaultControls} from './control/util.js';
import {defaults as defaultInteractions} from './interaction.js';
@@ -57,16 +56,18 @@ import CanvasVectorTileLayerRenderer from './renderer/canvas/VectorTileLayer.js'
* options or added with `addLayer` can be groups, which can contain further
* groups, and so on.
*
* @constructor
* @extends {module:ol/PluggableMap}
* @param {module:ol/PluggableMap~MapOptions} options Map options.
* @fires module:ol/MapBrowserEvent~MapBrowserEvent
* @fires module:ol/MapEvent~MapEvent
* @fires module:ol/render/Event~RenderEvent#postcompose
* @fires module:ol/render/Event~RenderEvent#precompose
* @api
*/
const Map = function(options) {
class Map extends PluggableMap {
/**
* @param {module:ol/PluggableMap~MapOptions} options Map options.
*/
constructor(options) {
options = assign({}, options);
if (!options.controls) {
options.controls = defaultControls();
@@ -75,12 +76,10 @@ const Map = function(options) {
options.interactions = defaultInteractions();
}
PluggableMap.call(this, options);
};
super(options);
}
inherits(Map, PluggableMap);
Map.prototype.createRenderer = function() {
createRenderer() {
const renderer = new CanvasMapRenderer(this);
renderer.registerLayerRenderers([
CanvasImageLayerRenderer,
@@ -89,6 +88,8 @@ Map.prototype.createRenderer = function() {
CanvasVectorTileLayerRenderer
]);
return renderer;
};
}
}
export default Map;
src/ol/MapBrowserEvent.js
+18 -19
View File
@@ -1,25 +1,25 @@
/**
* @module ol/MapBrowserEvent
*/
import {inherits} from './util.js';
import MapEvent from './MapEvent.js';
/**
* @classdesc
* Events emitted as map browser events are instances of this type.
* See {@link module:ol/Map~Map} for which events trigger a map browser event.
*
* @constructor
* @extends {module:ol/MapEvent}
*/
class MapBrowserEvent extends MapEvent {
/**
* @param {string} type Event type.
* @param {module:ol/PluggableMap} map Map.
* @param {Event} browserEvent Browser event.
* @param {boolean=} opt_dragging Is the map currently being dragged?
* @param {?module:ol/PluggableMap~FrameState=} opt_frameState Frame state.
*/
const MapBrowserEvent = function(type, map, browserEvent, opt_dragging, opt_frameState) {
constructor(type, map, browserEvent, opt_dragging, opt_frameState) {
MapEvent.call(this, type, map, opt_frameState);
super(type, map, opt_frameState);
/**
* The original browser event.
@@ -52,31 +52,30 @@ const MapBrowserEvent = function(type, map, browserEvent, opt_dragging, opt_fram
*/
this.dragging = opt_dragging !== undefined ? opt_dragging : false;
};
}
inherits(MapBrowserEvent, MapEvent);
/**
/**
* Prevents the default browser action.
* @see https://developer.mozilla.org/en-US/docs/Web/API/event.preventDefault
* @override
* @api
*/
MapBrowserEvent.prototype.preventDefault = function() {
MapEvent.prototype.preventDefault.call(this);
preventDefault() {
super.preventDefault();
this.originalEvent.preventDefault();
};
}
/**
/**
* Prevents further propagation of the current event.
* @see https://developer.mozilla.org/en-US/docs/Web/API/event.stopPropagation
* @override
* @api
*/
MapBrowserEvent.prototype.stopPropagation = function() {
MapEvent.prototype.stopPropagation.call(this);
stopPropagation() {
super.stopPropagation();
this.originalEvent.stopPropagation();
};
}
}
export default MapBrowserEvent;
src/ol/MapBrowserEventHandler.js
+40 -51
View File
@@ -1,7 +1,6 @@
/**
* @module ol/MapBrowserEventHandler
*/
import {inherits} from './util.js';
import {DEVICE_PIXEL_RATIO} from './has.js';
import MapBrowserEventType from './MapBrowserEventType.js';
import MapBrowserPointerEvent from './MapBrowserPointerEvent.js';
@@ -10,17 +9,15 @@ import EventTarget from './events/EventTarget.js';
import PointerEventType from './pointer/EventType.js';
import PointerEventHandler from './pointer/PointerEventHandler.js';
/**
* @param {module:ol/PluggableMap} map The map with the viewport to
* listen to events on.
* @param {number=} moveTolerance The minimal distance the pointer must travel
* to trigger a move.
* @constructor
* @extends {module:ol/events/EventTarget}
*/
const MapBrowserEventHandler = function(map, moveTolerance) {
class MapBrowserEventHandler extends EventTarget {
EventTarget.call(this);
/**
* @param {module:ol/PluggableMap} map The map with the viewport to listen to events on.
* @param {number=} moveTolerance The minimal distance the pointer must travel to trigger a move.
*/
constructor(map, moveTolerance) {
super();
/**
* This is the element that we will listen to the real events on.
@@ -110,17 +107,14 @@ const MapBrowserEventHandler = function(map, moveTolerance) {
PointerEventType.POINTERMOVE,
this.relayEvent_, this);
};
}
inherits(MapBrowserEventHandler, EventTarget);
/**
/**
* @param {module:ol/pointer/PointerEvent} pointerEvent Pointer
* event.
* @private
*/
MapBrowserEventHandler.prototype.emulateClick_ = function(pointerEvent) {
emulateClick_(pointerEvent) {
let newEvent = new MapBrowserPointerEvent(
MapBrowserEventType.CLICK, this.map_, pointerEvent);
this.dispatchEvent(newEvent);
@@ -140,17 +134,16 @@ MapBrowserEventHandler.prototype.emulateClick_ = function(pointerEvent) {
this.dispatchEvent(newEvent);
}.bind(this), 250);
}
};
}
/**
/**
* Keeps track on how many pointers are currently active.
*
* @param {module:ol/pointer/PointerEvent} pointerEvent Pointer
* event.
* @private
*/
MapBrowserEventHandler.prototype.updateActivePointers_ = function(pointerEvent) {
updateActivePointers_(pointerEvent) {
const event = pointerEvent;
if (event.type == MapBrowserEventType.POINTERUP ||
@@ -160,15 +153,14 @@ MapBrowserEventHandler.prototype.updateActivePointers_ = function(pointerEvent)
this.trackedTouches_[event.pointerId] = true;
}
this.activePointers_ = Object.keys(this.trackedTouches_).length;
};
}
/**
/**
* @param {module:ol/pointer/PointerEvent} pointerEvent Pointer
* event.
* @private
*/
MapBrowserEventHandler.prototype.handlePointerUp_ = function(pointerEvent) {
handlePointerUp_(pointerEvent) {
this.updateActivePointers_(pointerEvent);
const newEvent = new MapBrowserPointerEvent(
MapBrowserEventType.POINTERUP, this.map_, pointerEvent);
@@ -192,26 +184,24 @@ MapBrowserEventHandler.prototype.handlePointerUp_ = function(pointerEvent) {
this.documentPointerEventHandler_.dispose();
this.documentPointerEventHandler_ = null;
}
};
}
/**
/**
* @param {module:ol/pointer/PointerEvent} pointerEvent Pointer
* event.
* @return {boolean} If the left mouse button was pressed.
* @private
*/
MapBrowserEventHandler.prototype.isMouseActionButton_ = function(pointerEvent) {
isMouseActionButton_(pointerEvent) {
return pointerEvent.button === 0;
};
}
/**
/**
* @param {module:ol/pointer/PointerEvent} pointerEvent Pointer
* event.
* @private
*/
MapBrowserEventHandler.prototype.handlePointerDown_ = function(pointerEvent) {
handlePointerDown_(pointerEvent) {
this.updateActivePointers_(pointerEvent);
const newEvent = new MapBrowserPointerEvent(
MapBrowserEventType.POINTERDOWN, this.map_, pointerEvent);
@@ -252,15 +242,14 @@ MapBrowserEventHandler.prototype.handlePointerDown_ = function(pointerEvent) {
this.handlePointerUp_, this)
);
}
};
}
/**
/**
* @param {module:ol/pointer/PointerEvent} pointerEvent Pointer
* event.
* @private
*/
MapBrowserEventHandler.prototype.handlePointerMove_ = function(pointerEvent) {
handlePointerMove_(pointerEvent) {
// Between pointerdown and pointerup, pointermove events are triggered.
// To avoid a 'false' touchmove event to be dispatched, we test if the pointer
// moved a significant distance.
@@ -277,40 +266,37 @@ MapBrowserEventHandler.prototype.handlePointerMove_ = function(pointerEvent) {
// https://code.google.com/p/android/issues/detail?id=19827
// ex: Galaxy Tab P3110 + Android 4.1.1
pointerEvent.preventDefault();
};
}
/**
/**
* Wrap and relay a pointer event. Note that this requires that the type
* string for the MapBrowserPointerEvent matches the PointerEvent type.
* @param {module:ol/pointer/PointerEvent} pointerEvent Pointer
* event.
* @private
*/
MapBrowserEventHandler.prototype.relayEvent_ = function(pointerEvent) {
relayEvent_(pointerEvent) {
const dragging = !!(this.down_ && this.isMoving_(pointerEvent));
this.dispatchEvent(new MapBrowserPointerEvent(
pointerEvent.type, this.map_, pointerEvent, dragging));
};
}
/**
/**
* @param {module:ol/pointer/PointerEvent} pointerEvent Pointer
* event.
* @return {boolean} Is moving.
* @private
*/
MapBrowserEventHandler.prototype.isMoving_ = function(pointerEvent) {
isMoving_(pointerEvent) {
return this.dragging_ ||
Math.abs(pointerEvent.clientX - this.down_.clientX) > this.moveTolerance_ ||
Math.abs(pointerEvent.clientY - this.down_.clientY) > this.moveTolerance_;
};
}
/**
/**
* @inheritDoc
*/
MapBrowserEventHandler.prototype.disposeInternal = function() {
disposeInternal() {
if (this.relayedListenerKey_) {
unlistenByKey(this.relayedListenerKey_);
this.relayedListenerKey_ = null;
@@ -331,6 +317,9 @@ MapBrowserEventHandler.prototype.disposeInternal = function() {
this.pointerEventHandler_.dispose();
this.pointerEventHandler_ = null;
}
EventTarget.prototype.disposeInternal.call(this);
};
super.disposeInternal();
}
}
export default MapBrowserEventHandler;
src/ol/MapBrowserPointerEvent.js
+9 -12
View File
@@ -1,24 +1,20 @@
/**
* @module ol/MapBrowserPointerEvent
*/
import {inherits} from './util.js';
import MapBrowserEvent from './MapBrowserEvent.js';
/**
* @constructor
* @extends {module:ol/MapBrowserEvent}
class MapBrowserPointerEvent extends MapBrowserEvent {
/**
* @param {string} type Event type.
* @param {module:ol/PluggableMap} map Map.
* @param {module:ol/pointer/PointerEvent} pointerEvent Pointer
* event.
* @param {module:ol/pointer/PointerEvent} pointerEvent Pointer event.
* @param {boolean=} opt_dragging Is the map currently being dragged?
* @param {?module:ol/PluggableMap~FrameState=} opt_frameState Frame state.
*/
const MapBrowserPointerEvent = function(type, map, pointerEvent, opt_dragging,
opt_frameState) {
constructor(type, map, pointerEvent, opt_dragging, opt_frameState) {
MapBrowserEvent.call(this, type, map, pointerEvent.originalEvent, opt_dragging,
opt_frameState);
super(type, map, pointerEvent.originalEvent, opt_dragging, opt_frameState);
/**
* @const
@@ -26,7 +22,8 @@ const MapBrowserPointerEvent = function(type, map, pointerEvent, opt_dragging,
*/
this.pointerEvent = pointerEvent;
};
}
}
inherits(MapBrowserPointerEvent, MapBrowserEvent);
export default MapBrowserPointerEvent;
src/ol/MapEvent.js
+9 -8
View File
@@ -1,23 +1,23 @@
/**
* @module ol/MapEvent
*/
import {inherits} from './util.js';
import Event from './events/Event.js';
/**
* @classdesc
* Events emitted as map events are instances of this type.
* See {@link module:ol/Map~Map} for which events trigger a map event.
*
* @constructor
* @extends {module:ol/events/Event}
*/
class MapEvent extends Event {
/**
* @param {string} type Event type.
* @param {module:ol/PluggableMap} map Map.
* @param {?module:ol/PluggableMap~FrameState=} opt_frameState Frame state.
*/
const MapEvent = function(type, map, opt_frameState) {
constructor(type, map, opt_frameState) {
Event.call(this, type);
super(type);
/**
* The map where the event occurred.
@@ -33,7 +33,8 @@ const MapEvent = function(type, map, opt_frameState) {
*/
this.frameState = opt_frameState !== undefined ? opt_frameState : null;
};
}
}
inherits(MapEvent, Event);
export default MapEvent;
src/ol/Object.js
+111 -116
View File
@@ -1,7 +1,7 @@
/**
* @module ol/Object
*/
import {getUid, inherits} from './util.js';
import {getUid} from './util.js';
import ObjectEventType from './ObjectEventType.js';
import Observable from './Observable.js';
import Event from './events/Event.js';
@@ -10,17 +10,17 @@ import {assign} from './obj.js';
/**
* @classdesc
* Events emitted by {@link module:ol/Object~BaseObject} instances are instances of
* this type.
*
* Events emitted by {@link module:ol/Object~BaseObject} instances are instances of this type.
*/
class ObjectEvent extends Event {
/**
* @param {string} type The event type.
* @param {string} key The property name.
* @param {*} oldValue The old value for `key`.
* @extends {module:ol/events/Event}
* @constructor
*/
const ObjectEvent = function(type, key, oldValue) {
Event.call(this, type);
constructor(type, key, oldValue) {
super(type);
/**
* The name of the property whose value is changing.
@@ -37,8 +37,9 @@ const ObjectEvent = function(type, key, oldValue) {
*/
this.oldValue = oldValue;
};
inherits(ObjectEvent, Event);
}
}
/**
@@ -81,14 +82,16 @@ inherits(ObjectEvent, Event);
* Properties can be deleted by using the unset method. E.g.
* object.unset('foo').
*
* @constructor
* @extends {module:ol/Observable}
* @param {Object.<string, *>=} opt_values An object with key-value pairs.
* @fires module:ol/Object~ObjectEvent
* @api
*/
const BaseObject = function(opt_values) {
Observable.call(this);
class BaseObject extends Observable {
/**
* @param {Object.<string, *>=} opt_values An object with key-value pairs.
*/
constructor(opt_values) {
super();
// Call {@link module:ol~getUid} to ensure that the order of objects' ids is
// the same as the order in which they were created. This also helps to
@@ -105,9 +108,100 @@ const BaseObject = function(opt_values) {
if (opt_values !== undefined) {
this.setProperties(opt_values);
}
};
}
inherits(BaseObject, Observable);
/**
* Gets a value.
* @param {string} key Key name.
* @return {*} Value.
* @api
*/
get(key) {
let value;
if (this.values_.hasOwnProperty(key)) {
value = this.values_[key];
}
return value;
}
/**
* Get a list of object property names.
* @return {Array.<string>} List of property names.
* @api
*/
getKeys() {
return Object.keys(this.values_);
}
/**
* Get an object of all property names and values.
* @return {Object.<string, *>} Object.
* @api
*/
getProperties() {
return assign({}, this.values_);
}
/**
* @param {string} key Key name.
* @param {*} oldValue Old value.
*/
notify(key, oldValue) {
let eventType;
eventType = getChangeEventType(key);
this.dispatchEvent(new ObjectEvent(eventType, key, oldValue));
eventType = ObjectEventType.PROPERTYCHANGE;
this.dispatchEvent(new ObjectEvent(eventType, key, oldValue));
}
/**
* Sets a value.
* @param {string} key Key name.
* @param {*} value Value.
* @param {boolean=} opt_silent Update without triggering an event.
* @api
*/
set(key, value, opt_silent) {
if (opt_silent) {
this.values_[key] = value;
} else {
const oldValue = this.values_[key];
this.values_[key] = value;
if (oldValue !== value) {
this.notify(key, oldValue);
}
}
}
/**
* Sets a collection of key-value pairs. Note that this changes any existing
* properties and adds new ones (it does not remove any existing properties).
* @param {Object.<string, *>} values Values.
* @param {boolean=} opt_silent Update without triggering an event.
* @api
*/
setProperties(values, opt_silent) {
for (const key in values) {
this.set(key, values[key], opt_silent);
}
}
/**
* Unsets a property.
* @param {string} key Key name.
* @param {boolean=} opt_silent Unset without triggering an event.
* @api
*/
unset(key, opt_silent) {
if (key in this.values_) {
const oldValue = this.values_[key];
delete this.values_[key];
if (!opt_silent) {
this.notify(key, oldValue);
}
}
}
}
/**
@@ -127,103 +221,4 @@ export function getChangeEventType(key) {
}
/**
* Gets a value.
* @param {string} key Key name.
* @return {*} Value.
* @api
*/
BaseObject.prototype.get = function(key) {
let value;
if (this.values_.hasOwnProperty(key)) {
value = this.values_[key];
}
return value;
};
/**
* Get a list of object property names.
* @return {Array.<string>} List of property names.
* @api
*/
BaseObject.prototype.getKeys = function() {
return Object.keys(this.values_);
};
/**
* Get an object of all property names and values.
* @return {Object.<string, *>} Object.
* @api
*/
BaseObject.prototype.getProperties = function() {
return assign({}, this.values_);
};
/**
* @param {string} key Key name.
* @param {*} oldValue Old value.
*/
BaseObject.prototype.notify = function(key, oldValue) {
let eventType;
eventType = getChangeEventType(key);
this.dispatchEvent(new ObjectEvent(eventType, key, oldValue));
eventType = ObjectEventType.PROPERTYCHANGE;
this.dispatchEvent(new ObjectEvent(eventType, key, oldValue));
};
/**
* Sets a value.
* @param {string} key Key name.
* @param {*} value Value.
* @param {boolean=} opt_silent Update without triggering an event.
* @api
*/
BaseObject.prototype.set = function(key, value, opt_silent) {
if (opt_silent) {
this.values_[key] = value;
} else {
const oldValue = this.values_[key];
this.values_[key] = value;
if (oldValue !== value) {
this.notify(key, oldValue);
}
}
};
/**
* Sets a collection of key-value pairs. Note that this changes any existing
* properties and adds new ones (it does not remove any existing properties).
* @param {Object.<string, *>} values Values.
* @param {boolean=} opt_silent Update without triggering an event.
* @api
*/
BaseObject.prototype.setProperties = function(values, opt_silent) {
for (const key in values) {
this.set(key, values[key], opt_silent);
}
};
/**
* Unsets a property.
* @param {string} key Key name.
* @param {boolean=} opt_silent Unset without triggering an event.
* @api
*/
BaseObject.prototype.unset = function(key, opt_silent) {
if (key in this.values_) {
const oldValue = this.values_[key];
delete this.values_[key];
if (!opt_silent) {
this.notify(key, oldValue);
}
}
};
export default BaseObject;
src/ol/Observable.js
+84 -105
View File
@@ -1,7 +1,6 @@
/**
* @module ol/Observable
*/
import {inherits} from './util.js';
import {listen, unlistenByKey, unlisten, listenOnce} from './events.js';
import EventTarget from './events/EventTarget.js';
import EventType from './events/EventType.js';
@@ -14,15 +13,13 @@ import EventType from './events/EventType.js';
* and unregistration. A generic `change` event is always available through
* {@link module:ol/Observable~Observable#changed}.
*
* @constructor
* @extends {module:ol/events/EventTarget}
* @fires module:ol/events/Event~Event
* @struct
* @api
*/
const Observable = function() {
class Observable extends EventTarget {
constructor() {
EventTarget.call(this);
super();
/**
* @private
@@ -30,9 +27,88 @@ const Observable = function() {
*/
this.revision_ = 0;
};
}
inherits(Observable, EventTarget);
/**
* Increases the revision counter and dispatches a 'change' event.
* @api
*/
changed() {
++this.revision_;
this.dispatchEvent(EventType.CHANGE);
}
/**
* Get the version number for this object. Each time the object is modified,
* its version number will be incremented.
* @return {number} Revision.
* @api
*/
getRevision() {
return this.revision_;
}
/**
* Listen for a certain type of event.
* @param {string|Array.<string>} type The event type or array of event types.
* @param {function(?): ?} listener The listener function.
* @return {module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} Unique key for the listener. If
* called with an array of event types as the first argument, the return
* will be an array of keys.
* @api
*/
on(type, listener) {
if (Array.isArray(type)) {
const len = type.length;
const keys = new Array(len);
for (let i = 0; i < len; ++i) {
keys[i] = listen(this, type[i], listener);
}
return keys;
} else {
return listen(this, /** @type {string} */ (type), listener);
}
}
/**
* Listen once for a certain type of event.
* @param {string|Array.<string>} type The event type or array of event types.
* @param {function(?): ?} listener The listener function.
* @return {module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} Unique key for the listener. If
* called with an array of event types as the first argument, the return
* will be an array of keys.
* @api
*/
once(type, listener) {
if (Array.isArray(type)) {
const len = type.length;
const keys = new Array(len);
for (let i = 0; i < len; ++i) {
keys[i] = listenOnce(this, type[i], listener);
}
return keys;
} else {
return listenOnce(this, /** @type {string} */ (type), listener);
}
}
/**
* Unlisten for a certain type of event.
* @param {string|Array.<string>} type The event type or array of event types.
* @param {function(?): ?} listener The listener function.
* @api
*/
un(type, listener) {
if (Array.isArray(type)) {
for (let i = 0, ii = type.length; i < ii; ++i) {
unlisten(this, type[i], listener);
}
return;
} else {
unlisten(this, /** @type {string} */ (type), listener);
}
}
}
/**
@@ -52,101 +128,4 @@ export function unByKey(key) {
}
/**
* Increases the revision counter and dispatches a 'change' event.
* @api
*/
Observable.prototype.changed = function() {
++this.revision_;
this.dispatchEvent(EventType.CHANGE);
};
/**
* Dispatches an event and calls all listeners listening for events
* of this type. The event parameter can either be a string or an
* Object with a `type` property.
*
* @param {{type: string,
* target: (EventTarget|module:ol/events/EventTarget|undefined)}|
* module:ol/events/Event|string} event Event object.
* @function
* @api
*/
Observable.prototype.dispatchEvent;
/**
* Get the version number for this object. Each time the object is modified,
* its version number will be incremented.
* @return {number} Revision.
* @api
*/
Observable.prototype.getRevision = function() {
return this.revision_;
};
/**
* Listen for a certain type of event.
* @param {string|Array.<string>} type The event type or array of event types.
* @param {function(?): ?} listener The listener function.
* @return {module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} Unique key for the listener. If
* called with an array of event types as the first argument, the return
* will be an array of keys.
* @api
*/
Observable.prototype.on = function(type, listener) {
if (Array.isArray(type)) {
const len = type.length;
const keys = new Array(len);
for (let i = 0; i < len; ++i) {
keys[i] = listen(this, type[i], listener);
}
return keys;
} else {
return listen(this, /** @type {string} */ (type), listener);
}
};
/**
* Listen once for a certain type of event.
* @param {string|Array.<string>} type The event type or array of event types.
* @param {function(?): ?} listener The listener function.
* @return {module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} Unique key for the listener. If
* called with an array of event types as the first argument, the return
* will be an array of keys.
* @api
*/
Observable.prototype.once = function(type, listener) {
if (Array.isArray(type)) {
const len = type.length;
const keys = new Array(len);
for (let i = 0; i < len; ++i) {
keys[i] = listenOnce(this, type[i], listener);
}
return keys;
} else {
return listenOnce(this, /** @type {string} */ (type), listener);
}
};
/**
* Unlisten for a certain type of event.
* @param {string|Array.<string>} type The event type or array of event types.
* @param {function(?): ?} listener The listener function.
* @api
*/
Observable.prototype.un = function(type, listener) {
if (Array.isArray(type)) {
for (let i = 0, ii = type.length; i < ii; ++i) {
unlisten(this, type[i], listener);
}
return;
} else {
unlisten(this, /** @type {string} */ (type), listener);
}
};
export default Observable;
src/ol/Overlay.js
+79 -101
View File
@@ -1,7 +1,6 @@
/**
* @module ol/Overlay
*/
import {inherits} from './util.js';
import MapEventType from './MapEventType.js';
import BaseObject, {getChangeEventType} from './Object.js';
import OverlayPositioning from './OverlayPositioning.js';
@@ -93,14 +92,16 @@ const Property = {
* popup.setPosition(coordinate);
* map.addOverlay(popup);
*
* @constructor
* @extends {module:ol/Object}
* @param {module:ol/Overlay~Options} options Overlay options.
* @api
*/
const Overlay = function(options) {
class Overlay extends BaseObject {
BaseObject.call(this);
/**
* @param {module:ol/Overlay~Options} options Overlay options.
*/
constructor(options) {
super();
/**
* @protected
@@ -211,101 +212,91 @@ const Overlay = function(options) {
this.setPosition(options.position);
}
};
}
inherits(Overlay, BaseObject);
/**
/**
* Get the DOM element of this overlay.
* @return {HTMLElement|undefined} The Element containing the overlay.
* @observable
* @api
*/
Overlay.prototype.getElement = function() {
getElement() {
return /** @type {HTMLElement|undefined} */ (this.get(Property.ELEMENT));
};
}
/**
/**
* Get the overlay identifier which is set on constructor.
* @return {number|string|undefined} Id.
* @api
*/
Overlay.prototype.getId = function() {
getId() {
return this.id;
};
}
/**
/**
* Get the map associated with this overlay.
* @return {module:ol/PluggableMap|undefined} The map that the
* overlay is part of.
* @observable
* @api
*/
Overlay.prototype.getMap = function() {
getMap() {
return (
/** @type {module:ol/PluggableMap|undefined} */ (this.get(Property.MAP))
);
};
}
/**
/**
* Get the offset of this overlay.
* @return {Array.<number>} The offset.
* @observable
* @api
*/
Overlay.prototype.getOffset = function() {
getOffset() {
return /** @type {Array.<number>} */ (this.get(Property.OFFSET));
};
}
/**
/**
* Get the current position of this overlay.
* @return {module:ol/coordinate~Coordinate|undefined} The spatial point that the overlay is
* anchored at.
* @observable
* @api
*/
Overlay.prototype.getPosition = function() {
getPosition() {
return (
/** @type {module:ol/coordinate~Coordinate|undefined} */ (this.get(Property.POSITION))
);
};
}
/**
/**
* Get the current positioning of this overlay.
* @return {module:ol/OverlayPositioning} How the overlay is positioned
* relative to its point on the map.
* @observable
* @api
*/
Overlay.prototype.getPositioning = function() {
getPositioning() {
return (
/** @type {module:ol/OverlayPositioning} */ (this.get(Property.POSITIONING))
);
};
}
/**
/**
* @protected
*/
Overlay.prototype.handleElementChanged = function() {
handleElementChanged() {
removeChildren(this.element);
const element = this.getElement();
if (element) {
this.element.appendChild(element);
}
};
}
/**
/**
* @protected
*/
Overlay.prototype.handleMapChanged = function() {
handleMapChanged() {
if (this.mapPostrenderListenerKey) {
removeNode(this.element);
unlistenByKey(this.mapPostrenderListenerKey);
@@ -324,79 +315,71 @@ Overlay.prototype.handleMapChanged = function() {
container.appendChild(this.element);
}
}
};
}
/**
/**
* @protected
*/
Overlay.prototype.render = function() {
render() {
this.updatePixelPosition();
};
}
/**
/**
* @protected
*/
Overlay.prototype.handleOffsetChanged = function() {
handleOffsetChanged() {
this.updatePixelPosition();
};
}
/**
/**
* @protected
*/
Overlay.prototype.handlePositionChanged = function() {
handlePositionChanged() {
this.updatePixelPosition();
if (this.get(Property.POSITION) && this.autoPan) {
this.panIntoView();
}
};
}
/**
/**
* @protected
*/
Overlay.prototype.handlePositioningChanged = function() {
handlePositioningChanged() {
this.updatePixelPosition();
};
}
/**
/**
* Set the DOM element to be associated with this overlay.
* @param {HTMLElement|undefined} element The Element containing the overlay.
* @observable
* @api
*/
Overlay.prototype.setElement = function(element) {
setElement(element) {
this.set(Property.ELEMENT, element);
};
}
/**
/**
* Set the map to be associated with this overlay.
* @param {module:ol/PluggableMap|undefined} map The map that the
* overlay is part of.
* @observable
* @api
*/
Overlay.prototype.setMap = function(map) {
setMap(map) {
this.set(Property.MAP, map);
};
}
/**
/**
* Set the offset for this overlay.
* @param {Array.<number>} offset Offset.
* @observable
* @api
*/
Overlay.prototype.setOffset = function(offset) {
setOffset(offset) {
this.set(Property.OFFSET, offset);
};
}
/**
/**
* Set the position for this overlay. If the position is `undefined` the
* overlay is hidden.
* @param {module:ol/coordinate~Coordinate|undefined} position The spatial point that the overlay
@@ -404,17 +387,16 @@ Overlay.prototype.setOffset = function(offset) {
* @observable
* @api
*/
Overlay.prototype.setPosition = function(position) {
setPosition(position) {
this.set(Property.POSITION, position);
};
}
/**
/**
* Pan the map so that the overlay is entirely visible in the current viewport
* (if necessary).
* @protected
*/
Overlay.prototype.panIntoView = function() {
panIntoView() {
const map = this.getMap();
if (!map || !map.getTargetElement()) {
@@ -464,17 +446,16 @@ Overlay.prototype.panIntoView = function() {
});
}
}
};
}
/**
/**
* Get the extent of an element relative to the document
* @param {HTMLElement|undefined} element The element.
* @param {module:ol/size~Size|undefined} size The size of the element.
* @return {module:ol/extent~Extent} The extent.
* @protected
*/
Overlay.prototype.getRect = function(element, size) {
getRect(element, size) {
const box = element.getBoundingClientRect();
const offsetX = box.left + window.pageXOffset;
const offsetY = box.top + window.pageYOffset;
@@ -484,39 +465,36 @@ Overlay.prototype.getRect = function(element, size) {
offsetX + size[0],
offsetY + size[1]
];
};
}
/**
/**
* Set the positioning for this overlay.
* @param {module:ol/OverlayPositioning} positioning how the overlay is
* positioned relative to its point on the map.
* @observable
* @api
*/
Overlay.prototype.setPositioning = function(positioning) {
setPositioning(positioning) {
this.set(Property.POSITIONING, positioning);
};
}
/**
/**
* Modify the visibility of the element.
* @param {boolean} visible Element visibility.
* @protected
*/
Overlay.prototype.setVisible = function(visible) {
setVisible(visible) {
if (this.rendered.visible !== visible) {
this.element.style.display = visible ? '' : 'none';
this.rendered.visible = visible;
}
};
}
/**
/**
* Update pixel position.
* @protected
*/
Overlay.prototype.updatePixelPosition = function() {
updatePixelPosition() {
const map = this.getMap();
const position = this.getPosition();
if (!map || !map.isRendered() || !position) {
@@ -527,15 +505,14 @@ Overlay.prototype.updatePixelPosition = function() {
const pixel = map.getPixelFromCoordinate(position);
const mapSize = map.getSize();
this.updateRenderedPosition(pixel, mapSize);
};
}
/**
/**
* @param {module:ol~Pixel} pixel The pixel location.
* @param {module:ol/size~Size|undefined} mapSize The map size.
* @protected
*/
Overlay.prototype.updateRenderedPosition = function(pixel, mapSize) {
updateRenderedPosition(pixel, mapSize) {
const style = this.element.style;
const offset = this.getOffset();
@@ -593,15 +570,16 @@ Overlay.prototype.updateRenderedPosition = function(pixel, mapSize) {
this.rendered.top_ = style.top = top;
}
}
};
}
/**
/**
* returns the options this Overlay has been created with
* @return {module:ol/Overlay~Options} overlay options
*/
Overlay.prototype.getOptions = function() {
getOptions() {
return this.options;
};
}
}
export default Overlay;
src/ol/PluggableMap.js
+172 -224
View File
@@ -1,7 +1,7 @@
/**
* @module ol/PluggableMap
*/
import {getUid, inherits} from './util.js';
import {getUid} from './util.js';
import Collection from './Collection.js';
import CollectionEventType from './CollectionEventType.js';
import MapBrowserEvent from './MapBrowserEvent.js';
@@ -131,18 +131,20 @@ import {create as createTransform, apply as applyTransform} from './transform.js
/**
* @constructor
* @extends {module:ol/Object}
* @param {module:ol/PluggableMap~MapOptions} options Map options.
* @fires module:ol/MapBrowserEvent~MapBrowserEvent
* @fires module:ol/MapEvent~MapEvent
* @fires module:ol/render/Event~RenderEvent#postcompose
* @fires module:ol/render/Event~RenderEvent#precompose
* @api
*/
const PluggableMap = function(options) {
class PluggableMap extends BaseObject {
BaseObject.call(this);
/**
* @param {module:ol/PluggableMap~MapOptions} options Map options.
*/
constructor(options) {
super();
const optionsInternal = createOptionsInternal(options);
@@ -458,78 +460,69 @@ const PluggableMap = function(options) {
event.element.setMap(null);
}, this);
};
}
inherits(PluggableMap, BaseObject);
PluggableMap.prototype.createRenderer = function() {
createRenderer() {
throw new Error('Use a map type that has a createRenderer method');
};
}
/**
/**
* Add the given control to the map.
* @param {module:ol/control/Control} control Control.
* @api
*/
PluggableMap.prototype.addControl = function(control) {
addControl(control) {
this.getControls().push(control);
};
}
/**
/**
* Add the given interaction to the map.
* @param {module:ol/interaction/Interaction} interaction Interaction to add.
* @api
*/
PluggableMap.prototype.addInteraction = function(interaction) {
addInteraction(interaction) {
this.getInteractions().push(interaction);
};
}
/**
/**
* Adds the given layer to the top of this map. If you want to add a layer
* elsewhere in the stack, use `getLayers()` and the methods available on
* {@link module:ol/Collection~Collection}.
* @param {module:ol/layer/Base} layer Layer.
* @api
*/
PluggableMap.prototype.addLayer = function(layer) {
addLayer(layer) {
const layers = this.getLayerGroup().getLayers();
layers.push(layer);
};
}
/**
/**
* Add the given overlay to the map.
* @param {module:ol/Overlay} overlay Overlay.
* @api
*/
PluggableMap.prototype.addOverlay = function(overlay) {
addOverlay(overlay) {
this.getOverlays().push(overlay);
};
}
/**
/**
* This deals with map's overlay collection changes.
* @param {module:ol/Overlay} overlay Overlay.
* @private
*/
PluggableMap.prototype.addOverlayInternal_ = function(overlay) {
addOverlayInternal_(overlay) {
const id = overlay.getId();
if (id !== undefined) {
this.overlayIdIndex_[id.toString()] = overlay;
}
overlay.setMap(this);
};
}
/**
/**
*
* @inheritDoc
*/
PluggableMap.prototype.disposeInternal = function() {
disposeInternal() {
this.mapBrowserEventHandler_.dispose();
unlisten(this.viewport_, EventType.CONTEXTMENU, this.handleBrowserEvent, this);
unlisten(this.viewport_, EventType.WHEEL, this.handleBrowserEvent, this);
@@ -543,11 +536,10 @@ PluggableMap.prototype.disposeInternal = function() {
this.animationDelayKey_ = undefined;
}
this.setTarget(null);
BaseObject.prototype.disposeInternal.call(this);
};
super.disposeInternal();
}
/**
/**
* Detect features that intersect a pixel on the viewport, and execute a
* callback with each intersecting feature. Layers included in the detection can
* be configured through the `layerFilter` option in `opt_options`.
@@ -566,7 +558,7 @@ PluggableMap.prototype.disposeInternal = function() {
* @template S,T
* @api
*/
PluggableMap.prototype.forEachFeatureAtPixel = function(pixel, callback, opt_options) {
forEachFeatureAtPixel(pixel, callback, opt_options) {
if (!this.frameState_) {
return;
}
@@ -579,10 +571,9 @@ PluggableMap.prototype.forEachFeatureAtPixel = function(pixel, callback, opt_opt
return this.renderer_.forEachFeatureAtCoordinate(
coordinate, this.frameState_, hitTolerance, callback, null,
layerFilter, null);
};
}
/**
/**
* Get all features that intersect a pixel on the viewport.
* @param {module:ol~Pixel} pixel Pixel.
* @param {module:ol/PluggableMap~AtPixelOptions=} opt_options Optional options.
@@ -590,7 +581,7 @@ PluggableMap.prototype.forEachFeatureAtPixel = function(pixel, callback, opt_opt
* `null` if none were found.
* @api
*/
PluggableMap.prototype.getFeaturesAtPixel = function(pixel, opt_options) {
getFeaturesAtPixel(pixel, opt_options) {
let features = null;
this.forEachFeatureAtPixel(pixel, function(feature) {
if (!features) {
@@ -599,9 +590,9 @@ PluggableMap.prototype.getFeaturesAtPixel = function(pixel, opt_options) {
features.push(feature);
}, opt_options);
return features;
};
}
/**
/**
* Detect layers that have a color value at a pixel on the viewport, and
* execute a callback with each matching layer. Layers included in the
* detection can be configured through `opt_layerFilter`.
@@ -618,7 +609,7 @@ PluggableMap.prototype.getFeaturesAtPixel = function(pixel, opt_options) {
* @template S,T
* @api
*/
PluggableMap.prototype.forEachLayerAtPixel = function(pixel, callback, opt_options) {
forEachLayerAtPixel(pixel, callback, opt_options) {
if (!this.frameState_) {
return;
}
@@ -628,10 +619,9 @@ PluggableMap.prototype.forEachLayerAtPixel = function(pixel, callback, opt_optio
const layerFilter = options.layerFilter || TRUE;
return this.renderer_.forEachLayerAtPixel(
pixel, this.frameState_, hitTolerance, callback, null, layerFilter, null);
};
}
/**
/**
* Detect if features intersect a pixel on the viewport. Layers included in the
* detection can be configured through `opt_layerFilter`.
* @param {module:ol~Pixel} pixel Pixel.
@@ -640,7 +630,7 @@ PluggableMap.prototype.forEachLayerAtPixel = function(pixel, callback, opt_optio
* @template U
* @api
*/
PluggableMap.prototype.hasFeatureAtPixel = function(pixel, opt_options) {
hasFeatureAtPixel(pixel, opt_options) {
if (!this.frameState_) {
return false;
}
@@ -651,37 +641,34 @@ PluggableMap.prototype.hasFeatureAtPixel = function(pixel, opt_options) {
opt_options.hitTolerance * this.frameState_.pixelRatio : 0;
return this.renderer_.hasFeatureAtCoordinate(
coordinate, this.frameState_, hitTolerance, layerFilter, null);
};
}
/**
/**
* Returns the coordinate in view projection for a browser event.
* @param {Event} event Event.
* @return {module:ol/coordinate~Coordinate} Coordinate.
* @api
*/
PluggableMap.prototype.getEventCoordinate = function(event) {
getEventCoordinate(event) {
return this.getCoordinateFromPixel(this.getEventPixel(event));
};
}
/**
/**
* Returns the map pixel position for a browser event relative to the viewport.
* @param {Event} event Event.
* @return {module:ol~Pixel} Pixel.
* @api
*/
PluggableMap.prototype.getEventPixel = function(event) {
getEventPixel(event) {
const viewportPosition = this.viewport_.getBoundingClientRect();
const eventPosition = event.changedTouches ? event.changedTouches[0] : event;
return [
eventPosition.clientX - viewportPosition.left,
eventPosition.clientY - viewportPosition.top
];
};
}
/**
/**
* Get the target in which this map is rendered.
* Note that this returns what is entered as an option or in setTarget:
* if that was an element, it returns an element; if a string, it returns that.
@@ -690,68 +677,63 @@ PluggableMap.prototype.getEventPixel = function(event) {
* @observable
* @api
*/
PluggableMap.prototype.getTarget = function() {
getTarget() {
return /** @type {HTMLElement|string|undefined} */ (this.get(MapProperty.TARGET));
};
}
/**
/**
* Get the DOM element into which this map is rendered. In contrast to
* `getTarget` this method always return an `Element`, or `null` if the
* map has no target.
* @return {HTMLElement} The element that the map is rendered in.
* @api
*/
PluggableMap.prototype.getTargetElement = function() {
getTargetElement() {
const target = this.getTarget();
if (target !== undefined) {
return typeof target === 'string' ? document.getElementById(target) : target;
} else {
return null;
}
};
}
/**
/**
* Get the coordinate for a given pixel. This returns a coordinate in the
* map view projection.
* @param {module:ol~Pixel} pixel Pixel position in the map viewport.
* @return {module:ol/coordinate~Coordinate} The coordinate for the pixel position.
* @api
*/
PluggableMap.prototype.getCoordinateFromPixel = function(pixel) {
getCoordinateFromPixel(pixel) {
const frameState = this.frameState_;
if (!frameState) {
return null;
} else {
return applyTransform(frameState.pixelToCoordinateTransform, pixel.slice());
}
};
}
/**
/**
* Get the map controls. Modifying this collection changes the controls
* associated with the map.
* @return {module:ol/Collection.<module:ol/control/Control>} Controls.
* @api
*/
PluggableMap.prototype.getControls = function() {
getControls() {
return this.controls;
};
}
/**
/**
* Get the map overlays. Modifying this collection changes the overlays
* associated with the map.
* @return {module:ol/Collection.<module:ol/Overlay>} Overlays.
* @api
*/
PluggableMap.prototype.getOverlays = function() {
getOverlays() {
return this.overlays_;
};
}
/**
/**
* Get an overlay by its identifier (the value returned by overlay.getId()).
* Note that the index treats string and numeric identifiers as the same. So
* `map.getOverlayById(2)` will return an overlay with id `'2'` or `2`.
@@ -759,13 +741,12 @@ PluggableMap.prototype.getOverlays = function() {
* @return {module:ol/Overlay} Overlay.
* @api
*/
PluggableMap.prototype.getOverlayById = function(id) {
getOverlayById(id) {
const overlay = this.overlayIdIndex_[id.toString()];
return overlay !== undefined ? overlay : null;
};
}
/**
/**
* Get the map interactions. Modifying this collection changes the interactions
* associated with the map.
*
@@ -773,130 +754,120 @@ PluggableMap.prototype.getOverlayById = function(id) {
* @return {module:ol/Collection.<module:ol/interaction/Interaction>} Interactions.
* @api
*/
PluggableMap.prototype.getInteractions = function() {
getInteractions() {
return this.interactions;
};
}
/**
/**
* Get the layergroup associated with this map.
* @return {module:ol/layer/Group} A layer group containing the layers in this map.
* @observable
* @api
*/
PluggableMap.prototype.getLayerGroup = function() {
getLayerGroup() {
return (
/** @type {module:ol/layer/Group} */ (this.get(MapProperty.LAYERGROUP))
);
};
}
/**
/**
* Get the collection of layers associated with this map.
* @return {!module:ol/Collection.<module:ol/layer/Base>} Layers.
* @api
*/
PluggableMap.prototype.getLayers = function() {
getLayers() {
const layers = this.getLayerGroup().getLayers();
return layers;
};
}
/**
/**
* Get the pixel for a coordinate. This takes a coordinate in the map view
* projection and returns the corresponding pixel.
* @param {module:ol/coordinate~Coordinate} coordinate A map coordinate.
* @return {module:ol~Pixel} A pixel position in the map viewport.
* @api
*/
PluggableMap.prototype.getPixelFromCoordinate = function(coordinate) {
getPixelFromCoordinate(coordinate) {
const frameState = this.frameState_;
if (!frameState) {
return null;
} else {
return applyTransform(frameState.coordinateToPixelTransform, coordinate.slice(0, 2));
}
};
}
/**
/**
* Get the map renderer.
* @return {module:ol/renderer/Map} Renderer
*/
PluggableMap.prototype.getRenderer = function() {
getRenderer() {
return this.renderer_;
};
}
/**
/**
* Get the size of this map.
* @return {module:ol/size~Size|undefined} The size in pixels of the map in the DOM.
* @observable
* @api
*/
PluggableMap.prototype.getSize = function() {
getSize() {
return (
/** @type {module:ol/size~Size|undefined} */ (this.get(MapProperty.SIZE))
);
};
}
/**
/**
* Get the view associated with this map. A view manages properties such as
* center and resolution.
* @return {module:ol/View} The view that controls this map.
* @observable
* @api
*/
PluggableMap.prototype.getView = function() {
getView() {
return (
/** @type {module:ol/View} */ (this.get(MapProperty.VIEW))
);
};
}
/**
/**
* Get the element that serves as the map viewport.
* @return {HTMLElement} Viewport.
* @api
*/
PluggableMap.prototype.getViewport = function() {
getViewport() {
return this.viewport_;
};
}
/**
/**
* Get the element that serves as the container for overlays. Elements added to
* this container will let mousedown and touchstart events through to the map,
* so clicks and gestures on an overlay will trigger {@link module:ol/MapBrowserEvent~MapBrowserEvent}
* events.
* @return {!HTMLElement} The map's overlay container.
*/
PluggableMap.prototype.getOverlayContainer = function() {
getOverlayContainer() {
return this.overlayContainer_;
};
}
/**
/**
* Get the element that serves as a container for overlays that don't allow
* event propagation. Elements added to this container won't let mousedown and
* touchstart events through to the map, so clicks and gestures on an overlay
* don't trigger any {@link module:ol/MapBrowserEvent~MapBrowserEvent}.
* @return {!HTMLElement} The map's overlay container that stops events.
*/
PluggableMap.prototype.getOverlayContainerStopEvent = function() {
getOverlayContainerStopEvent() {
return this.overlayContainerStopEvent_;
};
}
/**
/**
* @param {module:ol/Tile} tile Tile.
* @param {string} tileSourceKey Tile source key.
* @param {module:ol/coordinate~Coordinate} tileCenter Tile center.
* @param {number} tileResolution Tile resolution.
* @return {number} Tile priority.
*/
PluggableMap.prototype.getTilePriority = function(tile, tileSourceKey, tileCenter, tileResolution) {
getTilePriority(tile, tileSourceKey, tileCenter, tileResolution) {
// Filter out tiles at higher zoom levels than the current zoom level, or that
// are outside the visible extent.
const frameState = this.frameState_;
@@ -916,24 +887,22 @@ PluggableMap.prototype.getTilePriority = function(tile, tileSourceKey, tileCente
const deltaY = tileCenter[1] - frameState.focus[1];
return 65536 * Math.log(tileResolution) +
Math.sqrt(deltaX * deltaX + deltaY * deltaY) / tileResolution;
};
}
/**
/**
* @param {Event} browserEvent Browser event.
* @param {string=} opt_type Type.
*/
PluggableMap.prototype.handleBrowserEvent = function(browserEvent, opt_type) {
handleBrowserEvent(browserEvent, opt_type) {
const type = opt_type || browserEvent.type;
const mapBrowserEvent = new MapBrowserEvent(type, this, browserEvent);
this.handleMapBrowserEvent(mapBrowserEvent);
};
}
/**
/**
* @param {module:ol/MapBrowserEvent} mapBrowserEvent The event to handle.
*/
PluggableMap.prototype.handleMapBrowserEvent = function(mapBrowserEvent) {
handleMapBrowserEvent(mapBrowserEvent) {
if (!this.frameState_) {
// With no view defined, we cannot translate pixels into geographical
// coordinates so interactions cannot be used.
@@ -954,13 +923,12 @@ PluggableMap.prototype.handleMapBrowserEvent = function(mapBrowserEvent) {
}
}
}
};
}
/**
/**
* @protected
*/
PluggableMap.prototype.handlePostRender = function() {
handlePostRender() {
const frameState = this.frameState_;
@@ -999,21 +967,19 @@ PluggableMap.prototype.handlePostRender = function() {
postRenderFunctions[i](this, frameState);
}
postRenderFunctions.length = 0;
};
}
/**
/**
* @private
*/
PluggableMap.prototype.handleSizeChanged_ = function() {
handleSizeChanged_() {
this.render();
};
}
/**
/**
* @private
*/
PluggableMap.prototype.handleTargetChanged_ = function() {
handleTargetChanged_() {
// target may be undefined, null, a string or an Element.
// If it's a string we convert it to an Element before proceeding.
// If it's not now an Element we remove the viewport from the DOM.
@@ -1057,29 +1023,26 @@ PluggableMap.prototype.handleTargetChanged_ = function() {
this.updateSize();
// updateSize calls setSize, so no need to call this.render
// ourselves here.
};
}
/**
/**
* @private
*/
PluggableMap.prototype.handleTileChange_ = function() {
handleTileChange_() {
this.render();
};
}
/**
/**
* @private
*/
PluggableMap.prototype.handleViewPropertyChanged_ = function() {
handleViewPropertyChanged_() {
this.render();
};
}
/**
/**
* @private
*/
PluggableMap.prototype.handleViewChanged_ = function() {
handleViewChanged_() {
if (this.viewPropertyListenerKey_) {
unlistenByKey(this.viewPropertyListenerKey_);
this.viewPropertyListenerKey_ = null;
@@ -1099,13 +1062,12 @@ PluggableMap.prototype.handleViewChanged_ = function() {
this.handleViewPropertyChanged_, this);
}
this.render();
};
}
/**
/**
* @private
*/
PluggableMap.prototype.handleLayerGroupChanged_ = function() {
handleLayerGroupChanged_() {
if (this.layerGroupPropertyListenerKeys_) {
this.layerGroupPropertyListenerKeys_.forEach(unlistenByKey);
this.layerGroupPropertyListenerKeys_ = null;
@@ -1122,94 +1084,86 @@ PluggableMap.prototype.handleLayerGroupChanged_ = function() {
];
}
this.render();
};
}
/**
/**
* @return {boolean} Is rendered.
*/
PluggableMap.prototype.isRendered = function() {
isRendered() {
return !!this.frameState_;
};
}
/**
/**
* Requests an immediate render in a synchronous manner.
* @api
*/
PluggableMap.prototype.renderSync = function() {
renderSync() {
if (this.animationDelayKey_) {
cancelAnimationFrame(this.animationDelayKey_);
}
this.animationDelay_();
};
}
/**
/**
* Request a map rendering (at the next animation frame).
* @api
*/
PluggableMap.prototype.render = function() {
render() {
if (this.animationDelayKey_ === undefined) {
this.animationDelayKey_ = requestAnimationFrame(this.animationDelay_);
}
};
}
/**
/**
* Remove the given control from the map.
* @param {module:ol/control/Control} control Control.
* @return {module:ol/control/Control|undefined} The removed control (or undefined
* if the control was not found).
* @api
*/
PluggableMap.prototype.removeControl = function(control) {
removeControl(control) {
return this.getControls().remove(control);
};
}
/**
/**
* Remove the given interaction from the map.
* @param {module:ol/interaction/Interaction} interaction Interaction to remove.
* @return {module:ol/interaction/Interaction|undefined} The removed interaction (or
* undefined if the interaction was not found).
* @api
*/
PluggableMap.prototype.removeInteraction = function(interaction) {
removeInteraction(interaction) {
return this.getInteractions().remove(interaction);
};
}
/**
/**
* Removes the given layer from the map.
* @param {module:ol/layer/Base} layer Layer.
* @return {module:ol/layer/Base|undefined} The removed layer (or undefined if the
* layer was not found).
* @api
*/
PluggableMap.prototype.removeLayer = function(layer) {
removeLayer(layer) {
const layers = this.getLayerGroup().getLayers();
return layers.remove(layer);
};
}
/**
/**
* Remove the given overlay from the map.
* @param {module:ol/Overlay} overlay Overlay.
* @return {module:ol/Overlay|undefined} The removed overlay (or undefined
* if the overlay was not found).
* @api
*/
PluggableMap.prototype.removeOverlay = function(overlay) {
removeOverlay(overlay) {
return this.getOverlays().remove(overlay);
};
}
/**
/**
* @param {number} time Time.
* @private
*/
PluggableMap.prototype.renderFrame_ = function(time) {
renderFrame_(time) {
let viewState;
const size = this.getSize();
@@ -1295,70 +1249,64 @@ PluggableMap.prototype.renderFrame_ = function(time) {
setTimeout(this.handlePostRender.bind(this), 0);
};
}
/**
/**
* Sets the layergroup of this map.
* @param {module:ol/layer/Group} layerGroup A layer group containing the layers in this map.
* @observable
* @api
*/
PluggableMap.prototype.setLayerGroup = function(layerGroup) {
setLayerGroup(layerGroup) {
this.set(MapProperty.LAYERGROUP, layerGroup);
};
}
/**
/**
* Set the size of this map.
* @param {module:ol/size~Size|undefined} size The size in pixels of the map in the DOM.
* @observable
* @api
*/
PluggableMap.prototype.setSize = function(size) {
setSize(size) {
this.set(MapProperty.SIZE, size);
};
}
/**
/**
* Set the target element to render this map into.
* @param {HTMLElement|string|undefined} target The Element or id of the Element
* that the map is rendered in.
* @observable
* @api
*/
PluggableMap.prototype.setTarget = function(target) {
setTarget(target) {
this.set(MapProperty.TARGET, target);
};
}
/**
/**
* Set the view for this map.
* @param {module:ol/View} view The view that controls this map.
* @observable
* @api
*/
PluggableMap.prototype.setView = function(view) {
setView(view) {
this.set(MapProperty.VIEW, view);
};
}
/**
/**
* @param {module:ol/Feature} feature Feature.
*/
PluggableMap.prototype.skipFeature = function(feature) {
skipFeature(feature) {
const featureUid = getUid(feature).toString();
this.skippedFeatureUids_[featureUid] = true;
this.render();
};
}
/**
/**
* Force a recalculation of the map viewport size. This should be called when
* third-party code changes the size of the map viewport.
* @api
*/
PluggableMap.prototype.updateSize = function() {
updateSize() {
const targetElement = this.getTargetElement();
if (!targetElement) {
@@ -1378,17 +1326,17 @@ PluggableMap.prototype.updateSize = function() {
parseFloat(computedStyle['borderBottomWidth'])
]);
}
};
}
/**
/**
* @param {module:ol/Feature} feature Feature.
*/
PluggableMap.prototype.unskipFeature = function(feature) {
unskipFeature(feature) {
const featureUid = getUid(feature).toString();
delete this.skippedFeatureUids_[featureUid];
this.render();
};
}
}
/**
src/ol/Tile.js
+42 -43
View File
@@ -1,7 +1,6 @@
/**
* @module ol/Tile
*/
import {inherits} from './util.js';
import TileState from './TileState.js';
import {easeIn} from './easing.js';
import EventTarget from './events/EventTarget.js';
@@ -44,15 +43,17 @@ import EventType from './events/EventType.js';
* @classdesc
* Base class for tiles.
*
* @constructor
* @abstract
* @extends {module:ol/events/EventTarget}
*/
class Tile extends EventTarget {
/**
* @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate.
* @param {module:ol/TileState} state State.
* @param {module:ol/Tile~Options=} opt_options Tile options.
*/
const Tile = function(tileCoord, state, opt_options) {
EventTarget.call(this);
constructor(tileCoord, state, opt_options) {
super();
const options = opt_options ? opt_options : {};
@@ -96,33 +97,29 @@ const Tile = function(tileCoord, state, opt_options) {
*/
this.transitionStarts_ = {};
};
}
inherits(Tile, EventTarget);
/**
/**
* @protected
*/
Tile.prototype.changed = function() {
changed() {
this.dispatchEvent(EventType.CHANGE);
};
}
/**
/**
* @return {string} Key.
*/
Tile.prototype.getKey = function() {
getKey() {
return this.key + '/' + this.tileCoord;
};
}
/**
/**
* Get the interim tile most suitable for rendering using the chain of interim
* tiles. This corresponds to the most recent tile that has been loaded, if no
* such tile exists, the original tile is returned.
* @return {!module:ol/Tile} Best tile for rendering.
*/
Tile.prototype.getInterimTile = function() {
getInterimTile() {
if (!this.interimTile) {
//empty chain
return this;
@@ -142,13 +139,13 @@ Tile.prototype.getInterimTile = function() {
// we can not find a better tile
return this;
};
}
/**
/**
* Goes through the chain of interim tiles and discards sections of the chain
* that are no longer relevant.
*/
Tile.prototype.refreshInterimChain = function() {
refreshInterimChain() {
if (!this.interimTile) {
return;
}
@@ -176,49 +173,48 @@ Tile.prototype.refreshInterimChain = function() {
}
tile = prev.interimTile;
} while (tile);
};
}
/**
/**
* Get the tile coordinate for this tile.
* @return {module:ol/tilecoord~TileCoord} The tile coordinate.
* @api
*/
Tile.prototype.getTileCoord = function() {
getTileCoord() {
return this.tileCoord;
};
}
/**
/**
* @return {module:ol/TileState} State.
*/
Tile.prototype.getState = function() {
getState() {
return this.state;
};
}
/**
/**
* @param {module:ol/TileState} state State.
*/
Tile.prototype.setState = function(state) {
setState(state) {
this.state = state;
this.changed();
};
}
/**
/**
* Load the image or retry if loading previously failed.
* Loading is taken care of by the tile queue, and calling this method is
* only needed for preloading or for reloading in case of an error.
* @abstract
* @api
*/
Tile.prototype.load = function() {};
load() {}
/**
/**
* Get the alpha value for rendering.
* @param {number} id An id for the renderer.
* @param {number} time The render frame time.
* @return {number} A number between 0 and 1.
*/
Tile.prototype.getAlpha = function(id, time) {
getAlpha(id, time) {
if (!this.transition_) {
return 1;
}
@@ -236,29 +232,32 @@ Tile.prototype.getAlpha = function(id, time) {
return 1;
}
return easeIn(delta / this.transition_);
};
}
/**
/**
* Determine if a tile is in an alpha transition. A tile is considered in
* transition if tile.getAlpha() has not yet been called or has been called
* and returned 1.
* @param {number} id An id for the renderer.
* @return {boolean} The tile is in transition.
*/
Tile.prototype.inTransition = function(id) {
inTransition(id) {
if (!this.transition_) {
return false;
}
return this.transitionStarts_[id] !== -1;
};
}
/**
/**
* Mark a transition as complete.
* @param {number} id An id for the renderer.
*/
Tile.prototype.endTransition = function(id) {
endTransition(id) {
if (this.transition_) {
this.transitionStarts_[id] = -1;
}
};
}
}
export default Tile;
src/ol/TileCache.js
+15 -18
View File
@@ -1,29 +1,24 @@
/**
* @module ol/TileCache
*/
import {inherits} from './util.js';
import LRUCache from './structs/LRUCache.js';
import {fromKey, getKey} from './tilecoord.js';
/**
* @constructor
* @extends {module:ol/structs/LRUCache.<module:ol/Tile>}
class TileCache extends LRUCache {
/**
* @param {number=} opt_highWaterMark High water mark.
* @struct
*/
const TileCache = function(opt_highWaterMark) {
constructor(opt_highWaterMark) {
LRUCache.call(this, opt_highWaterMark);
super(opt_highWaterMark);
};
}
inherits(TileCache, LRUCache);
/**
/**
* @param {!Object.<string, module:ol/TileRange>} usedTiles Used tiles.
*/
TileCache.prototype.expireCache = function(usedTiles) {
expireCache(usedTiles) {
while (this.canExpireCache()) {
const tile = this.peekLast();
const zKey = tile.tileCoord[0].toString();
@@ -33,13 +28,12 @@ TileCache.prototype.expireCache = function(usedTiles) {
this.pop().dispose();
}
}
};
}
/**
/**
* Prune all tiles from the cache that don't have the same z as the newest tile.
*/
TileCache.prototype.pruneExceptNewestZ = function() {
pruneExceptNewestZ() {
if (this.getCount() === 0) {
return;
}
@@ -52,5 +46,8 @@ TileCache.prototype.pruneExceptNewestZ = function() {
tile.dispose();
}
}, this);
};
}
}
export default TileCache;
src/ol/TileQueue.js
+25 -33
View File
@@ -1,7 +1,6 @@
/**
* @module ol/TileQueue
*/
import {inherits} from './util.js';
import TileState from './TileState.js';
import {listen, unlisten} from './events.js';
import EventType from './events/EventType.js';
@@ -13,19 +12,15 @@ import PriorityQueue from './structs/PriorityQueue.js';
*/
/**
* @constructor
* @extends {module:ol/structs/PriorityQueue.<Array>}
* @param {module:ol/TileQueue~PriorityFunction} tilePriorityFunction
* Tile priority function.
* @param {function(): ?} tileChangeCallback
* Function called on each tile change event.
* @struct
*/
const TileQueue = function(tilePriorityFunction, tileChangeCallback) {
class TileQueue extends PriorityQueue {
PriorityQueue.call(
this,
/**
* @param {module:ol/TileQueue~PriorityFunction} tilePriorityFunction Tile priority function.
* @param {function(): ?} tileChangeCallback Function called on each tile change event.
*/
constructor(tilePriorityFunction, tileChangeCallback) {
super(
/**
* @param {Array} element Element.
* @return {number} Priority.
@@ -59,37 +54,32 @@ const TileQueue = function(tilePriorityFunction, tileChangeCallback) {
*/
this.tilesLoadingKeys_ = {};
};
}
inherits(TileQueue, PriorityQueue);
/**
/**
* @inheritDoc
*/
TileQueue.prototype.enqueue = function(element) {
const added = PriorityQueue.prototype.enqueue.call(this, element);
enqueue(element) {
const added = super.enqueue(element);
if (added) {
const tile = element[0];
listen(tile, EventType.CHANGE, this.handleTileChange, this);
}
return added;
};
}
/**
/**
* @return {number} Number of tiles loading.
*/
TileQueue.prototype.getTilesLoading = function() {
getTilesLoading() {
return this.tilesLoading_;
};
}
/**
/**
* @param {module:ol/events/Event} event Event.
* @protected
*/
TileQueue.prototype.handleTileChange = function(event) {
handleTileChange(event) {
const tile = /** @type {module:ol/Tile} */ (event.target);
const state = tile.getState();
if (state === TileState.LOADED || state === TileState.ERROR ||
@@ -102,14 +92,13 @@ TileQueue.prototype.handleTileChange = function(event) {
}
this.tileChangeCallback_();
}
};
}
/**
/**
* @param {number} maxTotalLoading Maximum number tiles to load simultaneously.
* @param {number} maxNewLoads Maximum number of new tiles to load.
*/
TileQueue.prototype.loadMoreTiles = function(maxTotalLoading, maxNewLoads) {
loadMoreTiles(maxTotalLoading, maxNewLoads) {
let newLoads = 0;
let abortedTiles = false;
let state, tile, tileKey;
@@ -132,5 +121,8 @@ TileQueue.prototype.loadMoreTiles = function(maxTotalLoading, maxNewLoads) {
// a small, saturated tile cache.
this.tileChangeCallback_();
}
};
}
}
export default TileQueue;
src/ol/TileRange.js
+93 -97
View File
@@ -1,18 +1,20 @@
/**
* @module ol/TileRange
*/
/**
* A representation of a contiguous block of tiles. A tile range is specified
* by its min/max tile coordinates and is inclusive of coordinates.
*
* @constructor
*/
class TileRange {
/**
* @param {number} minX Minimum X.
* @param {number} maxX Maximum X.
* @param {number} minY Minimum Y.
* @param {number} maxY Maximum Y.
* @struct
*/
const TileRange = function(minX, maxX, minY, maxY) {
constructor(minX, maxX, minY, maxY) {
/**
* @type {number}
@@ -34,7 +36,93 @@ const TileRange = function(minX, maxX, minY, maxY) {
*/
this.maxY = maxY;
};
}
/**
* @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate.
* @return {boolean} Contains tile coordinate.
*/
contains(tileCoord) {
return this.containsXY(tileCoord[1], tileCoord[2]);
}
/**
* @param {module:ol/TileRange} tileRange Tile range.
* @return {boolean} Contains.
*/
containsTileRange(tileRange) {
return this.minX <= tileRange.minX && tileRange.maxX <= this.maxX &&
this.minY <= tileRange.minY && tileRange.maxY <= this.maxY;
}
/**
* @param {number} x Tile coordinate x.
* @param {number} y Tile coordinate y.
* @return {boolean} Contains coordinate.
*/
containsXY(x, y) {
return this.minX <= x && x <= this.maxX && this.minY <= y && y <= this.maxY;
}
/**
* @param {module:ol/TileRange} tileRange Tile range.
* @return {boolean} Equals.
*/
equals(tileRange) {
return this.minX == tileRange.minX && this.minY == tileRange.minY &&
this.maxX == tileRange.maxX && this.maxY == tileRange.maxY;
}
/**
* @param {module:ol/TileRange} tileRange Tile range.
*/
extend(tileRange) {
if (tileRange.minX < this.minX) {
this.minX = tileRange.minX;
}
if (tileRange.maxX > this.maxX) {
this.maxX = tileRange.maxX;
}
if (tileRange.minY < this.minY) {
this.minY = tileRange.minY;
}
if (tileRange.maxY > this.maxY) {
this.maxY = tileRange.maxY;
}
}
/**
* @return {number} Height.
*/
getHeight() {
return this.maxY - this.minY + 1;
}
/**
* @return {module:ol/size~Size} Size.
*/
getSize() {
return [this.getWidth(), this.getHeight()];
}
/**
* @return {number} Width.
*/
getWidth() {
return this.maxX - this.minX + 1;
}
/**
* @param {module:ol/TileRange} tileRange Tile range.
* @return {boolean} Intersects.
*/
intersects(tileRange) {
return this.minX <= tileRange.maxX &&
this.maxX >= tileRange.minX &&
this.minY <= tileRange.maxY &&
this.maxY >= tileRange.minY;
}
}
/**
@@ -58,96 +146,4 @@ export function createOrUpdate(minX, maxX, minY, maxY, tileRange) {
}
/**
* @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate.
* @return {boolean} Contains tile coordinate.
*/
TileRange.prototype.contains = function(tileCoord) {
return this.containsXY(tileCoord[1], tileCoord[2]);
};
/**
* @param {module:ol/TileRange} tileRange Tile range.
* @return {boolean} Contains.
*/
TileRange.prototype.containsTileRange = function(tileRange) {
return this.minX <= tileRange.minX && tileRange.maxX <= this.maxX &&
this.minY <= tileRange.minY && tileRange.maxY <= this.maxY;
};
/**
* @param {number} x Tile coordinate x.
* @param {number} y Tile coordinate y.
* @return {boolean} Contains coordinate.
*/
TileRange.prototype.containsXY = function(x, y) {
return this.minX <= x && x <= this.maxX && this.minY <= y && y <= this.maxY;
};
/**
* @param {module:ol/TileRange} tileRange Tile range.
* @return {boolean} Equals.
*/
TileRange.prototype.equals = function(tileRange) {
return this.minX == tileRange.minX && this.minY == tileRange.minY &&
this.maxX == tileRange.maxX && this.maxY == tileRange.maxY;
};
/**
* @param {module:ol/TileRange} tileRange Tile range.
*/
TileRange.prototype.extend = function(tileRange) {
if (tileRange.minX < this.minX) {
this.minX = tileRange.minX;
}
if (tileRange.maxX > this.maxX) {
this.maxX = tileRange.maxX;
}
if (tileRange.minY < this.minY) {
this.minY = tileRange.minY;
}
if (tileRange.maxY > this.maxY) {
this.maxY = tileRange.maxY;
}
};
/**
* @return {number} Height.
*/
TileRange.prototype.getHeight = function() {
return this.maxY - this.minY + 1;
};
/**
* @return {module:ol/size~Size} Size.
*/
TileRange.prototype.getSize = function() {
return [this.getWidth(), this.getHeight()];
};
/**
* @return {number} Width.
*/
TileRange.prototype.getWidth = function() {
return this.maxX - this.minX + 1;
};
/**
* @param {module:ol/TileRange} tileRange Tile range.
* @return {boolean} Intersects.
*/
TileRange.prototype.intersects = function(tileRange) {
return this.minX <= tileRange.maxX &&
this.maxX >= tileRange.minX &&
this.minY <= tileRange.maxY &&
this.maxY >= tileRange.minY;
};
export default TileRange;
src/ol/VectorImageTile.js
+36 -44
View File
@@ -1,7 +1,7 @@
/**
* @module ol/VectorImageTile
*/
import {getUid, inherits} from './util.js';
import {getUid} from './util.js';
import Tile from './Tile.js';
import TileState from './TileState.js';
import {createCanvasContext2D} from './dom.js';
@@ -21,9 +21,9 @@ import {UNDEFINED} from './functions.js';
*/
/**
* @constructor
* @extends {module:ol/Tile}
class VectorImageTile extends Tile {
/**
* @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate.
* @param {module:ol/TileState} state State.
* @param {number} sourceRevision Source revision.
@@ -43,11 +43,11 @@ import {UNDEFINED} from './functions.js';
* Function to call when a source tile's state changes.
* @param {number} zoom Integer zoom to render the tile for.
*/
const VectorImageTile = function(tileCoord, state, sourceRevision, format,
tileLoadFunction, urlTileCoord, tileUrlFunction, sourceTileGrid, tileGrid,
sourceTiles, pixelRatio, projection, tileClass, handleTileChange, zoom) {
constructor(tileCoord, state, sourceRevision, format, tileLoadFunction,
urlTileCoord, tileUrlFunction, sourceTileGrid, tileGrid, sourceTiles,
pixelRatio, projection, tileClass, handleTileChange, zoom) {
Tile.call(this, tileCoord, state, {transition: 0});
super(tileCoord, state, {transition: 0});
/**
* @private
@@ -157,15 +157,12 @@ const VectorImageTile = function(tileCoord, state, sourceRevision, format,
}
}
};
}
inherits(VectorImageTile, Tile);
/**
/**
* @inheritDoc
*/
VectorImageTile.prototype.disposeInternal = function() {
disposeInternal() {
this.state = TileState.ABORT;
this.changed();
if (this.interimTile) {
@@ -187,39 +184,36 @@ VectorImageTile.prototype.disposeInternal = function() {
this.loadListenerKeys_.length = 0;
this.sourceTileListenerKeys_.forEach(unlistenByKey);
this.sourceTileListenerKeys_.length = 0;
Tile.prototype.disposeInternal.call(this);
};
super.disposeInternal();
}
/**
/**
* @param {module:ol/layer/Layer} layer Layer.
* @return {CanvasRenderingContext2D} The rendering context.
*/
VectorImageTile.prototype.getContext = function(layer) {
getContext(layer) {
const key = getUid(layer).toString();
if (!(key in this.context_)) {
this.context_[key] = createCanvasContext2D();
}
return this.context_[key];
};
}
/**
/**
* Get the Canvas for this tile.
* @param {module:ol/layer/Layer} layer Layer.
* @return {HTMLCanvasElement} Canvas.
*/
VectorImageTile.prototype.getImage = function(layer) {
getImage(layer) {
return this.getReplayState(layer).renderedTileRevision == -1 ?
null : this.getContext(layer).canvas;
};
}
/**
/**
* @param {module:ol/layer/Layer} layer Layer.
* @return {module:ol/VectorImageTile~ReplayState} The replay state.
*/
VectorImageTile.prototype.getReplayState = function(layer) {
getReplayState(layer) {
const key = getUid(layer).toString();
if (!(key in this.replayState_)) {
this.replayState_[key] = {
@@ -230,30 +224,27 @@ VectorImageTile.prototype.getReplayState = function(layer) {
};
}
return this.replayState_[key];
};
}
/**
/**
* @inheritDoc
*/
VectorImageTile.prototype.getKey = function() {
getKey() {
return this.tileKeys.join('/') + '-' + this.sourceRevision_;
};
}
/**
/**
* @param {string} tileKey Key (tileCoord) of the source tile.
* @return {module:ol/VectorTile} Source tile.
*/
VectorImageTile.prototype.getTile = function(tileKey) {
getTile(tileKey) {
return this.sourceTiles_[tileKey];
};
}
/**
/**
* @inheritDoc
*/
VectorImageTile.prototype.load = function() {
load() {
// Source tiles with LOADED state - we just count them because once they are
// loaded, we're no longer listening to state changes.
let leftToLoad = 0;
@@ -296,13 +287,12 @@ VectorImageTile.prototype.load = function() {
if (leftToLoad - Object.keys(errorSourceTiles).length == 0) {
setTimeout(this.finishLoading_.bind(this), 0);
}
};
}
/**
/**
* @private
*/
VectorImageTile.prototype.finishLoading_ = function() {
finishLoading_() {
let loaded = this.tileKeys.length;
let empty = 0;
for (let i = loaded - 1; i >= 0; --i) {
@@ -321,7 +311,9 @@ VectorImageTile.prototype.finishLoading_ = function() {
} else {
this.setState(empty == this.tileKeys.length ? TileState.EMPTY : TileState.ERROR);
}
};
}
}
export default VectorImageTile;
src/ol/VectorTile.js
+61 -76
View File
@@ -1,19 +1,26 @@
/**
* @module ol/VectorTile
*/
import {getUid, inherits} from './util.js';
import {getUid} from './util.js';
import Tile from './Tile.js';
import TileState from './TileState.js';
/**
* @const
* @type {module:ol/extent~Extent}
*/
const DEFAULT_EXTENT = [0, 0, 4096, 4096];
/**
* @typedef {function(new: module:ol/VectorTile, module:ol/tilecoord~TileCoord,
* module:ol/TileState, string, ?string, module:ol/Tile~LoadFunction)} TileClass
* @api
*/
/**
* @constructor
* @extends {module:ol/Tile}
class VectorTile extends Tile {
/**
* @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate.
* @param {module:ol/TileState} state State.
* @param {string} src Data source url.
@@ -21,9 +28,9 @@ import TileState from './TileState.js';
* @param {module:ol/Tile~LoadFunction} tileLoadFunction Tile load function.
* @param {module:ol/Tile~Options=} opt_options Tile options.
*/
const VectorTile = function(tileCoord, state, src, format, tileLoadFunction, opt_options) {
constructor(tileCoord, state, src, format, tileLoadFunction, opt_options) {
Tile.call(this, tileCoord, state, opt_options);
super(tileCoord, state, opt_options);
/**
* @type {number}
@@ -79,123 +86,104 @@ const VectorTile = function(tileCoord, state, src, format, tileLoadFunction, opt
*/
this.url_ = src;
};
}
inherits(VectorTile, Tile);
/**
* @const
* @type {module:ol/extent~Extent}
*/
const DEFAULT_EXTENT = [0, 0, 4096, 4096];
/**
/**
* @inheritDoc
*/
VectorTile.prototype.disposeInternal = function() {
disposeInternal() {
this.features_ = null;
this.replayGroups_ = {};
this.state = TileState.ABORT;
this.changed();
Tile.prototype.disposeInternal.call(this);
};
super.disposeInternal();
}
/**
/**
* Gets the extent of the vector tile.
* @return {module:ol/extent~Extent} The extent.
* @api
*/
VectorTile.prototype.getExtent = function() {
getExtent() {
return this.extent_ || DEFAULT_EXTENT;
};
}
/**
/**
* Get the feature format assigned for reading this tile's features.
* @return {module:ol/format/Feature} Feature format.
* @api
*/
VectorTile.prototype.getFormat = function() {
getFormat() {
return this.format_;
};
}
/**
/**
* Get the features for this tile. Geometries will be in the projection returned
* by {@link module:ol/VectorTile~VectorTile#getProjection}.
* @return {Array.<module:ol/Feature|module:ol/render/Feature>} Features.
* @api
*/
VectorTile.prototype.getFeatures = function() {
getFeatures() {
return this.features_;
};
}
/**
/**
* @inheritDoc
*/
VectorTile.prototype.getKey = function() {
getKey() {
return this.url_;
};
}
/**
/**
* Get the feature projection of features returned by
* {@link module:ol/VectorTile~VectorTile#getFeatures}.
* @return {module:ol/proj/Projection} Feature projection.
* @api
*/
VectorTile.prototype.getProjection = function() {
getProjection() {
return this.projection_;
};
}
/**
/**
* @param {module:ol/layer/Layer} layer Layer.
* @param {string} key Key.
* @return {module:ol/render/ReplayGroup} Replay group.
*/
VectorTile.prototype.getReplayGroup = function(layer, key) {
getReplayGroup(layer, key) {
return this.replayGroups_[getUid(layer) + ',' + key];
};
}
/**
/**
* @inheritDoc
*/
VectorTile.prototype.load = function() {
load() {
if (this.state == TileState.IDLE) {
this.setState(TileState.LOADING);
this.tileLoadFunction_(this, this.url_);
this.loader_(null, NaN, null);
}
};
}
/**
/**
* Handler for successful tile load.
* @param {Array.<module:ol/Feature>} features The loaded features.
* @param {module:ol/proj/Projection} dataProjection Data projection.
* @param {module:ol/extent~Extent} extent Extent.
*/
VectorTile.prototype.onLoad = function(features, dataProjection, extent) {
onLoad(features, dataProjection, extent) {
this.setProjection(dataProjection);
this.setFeatures(features);
this.setExtent(extent);
};
}
/**
/**
* Handler for tile load errors.
*/
VectorTile.prototype.onError = function() {
onError() {
this.setState(TileState.ERROR);
};
}
/**
/**
* Function for use in an {@link module:ol/source/VectorTile~VectorTile}'s
* `tileLoadFunction`. Sets the extent of the vector tile. This is only required
* for tiles in projections with `tile-pixels` as units. The extent should be
@@ -207,52 +195,49 @@ VectorTile.prototype.onError = function() {
* @param {module:ol/extent~Extent} extent The extent.
* @api
*/
VectorTile.prototype.setExtent = function(extent) {
setExtent(extent) {
this.extent_ = extent;
};
}
/**
/**
* Function for use in an {@link module:ol/source/VectorTile~VectorTile}'s `tileLoadFunction`.
* Sets the features for the tile.
* @param {Array.<module:ol/Feature>} features Features.
* @api
*/
VectorTile.prototype.setFeatures = function(features) {
setFeatures(features) {
this.features_ = features;
this.setState(TileState.LOADED);
};
}
/**
/**
* Function for use in an {@link module:ol/source/VectorTile~VectorTile}'s `tileLoadFunction`.
* Sets the projection of the features that were added with
* {@link module:ol/VectorTile~VectorTile#setFeatures}.
* @param {module:ol/proj/Projection} projection Feature projection.
* @api
*/
VectorTile.prototype.setProjection = function(projection) {
setProjection(projection) {
this.projection_ = projection;
};
}
/**
/**
* @param {module:ol/layer/Layer} layer Layer.
* @param {string} key Key.
* @param {module:ol/render/ReplayGroup} replayGroup Replay group.
*/
VectorTile.prototype.setReplayGroup = function(layer, key, replayGroup) {
setReplayGroup(layer, key, replayGroup) {
this.replayGroups_[getUid(layer) + ',' + key] = replayGroup;
};
}
/**
/**
* Set the feature loader for reading this tile's features.
* @param {module:ol/featureloader~FeatureLoader} loader Feature loader.
* @api
*/
VectorTile.prototype.setLoader = function(loader) {
setLoader(loader) {
this.loader_ = loader;
};
}
}
export default VectorTile;
src/ol/View.js
+139 -178
View File
@@ -2,7 +2,7 @@
* @module ol/View
*/
import {DEFAULT_TILE_SIZE} from './tilegrid/common.js';
import {getUid, inherits} from './util.js';
import {getUid} from './util.js';
import {UNDEFINED} from './functions.js';
import {createExtent, none as centerNone} from './centerconstraint.js';
import BaseObject from './Object.js';
@@ -224,13 +224,15 @@ const DEFAULT_MIN_ZOOM = 0;
* The *center constraint* is determined by the `extent` option. By
* default the center is not constrained at all.
*
* @constructor
* @extends {module:ol/Object}
* @param {module:ol/View~ViewOptions=} opt_options View options.
* @api
*/
const View = function(opt_options) {
BaseObject.call(this);
class View extends BaseObject {
/**
* @param {module:ol/View~ViewOptions=} opt_options View options.
*/
constructor(opt_options) {
super();
const options = assign({}, opt_options);
@@ -262,16 +264,13 @@ const View = function(opt_options) {
this.projection_ = createProjection(options.projection, 'EPSG:3857');
this.applyOptions_(options);
};
}
inherits(View, BaseObject);
/**
/**
* Set up the view with the given options.
* @param {module:ol/View~ViewOptions} options View options.
*/
View.prototype.applyOptions_ = function(options) {
applyOptions_(options) {
/**
* @type {Object.<string, *>}
@@ -347,9 +346,9 @@ View.prototype.applyOptions_ = function(options) {
*/
this.options_ = options;
};
}
/**
/**
* Get an updated version of the view options used to construct the view. The
* current resolution (or zoom), center, and rotation are applied to any stored
* options. The provided options can be used to apply new min/max zoom or
@@ -357,7 +356,7 @@ View.prototype.applyOptions_ = function(options) {
* @param {module:ol/View~ViewOptions} newOptions New options to be applied.
* @return {module:ol/View~ViewOptions} New options updated with the current view state.
*/
View.prototype.getUpdatedOptions_ = function(newOptions) {
getUpdatedOptions_(newOptions) {
const options = assign({}, this.options_);
// preserve resolution (or zoom)
@@ -374,10 +373,9 @@ View.prototype.getUpdatedOptions_ = function(newOptions) {
options.rotation = this.getRotation();
return assign({}, options, newOptions);
};
}
/**
/**
* Animate the view. The view's center, zoom (or resolution), and rotation
* can be animated for smooth transitions between view states. For example,
* to animate the view to a new zoom level:
@@ -410,7 +408,7 @@ View.prototype.getUpdatedOptions_ = function(newOptions) {
* the animation completed without being cancelled.
* @api
*/
View.prototype.animate = function(var_args) {
animate(var_args) {
let animationCount = arguments.length;
let callback;
if (animationCount > 1 && typeof arguments[animationCount - 1] === 'function') {
@@ -490,34 +488,31 @@ View.prototype.animate = function(var_args) {
this.animations_.push(series);
this.setHint(ViewHint.ANIMATING, 1);
this.updateAnimations_();
};
}
/**
/**
* Determine if the view is being animated.
* @return {boolean} The view is being animated.
* @api
*/
View.prototype.getAnimating = function() {
getAnimating() {
return this.hints_[ViewHint.ANIMATING] > 0;
};
}
/**
/**
* Determine if the user is interacting with the view, such as panning or zooming.
* @return {boolean} The view is being interacted with.
* @api
*/
View.prototype.getInteracting = function() {
getInteracting() {
return this.hints_[ViewHint.INTERACTING] > 0;
};
}
/**
/**
* Cancel any ongoing animations.
* @api
*/
View.prototype.cancelAnimations = function() {
cancelAnimations() {
this.setHint(ViewHint.ANIMATING, -this.hints_[ViewHint.ANIMATING]);
for (let i = 0, ii = this.animations_.length; i < ii; ++i) {
const series = this.animations_[i];
@@ -526,12 +521,12 @@ View.prototype.cancelAnimations = function() {
}
}
this.animations_.length = 0;
};
}
/**
/**
* Update all animations.
*/
View.prototype.updateAnimations_ = function() {
updateAnimations_() {
if (this.updateAnimationKey_ !== undefined) {
cancelAnimationFrame(this.updateAnimationKey_);
this.updateAnimationKey_ = undefined;
@@ -608,14 +603,14 @@ View.prototype.updateAnimations_ = function() {
if (more && this.updateAnimationKey_ === undefined) {
this.updateAnimationKey_ = requestAnimationFrame(this.updateAnimations_);
}
};
}
/**
/**
* @param {number} rotation Target rotation.
* @param {module:ol/coordinate~Coordinate} anchor Rotation anchor.
* @return {module:ol/coordinate~Coordinate|undefined} Center for rotation and anchor.
*/
View.prototype.calculateCenterRotate = function(rotation, anchor) {
calculateCenterRotate(rotation, anchor) {
let center;
const currentCenter = this.getCenter();
if (currentCenter !== undefined) {
@@ -624,15 +619,14 @@ View.prototype.calculateCenterRotate = function(rotation, anchor) {
addCoordinate(center, anchor);
}
return center;
};
}
/**
/**
* @param {number} resolution Target resolution.
* @param {module:ol/coordinate~Coordinate} anchor Zoom anchor.
* @return {module:ol/coordinate~Coordinate|undefined} Center for resolution and anchor.
*/
View.prototype.calculateCenterZoom = function(resolution, anchor) {
calculateCenterZoom(resolution, anchor) {
let center;
const currentCenter = this.getCenter();
const currentResolution = this.getResolution();
@@ -642,14 +636,13 @@ View.prototype.calculateCenterZoom = function(resolution, anchor) {
center = [x, y];
}
return center;
};
}
/**
/**
* @private
* @return {module:ol/size~Size} Viewport size or `[100, 100]` when no viewport is found.
*/
View.prototype.getSizeFromViewport_ = function() {
getSizeFromViewport_() {
const size = [100, 100];
const selector = '.ol-viewport[data-view="' + getUid(this) + '"]';
const element = document.querySelector(selector);
@@ -659,21 +652,19 @@ View.prototype.getSizeFromViewport_ = function() {
size[1] = parseInt(metrics.height, 10);
}
return size;
};
}
/**
/**
* Get the constrained center of this view.
* @param {module:ol/coordinate~Coordinate|undefined} center Center.
* @return {module:ol/coordinate~Coordinate|undefined} Constrained center.
* @api
*/
View.prototype.constrainCenter = function(center) {
constrainCenter(center) {
return this.constraints_.center(center);
};
}
/**
/**
* Get the constrained resolution of this view.
* @param {number|undefined} resolution Resolution.
* @param {number=} opt_delta Delta. Default is `0`.
@@ -681,52 +672,48 @@ View.prototype.constrainCenter = function(center) {
* @return {number|undefined} Constrained resolution.
* @api
*/
View.prototype.constrainResolution = function(resolution, opt_delta, opt_direction) {
constrainResolution(resolution, opt_delta, opt_direction) {
const delta = opt_delta || 0;
const direction = opt_direction || 0;
return this.constraints_.resolution(resolution, delta, direction);
};
}
/**
/**
* Get the constrained rotation of this view.
* @param {number|undefined} rotation Rotation.
* @param {number=} opt_delta Delta. Default is `0`.
* @return {number|undefined} Constrained rotation.
* @api
*/
View.prototype.constrainRotation = function(rotation, opt_delta) {
constrainRotation(rotation, opt_delta) {
const delta = opt_delta || 0;
return this.constraints_.rotation(rotation, delta);
};
}
/**
/**
* Get the view center.
* @return {module:ol/coordinate~Coordinate|undefined} The center of the view.
* @observable
* @api
*/
View.prototype.getCenter = function() {
getCenter() {
return (
/** @type {module:ol/coordinate~Coordinate|undefined} */ (this.get(ViewProperty.CENTER))
);
};
}
/**
/**
* @return {module:ol/View~Constraints} Constraints.
*/
View.prototype.getConstraints = function() {
getConstraints() {
return this.constraints_;
};
}
/**
/**
* @param {Array.<number>=} opt_hints Destination array.
* @return {Array.<number>} Hint.
*/
View.prototype.getHints = function(opt_hints) {
getHints(opt_hints) {
if (opt_hints !== undefined) {
opt_hints[0] = this.hints_[0];
opt_hints[1] = this.hints_[1];
@@ -734,10 +721,9 @@ View.prototype.getHints = function(opt_hints) {
} else {
return this.hints_.slice();
}
};
}
/**
/**
* Calculate the extent for the current view state and the passed size.
* The size is the pixel dimensions of the box into which the calculated extent
* should fit. In most cases you want to get the extent of the entire map,
@@ -747,7 +733,7 @@ View.prototype.getHints = function(opt_hints) {
* @return {module:ol/extent~Extent} Extent.
* @api
*/
View.prototype.calculateExtent = function(opt_size) {
calculateExtent(opt_size) {
const size = opt_size || this.getSizeFromViewport_();
const center = /** @type {!module:ol/coordinate~Coordinate} */ (this.getCenter());
assert(center, 1); // The view center is not defined
@@ -757,102 +743,92 @@ View.prototype.calculateExtent = function(opt_size) {
assert(rotation !== undefined, 3); // The view rotation is not defined
return getForViewAndSize(center, resolution, rotation, size);
};
}
/**
/**
* Get the maximum resolution of the view.
* @return {number} The maximum resolution of the view.
* @api
*/
View.prototype.getMaxResolution = function() {
getMaxResolution() {
return this.maxResolution_;
};
}
/**
/**
* Get the minimum resolution of the view.
* @return {number} The minimum resolution of the view.
* @api
*/
View.prototype.getMinResolution = function() {
getMinResolution() {
return this.minResolution_;
};
}
/**
/**
* Get the maximum zoom level for the view.
* @return {number} The maximum zoom level.
* @api
*/
View.prototype.getMaxZoom = function() {
getMaxZoom() {
return /** @type {number} */ (this.getZoomForResolution(this.minResolution_));
};
}
/**
/**
* Set a new maximum zoom level for the view.
* @param {number} zoom The maximum zoom level.
* @api
*/
View.prototype.setMaxZoom = function(zoom) {
setMaxZoom(zoom) {
this.applyOptions_(this.getUpdatedOptions_({maxZoom: zoom}));
};
}
/**
/**
* Get the minimum zoom level for the view.
* @return {number} The minimum zoom level.
* @api
*/
View.prototype.getMinZoom = function() {
getMinZoom() {
return /** @type {number} */ (this.getZoomForResolution(this.maxResolution_));
};
}
/**
/**
* Set a new minimum zoom level for the view.
* @param {number} zoom The minimum zoom level.
* @api
*/
View.prototype.setMinZoom = function(zoom) {
setMinZoom(zoom) {
this.applyOptions_(this.getUpdatedOptions_({minZoom: zoom}));
};
}
/**
/**
* Get the view projection.
* @return {module:ol/proj/Projection} The projection of the view.
* @api
*/
View.prototype.getProjection = function() {
getProjection() {
return this.projection_;
};
}
/**
/**
* Get the view resolution.
* @return {number|undefined} The resolution of the view.
* @observable
* @api
*/
View.prototype.getResolution = function() {
getResolution() {
return /** @type {number|undefined} */ (this.get(ViewProperty.RESOLUTION));
};
}
/**
/**
* Get the resolutions for the view. This returns the array of resolutions
* passed to the constructor of the View, or undefined if none were given.
* @return {Array.<number>|undefined} The resolutions of the view.
* @api
*/
View.prototype.getResolutions = function() {
getResolutions() {
return this.resolutions_;
};
}
/**
/**
* Get the resolution for a provided extent (in map units) and size (in pixels).
* @param {module:ol/extent~Extent} extent Extent.
* @param {module:ol/size~Size=} opt_size Box pixel size.
@@ -860,21 +836,20 @@ View.prototype.getResolutions = function() {
* the given size.
* @api
*/
View.prototype.getResolutionForExtent = function(extent, opt_size) {
getResolutionForExtent(extent, opt_size) {
const size = opt_size || this.getSizeFromViewport_();
const xResolution = getWidth(extent) / size[0];
const yResolution = getHeight(extent) / size[1];
return Math.max(xResolution, yResolution);
};
}
/**
/**
* Return a function that returns a value between 0 and 1 for a
* resolution. Exponential scaling is assumed.
* @param {number=} opt_power Power.
* @return {function(number): number} Resolution for value function.
*/
View.prototype.getResolutionForValueFunction = function(opt_power) {
getResolutionForValueFunction(opt_power) {
const power = opt_power || 2;
const maxResolution = this.maxResolution_;
const minResolution = this.minResolution_;
@@ -888,27 +863,25 @@ View.prototype.getResolutionForValueFunction = function(opt_power) {
const resolution = maxResolution / Math.pow(power, value * max);
return resolution;
});
};
}
/**
/**
* Get the view rotation.
* @return {number} The rotation of the view in radians.
* @observable
* @api
*/
View.prototype.getRotation = function() {
getRotation() {
return /** @type {number} */ (this.get(ViewProperty.ROTATION));
};
}
/**
/**
* Return a function that returns a resolution for a value between
* 0 and 1. Exponential scaling is assumed.
* @param {number=} opt_power Power.
* @return {function(number): number} Value for resolution function.
*/
View.prototype.getValueForResolutionFunction = function(opt_power) {
getValueForResolutionFunction(opt_power) {
const power = opt_power || 2;
const maxResolution = this.maxResolution_;
const minResolution = this.minResolution_;
@@ -922,13 +895,12 @@ View.prototype.getValueForResolutionFunction = function(opt_power) {
const value = (Math.log(maxResolution / resolution) / Math.log(power)) / max;
return value;
});
};
}
/**
/**
* @return {module:ol/View~State} View state.
*/
View.prototype.getState = function() {
getState() {
const center = /** @type {module:ol/coordinate~Coordinate} */ (this.getCenter());
const projection = this.getProjection();
const resolution = /** @type {number} */ (this.getResolution());
@@ -942,33 +914,31 @@ View.prototype.getState = function() {
zoom: this.getZoom()
})
);
};
}
/**
/**
* Get the current zoom level. If you configured your view with a resolutions
* array (this is rare), this method may return non-integer zoom levels (so
* the zoom level is not safe to use as an index into a resolutions array).
* @return {number|undefined} Zoom.
* @api
*/
View.prototype.getZoom = function() {
getZoom() {
let zoom;
const resolution = this.getResolution();
if (resolution !== undefined) {
zoom = this.getZoomForResolution(resolution);
}
return zoom;
};
}
/**
/**
* Get the zoom level for a resolution.
* @param {number} resolution The resolution.
* @return {number|undefined} The zoom level for the provided resolution.
* @api
*/
View.prototype.getZoomForResolution = function(resolution) {
getZoomForResolution(resolution) {
let offset = this.minZoom_ || 0;
let max, zoomFactor;
if (this.resolutions_) {
@@ -985,22 +955,20 @@ View.prototype.getZoomForResolution = function(resolution) {
zoomFactor = this.zoomFactor_;
}
return offset + Math.log(max / resolution) / Math.log(zoomFactor);
};
}
/**
/**
* Get the resolution for a zoom level.
* @param {number} zoom Zoom level.
* @return {number} The view resolution for the provided zoom level.
* @api
*/
View.prototype.getResolutionForZoom = function(zoom) {
getResolutionForZoom(zoom) {
return /** @type {number} */ (this.constrainResolution(
this.maxResolution_, zoom - this.minZoom_, 0));
};
}
/**
/**
* Fit the given geometry or extent based on the given map size and border.
* The size is pixel dimensions of the box to fit the extent into.
* In most cases you will want to use the map size, that is `map.getSize()`.
@@ -1010,7 +978,7 @@ View.prototype.getResolutionForZoom = function(zoom) {
* @param {module:ol/View~FitOptions=} opt_options Options.
* @api
*/
View.prototype.fit = function(geometryOrExtent, opt_options) {
fit(geometryOrExtent, opt_options) {
const options = opt_options || {};
let size = options.size;
if (!size) {
@@ -1103,17 +1071,16 @@ View.prototype.fit = function(geometryOrExtent, opt_options) {
this.setCenter(center);
setTimeout(callback.bind(undefined, true), 0);
}
};
}
/**
/**
* Center on coordinate and view position.
* @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
* @param {module:ol/size~Size} size Box pixel size.
* @param {module:ol~Pixel} position Position on the view to center on.
* @api
*/
View.prototype.centerOn = function(coordinate, size, position) {
centerOn(coordinate, size, position) {
// calculate rotated position
const rotation = this.getRotation();
const cosAngle = Math.cos(-rotation);
@@ -1130,94 +1097,88 @@ View.prototype.centerOn = function(coordinate, size, position) {
const centerY = rotY * cosAngle + rotX * sinAngle;
this.setCenter([centerX, centerY]);
};
}
/**
/**
* @return {boolean} Is defined.
*/
View.prototype.isDef = function() {
isDef() {
return !!this.getCenter() && this.getResolution() !== undefined;
};
}
/**
/**
* Rotate the view around a given coordinate.
* @param {number} rotation New rotation value for the view.
* @param {module:ol/coordinate~Coordinate=} opt_anchor The rotation center.
* @api
*/
View.prototype.rotate = function(rotation, opt_anchor) {
rotate(rotation, opt_anchor) {
if (opt_anchor !== undefined) {
const center = this.calculateCenterRotate(rotation, opt_anchor);
this.setCenter(center);
}
this.setRotation(rotation);
};
}
/**
/**
* Set the center of the current view.
* @param {module:ol/coordinate~Coordinate|undefined} center The center of the view.
* @observable
* @api
*/
View.prototype.setCenter = function(center) {
setCenter(center) {
this.set(ViewProperty.CENTER, center);
if (this.getAnimating()) {
this.cancelAnimations();
}
};
}
/**
/**
* @param {module:ol/ViewHint} hint Hint.
* @param {number} delta Delta.
* @return {number} New value.
*/
View.prototype.setHint = function(hint, delta) {
setHint(hint, delta) {
this.hints_[hint] += delta;
this.changed();
return this.hints_[hint];
};
}
/**
/**
* Set the resolution for this view.
* @param {number|undefined} resolution The resolution of the view.
* @observable
* @api
*/
View.prototype.setResolution = function(resolution) {
setResolution(resolution) {
this.set(ViewProperty.RESOLUTION, resolution);
if (this.getAnimating()) {
this.cancelAnimations();
}
};
}
/**
/**
* Set the rotation for this view.
* @param {number} rotation The rotation of the view in radians.
* @observable
* @api
*/
View.prototype.setRotation = function(rotation) {
setRotation(rotation) {
this.set(ViewProperty.ROTATION, rotation);
if (this.getAnimating()) {
this.cancelAnimations();
}
};
}
/**
/**
* Zoom to a specific zoom level.
* @param {number} zoom Zoom level.
* @api
*/
View.prototype.setZoom = function(zoom) {
setZoom(zoom) {
this.setResolution(this.getResolutionForZoom(zoom));
};
}
}
/**
src/ol/WebGLMap.js
+12 -12
View File
@@ -1,7 +1,6 @@
/**
* @module ol/WebGLMap
*/
import {inherits} from './util.js';
import PluggableMap from './PluggableMap.js';
import {defaults as defaultControls} from './control.js';
import {defaults as defaultInteractions} from './interaction.js';
@@ -57,16 +56,18 @@ import WebGLVectorLayerRenderer from './renderer/webgl/VectorLayer.js';
* {@link module:ol/layer/Base}, so layers entered in the options or added
* with `addLayer` can be groups, which can contain further groups, and so on.
*
* @constructor
* @extends {module:ol/PluggableMap}
* @param {module:ol/PluggableMap~MapOptions} options Map options.
* @fires module:ol/MapBrowserEvent~MapBrowserEvent
* @fires module:ol/MapEvent~MapEvent
* @fires module:ol/render/Event~RenderEvent#postcompose
* @fires module:ol/render/Event~RenderEvent#precompose
* @api
*/
const WebGLMap = function(options) {
class WebGLMap extends PluggableMap {
/**
* @param {module:ol/PluggableMap~MapOptions} options Map options.
*/
constructor(options) {
options = assign({}, options);
if (!options.controls) {
options.controls = defaultControls();
@@ -75,13 +76,10 @@ const WebGLMap = function(options) {
options.interactions = defaultInteractions();
}
PluggableMap.call(this, options);
};
super(options);
}
inherits(WebGLMap, PluggableMap);
WebGLMap.prototype.createRenderer = function() {
createRenderer() {
const renderer = new WebGLMapRenderer(this);
renderer.registerLayerRenderers([
WebGLImageLayerRenderer,
@@ -89,6 +87,8 @@ WebGLMap.prototype.createRenderer = function() {
WebGLVectorLayerRenderer
]);
return renderer;
};
}
}
export default WebGLMap;
src/ol/control/Attribution.js
+52 -58
View File
@@ -1,7 +1,6 @@
/**
* @module ol/control/Attribution
*/
import {inherits} from '../util.js';
import {equals} from '../array.js';
import Control from '../control/Control.js';
import {CLASS_CONTROL, CLASS_UNSELECTABLE, CLASS_COLLAPSED} from '../css.js';
@@ -42,15 +41,23 @@ import {visibleAtResolution} from '../layer/Layer.js';
* By default it will show in the bottom right portion of the map, but this can
* be changed by using a css selector for `.ol-attribution`.
*
* @constructor
* @extends {module:ol/control/Control}
* @param {module:ol/control/Attribution~Options=} opt_options Attribution options.
* @api
*/
const Attribution = function(opt_options) {
class Attribution extends Control {
/**
* @param {module:ol/control/Attribution~Options=} opt_options Attribution options.
*/
constructor(opt_options) {
const options = opt_options ? opt_options : {};
super({
element: document.createElement('div'),
render: options.render || render,
target: options.target
});
/**
* @private
* @type {Element}
@@ -117,17 +124,11 @@ const Attribution = function(opt_options) {
const cssClasses = className + ' ' + CLASS_UNSELECTABLE + ' ' + CLASS_CONTROL +
(this.collapsed_ && this.collapsible_ ? ' ' + CLASS_COLLAPSED : '') +
(this.collapsible_ ? '' : ' ol-uncollapsible');
const element = document.createElement('div');
const element = this.element;
element.className = cssClasses;
element.appendChild(this.ulElement_);
element.appendChild(button);
Control.call(this, {
element: element,
render: options.render || render,
target: options.target
});
/**
* A list of currently rendered resolutions.
* @type {Array.<string>}
@@ -141,18 +142,15 @@ const Attribution = function(opt_options) {
*/
this.renderedVisible_ = true;
};
}
inherits(Attribution, Control);
/**
/**
* Get a list of visible attributions.
* @param {module:ol/PluggableMap~FrameState} frameState Frame state.
* @return {Array.<string>} Attributions.
* @private
*/
Attribution.prototype.getSourceAttributions_ = function(frameState) {
getSourceAttributions_(frameState) {
/**
* Used to determine if an attribution already exists.
* @type {!Object.<string, boolean>}
@@ -203,25 +201,13 @@ Attribution.prototype.getSourceAttributions_ = function(frameState) {
}
}
return visibleAttributions;
};
}
/**
* Update the attribution element.
* @param {module:ol/MapEvent} mapEvent Map event.
* @this {module:ol/control/Attribution}
* @api
*/
export function render(mapEvent) {
this.updateElement_(mapEvent.frameState);
}
/**
/**
* @private
* @param {?module:ol/PluggableMap~FrameState} frameState Frame state.
*/
Attribution.prototype.updateElement_ = function(frameState) {
updateElement_(frameState) {
if (!frameState) {
if (this.renderedVisible_) {
this.element.style.display = 'none';
@@ -252,23 +238,21 @@ Attribution.prototype.updateElement_ = function(frameState) {
}
this.renderedAttributions_ = attributions;
};
}
/**
/**
* @param {MouseEvent} event The event to handle
* @private
*/
Attribution.prototype.handleClick_ = function(event) {
handleClick_(event) {
event.preventDefault();
this.handleToggle_();
};
}
/**
/**
* @private
*/
Attribution.prototype.handleToggle_ = function() {
handleToggle_() {
this.element.classList.toggle(CLASS_COLLAPSED);
if (this.collapsed_) {
replaceNode(this.collapseLabel_, this.label_);
@@ -276,25 +260,23 @@ Attribution.prototype.handleToggle_ = function() {
replaceNode(this.label_, this.collapseLabel_);
}
this.collapsed_ = !this.collapsed_;
};
}
/**
/**
* Return `true` if the attribution is collapsible, `false` otherwise.
* @return {boolean} True if the widget is collapsible.
* @api
*/
Attribution.prototype.getCollapsible = function() {
getCollapsible() {
return this.collapsible_;
};
}
/**
/**
* Set whether the attribution should be collapsible.
* @param {boolean} collapsible True if the widget is collapsible.
* @api
*/
Attribution.prototype.setCollapsible = function(collapsible) {
setCollapsible(collapsible) {
if (this.collapsible_ === collapsible) {
return;
}
@@ -303,31 +285,43 @@ Attribution.prototype.setCollapsible = function(collapsible) {
if (!collapsible && this.collapsed_) {
this.handleToggle_();
}
};
}
/**
/**
* Collapse or expand the attribution according to the passed parameter. Will
* not do anything if the attribution isn't collapsible or if the current
* collapsed state is already the one requested.
* @param {boolean} collapsed True if the widget is collapsed.
* @api
*/
Attribution.prototype.setCollapsed = function(collapsed) {
setCollapsed(collapsed) {
if (!this.collapsible_ || this.collapsed_ === collapsed) {
return;
}
this.handleToggle_();
};
}
/**
/**
* Return `true` when the attribution is currently collapsed or `false`
* otherwise.
* @return {boolean} True if the widget is collapsed.
* @api
*/
Attribution.prototype.getCollapsed = function() {
getCollapsed() {
return this.collapsed_;
};
}
}
/**
* Update the attribution element.
* @param {module:ol/MapEvent} mapEvent Map event.
* @this {module:ol/control/Attribution}
* @api
*/
export function render(mapEvent) {
this.updateElement_(mapEvent.frameState);
}
export default Attribution;
src/ol/control/Control.js
+24 -26
View File
@@ -1,7 +1,6 @@
/**
* @module ol/control/Control
*/
import {inherits} from '../util.js';
import {UNDEFINED} from '../functions.js';
import MapEventType from '../MapEventType.js';
import BaseObject from '../Object.js';
@@ -44,14 +43,16 @@ import {listen, unlistenByKey} from '../events.js';
* You can also extend this base for your own control class. See
* examples/custom-controls for an example of how to do this.
*
* @constructor
* @extends {module:ol/Object}
* @param {module:ol/control/Control~Options} options Control options.
* @api
*/
const Control = function(options) {
class Control extends BaseObject {
BaseObject.call(this);
/**
* @param {module:ol/control/Control~Options} options Control options.
*/
constructor(options) {
super();
/**
* @protected
@@ -86,38 +87,33 @@ const Control = function(options) {
this.setTarget(options.target);
}
};
}
inherits(Control, BaseObject);
/**
/**
* @inheritDoc
*/
Control.prototype.disposeInternal = function() {
disposeInternal() {
removeNode(this.element);
BaseObject.prototype.disposeInternal.call(this);
};
super.disposeInternal();
}
/**
/**
* Get the map associated with this control.
* @return {module:ol/PluggableMap} Map.
* @api
*/
Control.prototype.getMap = function() {
getMap() {
return this.map_;
};
}
/**
/**
* Remove the control from its current map and attach it to the new map.
* Subclasses may set up event handlers to get notified about changes to
* the map here.
* @param {module:ol/PluggableMap} map Map.
* @api
*/
Control.prototype.setMap = function(map) {
setMap(map) {
if (this.map_) {
removeNode(this.element);
}
@@ -136,10 +132,9 @@ Control.prototype.setMap = function(map) {
}
map.render();
}
};
}
/**
/**
* This function is used to set a target element for the control. It has no
* effect if it is called after the control has been added to the map (i.e.
* after `setMap` is called on the control). If no `target` is set in the
@@ -148,9 +143,12 @@ Control.prototype.setMap = function(map) {
* @param {Element|string} target Target.
* @api
*/
Control.prototype.setTarget = function(target) {
setTarget(target) {
this.target_ = typeof target === 'string' ?
document.getElementById(target) :
target;
};
}
}
export default Control;
src/ol/control/FullScreen.js
+28 -32
View File
@@ -1,7 +1,6 @@
/**
* @module ol/control/FullScreen
*/
import {inherits} from '../util.js';
import Control from '../control/Control.js';
import {CLASS_CONTROL, CLASS_UNSELECTABLE, CLASS_UNSUPPORTED} from '../css.js';
import {replaceNode} from '../dom.js';
@@ -61,16 +60,22 @@ const getChangeType = (function() {
* The [Fullscreen API](http://www.w3.org/TR/fullscreen/) is used to
* toggle the map in full screen mode.
*
*
* @constructor
* @extends {module:ol/control/Control}
* @param {module:ol/control/FullScreen~Options=} opt_options Options.
* @api
*/
const FullScreen = function(opt_options) {
class FullScreen extends Control {
/**
* @param {module:ol/control/FullScreen~Options=} opt_options Options.
*/
constructor(opt_options) {
const options = opt_options ? opt_options : {};
super({
element: document.createElement('div'),
target: options.target
});
/**
* @private
* @type {string}
@@ -109,15 +114,10 @@ const FullScreen = function(opt_options) {
const cssClasses = this.cssClassName_ + ' ' + CLASS_UNSELECTABLE +
' ' + CLASS_CONTROL + ' ' +
(!isFullScreenSupported() ? CLASS_UNSUPPORTED : '');
const element = document.createElement('div');
const element = this.element;
element.className = cssClasses;
element.appendChild(button);
Control.call(this, {
element: element,
target: options.target
});
/**
* @private
* @type {boolean}
@@ -130,25 +130,21 @@ const FullScreen = function(opt_options) {
*/
this.source_ = options.source;
};
}
inherits(FullScreen, Control);
/**
/**
* @param {MouseEvent} event The event to handle
* @private
*/
FullScreen.prototype.handleClick_ = function(event) {
handleClick_(event) {
event.preventDefault();
this.handleFullScreen_();
};
}
/**
/**
* @private
*/
FullScreen.prototype.handleFullScreen_ = function() {
handleFullScreen_() {
if (!isFullScreenSupported()) {
return;
}
@@ -174,13 +170,12 @@ FullScreen.prototype.handleFullScreen_ = function() {
requestFullScreen(element);
}
}
};
}
/**
/**
* @private
*/
FullScreen.prototype.handleFullScreenChange_ = function() {
handleFullScreenChange_() {
const button = this.element.firstElementChild;
const map = this.getMap();
if (isFullScreen()) {
@@ -193,22 +188,23 @@ FullScreen.prototype.handleFullScreenChange_ = function() {
if (map) {
map.updateSize();
}
};
}
/**
/**
* @inheritDoc
* @api
*/
FullScreen.prototype.setMap = function(map) {
Control.prototype.setMap.call(this, map);
setMap(map) {
super.setMap(map);
if (map) {
this.listenerKeys.push(listen(document,
getChangeType(),
this.handleFullScreenChange_, this)
);
}
};
}
}
/**
* @return {boolean} Fullscreen is supported by the current platform.
src/ol/control/MousePosition.js
+56 -67
View File
@@ -1,8 +1,6 @@
/**
* @module ol/control/MousePosition
*/
import {inherits} from '../util.js';
import {listen} from '../events.js';
import EventType from '../events/EventType.js';
import {getChangeEventType} from '../Object.js';
@@ -46,20 +44,21 @@ const COORDINATE_FORMAT = 'coordinateFormat';
* By default the control is shown in the top right corner of the map, but this
* can be changed by using the css selector `.ol-mouse-position`.
*
* @constructor
* @extends {module:ol/control/Control}
* @param {module:ol/control/MousePosition~Options=} opt_options Mouse position
* options.
* @api
*/
const MousePosition = function(opt_options) {
class MousePosition extends Control {
/**
* @param {module:ol/control/MousePosition~Options=} opt_options Mouse position options.
*/
constructor(opt_options) {
const options = opt_options ? opt_options : {};
const element = document.createElement('DIV');
element.className = options.className !== undefined ? options.className : 'ol-mouse-position';
Control.call(this, {
super({
element: element,
render: options.render || render,
target: options.target
@@ -112,40 +111,16 @@ const MousePosition = function(opt_options) {
*/
this.lastMouseMovePixel_ = null;
};
inherits(MousePosition, Control);
/**
* Update the mouseposition element.
* @param {module:ol/MapEvent} mapEvent Map event.
* @this {module:ol/control/MousePosition}
* @api
*/
export function render(mapEvent) {
const frameState = mapEvent.frameState;
if (!frameState) {
this.mapProjection_ = null;
} else {
if (this.mapProjection_ != frameState.viewState.projection) {
this.mapProjection_ = frameState.viewState.projection;
this.transform_ = null;
}
}
this.updateHTML_(this.lastMouseMovePixel_);
}
/**
/**
* @private
*/
MousePosition.prototype.handleProjectionChanged_ = function() {
handleProjectionChanged_() {
this.transform_ = null;
};
}
/**
/**
* Return the coordinate format type used to render the current position or
* undefined.
* @return {module:ol/coordinate~CoordinateFormat|undefined} The format to render the current
@@ -153,54 +128,50 @@ MousePosition.prototype.handleProjectionChanged_ = function() {
* @observable
* @api
*/
MousePosition.prototype.getCoordinateFormat = function() {
getCoordinateFormat() {
return (
/** @type {module:ol/coordinate~CoordinateFormat|undefined} */ (this.get(COORDINATE_FORMAT))
);
};
}
/**
/**
* Return the projection that is used to report the mouse position.
* @return {module:ol/proj/Projection|undefined} The projection to report mouse
* position in.
* @observable
* @api
*/
MousePosition.prototype.getProjection = function() {
getProjection() {
return (
/** @type {module:ol/proj/Projection|undefined} */ (this.get(PROJECTION))
);
};
}
/**
/**
* @param {Event} event Browser event.
* @protected
*/
MousePosition.prototype.handleMouseMove = function(event) {
handleMouseMove(event) {
const map = this.getMap();
this.lastMouseMovePixel_ = map.getEventPixel(event);
this.updateHTML_(this.lastMouseMovePixel_);
};
}
/**
/**
* @param {Event} event Browser event.
* @protected
*/
MousePosition.prototype.handleMouseOut = function(event) {
handleMouseOut(event) {
this.updateHTML_(null);
this.lastMouseMovePixel_ = null;
};
}
/**
/**
* @inheritDoc
* @api
*/
MousePosition.prototype.setMap = function(map) {
Control.prototype.setMap.call(this, map);
setMap(map) {
super.setMap(map);
if (map) {
const viewport = map.getViewport();
this.listenerKeys.push(
@@ -212,38 +183,35 @@ MousePosition.prototype.setMap = function(map) {
);
}
}
};
}
/**
/**
* Set the coordinate format type used to render the current position.
* @param {module:ol/coordinate~CoordinateFormat} format The format to render the current
* position in.
* @observable
* @api
*/
MousePosition.prototype.setCoordinateFormat = function(format) {
setCoordinateFormat(format) {
this.set(COORDINATE_FORMAT, format);
};
}
/**
/**
* Set the projection that is used to report the mouse position.
* @param {module:ol/proj~ProjectionLike} projection The projection to report mouse
* position in.
* @observable
* @api
*/
MousePosition.prototype.setProjection = function(projection) {
setProjection(projection) {
this.set(PROJECTION, getProjection(projection));
};
}
/**
/**
* @param {?module:ol~Pixel} pixel Pixel.
* @private
*/
MousePosition.prototype.updateHTML_ = function(pixel) {
updateHTML_(pixel) {
let html = this.undefinedHTML_;
if (pixel && this.mapProjection_) {
if (!this.transform_) {
@@ -271,7 +239,28 @@ MousePosition.prototype.updateHTML_ = function(pixel) {
this.element.innerHTML = html;
this.renderedHTML_ = html;
}
};
}
}
/**
* Update the mouseposition element.
* @param {module:ol/MapEvent} mapEvent Map event.
* @this {module:ol/control/MousePosition}
* @api
*/
export function render(mapEvent) {
const frameState = mapEvent.frameState;
if (!frameState) {
this.mapProjection_ = null;
} else {
if (this.mapProjection_ != frameState.viewState.projection) {
this.mapProjection_ = frameState.viewState.projection;
this.transform_ = null;
}
}
this.updateHTML_(this.lastMouseMovePixel_);
}
export default MousePosition;
src/ol/control/OverviewMap.js
+82 -97
View File
@@ -1,7 +1,6 @@
/**
* @module ol/control/OverviewMap
*/
import {inherits} from '../util.js';
import Collection from '../Collection.js';
import Map from '../Map.js';
import MapEventType from '../MapEventType.js';
@@ -61,15 +60,24 @@ const MIN_RATIO = 0.1;
/**
* Create a new control with a map acting as an overview map for an other
* defined map.
* @constructor
* @extends {module:ol/control/Control}
* @param {module:ol/control/OverviewMap~Options=} opt_options OverviewMap options.
*
* @api
*/
const OverviewMap = function(opt_options) {
class OverviewMap extends Control {
/**
* @param {module:ol/control/OverviewMap~Options=} opt_options OverviewMap options.
*/
constructor(opt_options) {
const options = opt_options ? opt_options : {};
super({
element: document.createElement('div'),
render: options.render || render,
target: options.target
});
/**
* @type {boolean}
* @private
@@ -174,17 +182,11 @@ const OverviewMap = function(opt_options) {
const cssClasses = className + ' ' + CLASS_UNSELECTABLE + ' ' + CLASS_CONTROL +
(this.collapsed_ && this.collapsible_ ? ' ' + CLASS_COLLAPSED : '') +
(this.collapsible_ ? '' : ' ol-uncollapsible');
const element = document.createElement('div');
const element = this.element;
element.className = cssClasses;
element.appendChild(this.ovmapDiv_);
element.appendChild(button);
Control.call(this, {
element: element,
render: options.render || render,
target: options.target
});
/* Interactive map */
const scope = this;
@@ -222,16 +224,13 @@ const OverviewMap = function(opt_options) {
window.addEventListener('mousemove', move);
window.addEventListener('mouseup', endMoving);
});
};
}
inherits(OverviewMap, Control);
/**
/**
* @inheritDoc
* @api
*/
OverviewMap.prototype.setMap = function(map) {
setMap(map) {
const oldMap = this.getMap();
if (map === oldMap) {
return;
@@ -243,7 +242,7 @@ OverviewMap.prototype.setMap = function(map) {
}
this.ovmap_.setTarget(null);
}
Control.prototype.setMap.call(this, map);
super.setMap(map);
if (map) {
this.ovmap_.setTarget(this.ovmapDiv_);
@@ -265,15 +264,14 @@ OverviewMap.prototype.setMap = function(map) {
}
}
}
};
}
/**
/**
* Handle map property changes. This only deals with changes to the map's view.
* @param {module:ol/Object~ObjectEvent} event The propertychange event.
* @private
*/
OverviewMap.prototype.handleMapPropertyChange_ = function(event) {
handleMapPropertyChange_(event) {
if (event.key === MapProperty.VIEW) {
const oldView = /** @type {module:ol/View} */ (event.oldValue);
if (oldView) {
@@ -282,57 +280,41 @@ OverviewMap.prototype.handleMapPropertyChange_ = function(event) {
const newView = this.getMap().getView();
this.bindView_(newView);
}
};
}
/**
/**
* Register listeners for view property changes.
* @param {module:ol/View} view The view.
* @private
*/
OverviewMap.prototype.bindView_ = function(view) {
bindView_(view) {
listen(view,
getChangeEventType(ViewProperty.ROTATION),
this.handleRotationChanged_, this);
};
}
/**
/**
* Unregister listeners for view property changes.
* @param {module:ol/View} view The view.
* @private
*/
OverviewMap.prototype.unbindView_ = function(view) {
unbindView_(view) {
unlisten(view,
getChangeEventType(ViewProperty.ROTATION),
this.handleRotationChanged_, this);
};
}
/**
/**
* Handle rotation changes to the main map.
* TODO: This should rotate the extent rectrangle instead of the
* overview map's view.
* @private
*/
OverviewMap.prototype.handleRotationChanged_ = function() {
handleRotationChanged_() {
this.ovmap_.getView().setRotation(this.getMap().getView().getRotation());
};
}
/**
* Update the overview map element.
* @param {module:ol/MapEvent} mapEvent Map event.
* @this {module:ol/control/OverviewMap}
* @api
*/
export function render(mapEvent) {
this.validateExtent_();
this.updateBox_();
}
/**
/**
* Reset the overview map extent if the box size (width or
* height) is less than the size of the overview map size times minRatio
* or is greater than the size of the overview size times maxRatio.
@@ -343,7 +325,7 @@ export function render(mapEvent) {
* main map center location.
* @private
*/
OverviewMap.prototype.validateExtent_ = function() {
validateExtent_() {
const map = this.getMap();
const ovmap = this.ovmap_;
@@ -380,15 +362,14 @@ OverviewMap.prototype.validateExtent_ = function() {
} else if (!containsExtent(ovextent, extent)) {
this.recenter_();
}
};
}
/**
/**
* Reset the overview map extent to half calculated min and max ratio times
* the extent of the main map.
* @private
*/
OverviewMap.prototype.resetExtent_ = function() {
resetExtent_() {
if (MAX_RATIO === 0 || MIN_RATIO === 0) {
return;
}
@@ -411,15 +392,14 @@ OverviewMap.prototype.resetExtent_ = function() {
const ratio = 1 / (Math.pow(2, steps / 2) * MIN_RATIO);
scaleFromCenter(extent, ratio);
ovview.fit(extent);
};
}
/**
/**
* Set the center of the overview map to the map center without changing its
* resolution.
* @private
*/
OverviewMap.prototype.recenter_ = function() {
recenter_() {
const map = this.getMap();
const ovmap = this.ovmap_;
@@ -428,14 +408,13 @@ OverviewMap.prototype.recenter_ = function() {
const ovview = ovmap.getView();
ovview.setCenter(view.getCenter());
};
}
/**
/**
* Update the box using the main map extent
* @private
*/
OverviewMap.prototype.updateBox_ = function() {
updateBox_() {
const map = this.getMap();
const ovmap = this.ovmap_;
@@ -467,17 +446,15 @@ OverviewMap.prototype.updateBox_ = function() {
box.style.width = Math.abs((bottomLeft[0] - topRight[0]) / ovresolution) + 'px';
box.style.height = Math.abs((topRight[1] - bottomLeft[1]) / ovresolution) + 'px';
}
};
}
/**
/**
* @param {number} rotation Target rotation.
* @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
* @return {module:ol/coordinate~Coordinate|undefined} Coordinate for rotation and center anchor.
* @private
*/
OverviewMap.prototype.calculateCoordinateRotate_ = function(
rotation, coordinate) {
calculateCoordinateRotate_(rotation, coordinate) {
let coordinateRotate;
const map = this.getMap();
@@ -494,23 +471,21 @@ OverviewMap.prototype.calculateCoordinateRotate_ = function(
addCoordinate(coordinateRotate, currentCenter);
}
return coordinateRotate;
};
}
/**
/**
* @param {MouseEvent} event The event to handle
* @private
*/
OverviewMap.prototype.handleClick_ = function(event) {
handleClick_(event) {
event.preventDefault();
this.handleToggle_();
};
}
/**
/**
* @private
*/
OverviewMap.prototype.handleToggle_ = function() {
handleToggle_() {
this.element.classList.toggle(CLASS_COLLAPSED);
if (this.collapsed_) {
replaceNode(this.collapseLabel_, this.label_);
@@ -531,25 +506,23 @@ OverviewMap.prototype.handleToggle_ = function() {
},
this);
}
};
}
/**
/**
* Return `true` if the overview map is collapsible, `false` otherwise.
* @return {boolean} True if the widget is collapsible.
* @api
*/
OverviewMap.prototype.getCollapsible = function() {
getCollapsible() {
return this.collapsible_;
};
}
/**
/**
* Set whether the overview map should be collapsible.
* @param {boolean} collapsible True if the widget is collapsible.
* @api
*/
OverviewMap.prototype.setCollapsible = function(collapsible) {
setCollapsible(collapsible) {
if (this.collapsible_ === collapsible) {
return;
}
@@ -558,40 +531,52 @@ OverviewMap.prototype.setCollapsible = function(collapsible) {
if (!collapsible && this.collapsed_) {
this.handleToggle_();
}
};
}
/**
/**
* Collapse or expand the overview map according to the passed parameter. Will
* not do anything if the overview map isn't collapsible or if the current
* collapsed state is already the one requested.
* @param {boolean} collapsed True if the widget is collapsed.
* @api
*/
OverviewMap.prototype.setCollapsed = function(collapsed) {
setCollapsed(collapsed) {
if (!this.collapsible_ || this.collapsed_ === collapsed) {
return;
}
this.handleToggle_();
};
}
/**
/**
* Determine if the overview map is collapsed.
* @return {boolean} The overview map is collapsed.
* @api
*/
OverviewMap.prototype.getCollapsed = function() {
getCollapsed() {
return this.collapsed_;
};
}
/**
/**
* Return the overview map.
* @return {module:ol/PluggableMap} Overview map.
* @api
*/
OverviewMap.prototype.getOverviewMap = function() {
getOverviewMap() {
return this.ovmap_;
};
}
}
/**
* Update the overview map element.
* @param {module:ol/MapEvent} mapEvent Map event.
* @this {module:ol/control/OverviewMap}
* @api
*/
export function render(mapEvent) {
this.validateExtent_();
this.updateBox_();
}
export default OverviewMap;
src/ol/control/Rotate.js
+22 -26
View File
@@ -1,13 +1,11 @@
/**
* @module ol/control/Rotate
*/
import Control from '../control/Control.js';
import {CLASS_CONTROL, CLASS_HIDDEN, CLASS_UNSELECTABLE} from '../css.js';
import {easeOut} from '../easing.js';
import {listen} from '../events.js';
import EventType from '../events/EventType.js';
import {inherits} from '../util.js';
/**
@@ -33,15 +31,23 @@ import {inherits} from '../util.js';
* To style this control use css selector `.ol-rotate`. A `.ol-hidden` css
* selector is added to the button when the rotation is 0.
*
* @constructor
* @extends {module:ol/control/Control}
* @param {module:ol/control/Rotate~Options=} opt_options Rotate options.
* @api
*/
const Rotate = function(opt_options) {
class Rotate extends Control {
/**
* @param {module:ol/control/Rotate~Options=} opt_options Rotate options.
*/
constructor(opt_options) {
const options = opt_options ? opt_options : {};
super({
element: document.createElement('div'),
render: options.render || render,
target: options.target
});
const className = options.className !== undefined ? options.className : 'ol-rotate';
const label = options.label !== undefined ? options.label : '\u21E7';
@@ -69,22 +75,15 @@ const Rotate = function(opt_options) {
button.title = tipLabel;
button.appendChild(this.label_);
listen(button, EventType.CLICK,
Rotate.prototype.handleClick_, this);
listen(button, EventType.CLICK, this.handleClick_, this);
const cssClasses = className + ' ' + CLASS_UNSELECTABLE + ' ' + CLASS_CONTROL;
const element = document.createElement('div');
const element = this.element;
element.className = cssClasses;
element.appendChild(button);
this.callResetNorth_ = options.resetNorth ? options.resetNorth : undefined;
Control.call(this, {
element: element,
render: options.render || render,
target: options.target
});
/**
* @type {number}
* @private
@@ -107,29 +106,25 @@ const Rotate = function(opt_options) {
this.element.classList.add(CLASS_HIDDEN);
}
};
}
inherits(Rotate, Control);
/**
/**
* @param {MouseEvent} event The event to handle
* @private
*/
Rotate.prototype.handleClick_ = function(event) {
handleClick_(event) {
event.preventDefault();
if (this.callResetNorth_ !== undefined) {
this.callResetNorth_();
} else {
this.resetNorth_();
}
};
}
/**
/**
* @private
*/
Rotate.prototype.resetNorth_ = function() {
resetNorth_() {
const map = this.getMap();
const view = map.getView();
if (!view) {
@@ -148,7 +143,8 @@ Rotate.prototype.resetNorth_ = function() {
view.setRotation(0);
}
}
};
}
}
/**
src/ol/control/ScaleLine.js
+48 -56
View File
@@ -1,7 +1,6 @@
/**
* @module ol/control/ScaleLine
*/
import {inherits} from '../util.js';
import {getChangeEventType} from '../Object.js';
import {assert} from '../asserts.js';
import Control from '../control/Control.js';
@@ -59,17 +58,25 @@ const LEADING_DIGITS = [1, 2, 5];
* By default the scale line will show in the bottom left portion of the map,
* but this can be changed by using the css selector `.ol-scale-line`.
*
* @constructor
* @extends {module:ol/control/Control}
* @param {module:ol/control/ScaleLine~Options=} opt_options Scale line options.
* @api
*/
const ScaleLine = function(opt_options) {
class ScaleLine extends Control {
/**
* @param {module:ol/control/ScaleLine~Options=} opt_options Scale line options.
*/
constructor(opt_options) {
const options = opt_options ? opt_options : {};
const className = options.className !== undefined ? options.className : 'ol-scale-line';
super({
element: document.createElement('DIV'),
render: options.render || render,
target: options.target
});
/**
* @private
* @type {HTMLElement}
@@ -77,13 +84,8 @@ const ScaleLine = function(opt_options) {
this.innerElement_ = document.createElement('DIV');
this.innerElement_.className = className + '-inner';
/**
* @private
* @type {HTMLElement}
*/
this.element_ = document.createElement('DIV');
this.element_.className = className + ' ' + CLASS_UNSELECTABLE;
this.element_.appendChild(this.innerElement_);
this.element.className = className + ' ' + CLASS_UNSELECTABLE;
this.element.appendChild(this.innerElement_);
/**
* @private
@@ -115,12 +117,6 @@ const ScaleLine = function(opt_options) {
*/
this.renderedHTML_ = '';
Control.call(this, {
element: this.element_,
render: options.render || render,
target: options.target
});
listen(
this, getChangeEventType(UNITS_PROP),
this.handleUnitsChanged_, this);
@@ -128,70 +124,47 @@ const ScaleLine = function(opt_options) {
this.setUnits(/** @type {module:ol/control/ScaleLine~Units} */ (options.units) ||
Units.METRIC);
};
}
inherits(ScaleLine, Control);
/**
/**
* Return the units to use in the scale line.
* @return {module:ol/control/ScaleLine~Units|undefined} The units
* to use in the scale line.
* @observable
* @api
*/
ScaleLine.prototype.getUnits = function() {
getUnits() {
return (
/** @type {module:ol/control/ScaleLine~Units|undefined} */ (this.get(UNITS_PROP))
);
};
/**
* Update the scale line element.
* @param {module:ol/MapEvent} mapEvent Map event.
* @this {module:ol/control/ScaleLine}
* @api
*/
export function render(mapEvent) {
const frameState = mapEvent.frameState;
if (!frameState) {
this.viewState_ = null;
} else {
this.viewState_ = frameState.viewState;
}
this.updateElement_();
}
/**
/**
* @private
*/
ScaleLine.prototype.handleUnitsChanged_ = function() {
handleUnitsChanged_() {
this.updateElement_();
};
}
/**
/**
* Set the units to use in the scale line.
* @param {module:ol/control/ScaleLine~Units} units The units to use in the scale line.
* @observable
* @api
*/
ScaleLine.prototype.setUnits = function(units) {
setUnits(units) {
this.set(UNITS_PROP, units);
};
}
/**
/**
* @private
*/
ScaleLine.prototype.updateElement_ = function() {
updateElement_() {
const viewState = this.viewState_;
if (!viewState) {
if (this.renderedVisible_) {
this.element_.style.display = 'none';
this.element.style.display = 'none';
this.renderedVisible_ = false;
}
return;
@@ -278,7 +251,7 @@ ScaleLine.prototype.updateElement_ = function() {
Math.pow(10, Math.floor(i / 3));
width = Math.round(count / pointResolution);
if (isNaN(width)) {
this.element_.style.display = 'none';
this.element.style.display = 'none';
this.renderedVisible_ = false;
return;
} else if (width >= this.minWidth_) {
@@ -299,10 +272,29 @@ ScaleLine.prototype.updateElement_ = function() {
}
if (!this.renderedVisible_) {
this.element_.style.display = '';
this.element.style.display = '';
this.renderedVisible_ = true;
}
};
}
}
/**
* Update the scale line element.
* @param {module:ol/MapEvent} mapEvent Map event.
* @this {module:ol/control/ScaleLine}
* @api
*/
export function render(mapEvent) {
const frameState = mapEvent.frameState;
if (!frameState) {
this.viewState_ = null;
} else {
this.viewState_ = frameState.viewState;
}
this.updateElement_();
}
export default ScaleLine;
src/ol/control/Zoom.js
+24 -26
View File
@@ -1,7 +1,6 @@
/**
* @module ol/control/Zoom
*/
import {inherits} from '../util.js';
import {listen} from '../events.js';
import EventType from '../events/EventType.js';
import Control from '../control/Control.js';
@@ -31,15 +30,22 @@ import {easeOut} from '../easing.js';
* This control is one of the default controls of a map. To style this control
* use css selectors `.ol-zoom-in` and `.ol-zoom-out`.
*
* @constructor
* @extends {module:ol/control/Control}
* @param {module:ol/control/Zoom~Options=} opt_options Zoom options.
* @api
*/
const Zoom = function(opt_options) {
class Zoom extends Control {
/**
* @param {module:ol/control/Zoom~Options=} opt_options Zoom options.
*/
constructor(opt_options) {
const options = opt_options ? opt_options : {};
super({
element: document.createElement('div'),
target: options.target
});
const className = options.className !== undefined ? options.className : 'ol-zoom';
const delta = options.delta !== undefined ? options.delta : 1;
@@ -60,8 +66,7 @@ const Zoom = function(opt_options) {
typeof zoomInLabel === 'string' ? document.createTextNode(zoomInLabel) : zoomInLabel
);
listen(inElement, EventType.CLICK,
Zoom.prototype.handleClick_.bind(this, delta));
listen(inElement, EventType.CLICK, this.handleClick_.bind(this, delta));
const outElement = document.createElement('button');
outElement.className = className + '-out';
@@ -71,47 +76,37 @@ const Zoom = function(opt_options) {
typeof zoomOutLabel === 'string' ? document.createTextNode(zoomOutLabel) : zoomOutLabel
);
listen(outElement, EventType.CLICK,
Zoom.prototype.handleClick_.bind(this, -delta));
listen(outElement, EventType.CLICK, this.handleClick_.bind(this, -delta));
const cssClasses = className + ' ' + CLASS_UNSELECTABLE + ' ' + CLASS_CONTROL;
const element = document.createElement('div');
const element = this.element;
element.className = cssClasses;
element.appendChild(inElement);
element.appendChild(outElement);
Control.call(this, {
element: element,
target: options.target
});
/**
* @type {number}
* @private
*/
this.duration_ = options.duration !== undefined ? options.duration : 250;
};
}
inherits(Zoom, Control);
/**
/**
* @param {number} delta Zoom delta.
* @param {MouseEvent} event The event to handle
* @private
*/
Zoom.prototype.handleClick_ = function(delta, event) {
handleClick_(delta, event) {
event.preventDefault();
this.zoomByDelta_(delta);
};
}
/**
/**
* @param {number} delta Zoom delta.
* @private
*/
Zoom.prototype.zoomByDelta_ = function(delta) {
zoomByDelta_(delta) {
const map = this.getMap();
const view = map.getView();
if (!view) {
@@ -135,5 +130,8 @@ Zoom.prototype.zoomByDelta_ = function(delta) {
view.setResolution(newResolution);
}
}
};
}
}
export default Zoom;
src/ol/control/ZoomSlider.js
+165 -175
View File
@@ -1,7 +1,6 @@
/**
* @module ol/control/ZoomSlider
*/
import {inherits} from '../util.js';
import ViewHint from '../ViewHint.js';
import Control from '../control/Control.js';
import {CLASS_CONTROL, CLASS_UNSELECTABLE} from '../css.js';
@@ -42,15 +41,22 @@ const Direction = {
*
* map.addControl(new ZoomSlider());
*
* @constructor
* @extends {module:ol/control/Control}
* @param {module:ol/control/ZoomSlider~Options=} opt_options Zoom slider options.
* @api
*/
const ZoomSlider = function(opt_options) {
class ZoomSlider extends Control {
/**
* @param {module:ol/control/ZoomSlider~Options=} opt_options Zoom slider options.
*/
constructor(opt_options) {
const options = opt_options ? opt_options : {};
super({
element: document.createElement('div'),
render: options.render || render
});
/**
* Will hold the current resolution of the view.
*
@@ -123,7 +129,7 @@ const ZoomSlider = function(opt_options) {
const thumbElement = document.createElement('button');
thumbElement.setAttribute('type', 'button');
thumbElement.className = className + '-thumb ' + CLASS_UNSELECTABLE;
const containerElement = document.createElement('div');
const containerElement = this.element;
containerElement.className = className + ' ' + CLASS_UNSELECTABLE + ' ' + CLASS_CONTROL;
containerElement.appendChild(thumbElement);
/**
@@ -141,44 +147,34 @@ const ZoomSlider = function(opt_options) {
listen(containerElement, EventType.CLICK, this.handleContainerClick_, this);
listen(thumbElement, EventType.CLICK, stopPropagation);
}
Control.call(this, {
element: containerElement,
render: options.render || render
});
};
inherits(ZoomSlider, Control);
/**
/**
* @inheritDoc
*/
ZoomSlider.prototype.disposeInternal = function() {
disposeInternal() {
this.dragger_.dispose();
Control.prototype.disposeInternal.call(this);
};
super.disposeInternal();
}
/**
/**
* @inheritDoc
*/
ZoomSlider.prototype.setMap = function(map) {
Control.prototype.setMap.call(this, map);
setMap(map) {
super.setMap(map);
if (map) {
map.render();
}
};
}
/**
/**
* Initializes the slider element. This will determine and set this controls
* direction_ and also constrain the dragging of the thumb to always be within
* the bounds of the container.
*
* @private
*/
ZoomSlider.prototype.initSlider_ = function() {
initSlider_() {
const container = this.element;
const containerSize = {
width: container.offsetWidth, height: container.offsetHeight
@@ -202,7 +198,148 @@ ZoomSlider.prototype.initSlider_ = function() {
this.heightLimit_ = containerSize.height - thumbHeight;
}
this.sliderInitialized_ = true;
};
}
/**
* @param {MouseEvent} event The browser event to handle.
* @private
*/
handleContainerClick_(event) {
const view = this.getMap().getView();
const relativePosition = this.getRelativePosition_(
event.offsetX - this.thumbSize_[0] / 2,
event.offsetY - this.thumbSize_[1] / 2);
const resolution = this.getResolutionForPosition_(relativePosition);
view.animate({
resolution: view.constrainResolution(resolution),
duration: this.duration_,
easing: easeOut
});
}
/**
* Handle dragger start events.
* @param {module:ol/pointer/PointerEvent} event The drag event.
* @private
*/
handleDraggerStart_(event) {
if (!this.dragging_ && event.originalEvent.target === this.element.firstElementChild) {
this.getMap().getView().setHint(ViewHint.INTERACTING, 1);
this.previousX_ = event.clientX;
this.previousY_ = event.clientY;
this.dragging_ = true;
}
}
/**
* Handle dragger drag events.
*
* @param {module:ol/pointer/PointerEvent|Event} event The drag event.
* @private
*/
handleDraggerDrag_(event) {
if (this.dragging_) {
const element = this.element.firstElementChild;
const deltaX = event.clientX - this.previousX_ + parseInt(element.style.left, 10);
const deltaY = event.clientY - this.previousY_ + parseInt(element.style.top, 10);
const relativePosition = this.getRelativePosition_(deltaX, deltaY);
this.currentResolution_ = this.getResolutionForPosition_(relativePosition);
this.getMap().getView().setResolution(this.currentResolution_);
this.setThumbPosition_(this.currentResolution_);
this.previousX_ = event.clientX;
this.previousY_ = event.clientY;
}
}
/**
* Handle dragger end events.
* @param {module:ol/pointer/PointerEvent|Event} event The drag event.
* @private
*/
handleDraggerEnd_(event) {
if (this.dragging_) {
const view = this.getMap().getView();
view.setHint(ViewHint.INTERACTING, -1);
view.animate({
resolution: view.constrainResolution(this.currentResolution_),
duration: this.duration_,
easing: easeOut
});
this.dragging_ = false;
this.previousX_ = undefined;
this.previousY_ = undefined;
}
}
/**
* Positions the thumb inside its container according to the given resolution.
*
* @param {number} res The res.
* @private
*/
setThumbPosition_(res) {
const position = this.getPositionForResolution_(res);
const thumb = this.element.firstElementChild;
if (this.direction_ == Direction.HORIZONTAL) {
thumb.style.left = this.widthLimit_ * position + 'px';
} else {
thumb.style.top = this.heightLimit_ * position + 'px';
}
}
/**
* Calculates the relative position of the thumb given x and y offsets. The
* relative position scales from 0 to 1. The x and y offsets are assumed to be
* in pixel units within the dragger limits.
*
* @param {number} x Pixel position relative to the left of the slider.
* @param {number} y Pixel position relative to the top of the slider.
* @return {number} The relative position of the thumb.
* @private
*/
getRelativePosition_(x, y) {
let amount;
if (this.direction_ === Direction.HORIZONTAL) {
amount = x / this.widthLimit_;
} else {
amount = y / this.heightLimit_;
}
return clamp(amount, 0, 1);
}
/**
* Calculates the corresponding resolution of the thumb given its relative
* position (where 0 is the minimum and 1 is the maximum).
*
* @param {number} position The relative position of the thumb.
* @return {number} The corresponding resolution.
* @private
*/
getResolutionForPosition_(position) {
const fn = this.getMap().getView().getResolutionForValueFunction();
return fn(1 - position);
}
/**
* Determines the relative position of the slider for the given resolution. A
* relative position of 0 corresponds to the minimum view resolution. A
* relative position of 1 corresponds to the maximum view resolution.
*
* @param {number} res The resolution.
* @return {number} The relative position value (between 0 and 1).
* @private
*/
getPositionForResolution_(res) {
const fn = this.getMap().getView().getValueForResolutionFunction();
return 1 - fn(res);
}
}
/**
@@ -226,151 +363,4 @@ export function render(mapEvent) {
}
/**
* @param {MouseEvent} event The browser event to handle.
* @private
*/
ZoomSlider.prototype.handleContainerClick_ = function(event) {
const view = this.getMap().getView();
const relativePosition = this.getRelativePosition_(
event.offsetX - this.thumbSize_[0] / 2,
event.offsetY - this.thumbSize_[1] / 2);
const resolution = this.getResolutionForPosition_(relativePosition);
view.animate({
resolution: view.constrainResolution(resolution),
duration: this.duration_,
easing: easeOut
});
};
/**
* Handle dragger start events.
* @param {module:ol/pointer/PointerEvent} event The drag event.
* @private
*/
ZoomSlider.prototype.handleDraggerStart_ = function(event) {
if (!this.dragging_ && event.originalEvent.target === this.element.firstElementChild) {
this.getMap().getView().setHint(ViewHint.INTERACTING, 1);
this.previousX_ = event.clientX;
this.previousY_ = event.clientY;
this.dragging_ = true;
}
};
/**
* Handle dragger drag events.
*
* @param {module:ol/pointer/PointerEvent|Event} event The drag event.
* @private
*/
ZoomSlider.prototype.handleDraggerDrag_ = function(event) {
if (this.dragging_) {
const element = this.element.firstElementChild;
const deltaX = event.clientX - this.previousX_ + parseInt(element.style.left, 10);
const deltaY = event.clientY - this.previousY_ + parseInt(element.style.top, 10);
const relativePosition = this.getRelativePosition_(deltaX, deltaY);
this.currentResolution_ = this.getResolutionForPosition_(relativePosition);
this.getMap().getView().setResolution(this.currentResolution_);
this.setThumbPosition_(this.currentResolution_);
this.previousX_ = event.clientX;
this.previousY_ = event.clientY;
}
};
/**
* Handle dragger end events.
* @param {module:ol/pointer/PointerEvent|Event} event The drag event.
* @private
*/
ZoomSlider.prototype.handleDraggerEnd_ = function(event) {
if (this.dragging_) {
const view = this.getMap().getView();
view.setHint(ViewHint.INTERACTING, -1);
view.animate({
resolution: view.constrainResolution(this.currentResolution_),
duration: this.duration_,
easing: easeOut
});
this.dragging_ = false;
this.previousX_ = undefined;
this.previousY_ = undefined;
}
};
/**
* Positions the thumb inside its container according to the given resolution.
*
* @param {number} res The res.
* @private
*/
ZoomSlider.prototype.setThumbPosition_ = function(res) {
const position = this.getPositionForResolution_(res);
const thumb = this.element.firstElementChild;
if (this.direction_ == Direction.HORIZONTAL) {
thumb.style.left = this.widthLimit_ * position + 'px';
} else {
thumb.style.top = this.heightLimit_ * position + 'px';
}
};
/**
* Calculates the relative position of the thumb given x and y offsets. The
* relative position scales from 0 to 1. The x and y offsets are assumed to be
* in pixel units within the dragger limits.
*
* @param {number} x Pixel position relative to the left of the slider.
* @param {number} y Pixel position relative to the top of the slider.
* @return {number} The relative position of the thumb.
* @private
*/
ZoomSlider.prototype.getRelativePosition_ = function(x, y) {
let amount;
if (this.direction_ === Direction.HORIZONTAL) {
amount = x / this.widthLimit_;
} else {
amount = y / this.heightLimit_;
}
return clamp(amount, 0, 1);
};
/**
* Calculates the corresponding resolution of the thumb given its relative
* position (where 0 is the minimum and 1 is the maximum).
*
* @param {number} position The relative position of the thumb.
* @return {number} The corresponding resolution.
* @private
*/
ZoomSlider.prototype.getResolutionForPosition_ = function(position) {
const fn = this.getMap().getView().getResolutionForValueFunction();
return fn(1 - position);
};
/**
* Determines the relative position of the slider for the given resolution. A
* relative position of 0 corresponds to the minimum view resolution. A
* relative position of 1 corresponds to the maximum view resolution.
*
* @param {number} res The resolution.
* @return {number} The relative position value (between 0 and 1).
* @private
*/
ZoomSlider.prototype.getPositionForResolution_ = function(res) {
const fn = this.getMap().getView().getValueForResolutionFunction();
return 1 - fn(res);
};
export default ZoomSlider;
src/ol/control/ZoomToExtent.js
+21 -22
View File
@@ -1,7 +1,6 @@
/**
* @module ol/control/ZoomToExtent
*/
import {inherits} from '../util.js';
import {listen} from '../events.js';
import EventType from '../events/EventType.js';
import Control from '../control/Control.js';
@@ -26,14 +25,21 @@ import {CLASS_CONTROL, CLASS_UNSELECTABLE} from '../css.js';
* A button control which, when pressed, changes the map view to a specific
* extent. To style this control use the css selector `.ol-zoom-extent`.
*
* @constructor
* @extends {module:ol/control/Control}
* @param {module:ol/control/ZoomToExtent~Options=} opt_options Options.
* @api
*/
const ZoomToExtent = function(opt_options) {
class ZoomToExtent extends Control {
/**
* @param {module:ol/control/ZoomToExtent~Options=} opt_options Options.
*/
constructor(opt_options) {
const options = opt_options ? opt_options : {};
super({
element: document.createElement('div'),
target: options.target
});
/**
* @type {module:ol/extent~Extent}
* @protected
@@ -54,36 +60,29 @@ const ZoomToExtent = function(opt_options) {
listen(button, EventType.CLICK, this.handleClick_, this);
const cssClasses = className + ' ' + CLASS_UNSELECTABLE + ' ' + CLASS_CONTROL;
const element = document.createElement('div');
const element = this.element;
element.className = cssClasses;
element.appendChild(button);
}
Control.call(this, {
element: element,
target: options.target
});
};
inherits(ZoomToExtent, Control);
/**
/**
* @param {MouseEvent} event The event to handle
* @private
*/
ZoomToExtent.prototype.handleClick_ = function(event) {
handleClick_(event) {
event.preventDefault();
this.handleZoomToExtent();
};
}
/**
/**
* @protected
*/
ZoomToExtent.prototype.handleZoomToExtent = function() {
handleZoomToExtent() {
const map = this.getMap();
const view = map.getView();
const extent = !this.extent ? view.getProjection().getExtent() : this.extent;
view.fit(extent);
};
}
}
export default ZoomToExtent;
src/ol/events/Event.js
+20 -15
View File
@@ -1,6 +1,7 @@
/**
* @module ol/events/Event
*/
/**
* @classdesc
* Stripped down implementation of the W3C DOM Level 2 Event interface.
@@ -10,11 +11,13 @@
* `stopPropagation` and `preventDefault` methods. It is meant as base class
* for higher level events defined in the library, and works with
* {@link module:ol/events/EventTarget~EventTarget}.
*
* @constructor
*/
class Event {
/**
* @param {string} type Type.
*/
const Event = function(type) {
constructor(type) {
/**
* @type {boolean}
@@ -34,25 +37,27 @@ const Event = function(type) {
* @api
*/
this.target = null;
};
/**
* Stop event propagation.
* @function
* @api
*/
Event.prototype.preventDefault =
}
/**
* Stop event propagation.
* @function
* @api
*/
Event.prototype.stopPropagation = function() {
preventDefault() {
this.propagationStopped = true;
};
}
/**
* Stop event propagation.
* @function
* @api
*/
stopPropagation() {
this.propagationStopped = true;
}
}
/**
src/ol/events/EventTarget.js
+33 -35
View File
@@ -1,7 +1,6 @@
/**
* @module ol/events/EventTarget
*/
import {inherits} from '../util.js';
import Disposable from '../Disposable.js';
import {unlistenAll} from '../events.js';
import {UNDEFINED} from '../functions.js';
@@ -27,13 +26,11 @@ import Event from '../events/Event.js';
* `stopPropagation` or `preventDefault` on an event object, it means that no
* more listeners after this one will be called. Same as when the listener
* returns false.
*
* @constructor
* @extends {module:ol/Disposable}
*/
const EventTarget = function() {
class EventTarget extends Disposable {
constructor() {
Disposable.call(this);
super();
/**
* @private
@@ -53,16 +50,13 @@ const EventTarget = function() {
*/
this.listeners_ = {};
};
}
inherits(EventTarget, Disposable);
/**
/**
* @param {string} type Type.
* @param {module:ol/events~ListenerFunction} listener Listener.
*/
EventTarget.prototype.addEventListener = function(type, listener) {
addEventListener(type, listener) {
let listeners = this.listeners_[type];
if (!listeners) {
listeners = this.listeners_[type] = [];
@@ -70,17 +64,22 @@ EventTarget.prototype.addEventListener = function(type, listener) {
if (listeners.indexOf(listener) === -1) {
listeners.push(listener);
}
};
}
/**
/**
* Dispatches an event and calls all listeners listening for events
* of this type. The event parameter can either be a string or an
* Object with a `type` property.
*
* @param {{type: string,
* target: (EventTarget|module:ol/events/EventTarget|undefined)}|module:ol/events/Event|
* string} event Event or event type.
* target: (EventTarget|module:ol/events/EventTarget|undefined)}|
* module:ol/events/Event|string} event Event object.
* @return {boolean|undefined} `false` if anyone called preventDefault on the
* event object or if any of the listeners returned false.
* @function
* @api
*/
EventTarget.prototype.dispatchEvent = function(event) {
dispatchEvent(event) {
const evt = typeof event === 'string' ? new Event(event) : event;
const type = evt.type;
evt.target = this;
@@ -109,46 +108,42 @@ EventTarget.prototype.dispatchEvent = function(event) {
}
return propagate;
}
};
}
/**
/**
* @inheritDoc
*/
EventTarget.prototype.disposeInternal = function() {
disposeInternal() {
unlistenAll(this);
};
}
/**
/**
* Get the listeners for a specified event type. Listeners are returned in the
* order that they will be called in.
*
* @param {string} type Type.
* @return {Array.<module:ol/events~ListenerFunction>} Listeners.
*/
EventTarget.prototype.getListeners = function(type) {
getListeners(type) {
return this.listeners_[type];
};
}
/**
/**
* @param {string=} opt_type Type. If not provided,
* `true` will be returned if this EventTarget has any listeners.
* @return {boolean} Has listeners.
*/
EventTarget.prototype.hasListener = function(opt_type) {
hasListener(opt_type) {
return opt_type ?
opt_type in this.listeners_ :
Object.keys(this.listeners_).length > 0;
};
}
/**
/**
* @param {string} type Type.
* @param {module:ol/events~ListenerFunction} listener Listener.
*/
EventTarget.prototype.removeEventListener = function(type, listener) {
removeEventListener(type, listener) {
const listeners = this.listeners_[type];
if (listeners) {
const index = listeners.indexOf(listener);
@@ -163,5 +158,8 @@ EventTarget.prototype.removeEventListener = function(type, listener) {
}
}
}
};
}
}
export default EventTarget;
src/ol/format/EsriJSON.js
+134 -225
View File
@@ -1,7 +1,6 @@
/**
* @module ol/format/EsriJSON
*/
import {inherits} from '../util.js';
import Feature from '../Feature.js';
import {assert} from '../asserts.js';
import {containsExtent} from '../extent.js';
@@ -58,16 +57,18 @@ GEOMETRY_WRITERS[GeometryType.MULTI_POLYGON] = writeMultiPolygonGeometry;
* @classdesc
* Feature format for reading and writing data in the EsriJSON format.
*
* @constructor
* @extends {module:ol/format/JSONFeature}
* @param {module:ol/format/EsriJSON~Options=} opt_options Options.
* @api
*/
const EsriJSON = function(opt_options) {
class EsriJSON extends JSONFeature {
/**
* @param {module:ol/format/EsriJSON~Options=} opt_options Options.
*/
constructor(opt_options) {
const options = opt_options ? opt_options : {};
JSONFeature.call(this);
super();
/**
* Name of the geometry attribute for features.
@@ -76,9 +77,134 @@ const EsriJSON = function(opt_options) {
*/
this.geometryName_ = options.geometryName;
};
}
inherits(EsriJSON, JSONFeature);
/**
* @inheritDoc
*/
readFeatureFromObject(object, opt_options) {
const esriJSONFeature = /** @type {EsriJSONFeature} */ (object);
const geometry = readGeometry(esriJSONFeature.geometry, opt_options);
const feature = new Feature();
if (this.geometryName_) {
feature.setGeometryName(this.geometryName_);
}
feature.setGeometry(geometry);
if (opt_options && opt_options.idField &&
esriJSONFeature.attributes[opt_options.idField]) {
feature.setId(/** @type {number} */(esriJSONFeature.attributes[opt_options.idField]));
}
if (esriJSONFeature.attributes) {
feature.setProperties(esriJSONFeature.attributes);
}
return feature;
}
/**
* @inheritDoc
*/
readFeaturesFromObject(object, opt_options) {
const esriJSONObject = /** @type {EsriJSONObject} */ (object);
const options = opt_options ? opt_options : {};
if (esriJSONObject.features) {
const esriJSONFeatureCollection = /** @type {EsriJSONFeatureCollection} */ (object);
/** @type {Array.<module:ol/Feature>} */
const features = [];
const esriJSONFeatures = esriJSONFeatureCollection.features;
options.idField = object.objectIdFieldName;
for (let i = 0, ii = esriJSONFeatures.length; i < ii; ++i) {
features.push(this.readFeatureFromObject(esriJSONFeatures[i], options));
}
return features;
} else {
return [this.readFeatureFromObject(object, options)];
}
}
/**
* @inheritDoc
*/
readGeometryFromObject(object, opt_options) {
return readGeometry(/** @type {EsriJSONGeometry} */(object), opt_options);
}
/**
* @inheritDoc
*/
readProjectionFromObject(object) {
const esriJSONObject = /** @type {EsriJSONObject} */ (object);
if (esriJSONObject.spatialReference && esriJSONObject.spatialReference.wkid) {
const crs = esriJSONObject.spatialReference.wkid;
return getProjection('EPSG:' + crs);
} else {
return null;
}
}
/**
* Encode a geometry as a EsriJSON object.
*
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {EsriJSONGeometry} Object.
* @override
* @api
*/
writeGeometryObject(geometry, opt_options) {
return writeGeometry(geometry, this.adaptOptions(opt_options));
}
/**
* Encode a feature as a esriJSON Feature object.
*
* @param {module:ol/Feature} feature Feature.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {Object} Object.
* @override
* @api
*/
writeFeatureObject(feature, opt_options) {
opt_options = this.adaptOptions(opt_options);
const object = {};
const geometry = feature.getGeometry();
if (geometry) {
object['geometry'] = writeGeometry(geometry, opt_options);
if (opt_options && opt_options.featureProjection) {
object['geometry']['spatialReference'] = /** @type {EsriJSONCRS} */({
wkid: getProjection(opt_options.featureProjection).getCode().split(':').pop()
});
}
}
const properties = feature.getProperties();
delete properties[feature.getGeometryName()];
if (!isEmpty(properties)) {
object['attributes'] = properties;
} else {
object['attributes'] = {};
}
return object;
}
/**
* Encode an array of features as a EsriJSON object.
*
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {Object} EsriJSON Object.
* @override
* @api
*/
writeFeaturesObject(features, opt_options) {
opt_options = this.adaptOptions(opt_options);
const objects = [];
for (let i = 0, ii = features.length; i < ii; ++i) {
objects.push(this.writeFeatureObject(features[i], opt_options));
}
return /** @type {EsriJSONFeatureCollection} */ ({
'features': objects
});
}
}
/**
@@ -413,121 +539,6 @@ function writeMultiPolygonGeometry(geometry, opt_options) {
}
/**
* Read a feature from a EsriJSON Feature source. Only works for Feature,
* use `readFeatures` to read FeatureCollection source.
*
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/Feature} Feature.
* @api
*/
EsriJSON.prototype.readFeature;
/**
* Read all features from a EsriJSON source. Works with both Feature and
* FeatureCollection sources.
*
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {Array.<module:ol/Feature>} Features.
* @api
*/
EsriJSON.prototype.readFeatures;
/**
* @inheritDoc
*/
EsriJSON.prototype.readFeatureFromObject = function(object, opt_options) {
const esriJSONFeature = /** @type {EsriJSONFeature} */ (object);
const geometry = readGeometry(esriJSONFeature.geometry, opt_options);
const feature = new Feature();
if (this.geometryName_) {
feature.setGeometryName(this.geometryName_);
}
feature.setGeometry(geometry);
if (opt_options && opt_options.idField &&
esriJSONFeature.attributes[opt_options.idField]) {
feature.setId(/** @type {number} */(esriJSONFeature.attributes[opt_options.idField]));
}
if (esriJSONFeature.attributes) {
feature.setProperties(esriJSONFeature.attributes);
}
return feature;
};
/**
* @inheritDoc
*/
EsriJSON.prototype.readFeaturesFromObject = function(object, opt_options) {
const esriJSONObject = /** @type {EsriJSONObject} */ (object);
const options = opt_options ? opt_options : {};
if (esriJSONObject.features) {
const esriJSONFeatureCollection = /** @type {EsriJSONFeatureCollection} */ (object);
/** @type {Array.<module:ol/Feature>} */
const features = [];
const esriJSONFeatures = esriJSONFeatureCollection.features;
options.idField = object.objectIdFieldName;
for (let i = 0, ii = esriJSONFeatures.length; i < ii; ++i) {
features.push(this.readFeatureFromObject(esriJSONFeatures[i], options));
}
return features;
} else {
return [this.readFeatureFromObject(object, options)];
}
};
/**
* Read a geometry from a EsriJSON source.
*
* @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.
* @api
*/
EsriJSON.prototype.readGeometry;
/**
* @inheritDoc
*/
EsriJSON.prototype.readGeometryFromObject = function(object, opt_options) {
return readGeometry(/** @type {EsriJSONGeometry} */(object), opt_options);
};
/**
* Read the projection from a EsriJSON source.
*
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {module:ol/proj/Projection} Projection.
* @api
*/
EsriJSON.prototype.readProjection;
/**
* @inheritDoc
*/
EsriJSON.prototype.readProjectionFromObject = function(object) {
const esriJSONObject = /** @type {EsriJSONObject} */ (object);
if (esriJSONObject.spatialReference && esriJSONObject.spatialReference.wkid) {
const crs = esriJSONObject.spatialReference.wkid;
return getProjection('EPSG:' + crs);
} else {
return null;
}
};
/**
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
@@ -540,106 +551,4 @@ function writeGeometry(geometry, opt_options) {
}
/**
* Encode a geometry as a EsriJSON string.
*
* @function
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} EsriJSON.
* @api
*/
EsriJSON.prototype.writeGeometry;
/**
* Encode a geometry as a EsriJSON object.
*
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {EsriJSONGeometry} Object.
* @override
* @api
*/
EsriJSON.prototype.writeGeometryObject = function(geometry, opt_options) {
return writeGeometry(geometry, this.adaptOptions(opt_options));
};
/**
* Encode a feature as a EsriJSON Feature string.
*
* @function
* @param {module:ol/Feature} feature Feature.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} EsriJSON.
* @api
*/
EsriJSON.prototype.writeFeature;
/**
* Encode a feature as a esriJSON Feature object.
*
* @param {module:ol/Feature} feature Feature.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {Object} Object.
* @override
* @api
*/
EsriJSON.prototype.writeFeatureObject = function(feature, opt_options) {
opt_options = this.adaptOptions(opt_options);
const object = {};
const geometry = feature.getGeometry();
if (geometry) {
object['geometry'] = writeGeometry(geometry, opt_options);
if (opt_options && opt_options.featureProjection) {
object['geometry']['spatialReference'] = /** @type {EsriJSONCRS} */({
wkid: getProjection(opt_options.featureProjection).getCode().split(':').pop()
});
}
}
const properties = feature.getProperties();
delete properties[feature.getGeometryName()];
if (!isEmpty(properties)) {
object['attributes'] = properties;
} else {
object['attributes'] = {};
}
return object;
};
/**
* Encode an array of features as EsriJSON.
*
* @function
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} EsriJSON.
* @api
*/
EsriJSON.prototype.writeFeatures;
/**
* Encode an array of features as a EsriJSON object.
*
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {Object} EsriJSON Object.
* @override
* @api
*/
EsriJSON.prototype.writeFeaturesObject = function(features, opt_options) {
opt_options = this.adaptOptions(opt_options);
const objects = [];
for (let i = 0, ii = features.length; i < ii; ++i) {
objects.push(this.writeFeatureObject(features[i], opt_options));
}
return /** @type {EsriJSONFeatureCollection} */ ({
'features': objects
});
};
export default EsriJSON;
src/ol/format/Feature.js
+29 -39
View File
@@ -56,11 +56,11 @@ import {get as getProjection, equivalent as equivalentProjection, transformExten
* {@link module:ol/Feature~Feature} objects from a variety of commonly used geospatial
* file formats. See the documentation for each format for more details.
*
* @constructor
* @abstract
* @api
*/
const FeatureFormat = function() {
class FeatureFormat {
constructor() {
/**
* @protected
@@ -74,17 +74,16 @@ const FeatureFormat = function() {
*/
this.defaultFeatureProjection = null;
};
}
/**
/**
* Adds the data projection to the read options.
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Options.
* @return {module:ol/format/Feature~ReadOptions|undefined} Options.
* @protected
*/
FeatureFormat.prototype.getReadOptions = function(source, opt_options) {
getReadOptions(source, opt_options) {
let options;
if (opt_options) {
options = {
@@ -94,10 +93,9 @@ FeatureFormat.prototype.getReadOptions = function(source, opt_options) {
};
}
return this.adaptOptions(options);
};
}
/**
/**
* Sets the `dataProjection` on the options, if no `dataProjection`
* is set.
* @param {module:ol/format/Feature~WriteOptions|module:ol/format/Feature~ReadOptions|undefined} options
@@ -106,31 +104,28 @@ FeatureFormat.prototype.getReadOptions = function(source, opt_options) {
* @return {module:ol/format/Feature~WriteOptions|module:ol/format/Feature~ReadOptions|undefined}
* Updated options.
*/
FeatureFormat.prototype.adaptOptions = function(options) {
adaptOptions(options) {
return assign({
dataProjection: this.dataProjection,
featureProjection: this.defaultFeatureProjection
}, options);
};
}
/**
/**
* Get the extent from the source of the last {@link readFeatures} call.
* @return {module:ol/extent~Extent} Tile extent.
*/
FeatureFormat.prototype.getLastExtent = function() {
getLastExtent() {
return null;
};
}
/**
/**
* @abstract
* @return {module:ol/format/FormatType} Format.
*/
FeatureFormat.prototype.getType = function() {};
getType() {}
/**
/**
* Read a single feature from a source.
*
* @abstract
@@ -138,10 +133,9 @@ FeatureFormat.prototype.getType = function() {};
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/Feature} Feature.
*/
FeatureFormat.prototype.readFeature = function(source, opt_options) {};
readFeature(source, opt_options) {}
/**
/**
* Read all features from a source.
*
* @abstract
@@ -149,10 +143,9 @@ FeatureFormat.prototype.readFeature = function(source, opt_options) {};
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {Array.<module:ol/Feature>} Features.
*/
FeatureFormat.prototype.readFeatures = function(source, opt_options) {};
readFeatures(source, opt_options) {}
/**
/**
* Read a single geometry from a source.
*
* @abstract
@@ -160,20 +153,18 @@ FeatureFormat.prototype.readFeatures = function(source, opt_options) {};
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/geom/Geometry} Geometry.
*/
FeatureFormat.prototype.readGeometry = function(source, opt_options) {};
readGeometry(source, opt_options) {}
/**
/**
* Read the projection from a source.
*
* @abstract
* @param {Document|Node|Object|string} source Source.
* @return {module:ol/proj/Projection} Projection.
*/
FeatureFormat.prototype.readProjection = function(source) {};
readProjection(source) {}
/**
/**
* Encode a feature in this format.
*
* @abstract
@@ -181,10 +172,9 @@ FeatureFormat.prototype.readProjection = function(source) {};
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} Result.
*/
FeatureFormat.prototype.writeFeature = function(feature, opt_options) {};
writeFeature(feature, opt_options) {}
/**
/**
* Encode an array of features in this format.
*
* @abstract
@@ -192,10 +182,9 @@ FeatureFormat.prototype.writeFeature = function(feature, opt_options) {};
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} Result.
*/
FeatureFormat.prototype.writeFeatures = function(features, opt_options) {};
writeFeatures(features, opt_options) {}
/**
/**
* Write a single geometry in this format.
*
* @abstract
@@ -203,7 +192,8 @@ FeatureFormat.prototype.writeFeatures = function(features, opt_options) {};
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} Result.
*/
FeatureFormat.prototype.writeGeometry = function(geometry, opt_options) {};
writeGeometry(geometry, opt_options) {}
}
export default FeatureFormat;
src/ol/format/GML.js
-2
View File
@@ -9,10 +9,8 @@ import GML3 from '../format/GML3.js';
* version 3.1.1.
* Currently only supports GML 3.1.1 Simple Features profile.
*
* @constructor
* @param {module:ol/format/GMLBase~Options=} opt_options
* Optional configuration object.
* @extends {module:ol/format/GMLBase}
* @api
*/
const GML = GML3;
src/ol/format/GML2.js
+100 -136
View File
@@ -1,7 +1,6 @@
/**
* @module ol/format/GML2
*/
import {inherits} from '../util.js';
import {createOrUpdate} from '../extent.js';
import {transformWithOptions} from '../format/Feature.js';
import GMLBase, {GMLNS} from '../format/GMLBase.js';
@@ -20,25 +19,39 @@ import {createElementNS, getAllTextContent, makeArrayPusher, makeChildAppender,
const schemaLocation = GMLNS + ' http://schemas.opengis.net/gml/2.1.2/feature.xsd';
/**
* @const
* @type {Object.<string, string>}
*/
const MULTIGEOMETRY_TO_MEMBER_NODENAME = {
'MultiLineString': 'lineStringMember',
'MultiCurve': 'curveMember',
'MultiPolygon': 'polygonMember',
'MultiSurface': 'surfaceMember'
};
/**
* @classdesc
* Feature format for reading and writing data in the GML format,
* version 2.1.2.
*
* @constructor
* @param {module:ol/format/GMLBase~Options=} opt_options Optional configuration object.
* @extends {module:ol/format/GMLBase}
* @api
*/
const GML2 = function(opt_options) {
class GML2 extends GMLBase {
/**
* @param {module:ol/format/GMLBase~Options=} opt_options Optional configuration object.
*/
constructor(opt_options) {
const options = /** @type {module:ol/format/GMLBase~Options} */
(opt_options ? opt_options : {});
GMLBase.call(this, options);
super(options);
this.FEATURE_COLLECTION_PARSERS[GMLNS][
'featureMember'] =
makeArrayPusher(GMLBase.prototype.readFeaturesInternal);
makeArrayPusher(this.readFeaturesInternal);
/**
* @inheritDoc
@@ -46,18 +59,15 @@ const GML2 = function(opt_options) {
this.schemaLocation = options.schemaLocation ?
options.schemaLocation : schemaLocation;
};
}
inherits(GML2, GMLBase);
/**
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @private
* @return {Array.<number>|undefined} Flat coordinates.
*/
GML2.prototype.readFlatCoordinates_ = function(node, objectStack) {
readFlatCoordinates_(node, objectStack) {
const s = getAllTextContent(node, false).replace(/^\s*|\s*$/g, '');
const context = /** @type {module:ol/xml~NodeStackItem} */ (objectStack[0]);
const containerSrs = context['srsName'];
@@ -82,31 +92,29 @@ GML2.prototype.readFlatCoordinates_ = function(node, objectStack) {
}
}
return flatCoordinates;
};
}
/**
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @private
* @return {module:ol/extent~Extent|undefined} Envelope.
*/
GML2.prototype.readBox_ = function(node, objectStack) {
readBox_(node, objectStack) {
/** @type {Array.<number>} */
const flatCoordinates = pushParseAndPop([null],
this.BOX_PARSERS_, node, objectStack, this);
return createOrUpdate(flatCoordinates[1][0],
flatCoordinates[1][1], flatCoordinates[1][3],
flatCoordinates[1][4]);
};
}
/**
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @private
*/
GML2.prototype.innerBoundaryIsParser_ = function(node, objectStack) {
innerBoundaryIsParser_(node, objectStack) {
/** @type {Array.<number>|undefined} */
const flatLinearRing = pushParseAndPop(undefined,
this.RING_PARSERS, node, objectStack, this);
@@ -115,15 +123,14 @@ GML2.prototype.innerBoundaryIsParser_ = function(node, objectStack) {
(objectStack[objectStack.length - 1]);
flatLinearRings.push(flatLinearRing);
}
};
}
/**
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @private
*/
GML2.prototype.outerBoundaryIsParser_ = function(node, objectStack) {
outerBoundaryIsParser_(node, objectStack) {
/** @type {Array.<number>|undefined} */
const flatLinearRing = pushParseAndPop(undefined,
this.RING_PARSERS, node, objectStack, this);
@@ -132,10 +139,9 @@ GML2.prototype.outerBoundaryIsParser_ = function(node, objectStack) {
(objectStack[objectStack.length - 1]);
flatLinearRings[0] = flatLinearRing;
}
};
}
/**
/**
* @const
* @param {*} value Value.
* @param {Array.<*>} objectStack Object stack.
@@ -143,7 +149,7 @@ GML2.prototype.outerBoundaryIsParser_ = function(node, objectStack) {
* @return {Node|undefined} Node.
* @private
*/
GML2.prototype.GEOMETRY_NODE_FACTORY_ = function(value, objectStack, opt_nodeName) {
GEOMETRY_NODE_FACTORY_(value, objectStack, opt_nodeName) {
const context = objectStack[objectStack.length - 1];
const multiSurface = context['multiSurface'];
const surface = context['surface'];
@@ -163,15 +169,14 @@ GML2.prototype.GEOMETRY_NODE_FACTORY_ = function(value, objectStack, opt_nodeNam
}
return createElementNS('http://www.opengis.net/gml',
nodeName);
};
}
/**
/**
* @param {Node} node Node.
* @param {module:ol/Feature} feature Feature.
* @param {Array.<*>} objectStack Node stack.
*/
GML2.prototype.writeFeatureElement = function(node, feature, objectStack) {
writeFeatureElement(node, feature, objectStack) {
const fid = feature.getId();
if (fid) {
node.setAttribute('fid', fid);
@@ -210,16 +215,15 @@ GML2.prototype.writeFeatureElement = function(node, feature, objectStack) {
makeSimpleNodeFactory(undefined, featureNS),
values,
objectStack, keys);
};
}
/**
/**
* @param {Node} node Node.
* @param {module:ol/geom/LineString} geometry LineString geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
GML2.prototype.writeCurveOrLineString_ = function(node, geometry, objectStack) {
writeCurveOrLineString_(node, geometry, objectStack) {
const context = objectStack[objectStack.length - 1];
const srsName = context['srsName'];
if (node.nodeName !== 'LineStringSegment' && srsName) {
@@ -236,31 +240,29 @@ GML2.prototype.writeCurveOrLineString_ = function(node, geometry, objectStack) {
this.writeCurveSegments_(segments,
geometry, objectStack);
}
};
}
/**
/**
* @param {Node} node Node.
* @param {module:ol/geom/LineString} line LineString geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
GML2.prototype.writeLineStringOrCurveMember_ = function(node, line, objectStack) {
writeLineStringOrCurveMember_(node, line, objectStack) {
const child = this.GEOMETRY_NODE_FACTORY_(line, objectStack);
if (child) {
node.appendChild(child);
this.writeCurveOrLineString_(child, line, objectStack);
}
};
}
/**
/**
* @param {Node} node Node.
* @param {module:ol/geom/MultiLineString} geometry MultiLineString geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
GML2.prototype.writeMultiCurveOrLineString_ = function(node, geometry, objectStack) {
writeMultiCurveOrLineString_(node, geometry, objectStack) {
const context = objectStack[objectStack.length - 1];
const hasZ = context['hasZ'];
const srsName = context['srsName'];
@@ -273,15 +275,14 @@ GML2.prototype.writeMultiCurveOrLineString_ = function(node, geometry, objectSta
this.LINESTRINGORCURVEMEMBER_SERIALIZERS_,
this.MULTIGEOMETRY_MEMBER_NODE_FACTORY_, lines,
objectStack, undefined, this);
};
}
/**
/**
* @param {Node} node Node.
* @param {module:ol/geom/Geometry|module:ol/extent~Extent} geometry Geometry.
* @param {Array.<*>} objectStack Node stack.
*/
GML2.prototype.writeGeometryElement = function(node, geometry, objectStack) {
writeGeometryElement(node, geometry, objectStack) {
const context = /** @type {module:ol/format/Feature~WriteOptions} */ (objectStack[objectStack.length - 1]);
const item = assign({}, context);
item.node = node;
@@ -300,31 +301,29 @@ GML2.prototype.writeGeometryElement = function(node, geometry, objectStack) {
(item), this.GEOMETRY_SERIALIZERS_,
this.GEOMETRY_NODE_FACTORY_, [value],
objectStack, undefined, this);
};
}
/**
/**
* @param {string} namespaceURI XML namespace.
* @returns {Node} coordinates node.
* @private
*/
GML2.prototype.createCoordinatesNode_ = function(namespaceURI) {
createCoordinatesNode_(namespaceURI) {
const coordinates = createElementNS(namespaceURI, 'coordinates');
coordinates.setAttribute('decimal', '.');
coordinates.setAttribute('cs', ',');
coordinates.setAttribute('ts', ' ');
return coordinates;
};
}
/**
/**
* @param {Node} node Node.
* @param {module:ol/geom/LineString|module:ol/geom/LinearRing} value Geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
GML2.prototype.writeCoordinates_ = function(node, value, objectStack) {
writeCoordinates_(node, value, objectStack) {
const context = objectStack[objectStack.length - 1];
const hasZ = context['hasZ'];
const srsName = context['srsName'];
@@ -337,29 +336,27 @@ GML2.prototype.writeCoordinates_ = function(node, value, objectStack) {
parts[i] = this.getCoords_(point, srsName, hasZ);
}
writeStringTextNode(node, parts.join(' '));
};
}
/**
/**
* @param {Node} node Node.
* @param {module:ol/geom/LineString} line LineString geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
GML2.prototype.writeCurveSegments_ = function(node, line, objectStack) {
writeCurveSegments_(node, line, objectStack) {
const child = createElementNS(node.namespaceURI, 'LineStringSegment');
node.appendChild(child);
this.writeCurveOrLineString_(child, line, objectStack);
};
}
/**
/**
* @param {Node} node Node.
* @param {module:ol/geom/Polygon} geometry Polygon geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
GML2.prototype.writeSurfaceOrPolygon_ = function(node, geometry, objectStack) {
writeSurfaceOrPolygon_(node, geometry, objectStack) {
const context = objectStack[objectStack.length - 1];
const hasZ = context['hasZ'];
const srsName = context['srsName'];
@@ -379,17 +376,16 @@ GML2.prototype.writeSurfaceOrPolygon_ = function(node, geometry, objectStack) {
this.writeSurfacePatches_(
patches, geometry, objectStack);
}
};
}
/**
/**
* @param {*} value Value.
* @param {Array.<*>} objectStack Object stack.
* @param {string=} opt_nodeName Node name.
* @return {Node} Node.
* @private
*/
GML2.prototype.RING_NODE_FACTORY_ = function(value, objectStack, opt_nodeName) {
RING_NODE_FACTORY_(value, objectStack, opt_nodeName) {
const context = objectStack[objectStack.length - 1];
const parentNode = context.node;
const exteriorWritten = context['exteriorWritten'];
@@ -398,43 +394,40 @@ GML2.prototype.RING_NODE_FACTORY_ = function(value, objectStack, opt_nodeName) {
}
return createElementNS(parentNode.namespaceURI,
exteriorWritten !== undefined ? 'innerBoundaryIs' : 'outerBoundaryIs');
};
}
/**
/**
* @param {Node} node Node.
* @param {module:ol/geom/Polygon} polygon Polygon geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
GML2.prototype.writeSurfacePatches_ = function(node, polygon, objectStack) {
writeSurfacePatches_(node, polygon, objectStack) {
const child = createElementNS(node.namespaceURI, 'PolygonPatch');
node.appendChild(child);
this.writeSurfaceOrPolygon_(child, polygon, objectStack);
};
}
/**
/**
* @param {Node} node Node.
* @param {module:ol/geom/LinearRing} ring LinearRing geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
GML2.prototype.writeRing_ = function(node, ring, objectStack) {
writeRing_(node, ring, objectStack) {
const linearRing = createElementNS(node.namespaceURI, 'LinearRing');
node.appendChild(linearRing);
this.writeLinearRing_(linearRing, ring, objectStack);
};
}
/**
/**
* @param {Array.<number>} point Point geometry.
* @param {string=} opt_srsName Optional srsName
* @param {boolean=} opt_hasZ whether the geometry has a Z coordinate (is 3D) or not.
* @return {string} The coords string.
* @private
*/
GML2.prototype.getCoords_ = function(point, opt_srsName, opt_hasZ) {
getCoords_(point, opt_srsName, opt_hasZ) {
let axisOrientation = 'enu';
if (opt_srsName) {
axisOrientation = getProjection(opt_srsName).getAxisOrientation();
@@ -449,16 +442,15 @@ GML2.prototype.getCoords_ = function(point, opt_srsName, opt_hasZ) {
}
return coords;
};
}
/**
/**
* @param {Node} node Node.
* @param {module:ol/geom/Point} geometry Point geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
GML2.prototype.writePoint_ = function(node, geometry, objectStack) {
writePoint_(node, geometry, objectStack) {
const context = objectStack[objectStack.length - 1];
const hasZ = context['hasZ'];
const srsName = context['srsName'];
@@ -470,16 +462,15 @@ GML2.prototype.writePoint_ = function(node, geometry, objectStack) {
const point = geometry.getCoordinates();
const coord = this.getCoords_(point, srsName, hasZ);
writeStringTextNode(coordinates, coord);
};
}
/**
/**
* @param {Node} node Node.
* @param {module:ol/geom/MultiPoint} geometry MultiPoint geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
GML2.prototype.writeMultiPoint_ = function(node, geometry, objectStack) {
writeMultiPoint_(node, geometry, objectStack) {
const context = objectStack[objectStack.length - 1];
const hasZ = context['hasZ'];
const srsName = context['srsName'];
@@ -491,29 +482,27 @@ GML2.prototype.writeMultiPoint_ = function(node, geometry, objectStack) {
this.POINTMEMBER_SERIALIZERS_,
makeSimpleNodeFactory('pointMember'), points,
objectStack, undefined, this);
};
}
/**
/**
* @param {Node} node Node.
* @param {module:ol/geom/Point} point Point geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
GML2.prototype.writePointMember_ = function(node, point, objectStack) {
writePointMember_(node, point, objectStack) {
const child = createElementNS(node.namespaceURI, 'Point');
node.appendChild(child);
this.writePoint_(child, point, objectStack);
};
}
/**
/**
* @param {Node} node Node.
* @param {module:ol/geom/LinearRing} geometry LinearRing geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
GML2.prototype.writeLinearRing_ = function(node, geometry, objectStack) {
writeLinearRing_(node, geometry, objectStack) {
const context = objectStack[objectStack.length - 1];
const srsName = context['srsName'];
if (srsName) {
@@ -522,16 +511,15 @@ GML2.prototype.writeLinearRing_ = function(node, geometry, objectStack) {
const coordinates = this.createCoordinatesNode_(node.namespaceURI);
node.appendChild(coordinates);
this.writeCoordinates_(coordinates, geometry, objectStack);
};
}
/**
/**
* @param {Node} node Node.
* @param {module:ol/geom/MultiPolygon} geometry MultiPolygon geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
GML2.prototype.writeMultiSurfaceOrPolygon_ = function(node, geometry, objectStack) {
writeMultiSurfaceOrPolygon_(node, geometry, objectStack) {
const context = objectStack[objectStack.length - 1];
const hasZ = context['hasZ'];
const srsName = context['srsName'];
@@ -544,32 +532,30 @@ GML2.prototype.writeMultiSurfaceOrPolygon_ = function(node, geometry, objectStac
this.SURFACEORPOLYGONMEMBER_SERIALIZERS_,
this.MULTIGEOMETRY_MEMBER_NODE_FACTORY_, polygons,
objectStack, undefined, this);
};
}
/**
/**
* @param {Node} node Node.
* @param {module:ol/geom/Polygon} polygon Polygon geometry.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
GML2.prototype.writeSurfaceOrPolygonMember_ = function(node, polygon, objectStack) {
writeSurfaceOrPolygonMember_(node, polygon, objectStack) {
const child = this.GEOMETRY_NODE_FACTORY_(
polygon, objectStack);
if (child) {
node.appendChild(child);
this.writeSurfaceOrPolygon_(child, polygon, objectStack);
}
};
}
/**
/**
* @param {Node} node Node.
* @param {module:ol/extent~Extent} extent Extent.
* @param {Array.<*>} objectStack Node stack.
* @private
*/
GML2.prototype.writeEnvelope = function(node, extent, objectStack) {
writeEnvelope(node, extent, objectStack) {
const context = objectStack[objectStack.length - 1];
const srsName = context['srsName'];
if (srsName) {
@@ -582,22 +568,9 @@ GML2.prototype.writeEnvelope = function(node, extent, objectStack) {
OBJECT_PROPERTY_NODE_FACTORY,
values,
objectStack, keys, this);
};
}
/**
* @const
* @type {Object.<string, string>}
*/
const MULTIGEOMETRY_TO_MEMBER_NODENAME = {
'MultiLineString': 'lineStringMember',
'MultiCurve': 'curveMember',
'MultiPolygon': 'polygonMember',
'MultiSurface': 'surfaceMember'
};
/**
/**
* @const
* @param {*} value Value.
* @param {Array.<*>} objectStack Object stack.
@@ -605,12 +578,12 @@ const MULTIGEOMETRY_TO_MEMBER_NODENAME = {
* @return {Node|undefined} Node.
* @private
*/
GML2.prototype.MULTIGEOMETRY_MEMBER_NODE_FACTORY_ = function(value, objectStack, opt_nodeName) {
MULTIGEOMETRY_MEMBER_NODE_FACTORY_(value, objectStack, opt_nodeName) {
const parentNode = objectStack[objectStack.length - 1].node;
return createElementNS('http://www.opengis.net/gml',
MULTIGEOMETRY_TO_MEMBER_NODENAME[parentNode.nodeName]);
};
}
}
/**
* @const
@@ -623,7 +596,6 @@ GML2.prototype.GEOMETRY_FLAT_COORDINATES_PARSERS_ = {
}
};
/**
* @const
* @type {Object.<string, Object.<string, module:ol/xml~Parser>>}
@@ -636,7 +608,6 @@ GML2.prototype.FLAT_LINEAR_RINGS_PARSERS_ = {
}
};
/**
* @const
* @type {Object.<string, Object.<string, module:ol/xml~Parser>>}
@@ -649,7 +620,6 @@ GML2.prototype.BOX_PARSERS_ = {
}
};
/**
* @const
* @type {Object.<string, Object.<string, module:ol/xml~Parser>>}
@@ -673,7 +643,6 @@ GML2.prototype.GEOMETRY_PARSERS_ = {
}
};
/**
* @const
* @type {Object.<string, Object.<string, module:ol/xml~Serializer>>}
@@ -707,7 +676,6 @@ GML2.prototype.GEOMETRY_SERIALIZERS_ = {
}
};
/**
* @type {Object.<string, Object.<string, module:ol/xml~Serializer>>}
* @private
@@ -721,7 +689,6 @@ GML2.prototype.LINESTRINGORCURVEMEMBER_SERIALIZERS_ = {
}
};
/**
* @type {Object.<string, Object.<string, module:ol/xml~Serializer>>}
* @private
@@ -733,7 +700,6 @@ GML2.prototype.RING_SERIALIZERS_ = {
}
};
/**
* @type {Object.<string, Object.<string, module:ol/xml~Serializer>>}
* @private
@@ -745,7 +711,6 @@ GML2.prototype.POINTMEMBER_SERIALIZERS_ = {
}
};
/**
* @const
* @type {Object.<string, Object.<string, module:ol/xml~Serializer>>}
@@ -760,7 +725,6 @@ GML2.prototype.SURFACEORPOLYGONMEMBER_SERIALIZERS_ = {
}
};
/**
* @type {Object.<string, Object.<string, module:ol/xml~Serializer>>}
* @private
src/ol/format/GML3.js
+604 -647
View File
File diff suppressed because it is too large Load Diff
src/ol/format/GMLBase.js
+101 -131
View File
@@ -4,7 +4,6 @@
// FIXME Envelopes should not be treated as geometries! readEnvelope_ is part
// of GEOMETRY_PARSERS_ and methods using GEOMETRY_PARSERS_ do not expect
// envelopes/extents, only geometries!
import {inherits} from '../util.js';
import {extend} from '../array.js';
import Feature from '../Feature.js';
import {transformWithOptions} from '../format/Feature.js';
@@ -29,6 +28,20 @@ import {getAllTextContent, getAttributeNS, makeArrayPusher, makeReplacer, parseN
export const GMLNS = 'http://www.opengis.net/gml';
/**
* A regular expression that matches if a string only contains whitespace
* characters. It will e.g. match `''`, `' '`, `'\n'` etc. The non-breaking
* space (0xa0) is explicitly included as IE doesn't include it in its
* definition of `\s`.
*
* Information from `goog.string.isEmptyOrWhitespace`: https://github.com/google/closure-library/blob/e877b1e/closure/goog/string/string.js#L156-L160
*
* @const
* @type {RegExp}
*/
const ONLY_WHITESPACE_RE = /^[\s\xa0]*$/;
/**
* @typedef {Object} Options
* @property {Object.<string, string>|string} [featureNS] Feature
@@ -69,13 +82,16 @@ export const GMLNS = 'http://www.opengis.net/gml';
* This class cannot be instantiated, it contains only base content that
* is shared with versioned format classes GML2 and GML3.
*
* @constructor
* @abstract
* @param {module:ol/format/GMLBase~Options=} opt_options
* Optional configuration object.
* @extends {module:ol/format/XMLFeature}
*/
const GMLBase = function(opt_options) {
class GMLBase extends XMLFeature {
/**
* @param {module:ol/format/GMLBase~Options=} opt_options Optional configuration object.
*/
constructor(opt_options) {
super();
const options = /** @type {module:ol/format/GMLBase~Options} */ (opt_options ? opt_options : {});
/**
@@ -107,36 +123,18 @@ const GMLBase = function(opt_options) {
*/
this.FEATURE_COLLECTION_PARSERS = {};
this.FEATURE_COLLECTION_PARSERS[GMLNS] = {
'featureMember': makeReplacer(GMLBase.prototype.readFeaturesInternal),
'featureMembers': makeReplacer(GMLBase.prototype.readFeaturesInternal)
'featureMember': makeReplacer(this.readFeaturesInternal),
'featureMembers': makeReplacer(this.readFeaturesInternal)
};
XMLFeature.call(this);
};
}
inherits(GMLBase, XMLFeature);
/**
* A regular expression that matches if a string only contains whitespace
* characters. It will e.g. match `''`, `' '`, `'\n'` etc. The non-breaking
* space (0xa0) is explicitly included as IE doesn't include it in its
* definition of `\s`.
*
* Information from `goog.string.isEmptyOrWhitespace`: https://github.com/google/closure-library/blob/e877b1e/closure/goog/string/string.js#L156-L160
*
* @const
* @type {RegExp}
*/
const ONLY_WHITESPACE_RE = /^[\s\xa0]*$/;
/**
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {Array.<module:ol/Feature> | undefined} Features.
*/
GMLBase.prototype.readFeaturesInternal = function(node, objectStack) {
readFeaturesInternal(node, objectStack) {
const localName = node.localName;
let features = null;
if (localName == 'FeatureCollection') {
@@ -217,15 +215,14 @@ GMLBase.prototype.readFeaturesInternal = function(node, objectStack) {
features = [];
}
return features;
};
}
/**
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/geom/Geometry|undefined} Geometry.
*/
GMLBase.prototype.readGeometryElement = function(node, objectStack) {
readGeometryElement(node, objectStack) {
const context = /** @type {Object} */ (objectStack[0]);
context['srsName'] = node.firstElementChild.getAttribute('srsName');
context['srsDimension'] = node.firstElementChild.getAttribute('srsDimension');
@@ -238,15 +235,14 @@ GMLBase.prototype.readGeometryElement = function(node, objectStack) {
} else {
return undefined;
}
};
}
/**
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/Feature} Feature.
*/
GMLBase.prototype.readFeatureElement = function(node, objectStack) {
readFeatureElement(node, objectStack) {
let n;
const fid = node.getAttribute('fid') || getAttributeNS(node, GMLNS, 'id');
const values = {};
@@ -280,28 +276,26 @@ GMLBase.prototype.readFeatureElement = function(node, objectStack) {
feature.setId(fid);
}
return feature;
};
}
/**
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/geom/Point|undefined} Point.
*/
GMLBase.prototype.readPoint = function(node, objectStack) {
readPoint(node, objectStack) {
const flatCoordinates = this.readFlatCoordinatesFromNode_(node, objectStack);
if (flatCoordinates) {
return new Point(flatCoordinates, GeometryLayout.XYZ);
}
};
}
/**
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/geom/MultiPoint|undefined} MultiPoint.
*/
GMLBase.prototype.readMultiPoint = function(node, objectStack) {
readMultiPoint(node, objectStack) {
/** @type {Array.<Array.<number>>} */
const coordinates = pushParseAndPop([],
this.MULTIPOINT_PARSERS_, node, objectStack, this);
@@ -310,74 +304,68 @@ GMLBase.prototype.readMultiPoint = function(node, objectStack) {
} else {
return undefined;
}
};
}
/**
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/geom/MultiLineString|undefined} MultiLineString.
*/
GMLBase.prototype.readMultiLineString = function(node, objectStack) {
readMultiLineString(node, objectStack) {
/** @type {Array.<module:ol/geom/LineString>} */
const lineStrings = pushParseAndPop([],
this.MULTILINESTRING_PARSERS_, node, objectStack, this);
if (lineStrings) {
return new MultiLineString(lineStrings);
}
};
}
/**
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/geom/MultiPolygon|undefined} MultiPolygon.
*/
GMLBase.prototype.readMultiPolygon = function(node, objectStack) {
readMultiPolygon(node, objectStack) {
/** @type {Array.<module:ol/geom/Polygon>} */
const polygons = pushParseAndPop([], this.MULTIPOLYGON_PARSERS_, node, objectStack, this);
if (polygons) {
return new MultiPolygon(polygons);
}
};
}
/**
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @private
*/
GMLBase.prototype.pointMemberParser_ = function(node, objectStack) {
pointMemberParser_(node, objectStack) {
parseNode(this.POINTMEMBER_PARSERS_, node, objectStack, this);
};
}
/**
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @private
*/
GMLBase.prototype.lineStringMemberParser_ = function(node, objectStack) {
lineStringMemberParser_(node, objectStack) {
parseNode(this.LINESTRINGMEMBER_PARSERS_, node, objectStack, this);
};
}
/**
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @private
*/
GMLBase.prototype.polygonMemberParser_ = function(node, objectStack) {
polygonMemberParser_(node, objectStack) {
parseNode(this.POLYGONMEMBER_PARSERS_, node, objectStack, this);
};
}
/**
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/geom/LineString|undefined} LineString.
*/
GMLBase.prototype.readLineString = function(node, objectStack) {
readLineString(node, objectStack) {
const flatCoordinates = this.readFlatCoordinatesFromNode_(node, objectStack);
if (flatCoordinates) {
const lineString = new LineString(flatCoordinates, GeometryLayout.XYZ);
@@ -385,16 +373,15 @@ GMLBase.prototype.readLineString = function(node, objectStack) {
} else {
return undefined;
}
};
}
/**
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @private
* @return {Array.<number>|undefined} LinearRing flat coordinates.
*/
GMLBase.prototype.readFlatLinearRing_ = function(node, objectStack) {
readFlatLinearRing_(node, objectStack) {
const ring = pushParseAndPop(null,
this.GEOMETRY_FLAT_COORDINATES_PARSERS_, node,
objectStack, this);
@@ -403,28 +390,26 @@ GMLBase.prototype.readFlatLinearRing_ = function(node, objectStack) {
} else {
return undefined;
}
};
}
/**
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/geom/LinearRing|undefined} LinearRing.
*/
GMLBase.prototype.readLinearRing = function(node, objectStack) {
readLinearRing(node, objectStack) {
const flatCoordinates = this.readFlatCoordinatesFromNode_(node, objectStack);
if (flatCoordinates) {
return new LinearRing(flatCoordinates, GeometryLayout.XYZ);
}
};
}
/**
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/geom/Polygon|undefined} Polygon.
*/
GMLBase.prototype.readPolygon = function(node, objectStack) {
readPolygon(node, objectStack) {
/** @type {Array.<Array.<number>>} */
const flatLinearRings = pushParseAndPop([null],
this.FLAT_LINEAR_RINGS_PARSERS_, node, objectStack, this);
@@ -440,19 +425,49 @@ GMLBase.prototype.readPolygon = function(node, objectStack) {
} else {
return undefined;
}
};
}
/**
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @private
* @return {Array.<number>} Flat coordinates.
*/
GMLBase.prototype.readFlatCoordinatesFromNode_ = function(node, objectStack) {
readFlatCoordinatesFromNode_(node, objectStack) {
return pushParseAndPop(null, this.GEOMETRY_FLAT_COORDINATES_PARSERS_, node, objectStack, this);
};
}
/**
* @inheritDoc
*/
readGeometryFromNode(node, opt_options) {
const geometry = this.readGeometryElement(node,
[this.getReadOptions(node, opt_options ? opt_options : {})]);
return geometry ? geometry : null;
}
/**
* @inheritDoc
*/
readFeaturesFromNode(node, opt_options) {
const options = {
featureType: this.featureType,
featureNS: this.featureNS
};
if (opt_options) {
assign(options, this.getReadOptions(node, opt_options));
}
const features = this.readFeaturesInternal(node, [options]);
return features || [];
}
/**
* @inheritDoc
*/
readProjectionFromNode(node) {
return getProjection(this.srsName ? this.srsName : node.firstElementChild.getAttribute('srsName'));
}
}
/**
* @const
@@ -540,49 +555,4 @@ GMLBase.prototype.RING_PARSERS = {
}
};
/**
* @inheritDoc
*/
GMLBase.prototype.readGeometryFromNode = function(node, opt_options) {
const geometry = this.readGeometryElement(node,
[this.getReadOptions(node, opt_options ? opt_options : {})]);
return geometry ? geometry : null;
};
/**
* Read all features from a GML FeatureCollection.
*
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Options.
* @return {Array.<module:ol/Feature>} Features.
* @api
*/
GMLBase.prototype.readFeatures;
/**
* @inheritDoc
*/
GMLBase.prototype.readFeaturesFromNode = function(node, opt_options) {
const options = {
featureType: this.featureType,
featureNS: this.featureNS
};
if (opt_options) {
assign(options, this.getReadOptions(node, opt_options));
}
const features = this.readFeaturesInternal(node, [options]);
return features || [];
};
/**
* @inheritDoc
*/
GMLBase.prototype.readProjectionFromNode = function(node) {
return getProjection(this.srsName ? this.srsName : node.firstElementChild.getAttribute('srsName'));
};
export default GMLBase;
src/ol/format/GPX.js
+153 -198
View File
@@ -1,7 +1,6 @@
/**
* @module ol/format/GPX
*/
import {inherits} from '../util.js';
import Feature from '../Feature.js';
import {includes} from '../array.js';
import {transformWithOptions} from '../format/Feature.js';
@@ -18,52 +17,6 @@ import {createElementNS, makeArrayPusher, makeArraySerializer, makeChildAppender
XML_SCHEMA_INSTANCE_URI} from '../xml.js';
/**
* @typedef {Object} Options
* @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`
* nodes from `wpt`, `rte` and `trk` can be processed, as those are
* directly mapped to a feature.
*/
/**
* @typedef {Object} LayoutOptions
* @property {boolean} [hasZ]
* @property {boolean} [hasM]
*/
/**
* @classdesc
* Feature format for reading and writing data in the GPX format.
*
* @constructor
* @extends {module:ol/format/XMLFeature}
* @param {module:ol/format/GPX~Options=} opt_options Options.
* @api
*/
const GPX = function(opt_options) {
const options = opt_options ? opt_options : {};
XMLFeature.call(this);
/**
* @inheritDoc
*/
this.dataProjection = getProjection('EPSG:4326');
/**
* @type {function(module:ol/Feature, Node)|undefined}
* @private
*/
this.readExtensions_ = options.readExtensions;
};
inherits(GPX, XMLFeature);
/**
* @const
* @type {Array.<null|string>}
@@ -117,6 +70,159 @@ const LINK_PARSERS = makeStructureNS(
});
/**
* @const
* @type {Object.<string, Object.<string, module:ol/xml~Serializer>>}
*/
const GPX_SERIALIZERS = makeStructureNS(
NAMESPACE_URIS, {
'rte': makeChildAppender(writeRte),
'trk': makeChildAppender(writeTrk),
'wpt': makeChildAppender(writeWpt)
});
/**
* @typedef {Object} Options
* @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`
* nodes from `wpt`, `rte` and `trk` can be processed, as those are
* directly mapped to a feature.
*/
/**
* @typedef {Object} LayoutOptions
* @property {boolean} [hasZ]
* @property {boolean} [hasM]
*/
/**
* @classdesc
* Feature format for reading and writing data in the GPX format.
*
* Note that {@link module:ol/format/GPX~GPX#readFeature} only reads the first
* feature of the source.
*
* When reading, routes (`<rte>`) are converted into LineString geometries, and
* tracks (`<trk>`) into MultiLineString. Any properties on route and track
* waypoints are ignored.
*
* When writing, LineString geometries are output as routes (`<rte>`), and
* MultiLineString as tracks (`<trk>`).
*
* @api
*/
class GPX extends XMLFeature {
/**
* @param {module:ol/format/GPX~Options=} opt_options Options.
*/
constructor(opt_options) {
super();
const options = opt_options ? opt_options : {};
/**
* @inheritDoc
*/
this.dataProjection = getProjection('EPSG:4326');
/**
* @type {function(module:ol/Feature, Node)|undefined}
* @private
*/
this.readExtensions_ = options.readExtensions;
}
/**
* @param {Array.<module:ol/Feature>} features List of features.
* @private
*/
handleReadExtensions_(features) {
if (!features) {
features = [];
}
for (let i = 0, ii = features.length; i < ii; ++i) {
const feature = features[i];
if (this.readExtensions_) {
const extensionsNode = feature.get('extensionsNode_') || null;
this.readExtensions_(feature, extensionsNode);
}
feature.set('extensionsNode_', undefined);
}
}
/**
* @inheritDoc
*/
readFeatureFromNode(node, opt_options) {
if (!includes(NAMESPACE_URIS, node.namespaceURI)) {
return null;
}
const featureReader = FEATURE_READER[node.localName];
if (!featureReader) {
return null;
}
const feature = featureReader(node, [this.getReadOptions(node, opt_options)]);
if (!feature) {
return null;
}
this.handleReadExtensions_([feature]);
return feature;
}
/**
* @inheritDoc
*/
readFeaturesFromNode(node, opt_options) {
if (!includes(NAMESPACE_URIS, node.namespaceURI)) {
return [];
}
if (node.localName == 'gpx') {
/** @type {Array.<module:ol/Feature>} */
const features = pushParseAndPop([], GPX_PARSERS,
node, [this.getReadOptions(node, opt_options)]);
if (features) {
this.handleReadExtensions_(features);
return features;
} else {
return [];
}
}
return [];
}
/**
* Encode an array of features in the GPX format as an XML node.
* LineString geometries are output as routes (`<rte>`), and MultiLineString
* as tracks (`<trk>`).
*
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Options.
* @return {Node} Node.
* @override
* @api
*/
writeFeaturesNode(features, opt_options) {
opt_options = this.adaptOptions(opt_options);
//FIXME Serialize metadata
const gpx = createElementNS('http://www.topografix.com/GPX/1/1', 'gpx');
const xmlnsUri = 'http://www.w3.org/2000/xmlns/';
gpx.setAttributeNS(xmlnsUri, 'xmlns:xsi', XML_SCHEMA_INSTANCE_URI);
gpx.setAttributeNS(XML_SCHEMA_INSTANCE_URI, 'xsi:schemaLocation', SCHEMA_LOCATION);
gpx.setAttribute('version', '1.1');
gpx.setAttribute('creator', 'OpenLayers');
pushSerializeAndPop(/** @type {module:ol/xml~NodeStackItem} */
({node: gpx}), GPX_SERIALIZERS, GPX_NODE_FACTORY, features, [opt_options]);
return gpx;
}
}
/**
* @const
* @type {Object.<string, Object.<string, module:ol/xml~Parser>>}
@@ -380,18 +486,6 @@ function GPX_NODE_FACTORY(value, objectStack, opt_nodeName) {
}
/**
* @const
* @type {Object.<string, Object.<string, module:ol/xml~Serializer>>}
*/
const GPX_SERIALIZERS = makeStructureNS(
NAMESPACE_URIS, {
'rte': makeChildAppender(writeRte),
'trk': makeChildAppender(writeTrk),
'wpt': makeChildAppender(writeWpt)
});
/**
* @param {Array.<number>} flatCoordinates Flat coordinates.
* @param {module:ol/format/GPX~LayoutOptions} layoutOptions Layout options.
@@ -614,106 +708,6 @@ function readWpt(node, objectStack) {
}
/**
* @param {Array.<module:ol/Feature>} features List of features.
* @private
*/
GPX.prototype.handleReadExtensions_ = function(features) {
if (!features) {
features = [];
}
for (let i = 0, ii = features.length; i < ii; ++i) {
const feature = features[i];
if (this.readExtensions_) {
const extensionsNode = feature.get('extensionsNode_') || null;
this.readExtensions_(feature, extensionsNode);
}
feature.set('extensionsNode_', undefined);
}
};
/**
* Read the first feature from a GPX source.
* Routes (`<rte>`) are converted into LineString geometries, and tracks (`<trk>`)
* into MultiLineString. Any properties on route and track waypoints are ignored.
*
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/Feature} Feature.
* @api
*/
GPX.prototype.readFeature;
/**
* @inheritDoc
*/
GPX.prototype.readFeatureFromNode = function(node, opt_options) {
if (!includes(NAMESPACE_URIS, node.namespaceURI)) {
return null;
}
const featureReader = FEATURE_READER[node.localName];
if (!featureReader) {
return null;
}
const feature = featureReader(node, [this.getReadOptions(node, opt_options)]);
if (!feature) {
return null;
}
this.handleReadExtensions_([feature]);
return feature;
};
/**
* Read all features from a GPX source.
* Routes (`<rte>`) are converted into LineString geometries, and tracks (`<trk>`)
* into MultiLineString. Any properties on route and track waypoints are ignored.
*
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {Array.<module:ol/Feature>} Features.
* @api
*/
GPX.prototype.readFeatures;
/**
* @inheritDoc
*/
GPX.prototype.readFeaturesFromNode = function(node, opt_options) {
if (!includes(NAMESPACE_URIS, node.namespaceURI)) {
return [];
}
if (node.localName == 'gpx') {
/** @type {Array.<module:ol/Feature>} */
const features = pushParseAndPop([], GPX_PARSERS,
node, [this.getReadOptions(node, opt_options)]);
if (features) {
this.handleReadExtensions_(features);
return features;
} else {
return [];
}
}
return [];
};
/**
* Read the projection from a GPX source.
*
* @function
* @param {Document|Node|Object|string} source Source.
* @return {module:ol/proj/Projection} Projection.
* @api
*/
GPX.prototype.readProjection;
/**
* @param {Node} node Node.
* @param {string} value Value for the link's `href` attribute.
@@ -860,43 +854,4 @@ function writeWpt(node, feature, objectStack) {
}
/**
* Encode an array of features in the GPX format.
* LineString geometries are output as routes (`<rte>`), and MultiLineString
* as tracks (`<trk>`).
*
* @function
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} Result.
* @api
*/
GPX.prototype.writeFeatures;
/**
* Encode an array of features in the GPX format as an XML node.
* LineString geometries are output as routes (`<rte>`), and MultiLineString
* as tracks (`<trk>`).
*
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Options.
* @return {Node} Node.
* @override
* @api
*/
GPX.prototype.writeFeaturesNode = function(features, opt_options) {
opt_options = this.adaptOptions(opt_options);
//FIXME Serialize metadata
const gpx = createElementNS('http://www.topografix.com/GPX/1/1', 'gpx');
const xmlnsUri = 'http://www.w3.org/2000/xmlns/';
gpx.setAttributeNS(xmlnsUri, 'xmlns:xsi', XML_SCHEMA_INSTANCE_URI);
gpx.setAttributeNS(XML_SCHEMA_INSTANCE_URI, 'xsi:schemaLocation', SCHEMA_LOCATION);
gpx.setAttribute('version', '1.1');
gpx.setAttribute('creator', 'OpenLayers');
pushSerializeAndPop(/** @type {module:ol/xml~NodeStackItem} */
({node: gpx}), GPX_SERIALIZERS, GPX_NODE_FACTORY, features, [opt_options]);
return gpx;
};
export default GPX;
src/ol/format/GeoJSON.js
+159 -253
View File
@@ -4,7 +4,6 @@
// TODO: serialize dataProjection as crs member when writing
// see https://github.com/openlayers/openlayers/issues/2078
import {inherits} from '../util.js';
import {assert} from '../asserts.js';
import Feature from '../Feature.js';
import {transformWithOptions} from '../format/Feature.js';
@@ -37,16 +36,18 @@ import {get as getProjection} from '../proj.js';
* @classdesc
* Feature format for reading and writing data in the GeoJSON format.
*
* @constructor
* @extends {module:ol/format/JSONFeature}
* @param {module:ol/format/GeoJSON~Options=} opt_options Options.
* @api
*/
const GeoJSON = function(opt_options) {
class GeoJSON extends JSONFeature {
/**
* @param {module:ol/format/GeoJSON~Options=} opt_options Options.
*/
constructor(opt_options) {
const options = opt_options ? opt_options : {};
JSONFeature.call(this);
super();
/**
* @inheritDoc
@@ -73,9 +74,159 @@ const GeoJSON = function(opt_options) {
*/
this.extractGeometryName_ = options.extractGeometryName;
};
}
inherits(GeoJSON, JSONFeature);
/**
* @inheritDoc
*/
readFeatureFromObject(object, opt_options) {
/**
* @type {GeoJSONFeature}
*/
let geoJSONFeature = null;
if (object.type === 'Feature') {
geoJSONFeature = /** @type {GeoJSONFeature} */ (object);
} else {
geoJSONFeature = /** @type {GeoJSONFeature} */ ({
type: 'Feature',
geometry: /** @type {GeoJSONGeometry|GeoJSONGeometryCollection} */ (object)
});
}
const geometry = readGeometry(geoJSONFeature.geometry, opt_options);
const feature = new Feature();
if (this.geometryName_) {
feature.setGeometryName(this.geometryName_);
} else if (this.extractGeometryName_ && geoJSONFeature.geometry_name !== undefined) {
feature.setGeometryName(geoJSONFeature.geometry_name);
}
feature.setGeometry(geometry);
if (geoJSONFeature.id !== undefined) {
feature.setId(geoJSONFeature.id);
}
if (geoJSONFeature.properties) {
feature.setProperties(geoJSONFeature.properties);
}
return feature;
}
/**
* @inheritDoc
*/
readFeaturesFromObject(object, opt_options) {
const geoJSONObject = /** @type {GeoJSONObject} */ (object);
/** @type {Array.<module:ol/Feature>} */
let features = null;
if (geoJSONObject.type === 'FeatureCollection') {
const geoJSONFeatureCollection = /** @type {GeoJSONFeatureCollection} */ (object);
features = [];
const geoJSONFeatures = geoJSONFeatureCollection.features;
for (let i = 0, ii = geoJSONFeatures.length; i < ii; ++i) {
features.push(this.readFeatureFromObject(geoJSONFeatures[i], opt_options));
}
} else {
features = [this.readFeatureFromObject(object, opt_options)];
}
return features;
}
/**
* @inheritDoc
*/
readGeometryFromObject(object, opt_options) {
return readGeometry(/** @type {GeoJSONGeometry} */ (object), opt_options);
}
/**
* @inheritDoc
*/
readProjectionFromObject(object) {
const geoJSONObject = /** @type {GeoJSONObject} */ (object);
const crs = geoJSONObject.crs;
let projection;
if (crs) {
if (crs.type == 'name') {
projection = getProjection(crs.properties.name);
} else {
assert(false, 36); // Unknown SRS type
}
} else {
projection = this.dataProjection;
}
return (
/** @type {module:ol/proj/Projection} */ (projection)
);
}
/**
* Encode a feature as a GeoJSON Feature object.
*
* @param {module:ol/Feature} feature Feature.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {GeoJSONFeature} Object.
* @override
* @api
*/
writeFeatureObject(feature, opt_options) {
opt_options = this.adaptOptions(opt_options);
const object = /** @type {GeoJSONFeature} */ ({
'type': 'Feature'
});
const id = feature.getId();
if (id !== undefined) {
object.id = id;
}
const geometry = feature.getGeometry();
if (geometry) {
object.geometry = writeGeometry(geometry, opt_options);
} else {
object.geometry = null;
}
const properties = feature.getProperties();
delete properties[feature.getGeometryName()];
if (!isEmpty(properties)) {
object.properties = properties;
} else {
object.properties = null;
}
return object;
}
/**
* Encode an array of features as a GeoJSON object.
*
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {GeoJSONFeatureCollection} GeoJSON Object.
* @override
* @api
*/
writeFeaturesObject(features, opt_options) {
opt_options = this.adaptOptions(opt_options);
const objects = [];
for (let i = 0, ii = features.length; i < ii; ++i) {
objects.push(this.writeFeatureObject(features[i], opt_options));
}
return /** @type {GeoJSONFeatureCollection} */ ({
type: 'FeatureCollection',
features: objects
});
}
/**
* Encode a geometry as a GeoJSON object.
*
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {GeoJSONGeometry|GeoJSONGeometryCollection} Object.
* @override
* @api
*/
writeGeometryObject(geometry, opt_options) {
return writeGeometry(geometry, this.adaptOptions(opt_options));
}
}
/**
@@ -325,249 +476,4 @@ function writePolygonGeometry(geometry, opt_options) {
}
/**
* Read a feature from a GeoJSON Feature source. Only works for Feature or
* geometry types. Use {@link module: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#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.
* @api
*/
GeoJSON.prototype.readFeature;
/**
* Read all features from a GeoJSON source. Works for all GeoJSON types.
* If the source includes only geometries, features will be created with those
* geometries.
*
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {Array.<module:ol/Feature>} Features.
* @api
*/
GeoJSON.prototype.readFeatures;
/**
* @inheritDoc
*/
GeoJSON.prototype.readFeatureFromObject = function(object, opt_options) {
/**
* @type {GeoJSONFeature}
*/
let geoJSONFeature = null;
if (object.type === 'Feature') {
geoJSONFeature = /** @type {GeoJSONFeature} */ (object);
} else {
geoJSONFeature = /** @type {GeoJSONFeature} */ ({
type: 'Feature',
geometry: /** @type {GeoJSONGeometry|GeoJSONGeometryCollection} */ (object)
});
}
const geometry = readGeometry(geoJSONFeature.geometry, opt_options);
const feature = new Feature();
if (this.geometryName_) {
feature.setGeometryName(this.geometryName_);
} else if (this.extractGeometryName_ && geoJSONFeature.geometry_name !== undefined) {
feature.setGeometryName(geoJSONFeature.geometry_name);
}
feature.setGeometry(geometry);
if (geoJSONFeature.id !== undefined) {
feature.setId(geoJSONFeature.id);
}
if (geoJSONFeature.properties) {
feature.setProperties(geoJSONFeature.properties);
}
return feature;
};
/**
* @inheritDoc
*/
GeoJSON.prototype.readFeaturesFromObject = function(object, opt_options) {
const geoJSONObject = /** @type {GeoJSONObject} */ (object);
/** @type {Array.<module:ol/Feature>} */
let features = null;
if (geoJSONObject.type === 'FeatureCollection') {
const geoJSONFeatureCollection = /** @type {GeoJSONFeatureCollection} */ (object);
features = [];
const geoJSONFeatures = geoJSONFeatureCollection.features;
for (let i = 0, ii = geoJSONFeatures.length; i < ii; ++i) {
features.push(this.readFeatureFromObject(geoJSONFeatures[i], opt_options));
}
} else {
features = [this.readFeatureFromObject(object, opt_options)];
}
return features;
};
/**
* Read a geometry from a GeoJSON source.
*
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/geom/Geometry} Geometry.
* @api
*/
GeoJSON.prototype.readGeometry;
/**
* @inheritDoc
*/
GeoJSON.prototype.readGeometryFromObject = function(object, opt_options) {
return readGeometry(/** @type {GeoJSONGeometry} */ (object), opt_options);
};
/**
* Read the projection from a GeoJSON source.
*
* @function
* @param {Document|Node|Object|string} source Source.
* @return {module:ol/proj/Projection} Projection.
* @api
*/
GeoJSON.prototype.readProjection;
/**
* @inheritDoc
*/
GeoJSON.prototype.readProjectionFromObject = function(object) {
const geoJSONObject = /** @type {GeoJSONObject} */ (object);
const crs = geoJSONObject.crs;
let projection;
if (crs) {
if (crs.type == 'name') {
projection = getProjection(crs.properties.name);
} else {
assert(false, 36); // Unknown SRS type
}
} else {
projection = this.dataProjection;
}
return (
/** @type {module:ol/proj/Projection} */ (projection)
);
};
/**
* Encode a feature as a GeoJSON Feature string.
*
* @function
* @param {module:ol/Feature} feature Feature.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} GeoJSON.
* @override
* @api
*/
GeoJSON.prototype.writeFeature;
/**
* Encode a feature as a GeoJSON Feature object.
*
* @param {module:ol/Feature} feature Feature.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {GeoJSONFeature} Object.
* @override
* @api
*/
GeoJSON.prototype.writeFeatureObject = function(feature, opt_options) {
opt_options = this.adaptOptions(opt_options);
const object = /** @type {GeoJSONFeature} */ ({
'type': 'Feature'
});
const id = feature.getId();
if (id !== undefined) {
object.id = id;
}
const geometry = feature.getGeometry();
if (geometry) {
object.geometry = writeGeometry(geometry, opt_options);
} else {
object.geometry = null;
}
const properties = feature.getProperties();
delete properties[feature.getGeometryName()];
if (!isEmpty(properties)) {
object.properties = properties;
} else {
object.properties = null;
}
return object;
};
/**
* Encode an array of features as GeoJSON.
*
* @function
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} GeoJSON.
* @api
*/
GeoJSON.prototype.writeFeatures;
/**
* Encode an array of features as a GeoJSON object.
*
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {GeoJSONFeatureCollection} GeoJSON Object.
* @override
* @api
*/
GeoJSON.prototype.writeFeaturesObject = function(features, opt_options) {
opt_options = this.adaptOptions(opt_options);
const objects = [];
for (let i = 0, ii = features.length; i < ii; ++i) {
objects.push(this.writeFeatureObject(features[i], opt_options));
}
return /** @type {GeoJSONFeatureCollection} */ ({
type: 'FeatureCollection',
features: objects
});
};
/**
* Encode a geometry as a GeoJSON string.
*
* @function
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} GeoJSON.
* @api
*/
GeoJSON.prototype.writeGeometry;
/**
* Encode a geometry as a GeoJSON object.
*
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {GeoJSONGeometry|GeoJSONGeometryCollection} Object.
* @override
* @api
*/
GeoJSON.prototype.writeGeometryObject = function(geometry, opt_options) {
return writeGeometry(geometry, this.adaptOptions(opt_options));
};
export default GeoJSON;
src/ol/format/IGC.js
+50 -89
View File
@@ -1,7 +1,6 @@
/**
* @module ol/format/IGC
*/
import {inherits} from '../util.js';
import Feature from '../Feature.js';
import {transformWithOptions} from '../format/Feature.js';
import TextFeature from '../format/TextFeature.js';
@@ -19,44 +18,6 @@ const IGCZ = {
NONE: 'none'
};
/**
* @typedef {Object} Options
* @property {IGCZ|string} [altitudeMode='none'] Altitude mode. Possible
* values are `'barometric'`, `'gps'`, and `'none'`.
*/
/**
* @classdesc
* Feature format for `*.igc` flight recording files.
*
* @constructor
* @extends {module:ol/format/TextFeature}
* @param {module:ol/format/IGC~Options=} opt_options Options.
* @api
*/
const IGC = function(opt_options) {
const options = opt_options ? opt_options : {};
TextFeature.call(this);
/**
* @inheritDoc
*/
this.dataProjection = getProjection('EPSG:4326');
/**
* @private
* @type {IGCZ}
*/
this.altitudeMode_ = options.altitudeMode ? options.altitudeMode : IGCZ.NONE;
};
inherits(IGC, TextFeature);
/**
* @const
* @type {RegExp}
@@ -89,21 +50,48 @@ const NEWLINE_RE = /\r\n|\r|\n/;
/**
* Read the feature from the IGC source.
*
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/Feature} Feature.
* @api
* @typedef {Object} Options
* @property {IGCZ|string} [altitudeMode='none'] Altitude mode. Possible
* values are `'barometric'`, `'gps'`, and `'none'`.
*/
IGC.prototype.readFeature;
/**
* @classdesc
* Feature format for `*.igc` flight recording files.
*
* As IGC sources contain a single feature,
* {@link module:ol/format/IGC~IGC#readFeatures} will return the feature in an
* array
*
* @api
*/
class IGC extends TextFeature {
/**
* @param {module:ol/format/IGC~Options=} opt_options Options.
*/
constructor(opt_options) {
super();
const options = opt_options ? opt_options : {};
/**
* @inheritDoc
*/
IGC.prototype.readFeatureFromText = function(text, opt_options) {
this.dataProjection = getProjection('EPSG:4326');
/**
* @private
* @type {IGCZ}
*/
this.altitudeMode_ = options.altitudeMode ? options.altitudeMode : IGCZ.NONE;
}
/**
* @inheritDoc
*/
readFeatureFromText(text, opt_options) {
const altitudeMode = this.altitudeMode_;
const lines = text.split(NEWLINE_RE);
/** @type {Object.<string, string>} */
@@ -173,70 +161,43 @@ IGC.prototype.readFeatureFromText = function(text, opt_options) {
const feature = new Feature(transformWithOptions(lineString, false, opt_options));
feature.setProperties(properties);
return feature;
};
}
/**
* Read the feature from the source. As IGC sources contain a single
* feature, this will return the feature in an array.
*
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {Array.<module:ol/Feature>} Features.
* @api
*/
IGC.prototype.readFeatures;
/**
/**
* @inheritDoc
*/
IGC.prototype.readFeaturesFromText = function(text, opt_options) {
readFeaturesFromText(text, opt_options) {
const feature = this.readFeatureFromText(text, opt_options);
if (feature) {
return [feature];
} else {
return [];
}
};
}
/**
* Read the projection from the IGC source.
*
* @function
* @param {Document|Node|Object|string} source Source.
* @return {module:ol/proj/Projection} Projection.
* @api
*/
IGC.prototype.readProjection;
/**
/**
* Not implemented.
* @inheritDoc
*/
IGC.prototype.writeFeatureText = function(feature, opt_options) {};
writeFeatureText(feature, opt_options) {}
/**
/**
* Not implemented.
* @inheritDoc
*/
IGC.prototype.writeFeaturesText = function(features, opt_options) {};
writeFeaturesText(features, opt_options) {}
/**
/**
* Not implemented.
* @inheritDoc
*/
IGC.prototype.writeGeometryText = function(geometry, opt_options) {};
writeGeometryText(geometry, opt_options) {}
/**
/**
* Not implemented.
* @inheritDoc
*/
IGC.prototype.readGeometryFromText = function(text, opt_options) {};
readGeometryFromText(text, opt_options) {}
}
export default IGC;
src/ol/format/JSONFeature.js
+158 -138
View File
@@ -1,7 +1,6 @@
/**
* @module ol/format/JSONFeature
*/
import {inherits} from '../util.js';
import FeatureFormat from '../format/Feature.js';
import FormatType from '../format/FormatType.js';
@@ -11,15 +10,167 @@ import FormatType from '../format/FormatType.js';
* instantiated in apps.
* Base class for JSON feature formats.
*
* @constructor
* @abstract
* @extends {module:ol/format/Feature}
*/
const JSONFeature = function() {
FeatureFormat.call(this);
};
class JSONFeature extends FeatureFormat {
constructor() {
super();
}
inherits(JSONFeature, FeatureFormat);
/**
* @inheritDoc
*/
getType() {
return FormatType.JSON;
}
/**
* Read a feature. Only works for a single feature. Use `readFeatures` to
* read a feature collection.
*
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/Feature} Feature.
* @api
*/
readFeature(source, opt_options) {
return this.readFeatureFromObject(
getObject(source), this.getReadOptions(source, opt_options));
}
/**
* Read all features. Works with both a single feature and a feature
* collection.
*
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {Array.<module:ol/Feature>} Features.
* @api
*/
readFeatures(source, opt_options) {
return this.readFeaturesFromObject(
getObject(source), this.getReadOptions(source, opt_options));
}
/**
* @abstract
* @param {Object} object Object.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @protected
* @return {module:ol/Feature} Feature.
*/
readFeatureFromObject(object, opt_options) {}
/**
* @abstract
* @param {Object} object Object.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @protected
* @return {Array.<module:ol/Feature>} Features.
*/
readFeaturesFromObject(object, opt_options) {}
/**
* Read a geometry.
*
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/geom/Geometry} Geometry.
* @api
*/
readGeometry(source, opt_options) {
return this.readGeometryFromObject(
getObject(source), this.getReadOptions(source, opt_options));
}
/**
* @abstract
* @param {Object} object Object.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @protected
* @return {module:ol/geom/Geometry} Geometry.
*/
readGeometryFromObject(object, opt_options) {}
/**
* Read the projection.
*
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {module:ol/proj/Projection} Projection.
* @api
*/
readProjection(source) {
return this.readProjectionFromObject(getObject(source));
}
/**
* @abstract
* @param {Object} object Object.
* @protected
* @return {module:ol/proj/Projection} Projection.
*/
readProjectionFromObject(object) {}
/**
* Encode a feature as string.
*
* @param {module:ol/Feature} feature Feature.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} Encoded feature.
* @api
*/
writeFeature(feature, opt_options) {
return JSON.stringify(this.writeFeatureObject(feature, opt_options));
}
/**
* @abstract
* @param {module:ol/Feature} feature Feature.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {Object} Object.
*/
writeFeatureObject(feature, opt_options) {}
/**
* Encode an array of features as string.
*
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} Encoded features.
* @api
*/
writeFeatures(features, opt_options) {
return JSON.stringify(this.writeFeaturesObject(features, opt_options));
}
/**
* @abstract
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {Object} Object.
*/
writeFeaturesObject(features, opt_options) {}
/**
* Encode a geometry as string.
*
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} Encoded geometry.
* @api
*/
writeGeometry(geometry, opt_options) {
return JSON.stringify(this.writeGeometryObject(geometry, opt_options));
}
/**
* @abstract
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {Object} Object.
*/
writeGeometryObject(geometry, opt_options) {}
}
/**
@@ -38,135 +189,4 @@ function getObject(source) {
}
/**
* @inheritDoc
*/
JSONFeature.prototype.getType = function() {
return FormatType.JSON;
};
/**
* @inheritDoc
*/
JSONFeature.prototype.readFeature = function(source, opt_options) {
return this.readFeatureFromObject(
getObject(source), this.getReadOptions(source, opt_options));
};
/**
* @inheritDoc
*/
JSONFeature.prototype.readFeatures = function(source, opt_options) {
return this.readFeaturesFromObject(
getObject(source), this.getReadOptions(source, opt_options));
};
/**
* @abstract
* @param {Object} object Object.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @protected
* @return {module:ol/Feature} Feature.
*/
JSONFeature.prototype.readFeatureFromObject = function(object, opt_options) {};
/**
* @abstract
* @param {Object} object Object.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @protected
* @return {Array.<module:ol/Feature>} Features.
*/
JSONFeature.prototype.readFeaturesFromObject = function(object, opt_options) {};
/**
* @inheritDoc
*/
JSONFeature.prototype.readGeometry = function(source, opt_options) {
return this.readGeometryFromObject(
getObject(source), this.getReadOptions(source, opt_options));
};
/**
* @abstract
* @param {Object} object Object.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @protected
* @return {module:ol/geom/Geometry} Geometry.
*/
JSONFeature.prototype.readGeometryFromObject = function(object, opt_options) {};
/**
* @inheritDoc
*/
JSONFeature.prototype.readProjection = function(source) {
return this.readProjectionFromObject(getObject(source));
};
/**
* @abstract
* @param {Object} object Object.
* @protected
* @return {module:ol/proj/Projection} Projection.
*/
JSONFeature.prototype.readProjectionFromObject = function(object) {};
/**
* @inheritDoc
*/
JSONFeature.prototype.writeFeature = function(feature, opt_options) {
return JSON.stringify(this.writeFeatureObject(feature, opt_options));
};
/**
* @abstract
* @param {module:ol/Feature} feature Feature.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {Object} Object.
*/
JSONFeature.prototype.writeFeatureObject = function(feature, opt_options) {};
/**
* @inheritDoc
*/
JSONFeature.prototype.writeFeatures = function(features, opt_options) {
return JSON.stringify(this.writeFeaturesObject(features, opt_options));
};
/**
* @abstract
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {Object} Object.
*/
JSONFeature.prototype.writeFeaturesObject = function(features, opt_options) {};
/**
* @inheritDoc
*/
JSONFeature.prototype.writeGeometry = function(geometry, opt_options) {
return JSON.stringify(this.writeGeometryObject(geometry, opt_options));
};
/**
* @abstract
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {Object} Object.
*/
JSONFeature.prototype.writeGeometryObject = function(geometry, opt_options) {};
export default JSONFeature;
src/ol/format/KML.js
+542 -603
View File
File diff suppressed because it is too large Load Diff
src/ol/format/MVT.js
+227 -237
View File
@@ -3,7 +3,6 @@
*/
//FIXME Implement projection handling
import {inherits} from '../util.js';
import {assert} from '../asserts.js';
import PBF from 'pbf';
import FeatureFormat, {transformWithOptions} from '../format/Feature.js';
@@ -42,14 +41,16 @@ import RenderFeature from '../render/Feature.js';
* @classdesc
* Feature format for reading data in the Mapbox MVT format.
*
* @constructor
* @extends {module:ol/format/Feature}
* @param {module:ol/format/MVT~Options=} opt_options Options.
* @api
*/
const MVT = function(opt_options) {
class MVT extends FeatureFormat {
FeatureFormat.call(this);
/**
* @param {module:ol/format/MVT~Options=} opt_options Options.
*/
constructor(opt_options) {
super();
const options = opt_options ? opt_options : {};
@@ -94,9 +95,228 @@ const MVT = function(opt_options) {
*/
this.extent_ = null;
};
}
inherits(MVT, FeatureFormat);
/**
* Read the raw geometry from the pbf offset stored in a raw feature's geometry
* property.
* @suppress {missingProperties}
* @param {Object} pbf PBF.
* @param {Object} feature Raw feature.
* @param {Array.<number>} flatCoordinates Array to store flat coordinates in.
* @param {Array.<number>} ends Array to store ends in.
* @private
*/
readRawGeometry_(pbf, feature, flatCoordinates, ends) {
pbf.pos = feature.geometry;
const end = pbf.readVarint() + pbf.pos;
let cmd = 1;
let length = 0;
let x = 0;
let y = 0;
let coordsLen = 0;
let currentEnd = 0;
while (pbf.pos < end) {
if (!length) {
const cmdLen = pbf.readVarint();
cmd = cmdLen & 0x7;
length = cmdLen >> 3;
}
length--;
if (cmd === 1 || cmd === 2) {
x += pbf.readSVarint();
y += pbf.readSVarint();
if (cmd === 1) { // moveTo
if (coordsLen > currentEnd) {
ends.push(coordsLen);
currentEnd = coordsLen;
}
}
flatCoordinates.push(x, y);
coordsLen += 2;
} else if (cmd === 7) {
if (coordsLen > currentEnd) {
// close polygon
flatCoordinates.push(
flatCoordinates[currentEnd], flatCoordinates[currentEnd + 1]);
coordsLen += 2;
}
} else {
assert(false, 59); // Invalid command found in the PBF
}
}
if (coordsLen > currentEnd) {
ends.push(coordsLen);
currentEnd = coordsLen;
}
}
/**
* @private
* @param {Object} pbf PBF
* @param {Object} rawFeature Raw Mapbox feature.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/Feature|module:ol/render/Feature} Feature.
*/
createFeature_(pbf, rawFeature, opt_options) {
const type = rawFeature.type;
if (type === 0) {
return null;
}
let feature;
const id = rawFeature.id;
const values = rawFeature.properties;
values[this.layerName_] = rawFeature.layer.name;
const flatCoordinates = [];
const ends = [];
this.readRawGeometry_(pbf, rawFeature, flatCoordinates, ends);
const geometryType = getGeometryType(type, ends.length);
if (this.featureClass_ === RenderFeature) {
feature = new this.featureClass_(geometryType, flatCoordinates, ends, values, id);
} else {
let geom;
if (geometryType == GeometryType.POLYGON) {
const endss = [];
let offset = 0;
let prevEndIndex = 0;
for (let i = 0, ii = ends.length; i < ii; ++i) {
const end = ends[i];
if (!linearRingIsClockwise(flatCoordinates, offset, end, 2)) {
endss.push(ends.slice(prevEndIndex, i));
prevEndIndex = i;
}
offset = end;
}
if (endss.length > 1) {
geom = new MultiPolygon(flatCoordinates, GeometryLayout.XY, endss);
} else {
geom = new Polygon(flatCoordinates, GeometryLayout.XY, ends);
}
} else {
geom = geometryType === GeometryType.POINT ? new Point(flatCoordinates, GeometryLayout.XY) :
geometryType === GeometryType.LINE_STRING ? new LineString(flatCoordinates, GeometryLayout.XY) :
geometryType === GeometryType.POLYGON ? new Polygon(flatCoordinates, GeometryLayout.XY, ends) :
geometryType === GeometryType.MULTI_POINT ? new MultiPoint(flatCoordinates, GeometryLayout.XY) :
geometryType === GeometryType.MULTI_LINE_STRING ? new MultiLineString(flatCoordinates, GeometryLayout.XY, ends) :
null;
}
feature = new this.featureClass_();
if (this.geometryName_) {
feature.setGeometryName(this.geometryName_);
}
const geometry = transformWithOptions(geom, false, this.adaptOptions(opt_options));
feature.setGeometry(geometry);
feature.setId(id);
feature.setProperties(values);
}
return feature;
}
/**
* @inheritDoc
* @api
*/
getLastExtent() {
return this.extent_;
}
/**
* @inheritDoc
*/
getType() {
return FormatType.ARRAY_BUFFER;
}
/**
* @inheritDoc
* @api
*/
readFeatures(source, opt_options) {
const layers = this.layers_;
const pbf = new PBF(/** @type {ArrayBuffer} */ (source));
const pbfLayers = pbf.readFields(layersPBFReader, {});
/** @type {Array.<module:ol/Feature|module:ol/render/Feature>} */
const features = [];
for (const name in pbfLayers) {
if (layers && layers.indexOf(name) == -1) {
continue;
}
const pbfLayer = pbfLayers[name];
for (let i = 0, ii = pbfLayer.length; i < ii; ++i) {
const rawFeature = readRawFeature(pbf, pbfLayer, i);
features.push(this.createFeature_(pbf, rawFeature));
}
this.extent_ = pbfLayer ? [0, 0, pbfLayer.extent, pbfLayer.extent] : null;
}
return features;
}
/**
* @inheritDoc
* @api
*/
readProjection(source) {
return this.dataProjection;
}
/**
* Sets the layers that features will be read from.
* @param {Array.<string>} layers Layers.
* @api
*/
setLayers(layers) {
this.layers_ = layers;
}
/**
* Not implemented.
* @override
*/
readFeature() {}
/**
* Not implemented.
* @override
*/
readGeometry() {}
/**
* Not implemented.
* @override
*/
writeFeature() {}
/**
* Not implemented.
* @override
*/
writeGeometry() {}
/**
* Not implemented.
* @override
*/
writeFeatures() {}
}
/**
@@ -201,72 +421,6 @@ function readRawFeature(pbf, layer, i) {
}
/**
* Read the raw geometry from the pbf offset stored in a raw feature's geometry
* property.
* @suppress {missingProperties}
* @param {Object} pbf PBF.
* @param {Object} feature Raw feature.
* @param {Array.<number>} flatCoordinates Array to store flat coordinates in.
* @param {Array.<number>} ends Array to store ends in.
* @private
*/
MVT.prototype.readRawGeometry_ = function(pbf, feature, flatCoordinates, ends) {
pbf.pos = feature.geometry;
const end = pbf.readVarint() + pbf.pos;
let cmd = 1;
let length = 0;
let x = 0;
let y = 0;
let coordsLen = 0;
let currentEnd = 0;
while (pbf.pos < end) {
if (!length) {
const cmdLen = pbf.readVarint();
cmd = cmdLen & 0x7;
length = cmdLen >> 3;
}
length--;
if (cmd === 1 || cmd === 2) {
x += pbf.readSVarint();
y += pbf.readSVarint();
if (cmd === 1) { // moveTo
if (coordsLen > currentEnd) {
ends.push(coordsLen);
currentEnd = coordsLen;
}
}
flatCoordinates.push(x, y);
coordsLen += 2;
} else if (cmd === 7) {
if (coordsLen > currentEnd) {
// close polygon
flatCoordinates.push(
flatCoordinates[currentEnd], flatCoordinates[currentEnd + 1]);
coordsLen += 2;
}
} else {
assert(false, 59); // Invalid command found in the PBF
}
}
if (coordsLen > currentEnd) {
ends.push(coordsLen);
currentEnd = coordsLen;
}
};
/**
* @suppress {missingProperties}
* @param {number} type The raw feature's geometry type
@@ -292,168 +446,4 @@ function getGeometryType(type, numEnds) {
return geometryType;
}
/**
* @private
* @param {Object} pbf PBF
* @param {Object} rawFeature Raw Mapbox feature.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/Feature|module:ol/render/Feature} Feature.
*/
MVT.prototype.createFeature_ = function(pbf, rawFeature, opt_options) {
const type = rawFeature.type;
if (type === 0) {
return null;
}
let feature;
const id = rawFeature.id;
const values = rawFeature.properties;
values[this.layerName_] = rawFeature.layer.name;
const flatCoordinates = [];
const ends = [];
this.readRawGeometry_(pbf, rawFeature, flatCoordinates, ends);
const geometryType = getGeometryType(type, ends.length);
if (this.featureClass_ === RenderFeature) {
feature = new this.featureClass_(geometryType, flatCoordinates, ends, values, id);
} else {
let geom;
if (geometryType == GeometryType.POLYGON) {
const endss = [];
let offset = 0;
let prevEndIndex = 0;
for (let i = 0, ii = ends.length; i < ii; ++i) {
const end = ends[i];
if (!linearRingIsClockwise(flatCoordinates, offset, end, 2)) {
endss.push(ends.slice(prevEndIndex, i));
prevEndIndex = i;
}
offset = end;
}
if (endss.length > 1) {
geom = new MultiPolygon(flatCoordinates, GeometryLayout.XY, endss);
} else {
geom = new Polygon(flatCoordinates, GeometryLayout.XY, ends);
}
} else {
geom = geometryType === GeometryType.POINT ? new Point(flatCoordinates, GeometryLayout.XY) :
geometryType === GeometryType.LINE_STRING ? new LineString(flatCoordinates, GeometryLayout.XY) :
geometryType === GeometryType.POLYGON ? new Polygon(flatCoordinates, GeometryLayout.XY, ends) :
geometryType === GeometryType.MULTI_POINT ? new MultiPoint(flatCoordinates, GeometryLayout.XY) :
geometryType === GeometryType.MULTI_LINE_STRING ? new MultiLineString(flatCoordinates, GeometryLayout.XY, ends) :
null;
}
feature = new this.featureClass_();
if (this.geometryName_) {
feature.setGeometryName(this.geometryName_);
}
const geometry = transformWithOptions(geom, false, this.adaptOptions(opt_options));
feature.setGeometry(geometry);
feature.setId(id);
feature.setProperties(values);
}
return feature;
};
/**
* @inheritDoc
* @api
*/
MVT.prototype.getLastExtent = function() {
return this.extent_;
};
/**
* @inheritDoc
*/
MVT.prototype.getType = function() {
return FormatType.ARRAY_BUFFER;
};
/**
* @inheritDoc
* @api
*/
MVT.prototype.readFeatures = function(source, opt_options) {
const layers = this.layers_;
const pbf = new PBF(/** @type {ArrayBuffer} */ (source));
const pbfLayers = pbf.readFields(layersPBFReader, {});
/** @type {Array.<module:ol/Feature|module:ol/render/Feature>} */
const features = [];
for (const name in pbfLayers) {
if (layers && layers.indexOf(name) == -1) {
continue;
}
const pbfLayer = pbfLayers[name];
for (let i = 0, ii = pbfLayer.length; i < ii; ++i) {
const rawFeature = readRawFeature(pbf, pbfLayer, i);
features.push(this.createFeature_(pbf, rawFeature));
}
this.extent_ = pbfLayer ? [0, 0, pbfLayer.extent, pbfLayer.extent] : null;
}
return features;
};
/**
* @inheritDoc
* @api
*/
MVT.prototype.readProjection = function(source) {
return this.dataProjection;
};
/**
* Sets the layers that features will be read from.
* @param {Array.<string>} layers Layers.
* @api
*/
MVT.prototype.setLayers = function(layers) {
this.layers_ = layers;
};
/**
* Not implemented.
* @override
*/
MVT.prototype.readFeature = function() {};
/**
* Not implemented.
* @override
*/
MVT.prototype.readGeometry = function() {};
/**
* Not implemented.
* @override
*/
MVT.prototype.writeFeature = function() {};
/**
* Not implemented.
* @override
*/
MVT.prototype.writeGeometry = function() {};
/**
* Not implemented.
* @override
*/
MVT.prototype.writeFeatures = function() {};
export default MVT;
src/ol/format/OSMXML.js
+77 -104
View File
@@ -2,7 +2,6 @@
* @module ol/format/OSMXML
*/
// FIXME add typedef for stack state objects
import {inherits} from '../util.js';
import {extend} from '../array.js';
import Feature from '../Feature.js';
import {transformWithOptions} from '../format/Feature.js';
@@ -15,26 +14,6 @@ import {isEmpty} from '../obj.js';
import {get as getProjection} from '../proj.js';
import {pushParseAndPop, makeStructureNS} from '../xml.js';
/**
* @classdesc
* Feature format for reading data in the
* [OSMXML format](http://wiki.openstreetmap.org/wiki/OSM_XML).
*
* @constructor
* @extends {module:ol/format/XMLFeature}
* @api
*/
const OSMXML = function() {
XMLFeature.call(this);
/**
* @inheritDoc
*/
this.dataProjection = getProjection('EPSG:4326');
};
inherits(OSMXML, XMLFeature);
/**
* @const
@@ -65,6 +44,83 @@ const PARSERS = makeStructureNS(
});
/**
* @classdesc
* Feature format for reading data in the
* [OSMXML format](http://wiki.openstreetmap.org/wiki/OSM_XML).
*
* @api
*/
class OSMXML extends XMLFeature {
constructor() {
super();
/**
* @inheritDoc
*/
this.dataProjection = getProjection('EPSG:4326');
}
/**
* @inheritDoc
*/
readFeaturesFromNode(node, opt_options) {
const options = this.getReadOptions(node, opt_options);
if (node.localName == 'osm') {
const state = pushParseAndPop({
nodes: {},
ways: [],
features: []
}, PARSERS, node, [options]);
// parse nodes in ways
for (let j = 0; j < state.ways.length; j++) {
const values = /** @type {Object} */ (state.ways[j]);
/** @type {Array.<number>} */
const flatCoordinates = [];
for (let i = 0, ii = values.ndrefs.length; i < ii; i++) {
const point = state.nodes[values.ndrefs[i]];
extend(flatCoordinates, point);
}
let geometry;
if (values.ndrefs[0] == values.ndrefs[values.ndrefs.length - 1]) {
// closed way
geometry = new Polygon(flatCoordinates, GeometryLayout.XY, [flatCoordinates.length]);
} else {
geometry = new LineString(flatCoordinates, GeometryLayout.XY);
}
transformWithOptions(geometry, false, options);
const feature = new Feature(geometry);
feature.setId(values.id);
feature.setProperties(values.tags);
state.features.push(feature);
}
if (state.features) {
return state.features;
}
}
return [];
}
/**
* Not implemented.
* @inheritDoc
*/
writeFeatureNode(feature, opt_options) {}
/**
* Not implemented.
* @inheritDoc
*/
writeFeaturesNode(features, opt_options) {}
/**
* Not implemented.
* @inheritDoc
*/
writeGeometryNode(geometry, opt_options) {}
}
/**
* @const
* @type {Object.<string, Object.<string, module:ol/xml~Parser>>}
@@ -140,87 +196,4 @@ function readTag(node, objectStack) {
}
/**
* Read all features from an OSM source.
*
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {Array.<module:ol/Feature>} Features.
* @api
*/
OSMXML.prototype.readFeatures;
/**
* @inheritDoc
*/
OSMXML.prototype.readFeaturesFromNode = function(node, opt_options) {
const options = this.getReadOptions(node, opt_options);
if (node.localName == 'osm') {
const state = pushParseAndPop({
nodes: {},
ways: [],
features: []
}, PARSERS, node, [options]);
// parse nodes in ways
for (let j = 0; j < state.ways.length; j++) {
const values = /** @type {Object} */ (state.ways[j]);
/** @type {Array.<number>} */
const flatCoordinates = [];
for (let i = 0, ii = values.ndrefs.length; i < ii; i++) {
const point = state.nodes[values.ndrefs[i]];
extend(flatCoordinates, point);
}
let geometry;
if (values.ndrefs[0] == values.ndrefs[values.ndrefs.length - 1]) {
// closed way
geometry = new Polygon(flatCoordinates, GeometryLayout.XY, [flatCoordinates.length]);
} else {
geometry = new LineString(flatCoordinates, GeometryLayout.XY);
}
transformWithOptions(geometry, false, options);
const feature = new Feature(geometry);
feature.setId(values.id);
feature.setProperties(values.tags);
state.features.push(feature);
}
if (state.features) {
return state.features;
}
}
return [];
};
/**
* Read the projection from an OSM source.
*
* @function
* @param {Document|Node|Object|string} source Source.
* @return {module:ol/proj/Projection} Projection.
* @api
*/
OSMXML.prototype.readProjection;
/**
* Not implemented.
* @inheritDoc
*/
OSMXML.prototype.writeFeatureNode = function(feature, opt_options) {};
/**
* Not implemented.
* @inheritDoc
*/
OSMXML.prototype.writeFeaturesNode = function(features, opt_options) {};
/**
* Not implemented.
* @inheritDoc
*/
OSMXML.prototype.writeGeometryNode = function(geometry, opt_options) {};
export default OSMXML;
src/ol/format/OWS.js
+28 -34
View File
@@ -1,22 +1,11 @@
/**
* @module ol/format/OWS
*/
import {inherits} from '../util.js';
import {readHref} from '../format/XLink.js';
import XML from '../format/XML.js';
import {readString} from '../format/xsd.js';
import {makeObjectPropertyPusher, makeObjectPropertySetter, makeStructureNS, pushParseAndPop} from '../xml.js';
/**
* @constructor
* @extends {module:ol/format/XML}
*/
const OWS = function() {
XML.call(this);
};
inherits(OWS, XML);
/**
* @const
@@ -37,6 +26,34 @@ const PARSERS = makeStructureNS(
});
class OWS extends XML {
constructor() {
super();
}
/**
* @inheritDoc
*/
readFromDocument(doc) {
for (let n = doc.firstChild; n; n = n.nextSibling) {
if (n.nodeType == Node.ELEMENT_NODE) {
return this.readFromNode(n);
}
}
return null;
}
/**
* @inheritDoc
*/
readFromNode(node) {
const owsObject = pushParseAndPop({},
PARSERS, node, []);
return owsObject ? owsObject : null;
}
}
/**
* @const
* @type {Object.<string, Object.<string, module:ol/xml~Parser>>}
@@ -187,29 +204,6 @@ const SERVICE_PROVIDER_PARSERS =
});
/**
* @inheritDoc
*/
OWS.prototype.readFromDocument = function(doc) {
for (let n = doc.firstChild; n; n = n.nextSibling) {
if (n.nodeType == Node.ELEMENT_NODE) {
return this.readFromNode(n);
}
}
return null;
};
/**
* @inheritDoc
*/
OWS.prototype.readFromNode = function(node) {
const owsObject = pushParseAndPop({},
PARSERS, node, []);
return owsObject ? owsObject : null;
};
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
src/ol/format/Polyline.js
+81 -139
View File
@@ -1,7 +1,6 @@
/**
* @module ol/format/Polyline
*/
import {inherits} from '../util.js';
import {assert} from '../asserts.js';
import Feature from '../Feature.js';
import {transformWithOptions} from '../format/Feature.js';
@@ -27,16 +26,25 @@ import {get as getProjection} from '../proj.js';
* Feature format for reading and writing data in the Encoded
* Polyline Algorithm Format.
*
* @constructor
* @extends {module:ol/format/TextFeature}
* @param {module:ol/format/Polyline~Options=} opt_options Optional configuration object.
* When reading features, the coordinates are assumed to be in two dimensions
* and in [latitude, longitude] order.
*
* As Polyline sources contain a single feature,
* {@link module:ol/format/Polyline~Polyline#readFeatures} will return the
* feature in an array.
*
* @api
*/
const Polyline = function(opt_options) {
class Polyline extends TextFeature {
/**
* @param {module:ol/format/Polyline~Options=} opt_options Optional configuration object.
*/
constructor(opt_options) {
super();
const options = opt_options ? opt_options : {};
TextFeature.call(this);
/**
* @inheritDoc
@@ -55,9 +63,74 @@ const Polyline = function(opt_options) {
*/
this.geometryLayout_ = options.geometryLayout ?
options.geometryLayout : GeometryLayout.XY;
};
}
inherits(Polyline, TextFeature);
/**
* @inheritDoc
*/
readFeatureFromText(text, opt_options) {
const geometry = this.readGeometryFromText(text, opt_options);
return new Feature(geometry);
}
/**
* @inheritDoc
*/
readFeaturesFromText(text, opt_options) {
const feature = this.readFeatureFromText(text, opt_options);
return [feature];
}
/**
* @inheritDoc
*/
readGeometryFromText(text, opt_options) {
const stride = getStrideForLayout(this.geometryLayout_);
const flatCoordinates = decodeDeltas(text, stride, this.factor_);
flipXY(flatCoordinates, 0, flatCoordinates.length, stride, flatCoordinates);
const coordinates = inflateCoordinates(flatCoordinates, 0, flatCoordinates.length, stride);
return (
/** @type {module:ol/geom/Geometry} */ (transformWithOptions(
new LineString(coordinates, this.geometryLayout_),
false,
this.adaptOptions(opt_options)
))
);
}
/**
* @inheritDoc
*/
writeFeatureText(feature, opt_options) {
const geometry = feature.getGeometry();
if (geometry) {
return this.writeGeometryText(geometry, opt_options);
} else {
assert(false, 40); // Expected `feature` to have a geometry
return '';
}
}
/**
* @inheritDoc
*/
writeFeaturesText(features, opt_options) {
return this.writeFeatureText(features[0], opt_options);
}
/**
* @inheritDoc
*/
writeGeometryText(geometry, opt_options) {
geometry = /** @type {module:ol/geom/LineString} */
(transformWithOptions(geometry, true, this.adaptOptions(opt_options)));
const flatCoordinates = geometry.getFlatCoordinates();
const stride = geometry.getStride();
flipXY(flatCoordinates, 0, flatCoordinates.length, stride, flatCoordinates);
return encodeDeltas(flatCoordinates, stride, this.factor_);
}
}
/**
@@ -264,135 +337,4 @@ export function encodeUnsignedInteger(num) {
}
/**
* Read the feature from the Polyline source. The coordinates are assumed to be
* in two dimensions and in latitude, longitude order.
*
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/Feature} Feature.
* @api
*/
Polyline.prototype.readFeature;
/**
* @inheritDoc
*/
Polyline.prototype.readFeatureFromText = function(text, opt_options) {
const geometry = this.readGeometryFromText(text, opt_options);
return new Feature(geometry);
};
/**
* Read the feature from the source. As Polyline sources contain a single
* feature, this will return the feature in an array.
*
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {Array.<module:ol/Feature>} Features.
* @api
*/
Polyline.prototype.readFeatures;
/**
* @inheritDoc
*/
Polyline.prototype.readFeaturesFromText = function(text, opt_options) {
const feature = this.readFeatureFromText(text, opt_options);
return [feature];
};
/**
* Read the geometry from the source.
*
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/geom/Geometry} Geometry.
* @api
*/
Polyline.prototype.readGeometry;
/**
* @inheritDoc
*/
Polyline.prototype.readGeometryFromText = function(text, opt_options) {
const stride = getStrideForLayout(this.geometryLayout_);
const flatCoordinates = decodeDeltas(text, stride, this.factor_);
flipXY(flatCoordinates, 0, flatCoordinates.length, stride, flatCoordinates);
const coordinates = inflateCoordinates(flatCoordinates, 0, flatCoordinates.length, stride);
return (
/** @type {module:ol/geom/Geometry} */ (transformWithOptions(
new LineString(coordinates, this.geometryLayout_),
false,
this.adaptOptions(opt_options)
))
);
};
/**
* Read the projection from a Polyline source.
*
* @function
* @param {Document|Node|Object|string} source Source.
* @return {module:ol/proj/Projection} Projection.
* @api
*/
Polyline.prototype.readProjection;
/**
* @inheritDoc
*/
Polyline.prototype.writeFeatureText = function(feature, opt_options) {
const geometry = feature.getGeometry();
if (geometry) {
return this.writeGeometryText(geometry, opt_options);
} else {
assert(false, 40); // Expected `feature` to have a geometry
return '';
}
};
/**
* @inheritDoc
*/
Polyline.prototype.writeFeaturesText = function(features, opt_options) {
return this.writeFeatureText(features[0], opt_options);
};
/**
* Write a single geometry in Polyline format.
*
* @function
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} Geometry.
* @api
*/
Polyline.prototype.writeGeometry;
/**
* @inheritDoc
*/
Polyline.prototype.writeGeometryText = function(geometry, opt_options) {
geometry = /** @type {module:ol/geom/LineString} */
(transformWithOptions(geometry, true, this.adaptOptions(opt_options)));
const flatCoordinates = geometry.getFlatCoordinates();
const stride = geometry.getStride();
flipXY(flatCoordinates, 0, flatCoordinates.length, stride, flatCoordinates);
return encodeDeltas(flatCoordinates, stride, this.factor_);
};
export default Polyline;
src/ol/format/TextFeature.js
+160 -139
View File
@@ -1,7 +1,6 @@
/**
* @module ol/format/TextFeature
*/
import {inherits} from '../util.js';
import FeatureFormat from '../format/Feature.js';
import FormatType from '../format/FormatType.js';
@@ -11,15 +10,169 @@ import FormatType from '../format/FormatType.js';
* instantiated in apps.
* Base class for text feature formats.
*
* @constructor
* @abstract
* @extends {module:ol/format/Feature}
*/
const TextFeature = function() {
FeatureFormat.call(this);
};
class TextFeature extends FeatureFormat {
constructor() {
super();
}
inherits(TextFeature, FeatureFormat);
/**
* @inheritDoc
*/
getType() {
return FormatType.TEXT;
}
/**
* Read the feature from the source.
*
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/Feature} Feature.
* @api
*/
readFeature(source, opt_options) {
return this.readFeatureFromText(getText(source), this.adaptOptions(opt_options));
}
/**
* @abstract
* @param {string} text Text.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @protected
* @return {module:ol/Feature} Feature.
*/
readFeatureFromText(text, opt_options) {}
/**
* Read the features from the source.
*
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {Array.<module:ol/Feature>} Features.
* @api
*/
readFeatures(source, opt_options) {
return this.readFeaturesFromText(getText(source), this.adaptOptions(opt_options));
}
/**
* @abstract
* @param {string} text Text.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @protected
* @return {Array.<module:ol/Feature>} Features.
*/
readFeaturesFromText(text, opt_options) {}
/**
* Read the geometry from the source.
*
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/geom/Geometry} Geometry.
* @api
*/
readGeometry(source, opt_options) {
return this.readGeometryFromText(getText(source), this.adaptOptions(opt_options));
}
/**
* @abstract
* @param {string} text Text.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @protected
* @return {module:ol/geom/Geometry} Geometry.
*/
readGeometryFromText(text, opt_options) {}
/**
* Read the projection from the source.
*
* @function
* @param {Document|Node|Object|string} source Source.
* @return {module:ol/proj/Projection} Projection.
* @api
*/
readProjection(source) {
return this.readProjectionFromText(getText(source));
}
/**
* @param {string} text Text.
* @protected
* @return {module:ol/proj/Projection} Projection.
*/
readProjectionFromText(text) {
return this.dataProjection;
}
/**
* Encode a feature as a string.
*
* @function
* @param {module:ol/Feature} feature Feature.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} Encoded feature.
* @api
*/
writeFeature(feature, opt_options) {
return this.writeFeatureText(feature, this.adaptOptions(opt_options));
}
/**
* @abstract
* @param {module:ol/Feature} feature Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @protected
* @return {string} Text.
*/
writeFeatureText(feature, opt_options) {}
/**
* Encode an array of features as string.
*
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} Encoded features.
* @api
*/
writeFeatures(features, opt_options) {
return this.writeFeaturesText(features, this.adaptOptions(opt_options));
}
/**
* @abstract
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @protected
* @return {string} Text.
*/
writeFeaturesText(features, opt_options) {}
/**
* Write a single geometry.
*
* @function
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} Geometry.
* @api
*/
writeGeometry(geometry, opt_options) {
return this.writeGeometryText(geometry, this.adaptOptions(opt_options));
}
/**
* @abstract
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @protected
* @return {string} Text.
*/
writeGeometryText(geometry, opt_options) {}
}
/**
@@ -35,136 +188,4 @@ function getText(source) {
}
/**
* @inheritDoc
*/
TextFeature.prototype.getType = function() {
return FormatType.TEXT;
};
/**
* @inheritDoc
*/
TextFeature.prototype.readFeature = function(source, opt_options) {
return this.readFeatureFromText(getText(source), this.adaptOptions(opt_options));
};
/**
* @abstract
* @param {string} text Text.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @protected
* @return {module:ol/Feature} Feature.
*/
TextFeature.prototype.readFeatureFromText = function(text, opt_options) {};
/**
* @inheritDoc
*/
TextFeature.prototype.readFeatures = function(source, opt_options) {
return this.readFeaturesFromText(getText(source), this.adaptOptions(opt_options));
};
/**
* @abstract
* @param {string} text Text.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @protected
* @return {Array.<module:ol/Feature>} Features.
*/
TextFeature.prototype.readFeaturesFromText = function(text, opt_options) {};
/**
* @inheritDoc
*/
TextFeature.prototype.readGeometry = function(source, opt_options) {
return this.readGeometryFromText(getText(source), this.adaptOptions(opt_options));
};
/**
* @abstract
* @param {string} text Text.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @protected
* @return {module:ol/geom/Geometry} Geometry.
*/
TextFeature.prototype.readGeometryFromText = function(text, opt_options) {};
/**
* @inheritDoc
*/
TextFeature.prototype.readProjection = function(source) {
return this.readProjectionFromText(getText(source));
};
/**
* @param {string} text Text.
* @protected
* @return {module:ol/proj/Projection} Projection.
*/
TextFeature.prototype.readProjectionFromText = function(text) {
return this.dataProjection;
};
/**
* @inheritDoc
*/
TextFeature.prototype.writeFeature = function(feature, opt_options) {
return this.writeFeatureText(feature, this.adaptOptions(opt_options));
};
/**
* @abstract
* @param {module:ol/Feature} feature Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @protected
* @return {string} Text.
*/
TextFeature.prototype.writeFeatureText = function(feature, opt_options) {};
/**
* @inheritDoc
*/
TextFeature.prototype.writeFeatures = function(features, opt_options) {
return this.writeFeaturesText(features, this.adaptOptions(opt_options));
};
/**
* @abstract
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @protected
* @return {string} Text.
*/
TextFeature.prototype.writeFeaturesText = function(features, opt_options) {};
/**
* @inheritDoc
*/
TextFeature.prototype.writeGeometry = function(geometry, opt_options) {
return this.writeGeometryText(geometry, this.adaptOptions(opt_options));
};
/**
* @abstract
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @protected
* @return {string} Text.
*/
TextFeature.prototype.writeGeometryText = function(geometry, opt_options) {};
export default TextFeature;
src/ol/format/TopoJSON.js
+86 -114
View File
@@ -1,7 +1,6 @@
/**
* @module ol/format/TopoJSON
*/
import {inherits} from '../util.js';
import Feature from '../Feature.js';
import {transformWithOptions} from '../format/Feature.js';
import JSONFeature from '../format/JSONFeature.js';
@@ -43,17 +42,18 @@ import {get as getProjection} from '../proj.js';
* @classdesc
* Feature format for reading data in the TopoJSON format.
*
* @constructor
* @extends {module:ol/format/JSONFeature}
* @param {module:ol/format/TopoJSON~Options=} opt_options Options.
* @api
*/
const TopoJSON = function(opt_options) {
class TopoJSON extends JSONFeature {
/**
* @param {module:ol/format/TopoJSON~Options=} opt_options Options.
*/
constructor(opt_options) {
super();
const options = opt_options ? opt_options : {};
JSONFeature.call(this);
/**
* @private
* @type {string|undefined}
@@ -73,9 +73,86 @@ const TopoJSON = function(opt_options) {
options.dataProjection ?
options.dataProjection : 'EPSG:4326');
};
}
inherits(TopoJSON, JSONFeature);
/**
* @inheritDoc
*/
readFeaturesFromObject(object, opt_options) {
if (object.type == 'Topology') {
const topoJSONTopology = /** @type {TopoJSONTopology} */ (object);
let transform, scale = null, translate = null;
if (topoJSONTopology.transform) {
transform = topoJSONTopology.transform;
scale = transform.scale;
translate = transform.translate;
}
const arcs = topoJSONTopology.arcs;
if (transform) {
transformArcs(arcs, scale, translate);
}
/** @type {Array.<module:ol/Feature>} */
const features = [];
const topoJSONFeatures = topoJSONTopology.objects;
const property = this.layerName_;
let feature;
for (const objectName in topoJSONFeatures) {
if (this.layers_ && this.layers_.indexOf(objectName) == -1) {
continue;
}
if (topoJSONFeatures[objectName].type === 'GeometryCollection') {
feature = /** @type {TopoJSONGeometryCollection} */ (topoJSONFeatures[objectName]);
features.push.apply(features, readFeaturesFromGeometryCollection(
feature, arcs, scale, translate, property, objectName, opt_options));
} else {
feature = /** @type {TopoJSONGeometry} */ (topoJSONFeatures[objectName]);
features.push(readFeatureFromGeometry(
feature, arcs, scale, translate, property, objectName, opt_options));
}
}
return features;
} else {
return [];
}
}
/**
* @inheritDoc
*/
readProjectionFromObject(object) {
return this.dataProjection;
}
/**
* Not implemented.
* @inheritDoc
*/
writeFeatureObject(feature, opt_options) {}
/**
* Not implemented.
* @inheritDoc
*/
writeFeaturesObject(features, opt_options) {}
/**
* Not implemented.
* @inheritDoc
*/
writeGeometryObject(geometry, opt_options) {}
/**
* Not implemented.
* @override
*/
readGeometryFromObject() {}
/**
* Not implemented.
* @override
*/
readFeatureFromObject() {}
}
/**
@@ -298,59 +375,6 @@ function readFeatureFromGeometry(object, arcs, scale, translate, property, name,
}
/**
* Read all features from a TopoJSON source.
*
* @function
* @param {Document|Node|Object|string} source Source.
* @return {Array.<module:ol/Feature>} Features.
* @api
*/
TopoJSON.prototype.readFeatures;
/**
* @inheritDoc
*/
TopoJSON.prototype.readFeaturesFromObject = function(object, opt_options) {
if (object.type == 'Topology') {
const topoJSONTopology = /** @type {TopoJSONTopology} */ (object);
let transform, scale = null, translate = null;
if (topoJSONTopology.transform) {
transform = topoJSONTopology.transform;
scale = transform.scale;
translate = transform.translate;
}
const arcs = topoJSONTopology.arcs;
if (transform) {
transformArcs(arcs, scale, translate);
}
/** @type {Array.<module:ol/Feature>} */
const features = [];
const topoJSONFeatures = topoJSONTopology.objects;
const property = this.layerName_;
let feature;
for (const objectName in topoJSONFeatures) {
if (this.layers_ && this.layers_.indexOf(objectName) == -1) {
continue;
}
if (topoJSONFeatures[objectName].type === 'GeometryCollection') {
feature = /** @type {TopoJSONGeometryCollection} */ (topoJSONFeatures[objectName]);
features.push.apply(features, readFeaturesFromGeometryCollection(
feature, arcs, scale, translate, property, objectName, opt_options));
} else {
feature = /** @type {TopoJSONGeometry} */ (topoJSONFeatures[objectName]);
features.push(readFeatureFromGeometry(
feature, arcs, scale, translate, property, objectName, opt_options));
}
}
return features;
} else {
return [];
}
};
/**
* Apply a linear transform to array of arcs. The provided array of arcs is
* modified in place.
@@ -401,56 +425,4 @@ 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.
* @override
* @api
*/
TopoJSON.prototype.readProjection;
/**
* @inheritDoc
*/
TopoJSON.prototype.readProjectionFromObject = function(object) {
return this.dataProjection;
};
/**
* Not implemented.
* @inheritDoc
*/
TopoJSON.prototype.writeFeatureObject = function(feature, opt_options) {};
/**
* Not implemented.
* @inheritDoc
*/
TopoJSON.prototype.writeFeaturesObject = function(features, opt_options) {};
/**
* Not implemented.
* @inheritDoc
*/
TopoJSON.prototype.writeGeometryObject = function(geometry, opt_options) {};
/**
* Not implemented.
* @override
*/
TopoJSON.prototype.readGeometryFromObject = function() {};
/**
* Not implemented.
* @override
*/
TopoJSON.prototype.readFeatureFromObject = function() {};
export default TopoJSON;
src/ol/format/WFS.js
+278 -312
View File
@@ -1,7 +1,6 @@
/**
* @module ol/format/WFS
*/
import {inherits} from '../util.js';
import {assert} from '../asserts.js';
import GML2 from '../format/GML2.js';
import GML3 from '../format/GML3.js';
@@ -17,6 +16,69 @@ import {createElementNS, isDocument, isNode, makeArrayPusher, makeChildAppender,
pushParseAndPop, pushSerializeAndPop, XML_SCHEMA_INSTANCE_URI} from '../xml.js';
/**
* @const
* @type {Object.<string, Object.<string, module:ol/xml~Parser>>}
*/
const FEATURE_COLLECTION_PARSERS = {
'http://www.opengis.net/gml': {
'boundedBy': makeObjectPropertySetter(
GMLBase.prototype.readGeometryElement, 'bounds')
}
};
/**
* @const
* @type {Object.<string, Object.<string, module:ol/xml~Parser>>}
*/
const TRANSACTION_SUMMARY_PARSERS = {
'http://www.opengis.net/wfs': {
'totalInserted': makeObjectPropertySetter(readNonNegativeInteger),
'totalUpdated': makeObjectPropertySetter(readNonNegativeInteger),
'totalDeleted': makeObjectPropertySetter(readNonNegativeInteger)
}
};
/**
* @const
* @type {Object.<string, Object.<string, module:ol/xml~Parser>>}
*/
const TRANSACTION_RESPONSE_PARSERS = {
'http://www.opengis.net/wfs': {
'TransactionSummary': makeObjectPropertySetter(
readTransactionSummary, 'transactionSummary'),
'InsertResults': makeObjectPropertySetter(
readInsertResults, 'insertIds')
}
};
/**
* @type {Object.<string, Object.<string, module:ol/xml~Serializer>>}
*/
const QUERY_SERIALIZERS = {
'http://www.opengis.net/wfs': {
'PropertyName': makeChildAppender(writeStringTextNode)
}
};
/**
* @type {Object.<string, Object.<string, module:ol/xml~Serializer>>}
*/
const TRANSACTION_SERIALIZERS = {
'http://www.opengis.net/wfs': {
'Insert': makeChildAppender(writeFeature),
'Update': makeChildAppender(writeUpdate),
'Delete': makeChildAppender(writeDelete),
'Property': makeChildAppender(writeProperty),
'Native': makeChildAppender(writeNative)
}
};
/**
* @typedef {Object} Options
* @property {Object.<string, string>|string} [featureNS] The namespace URI used for features.
@@ -138,12 +200,16 @@ const DEFAULT_VERSION = '1.1.0';
* as option if you want to read a WFS that contains GML2 (WFS 1.0.0).
* Also see {@link module:ol/format/GMLBase~GMLBase} which is used by this format.
*
* @constructor
* @param {module:ol/format/WFS~Options=} opt_options Optional configuration object.
* @extends {module:ol/format/XMLFeature}
* @api
*/
const WFS = function(opt_options) {
class WFS extends XMLFeature {
/**
* @param {module:ol/format/WFS~Options=} opt_options Optional configuration object.
*/
constructor(opt_options) {
super();
const options = opt_options ? opt_options : {};
/**
@@ -171,45 +237,26 @@ const WFS = function(opt_options) {
*/
this.schemaLocation_ = options.schemaLocation ?
options.schemaLocation : SCHEMA_LOCATIONS[DEFAULT_VERSION];
}
XMLFeature.call(this);
};
inherits(WFS, XMLFeature);
/**
/**
* @return {Array.<string>|string|undefined} featureType
*/
WFS.prototype.getFeatureType = function() {
getFeatureType() {
return this.featureType_;
};
}
/**
/**
* @param {Array.<string>|string|undefined} featureType Feature type(s) to parse.
*/
WFS.prototype.setFeatureType = function(featureType) {
setFeatureType(featureType) {
this.featureType_ = featureType;
};
}
/**
* Read all features from a WFS FeatureCollection.
*
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {Array.<module:ol/Feature>} Features.
* @api
*/
WFS.prototype.readFeatures;
/**
/**
* @inheritDoc
*/
WFS.prototype.readFeaturesFromNode = function(node, opt_options) {
readFeaturesFromNode(node, opt_options) {
const context = /** @type {module:ol/xml~NodeStackItem} */ ({
'featureType': this.featureType_,
'featureNS': this.featureNS_
@@ -226,17 +273,16 @@ WFS.prototype.readFeaturesFromNode = function(node, opt_options) {
features = [];
}
return features;
};
}
/**
/**
* Read transaction response of the source.
*
* @param {Document|Node|Object|string} source Source.
* @return {module:ol/format/WFS~TransactionResponse|undefined} Transaction response.
* @api
*/
WFS.prototype.readTransactionResponse = function(source) {
readTransactionResponse(source) {
if (isDocument(source)) {
return this.readTransactionResponseFromDocument(
/** @type {Document} */ (source));
@@ -248,10 +294,9 @@ WFS.prototype.readTransactionResponse = function(source) {
} else {
return undefined;
}
};
}
/**
/**
* Read feature collection metadata of the source.
*
* @param {Document|Node|Object|string} source Source.
@@ -259,7 +304,7 @@ WFS.prototype.readTransactionResponse = function(source) {
* FeatureCollection metadata.
* @api
*/
WFS.prototype.readFeatureCollectionMetadata = function(source) {
readFeatureCollectionMetadata(source) {
if (isDocument(source)) {
return this.readFeatureCollectionMetadataFromDocument(
/** @type {Document} */ (source));
@@ -272,42 +317,28 @@ WFS.prototype.readFeatureCollectionMetadata = function(source) {
} else {
return undefined;
}
};
}
/**
/**
* @param {Document} doc Document.
* @return {module:ol/format/WFS~FeatureCollectionMetadata|undefined}
* FeatureCollection metadata.
*/
WFS.prototype.readFeatureCollectionMetadataFromDocument = function(doc) {
readFeatureCollectionMetadataFromDocument(doc) {
for (let n = doc.firstChild; n; n = n.nextSibling) {
if (n.nodeType == Node.ELEMENT_NODE) {
return this.readFeatureCollectionMetadataFromNode(n);
}
}
return undefined;
};
/**
* @const
* @type {Object.<string, Object.<string, module:ol/xml~Parser>>}
*/
const FEATURE_COLLECTION_PARSERS = {
'http://www.opengis.net/gml': {
'boundedBy': makeObjectPropertySetter(
GMLBase.prototype.readGeometryElement, 'bounds')
}
};
/**
/**
* @param {Node} node Node.
* @return {module:ol/format/WFS~FeatureCollectionMetadata|undefined}
* FeatureCollection metadata.
*/
WFS.prototype.readFeatureCollectionMetadataFromNode = function(node) {
readFeatureCollectionMetadataFromNode(node) {
const result = {};
const value = readNonNegativeIntegerString(
node.getAttribute('numberOfFeatures'));
@@ -315,20 +346,194 @@ WFS.prototype.readFeatureCollectionMetadataFromNode = function(node) {
return pushParseAndPop(
/** @type {module:ol/format/WFS~FeatureCollectionMetadata} */ (result),
FEATURE_COLLECTION_PARSERS, node, [], this.gmlFormat_);
};
/**
* @const
* @type {Object.<string, Object.<string, module:ol/xml~Parser>>}
*/
const TRANSACTION_SUMMARY_PARSERS = {
'http://www.opengis.net/wfs': {
'totalInserted': makeObjectPropertySetter(readNonNegativeInteger),
'totalUpdated': makeObjectPropertySetter(readNonNegativeInteger),
'totalDeleted': makeObjectPropertySetter(readNonNegativeInteger)
}
};
/**
* @param {Document} doc Document.
* @return {module:ol/format/WFS~TransactionResponse|undefined} Transaction response.
*/
readTransactionResponseFromDocument(doc) {
for (let n = doc.firstChild; n; n = n.nextSibling) {
if (n.nodeType == Node.ELEMENT_NODE) {
return this.readTransactionResponseFromNode(n);
}
}
return undefined;
}
/**
* @param {Node} node Node.
* @return {module:ol/format/WFS~TransactionResponse|undefined} Transaction response.
*/
readTransactionResponseFromNode(node) {
return pushParseAndPop(
/** @type {module:ol/format/WFS~TransactionResponse} */({}),
TRANSACTION_RESPONSE_PARSERS, node, []);
}
/**
* Encode format as WFS `GetFeature` and return the Node.
*
* @param {module:ol/format/WFS~WriteGetFeatureOptions} options Options.
* @return {Node} Result.
* @api
*/
writeGetFeature(options) {
const node = createElementNS(WFSNS, 'GetFeature');
node.setAttribute('service', 'WFS');
node.setAttribute('version', '1.1.0');
let filter;
if (options) {
if (options.handle) {
node.setAttribute('handle', options.handle);
}
if (options.outputFormat) {
node.setAttribute('outputFormat', options.outputFormat);
}
if (options.maxFeatures !== undefined) {
node.setAttribute('maxFeatures', options.maxFeatures);
}
if (options.resultType) {
node.setAttribute('resultType', options.resultType);
}
if (options.startIndex !== undefined) {
node.setAttribute('startIndex', options.startIndex);
}
if (options.count !== undefined) {
node.setAttribute('count', options.count);
}
filter = options.filter;
if (options.bbox) {
assert(options.geometryName,
12); // `options.geometryName` must also be provided when `options.bbox` is set
const bbox = bboxFilter(
/** @type {string} */ (options.geometryName), options.bbox, options.srsName);
if (filter) {
// if bbox and filter are both set, combine the two into a single filter
filter = andFilter(filter, bbox);
} else {
filter = bbox;
}
}
}
node.setAttributeNS(XML_SCHEMA_INSTANCE_URI, 'xsi:schemaLocation', this.schemaLocation_);
/** @type {module:ol/xml~NodeStackItem} */
const context = {
node: node,
'srsName': options.srsName,
'featureNS': options.featureNS ? options.featureNS : this.featureNS_,
'featurePrefix': options.featurePrefix,
'geometryName': options.geometryName,
'filter': filter,
'propertyNames': options.propertyNames ? options.propertyNames : []
};
assert(Array.isArray(options.featureTypes),
11); // `options.featureTypes` should be an Array
writeGetFeature(node, /** @type {!Array.<string>} */ (options.featureTypes), [context]);
return node;
}
/**
* Encode format as WFS `Transaction` and return the Node.
*
* @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
*/
writeTransaction(inserts, updates, deletes, options) {
const objectStack = [];
const node = createElementNS(WFSNS, 'Transaction');
const version = options.version ? options.version : DEFAULT_VERSION;
const gmlVersion = version === '1.0.0' ? 2 : 3;
node.setAttribute('service', 'WFS');
node.setAttribute('version', version);
let baseObj;
/** @type {module:ol/xml~NodeStackItem} */
let obj;
if (options) {
baseObj = options.gmlOptions ? options.gmlOptions : {};
if (options.handle) {
node.setAttribute('handle', options.handle);
}
}
const schemaLocation = SCHEMA_LOCATIONS[version];
node.setAttributeNS(XML_SCHEMA_INSTANCE_URI, 'xsi:schemaLocation', schemaLocation);
const featurePrefix = options.featurePrefix ? options.featurePrefix : FEATURE_PREFIX;
if (inserts) {
obj = {node: node, 'featureNS': options.featureNS,
'featureType': options.featureType, 'featurePrefix': featurePrefix,
'gmlVersion': gmlVersion, 'hasZ': options.hasZ, 'srsName': options.srsName};
assign(obj, baseObj);
pushSerializeAndPop(obj,
TRANSACTION_SERIALIZERS,
makeSimpleNodeFactory('Insert'), inserts,
objectStack);
}
if (updates) {
obj = {node: node, 'featureNS': options.featureNS,
'featureType': options.featureType, 'featurePrefix': featurePrefix,
'gmlVersion': gmlVersion, 'hasZ': options.hasZ, 'srsName': options.srsName};
assign(obj, baseObj);
pushSerializeAndPop(obj,
TRANSACTION_SERIALIZERS,
makeSimpleNodeFactory('Update'), updates,
objectStack);
}
if (deletes) {
pushSerializeAndPop({node: node, 'featureNS': options.featureNS,
'featureType': options.featureType, 'featurePrefix': featurePrefix,
'gmlVersion': gmlVersion, 'srsName': options.srsName},
TRANSACTION_SERIALIZERS,
makeSimpleNodeFactory('Delete'), deletes,
objectStack);
}
if (options.nativeElements) {
pushSerializeAndPop({node: node, 'featureNS': options.featureNS,
'featureType': options.featureType, 'featurePrefix': featurePrefix,
'gmlVersion': gmlVersion, 'srsName': options.srsName},
TRANSACTION_SERIALIZERS,
makeSimpleNodeFactory('Native'), options.nativeElements,
objectStack);
}
return node;
}
/**
* @inheritDoc
*/
readProjectionFromDocument(doc) {
for (let n = doc.firstChild; n; n = n.nextSibling) {
if (n.nodeType == Node.ELEMENT_NODE) {
return this.readProjectionFromNode(n);
}
}
return null;
}
/**
* @inheritDoc
*/
readProjectionFromNode(node) {
if (node.firstElementChild &&
node.firstElementChild.firstElementChild) {
node = node.firstElementChild.firstElementChild;
for (let n = node.firstElementChild; n; n = n.nextElementSibling) {
if (!(n.childNodes.length === 0 ||
(n.childNodes.length === 1 &&
n.firstChild.nodeType === 3))) {
const objectStack = [{}];
this.gmlFormat_.readGeometryElement(n, objectStack);
return getProjection(objectStack.pop().srsName);
}
}
}
return null;
}
}
/**
@@ -386,55 +591,6 @@ function readInsertResults(node, objectStack) {
}
/**
* @const
* @type {Object.<string, Object.<string, module:ol/xml~Parser>>}
*/
const TRANSACTION_RESPONSE_PARSERS = {
'http://www.opengis.net/wfs': {
'TransactionSummary': makeObjectPropertySetter(
readTransactionSummary, 'transactionSummary'),
'InsertResults': makeObjectPropertySetter(
readInsertResults, 'insertIds')
}
};
/**
* @param {Document} doc Document.
* @return {module:ol/format/WFS~TransactionResponse|undefined} Transaction response.
*/
WFS.prototype.readTransactionResponseFromDocument = function(doc) {
for (let n = doc.firstChild; n; n = n.nextSibling) {
if (n.nodeType == Node.ELEMENT_NODE) {
return this.readTransactionResponseFromNode(n);
}
}
return undefined;
};
/**
* @param {Node} node Node.
* @return {module:ol/format/WFS~TransactionResponse|undefined} Transaction response.
*/
WFS.prototype.readTransactionResponseFromNode = function(node) {
return pushParseAndPop(
/** @type {module:ol/format/WFS~TransactionResponse} */({}),
TRANSACTION_RESPONSE_PARSERS, node, []);
};
/**
* @type {Object.<string, Object.<string, module:ol/xml~Serializer>>}
*/
const QUERY_SERIALIZERS = {
'http://www.opengis.net/wfs': {
'PropertyName': makeChildAppender(writeStringTextNode)
}
};
/**
* @param {Node} node Node.
* @param {module:ol/Feature} feature Feature.
@@ -507,20 +663,6 @@ function writeDelete(node, feature, objectStack) {
}
/**
* @type {Object.<string, Object.<string, module:ol/xml~Serializer>>}
*/
const TRANSACTION_SERIALIZERS = {
'http://www.opengis.net/wfs': {
'Insert': makeChildAppender(writeFeature),
'Update': makeChildAppender(writeUpdate),
'Delete': makeChildAppender(writeDelete),
'Property': makeChildAppender(writeProperty),
'Native': makeChildAppender(writeNative)
}
};
/**
* @param {Node} node Node.
* @param {module:ol/Feature} feature Feature.
@@ -942,180 +1084,4 @@ function writeGetFeature(node, featureTypes, objectStack) {
}
/**
* Encode format as WFS `GetFeature` and return the Node.
*
* @param {module:ol/format/WFS~WriteGetFeatureOptions} options Options.
* @return {Node} Result.
* @api
*/
WFS.prototype.writeGetFeature = function(options) {
const node = createElementNS(WFSNS, 'GetFeature');
node.setAttribute('service', 'WFS');
node.setAttribute('version', '1.1.0');
let filter;
if (options) {
if (options.handle) {
node.setAttribute('handle', options.handle);
}
if (options.outputFormat) {
node.setAttribute('outputFormat', options.outputFormat);
}
if (options.maxFeatures !== undefined) {
node.setAttribute('maxFeatures', options.maxFeatures);
}
if (options.resultType) {
node.setAttribute('resultType', options.resultType);
}
if (options.startIndex !== undefined) {
node.setAttribute('startIndex', options.startIndex);
}
if (options.count !== undefined) {
node.setAttribute('count', options.count);
}
filter = options.filter;
if (options.bbox) {
assert(options.geometryName,
12); // `options.geometryName` must also be provided when `options.bbox` is set
const bbox = bboxFilter(
/** @type {string} */ (options.geometryName), options.bbox, options.srsName);
if (filter) {
// if bbox and filter are both set, combine the two into a single filter
filter = andFilter(filter, bbox);
} else {
filter = bbox;
}
}
}
node.setAttributeNS(XML_SCHEMA_INSTANCE_URI, 'xsi:schemaLocation', this.schemaLocation_);
/** @type {module:ol/xml~NodeStackItem} */
const context = {
node: node,
'srsName': options.srsName,
'featureNS': options.featureNS ? options.featureNS : this.featureNS_,
'featurePrefix': options.featurePrefix,
'geometryName': options.geometryName,
'filter': filter,
'propertyNames': options.propertyNames ? options.propertyNames : []
};
assert(Array.isArray(options.featureTypes),
11); // `options.featureTypes` should be an Array
writeGetFeature(node, /** @type {!Array.<string>} */ (options.featureTypes), [context]);
return node;
};
/**
* Encode format as WFS `Transaction` and return the Node.
*
* @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
*/
WFS.prototype.writeTransaction = function(inserts, updates, deletes, options) {
const objectStack = [];
const node = createElementNS(WFSNS, 'Transaction');
const version = options.version ? options.version : DEFAULT_VERSION;
const gmlVersion = version === '1.0.0' ? 2 : 3;
node.setAttribute('service', 'WFS');
node.setAttribute('version', version);
let baseObj;
/** @type {module:ol/xml~NodeStackItem} */
let obj;
if (options) {
baseObj = options.gmlOptions ? options.gmlOptions : {};
if (options.handle) {
node.setAttribute('handle', options.handle);
}
}
const schemaLocation = SCHEMA_LOCATIONS[version];
node.setAttributeNS(XML_SCHEMA_INSTANCE_URI, 'xsi:schemaLocation', schemaLocation);
const featurePrefix = options.featurePrefix ? options.featurePrefix : FEATURE_PREFIX;
if (inserts) {
obj = {node: node, 'featureNS': options.featureNS,
'featureType': options.featureType, 'featurePrefix': featurePrefix,
'gmlVersion': gmlVersion, 'hasZ': options.hasZ, 'srsName': options.srsName};
assign(obj, baseObj);
pushSerializeAndPop(obj,
TRANSACTION_SERIALIZERS,
makeSimpleNodeFactory('Insert'), inserts,
objectStack);
}
if (updates) {
obj = {node: node, 'featureNS': options.featureNS,
'featureType': options.featureType, 'featurePrefix': featurePrefix,
'gmlVersion': gmlVersion, 'hasZ': options.hasZ, 'srsName': options.srsName};
assign(obj, baseObj);
pushSerializeAndPop(obj,
TRANSACTION_SERIALIZERS,
makeSimpleNodeFactory('Update'), updates,
objectStack);
}
if (deletes) {
pushSerializeAndPop({node: node, 'featureNS': options.featureNS,
'featureType': options.featureType, 'featurePrefix': featurePrefix,
'gmlVersion': gmlVersion, 'srsName': options.srsName},
TRANSACTION_SERIALIZERS,
makeSimpleNodeFactory('Delete'), deletes,
objectStack);
}
if (options.nativeElements) {
pushSerializeAndPop({node: node, 'featureNS': options.featureNS,
'featureType': options.featureType, 'featurePrefix': featurePrefix,
'gmlVersion': gmlVersion, 'srsName': options.srsName},
TRANSACTION_SERIALIZERS,
makeSimpleNodeFactory('Native'), options.nativeElements,
objectStack);
}
return node;
};
/**
* Read the projection from a WFS source.
*
* @function
* @param {Document|Node|Object|string} source Source.
* @return {?module:ol/proj/Projection} Projection.
* @api
*/
WFS.prototype.readProjection;
/**
* @inheritDoc
*/
WFS.prototype.readProjectionFromDocument = function(doc) {
for (let n = doc.firstChild; n; n = n.nextSibling) {
if (n.nodeType == Node.ELEMENT_NODE) {
return this.readProjectionFromNode(n);
}
}
return null;
};
/**
* @inheritDoc
*/
WFS.prototype.readProjectionFromNode = function(node) {
if (node.firstElementChild &&
node.firstElementChild.firstElementChild) {
node = node.firstElementChild.firstElementChild;
for (let n = node.firstElementChild; n; n = n.nextElementSibling) {
if (!(n.childNodes.length === 0 ||
(n.childNodes.length === 1 &&
n.firstChild.nodeType === 3))) {
const objectStack = [{}];
this.gmlFormat_.readGeometryElement(n, objectStack);
return getProjection(objectStack.pop().srsName);
}
}
}
return null;
};
export default WFS;
src/ol/format/WKT.js
+282 -354
View File
@@ -1,7 +1,6 @@
/**
* @module ol/format/WKT
*/
import {inherits} from '../util.js';
import Feature from '../Feature.js';
import {transformWithOptions} from '../format/Feature.js';
import TextFeature from '../format/TextFeature.js';
@@ -17,6 +16,19 @@ import Polygon from '../geom/Polygon.js';
import SimpleGeometry from '../geom/SimpleGeometry.js';
/**
* @enum {function (new:module:ol/geom/Geometry, Array, module:ol/geom/GeometryLayout)}
*/
const GeometryConstructor = {
'POINT': Point,
'LINESTRING': LineString,
'POLYGON': Polygon,
'MULTIPOINT': MultiPoint,
'MULTILINESTRING': MultiLineString,
'MULTIPOLYGON': MultiPolygon
};
/**
* @typedef {Object} Options
* @property {boolean} [splitCollection=false] Whether to split GeometryCollections into
@@ -71,13 +83,25 @@ const TokenType = {
EOF: 6
};
/**
* @const
* @type {Object.<string, string>}
*/
const WKTGeometryType = {};
for (const type in GeometryType) {
WKTGeometryType[type] = GeometryType[type].toUpperCase();
}
/**
* Class to tokenize a WKT string.
* @param {string} wkt WKT string.
* @constructor
*/
const Lexer = function(wkt) {
class Lexer {
/**
* @param {string} wkt WKT string.
*/
constructor(wkt) {
/**
* @type {string}
@@ -89,56 +113,51 @@ const Lexer = function(wkt) {
* @private
*/
this.index_ = -1;
};
}
/**
/**
* @param {string} c Character.
* @return {boolean} Whether the character is alphabetic.
* @private
*/
Lexer.prototype.isAlpha_ = function(c) {
isAlpha_(c) {
return c >= 'a' && c <= 'z' || c >= 'A' && c <= 'Z';
};
}
/**
/**
* @param {string} c Character.
* @param {boolean=} opt_decimal Whether the string number
* contains a dot, i.e. is a decimal number.
* @return {boolean} Whether the character is numeric.
* @private
*/
Lexer.prototype.isNumeric_ = function(c, opt_decimal) {
isNumeric_(c, opt_decimal) {
const decimal = opt_decimal !== undefined ? opt_decimal : false;
return c >= '0' && c <= '9' || c == '.' && !decimal;
};
}
/**
/**
* @param {string} c Character.
* @return {boolean} Whether the character is whitespace.
* @private
*/
Lexer.prototype.isWhiteSpace_ = function(c) {
isWhiteSpace_(c) {
return c == ' ' || c == '\t' || c == '\r' || c == '\n';
};
}
/**
/**
* @return {string} Next string character.
* @private
*/
Lexer.prototype.nextChar_ = function() {
nextChar_() {
return this.wkt.charAt(++this.index_);
};
}
/**
/**
* Fetch and return the next token.
* @return {!module:ol/format/WKT~Token} Next string token.
*/
Lexer.prototype.nextToken = function() {
nextToken() {
const c = this.nextChar_();
const token = {position: this.index_, value: c};
@@ -163,14 +182,13 @@ Lexer.prototype.nextToken = function() {
}
return token;
};
}
/**
/**
* @return {number} Numeric token value.
* @private
*/
Lexer.prototype.readNumber_ = function() {
readNumber_() {
let c;
const index = this.index_;
let decimal = false;
@@ -192,29 +210,31 @@ Lexer.prototype.readNumber_ = function() {
scientificNotation && (c == '-' || c == '+')
);
return parseFloat(this.wkt.substring(index, this.index_--));
};
}
/**
/**
* @return {string} String token value.
* @private
*/
Lexer.prototype.readText_ = function() {
readText_() {
let c;
const index = this.index_;
do {
c = this.nextChar_();
} while (this.isAlpha_(c));
return this.wkt.substring(index, this.index_--).toUpperCase();
};
}
}
/**
* Class to parse the tokens from the WKT string.
* @param {module:ol/format/WKT~Lexer} lexer The lexer.
* @constructor
*/
const Parser = function(lexer) {
class Parser {
/**
* @param {module:ol/format/WKT~Lexer} lexer The lexer.
*/
constructor(lexer) {
/**
* @type {module:ol/format/WKT~Lexer}
@@ -233,59 +253,55 @@ const Parser = function(lexer) {
* @private
*/
this.layout_ = GeometryLayout.XY;
};
}
/**
/**
* Fetch the next token form the lexer and replace the active token.
* @private
*/
Parser.prototype.consume_ = function() {
consume_() {
this.token_ = this.lexer_.nextToken();
};
}
/**
/**
* Tests if the given type matches the type of the current token.
* @param {module:ol/format/WKT~TokenType} type Token type.
* @return {boolean} Whether the token matches the given type.
*/
Parser.prototype.isTokenType = function(type) {
isTokenType(type) {
const isMatch = this.token_.type == type;
return isMatch;
};
}
/**
/**
* If the given type matches the current token, consume it.
* @param {module:ol/format/WKT~TokenType} type Token type.
* @return {boolean} Whether the token matches the given type.
*/
Parser.prototype.match = function(type) {
match(type) {
const isMatch = this.isTokenType(type);
if (isMatch) {
this.consume_();
}
return isMatch;
};
}
/**
/**
* Try to parse the tokens provided by the lexer.
* @return {module:ol/geom/Geometry} The geometry.
*/
Parser.prototype.parse = function() {
parse() {
this.consume_();
const geometry = this.parseGeometry_();
return geometry;
};
}
/**
/**
* Try to parse the dimensional info.
* @return {module:ol/geom/GeometryLayout} The layout.
* @private
*/
Parser.prototype.parseGeometryLayout_ = function() {
parseGeometryLayout_() {
let layout = GeometryLayout.XY;
const dimToken = this.token_;
if (this.isTokenType(TokenType.TEXT)) {
@@ -302,14 +318,13 @@ Parser.prototype.parseGeometryLayout_ = function() {
}
}
return layout;
};
}
/**
/**
* @return {!Array.<module:ol/geom/Geometry>} A collection of geometries.
* @private
*/
Parser.prototype.parseGeometryCollectionText_ = function() {
parseGeometryCollectionText_() {
if (this.match(TokenType.LEFT_PAREN)) {
const geometries = [];
do {
@@ -322,14 +337,13 @@ Parser.prototype.parseGeometryCollectionText_ = function() {
return [];
}
throw new Error(this.formatErrorMessage_());
};
}
/**
/**
* @return {Array.<number>} All values in a point.
* @private
*/
Parser.prototype.parsePointText_ = function() {
parsePointText_() {
if (this.match(TokenType.LEFT_PAREN)) {
const coordinates = this.parsePoint_();
if (this.match(TokenType.RIGHT_PAREN)) {
@@ -339,14 +353,13 @@ Parser.prototype.parsePointText_ = function() {
return null;
}
throw new Error(this.formatErrorMessage_());
};
}
/**
/**
* @return {!Array.<!Array.<number>>} All points in a linestring.
* @private
*/
Parser.prototype.parseLineStringText_ = function() {
parseLineStringText_() {
if (this.match(TokenType.LEFT_PAREN)) {
const coordinates = this.parsePointList_();
if (this.match(TokenType.RIGHT_PAREN)) {
@@ -356,14 +369,13 @@ Parser.prototype.parseLineStringText_ = function() {
return [];
}
throw new Error(this.formatErrorMessage_());
};
}
/**
/**
* @return {!Array.<!Array.<number>>} All points in a polygon.
* @private
*/
Parser.prototype.parsePolygonText_ = function() {
parsePolygonText_() {
if (this.match(TokenType.LEFT_PAREN)) {
const coordinates = this.parseLineStringTextList_();
if (this.match(TokenType.RIGHT_PAREN)) {
@@ -373,14 +385,13 @@ Parser.prototype.parsePolygonText_ = function() {
return [];
}
throw new Error(this.formatErrorMessage_());
};
}
/**
/**
* @return {!Array.<!Array.<number>>} All points in a multipoint.
* @private
*/
Parser.prototype.parseMultiPointText_ = function() {
parseMultiPointText_() {
if (this.match(TokenType.LEFT_PAREN)) {
let coordinates;
if (this.token_.type == TokenType.LEFT_PAREN) {
@@ -395,15 +406,14 @@ Parser.prototype.parseMultiPointText_ = function() {
return [];
}
throw new Error(this.formatErrorMessage_());
};
}
/**
/**
* @return {!Array.<!Array.<number>>} All linestring points
* in a multilinestring.
* @private
*/
Parser.prototype.parseMultiLineStringText_ = function() {
parseMultiLineStringText_() {
if (this.match(TokenType.LEFT_PAREN)) {
const coordinates = this.parseLineStringTextList_();
if (this.match(TokenType.RIGHT_PAREN)) {
@@ -413,14 +423,13 @@ Parser.prototype.parseMultiLineStringText_ = function() {
return [];
}
throw new Error(this.formatErrorMessage_());
};
}
/**
/**
* @return {!Array.<!Array.<number>>} All polygon points in a multipolygon.
* @private
*/
Parser.prototype.parseMultiPolygonText_ = function() {
parseMultiPolygonText_() {
if (this.match(TokenType.LEFT_PAREN)) {
const coordinates = this.parsePolygonTextList_();
if (this.match(TokenType.RIGHT_PAREN)) {
@@ -430,14 +439,13 @@ Parser.prototype.parseMultiPolygonText_ = function() {
return [];
}
throw new Error(this.formatErrorMessage_());
};
}
/**
/**
* @return {!Array.<number>} A point.
* @private
*/
Parser.prototype.parsePoint_ = function() {
parsePoint_() {
const coordinates = [];
const dimensions = this.layout_.length;
for (let i = 0; i < dimensions; ++i) {
@@ -452,84 +460,141 @@ Parser.prototype.parsePoint_ = function() {
return coordinates;
}
throw new Error(this.formatErrorMessage_());
};
}
/**
/**
* @return {!Array.<!Array.<number>>} An array of points.
* @private
*/
Parser.prototype.parsePointList_ = function() {
parsePointList_() {
const coordinates = [this.parsePoint_()];
while (this.match(TokenType.COMMA)) {
coordinates.push(this.parsePoint_());
}
return coordinates;
};
}
/**
/**
* @return {!Array.<!Array.<number>>} An array of points.
* @private
*/
Parser.prototype.parsePointTextList_ = function() {
parsePointTextList_() {
const coordinates = [this.parsePointText_()];
while (this.match(TokenType.COMMA)) {
coordinates.push(this.parsePointText_());
}
return coordinates;
};
}
/**
/**
* @return {!Array.<!Array.<number>>} An array of points.
* @private
*/
Parser.prototype.parseLineStringTextList_ = function() {
parseLineStringTextList_() {
const coordinates = [this.parseLineStringText_()];
while (this.match(TokenType.COMMA)) {
coordinates.push(this.parseLineStringText_());
}
return coordinates;
};
}
/**
/**
* @return {!Array.<!Array.<number>>} An array of points.
* @private
*/
Parser.prototype.parsePolygonTextList_ = function() {
parsePolygonTextList_() {
const coordinates = [this.parsePolygonText_()];
while (this.match(TokenType.COMMA)) {
coordinates.push(this.parsePolygonText_());
}
return coordinates;
};
}
/**
/**
* @return {boolean} Whether the token implies an empty geometry.
* @private
*/
Parser.prototype.isEmptyGeometry_ = function() {
isEmptyGeometry_() {
const isEmpty = this.isTokenType(TokenType.TEXT) &&
this.token_.value == EMPTY;
if (isEmpty) {
this.consume_();
}
return isEmpty;
};
}
/**
/**
* Create an error message for an unexpected token error.
* @return {string} Error message.
* @private
*/
Parser.prototype.formatErrorMessage_ = function() {
formatErrorMessage_() {
return 'Unexpected `' + this.token_.value + '` at position ' +
this.token_.position + ' in `' + this.lexer_.wkt + '`';
};
}
/**
* @return {!module:ol/geom/Geometry} The geometry.
* @private
*/
parseGeometry_() {
const token = this.token_;
if (this.match(TokenType.TEXT)) {
const geomType = token.value;
this.layout_ = this.parseGeometryLayout_();
if (geomType == 'GEOMETRYCOLLECTION') {
const geometries = this.parseGeometryCollectionText_();
return new GeometryCollection(geometries);
} else {
const ctor = GeometryConstructor[geomType];
if (!ctor) {
throw new Error('Invalid geometry type: ' + geomType);
}
let coordinates;
switch (geomType) {
case 'POINT': {
coordinates = this.parsePointText_();
break;
}
case 'LINESTRING': {
coordinates = this.parseLineStringText_();
break;
}
case 'POLYGON': {
coordinates = this.parsePolygonText_();
break;
}
case 'MULTIPOINT': {
coordinates = this.parseMultiPointText_();
break;
}
case 'MULTILINESTRING': {
coordinates = this.parseMultiLineStringText_();
break;
}
case 'MULTIPOLYGON': {
coordinates = this.parseMultiPolygonText_();
break;
}
default: {
throw new Error('Invalid geometry type: ' + geomType);
}
}
if (!coordinates) {
if (ctor === GeometryConstructor['POINT']) {
coordinates = [NaN, NaN];
} else {
coordinates = [];
}
}
return new ctor(coordinates, this.layout_);
}
}
throw new Error(this.formatErrorMessage_());
}
}
/**
@@ -537,16 +602,18 @@ Parser.prototype.formatErrorMessage_ = function() {
* Geometry format for reading and writing data in the `WellKnownText` (WKT)
* format.
*
* @constructor
* @extends {module:ol/format/TextFeature}
* @param {module:ol/format/WKT~Options=} opt_options Options.
* @api
*/
const WKT = function(opt_options) {
class WKT extends TextFeature {
/**
* @param {module:ol/format/WKT~Options=} opt_options Options.
*/
constructor(opt_options) {
super();
const options = opt_options ? opt_options : {};
TextFeature.call(this);
/**
* Split GeometryCollection into multiple features.
@@ -556,9 +623,104 @@ const WKT = function(opt_options) {
this.splitCollection_ = options.splitCollection !== undefined ?
options.splitCollection : false;
};
}
inherits(WKT, TextFeature);
/**
* Parse a WKT string.
* @param {string} wkt WKT string.
* @return {module:ol/geom/Geometry|undefined}
* The geometry created.
* @private
*/
parse_(wkt) {
const lexer = new Lexer(wkt);
const parser = new Parser(lexer);
return parser.parse();
}
/**
* @inheritDoc
*/
readFeatureFromText(text, opt_options) {
const geom = this.readGeometryFromText(text, opt_options);
if (geom) {
const feature = new Feature();
feature.setGeometry(geom);
return feature;
}
return null;
}
/**
* @inheritDoc
*/
readFeaturesFromText(text, opt_options) {
let geometries = [];
const geometry = this.readGeometryFromText(text, opt_options);
if (this.splitCollection_ &&
geometry.getType() == GeometryType.GEOMETRY_COLLECTION) {
geometries = (/** @type {module:ol/geom/GeometryCollection} */ (geometry))
.getGeometriesArray();
} else {
geometries = [geometry];
}
const features = [];
for (let i = 0, ii = geometries.length; i < ii; ++i) {
const feature = new Feature();
feature.setGeometry(geometries[i]);
features.push(feature);
}
return features;
}
/**
* @inheritDoc
*/
readGeometryFromText(text, opt_options) {
const geometry = this.parse_(text);
if (geometry) {
return (
/** @type {module:ol/geom/Geometry} */ (transformWithOptions(geometry, false, opt_options))
);
} else {
return null;
}
}
/**
* @inheritDoc
*/
writeFeatureText(feature, opt_options) {
const geometry = feature.getGeometry();
if (geometry) {
return this.writeGeometryText(geometry, opt_options);
}
return '';
}
/**
* @inheritDoc
*/
writeFeaturesText(features, opt_options) {
if (features.length == 1) {
return this.writeFeatureText(features[0], opt_options);
}
const geometries = [];
for (let i = 0, ii = features.length; i < ii; ++i) {
geometries.push(features[i].getGeometry());
}
const collection = new GeometryCollection(geometries);
return this.writeGeometryText(collection, opt_options);
}
/**
* @inheritDoc
*/
writeGeometryText(geometry, opt_options) {
return encode(/** @type {module:ol/geom/Geometry} */ (
transformWithOptions(geometry, true, opt_options)));
}
}
/**
@@ -712,238 +874,4 @@ function encode(geom) {
}
/**
* Parse a WKT string.
* @param {string} wkt WKT string.
* @return {module:ol/geom/Geometry|undefined}
* The geometry created.
* @private
*/
WKT.prototype.parse_ = function(wkt) {
const lexer = new Lexer(wkt);
const parser = new Parser(lexer);
return parser.parse();
};
/**
* Read a feature from a WKT source.
*
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/Feature} Feature.
* @api
*/
WKT.prototype.readFeature;
/**
* @inheritDoc
*/
WKT.prototype.readFeatureFromText = function(text, opt_options) {
const geom = this.readGeometryFromText(text, opt_options);
if (geom) {
const feature = new Feature();
feature.setGeometry(geom);
return feature;
}
return null;
};
/**
* Read all features from a WKT source.
*
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {Array.<module:ol/Feature>} Features.
* @api
*/
WKT.prototype.readFeatures;
/**
* @inheritDoc
*/
WKT.prototype.readFeaturesFromText = function(text, opt_options) {
let geometries = [];
const geometry = this.readGeometryFromText(text, opt_options);
if (this.splitCollection_ &&
geometry.getType() == GeometryType.GEOMETRY_COLLECTION) {
geometries = (/** @type {module:ol/geom/GeometryCollection} */ (geometry))
.getGeometriesArray();
} else {
geometries = [geometry];
}
const features = [];
for (let i = 0, ii = geometries.length; i < ii; ++i) {
const feature = new Feature();
feature.setGeometry(geometries[i]);
features.push(feature);
}
return features;
};
/**
* Read a single geometry from a WKT source.
*
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/geom/Geometry} Geometry.
* @api
*/
WKT.prototype.readGeometry;
/**
* @inheritDoc
*/
WKT.prototype.readGeometryFromText = function(text, opt_options) {
const geometry = this.parse_(text);
if (geometry) {
return (
/** @type {module:ol/geom/Geometry} */ (transformWithOptions(geometry, false, opt_options))
);
} else {
return null;
}
};
/**
* @enum {function (new:module:ol/geom/Geometry, Array, module:ol/geom/GeometryLayout)}
*/
const GeometryConstructor = {
'POINT': Point,
'LINESTRING': LineString,
'POLYGON': Polygon,
'MULTIPOINT': MultiPoint,
'MULTILINESTRING': MultiLineString,
'MULTIPOLYGON': MultiPolygon
};
/**
* @enum {(function(): Array)}
*/
const GeometryParser = {
'POINT': Parser.prototype.parsePointText_,
'LINESTRING': Parser.prototype.parseLineStringText_,
'POLYGON': Parser.prototype.parsePolygonText_,
'MULTIPOINT': Parser.prototype.parseMultiPointText_,
'MULTILINESTRING': Parser.prototype.parseMultiLineStringText_,
'MULTIPOLYGON': Parser.prototype.parseMultiPolygonText_
};
/**
* @return {!module:ol/geom/Geometry} The geometry.
* @private
*/
Parser.prototype.parseGeometry_ = function() {
const token = this.token_;
if (this.match(TokenType.TEXT)) {
const geomType = token.value;
this.layout_ = this.parseGeometryLayout_();
if (geomType == GeometryType.GEOMETRY_COLLECTION.toUpperCase()) {
const geometries = this.parseGeometryCollectionText_();
return new GeometryCollection(geometries);
} else {
const parser = GeometryParser[geomType];
const ctor = GeometryConstructor[geomType];
if (!parser || !ctor) {
throw new Error('Invalid geometry type: ' + geomType);
}
let coordinates = parser.call(this);
if (!coordinates) {
if (ctor === GeometryConstructor[GeometryType.POINT]) {
coordinates = [NaN, NaN];
} else {
coordinates = [];
}
}
return new ctor(coordinates, this.layout_);
}
}
throw new Error(this.formatErrorMessage_());
};
/**
* Encode a feature as a WKT string.
*
* @function
* @param {module:ol/Feature} feature Feature.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} WKT string.
* @api
*/
WKT.prototype.writeFeature;
/**
* @inheritDoc
*/
WKT.prototype.writeFeatureText = function(feature, opt_options) {
const geometry = feature.getGeometry();
if (geometry) {
return this.writeGeometryText(geometry, opt_options);
}
return '';
};
/**
* Encode an array of features as a WKT string.
*
* @function
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} WKT string.
* @api
*/
WKT.prototype.writeFeatures;
/**
* @inheritDoc
*/
WKT.prototype.writeFeaturesText = function(features, opt_options) {
if (features.length == 1) {
return this.writeFeatureText(features[0], opt_options);
}
const geometries = [];
for (let i = 0, ii = features.length; i < ii; ++i) {
geometries.push(features[i].getGeometry());
}
const collection = new GeometryCollection(geometries);
return this.writeGeometryText(collection, opt_options);
};
/**
* Write a single geometry as a WKT string.
*
* @function
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} WKT string.
* @api
*/
WKT.prototype.writeGeometry;
/**
* @inheritDoc
*/
WKT.prototype.writeGeometryText = function(geometry, opt_options) {
return encode(/** @type {module:ol/geom/Geometry} */ (
transformWithOptions(geometry, true, opt_options)));
};
export default WKT;
src/ol/format/WMSCapabilities.js
+41 -58
View File
@@ -1,7 +1,6 @@
/**
* @module ol/format/WMSCapabilities
*/
import {inherits} from '../util.js';
import {readHref} from '../format/XLink.js';
import XML from '../format/XML.js';
import {readDecimalString, readString, readNonNegativeInteger, readDecimal, readBooleanString, readNonNegativeIntegerString} from '../format/xsd.js';
@@ -9,27 +8,6 @@ import {makeArrayPusher, makeObjectPropertyPusher, makeObjectPropertySetter,
makeStructureNS, pushParseAndPop} from '../xml.js';
/**
* @classdesc
* Format for reading WMS capabilities data
*
* @constructor
* @extends {module:ol/format/XML}
* @api
*/
const WMSCapabilities = function() {
XML.call(this);
/**
* @type {string|undefined}
*/
this.version = undefined;
};
inherits(WMSCapabilities, XML);
/**
* @const
* @type {Array.<null|string>}
@@ -63,6 +41,47 @@ const CAPABILITY_PARSERS = makeStructureNS(
});
/**
* @classdesc
* Format for reading WMS capabilities data
*
* @api
*/
class WMSCapabilities extends XML {
constructor() {
super();
/**
* @type {string|undefined}
*/
this.version = undefined;
}
/**
* @inheritDoc
*/
readFromDocument(doc) {
for (let n = doc.firstChild; n; n = n.nextSibling) {
if (n.nodeType == Node.ELEMENT_NODE) {
return this.readFromNode(n);
}
}
return null;
}
/**
* @inheritDoc
*/
readFromNode(node) {
this.version = node.getAttribute('version').trim();
const wmsCapabilityObject = pushParseAndPop({
'version': this.version
}, PARSERS, node, []);
return wmsCapabilityObject ? wmsCapabilityObject : null;
}
}
/**
* @const
* @type {Object.<string, Object.<string, module:ol/xml~Parser>>}
@@ -266,42 +285,6 @@ const KEYWORDLIST_PARSERS = makeStructureNS(
});
/**
* Read a WMS capabilities document.
*
* @function
* @param {Document|Node|string} source The XML source.
* @return {Object} An object representing the WMS capabilities.
* @api
*/
WMSCapabilities.prototype.read;
/**
* @inheritDoc
*/
WMSCapabilities.prototype.readFromDocument = function(doc) {
for (let n = doc.firstChild; n; n = n.nextSibling) {
if (n.nodeType == Node.ELEMENT_NODE) {
return this.readFromNode(n);
}
}
return null;
};
/**
* @inheritDoc
*/
WMSCapabilities.prototype.readFromNode = function(node) {
this.version = node.getAttribute('version').trim();
const wmsCapabilityObject = pushParseAndPop({
'version': this.version
}, PARSERS, node, []);
return wmsCapabilityObject ? wmsCapabilityObject : null;
};
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
src/ol/format/WMSGetFeatureInfo.js
+43 -61
View File
@@ -1,7 +1,6 @@
/**
* @module ol/format/WMSGetFeatureInfo
*/
import {inherits} from '../util.js';
import {extend, includes} from '../array.js';
import GML2 from '../format/GML2.js';
import XMLFeature from '../format/XMLFeature.js';
@@ -15,17 +14,34 @@ import {makeArrayPusher, makeStructureNS, pushParseAndPop} from '../xml.js';
*/
/**
* @const
* @type {string}
*/
const featureIdentifier = '_feature';
/**
* @const
* @type {string}
*/
const layerIdentifier = '_layer';
/**
* @classdesc
* Format for reading WMSGetFeatureInfo format. It uses
* {@link module:ol/format/GML2~GML2} to read features.
*
* @constructor
* @extends {module:ol/format/XMLFeature}
* @param {module:ol/format/WMSGetFeatureInfo~Options=} opt_options Options.
* @api
*/
const WMSGetFeatureInfo = function(opt_options) {
class WMSGetFeatureInfo extends XMLFeature {
/**
* @param {module:ol/format/WMSGetFeatureInfo~Options=} opt_options Options.
*/
constructor(opt_options) {
super();
const options = opt_options ? opt_options : {};
@@ -48,50 +64,29 @@ const WMSGetFeatureInfo = function(opt_options) {
* @type {Array.<string>}
*/
this.layers_ = options.layers ? options.layers : null;
}
XMLFeature.call(this);
};
inherits(WMSGetFeatureInfo, XMLFeature);
/**
* @const
* @type {string}
*/
const featureIdentifier = '_feature';
/**
* @const
* @type {string}
*/
const layerIdentifier = '_layer';
/**
/**
* @return {Array.<string>} layers
*/
WMSGetFeatureInfo.prototype.getLayers = function() {
getLayers() {
return this.layers_;
};
}
/**
/**
* @param {Array.<string>} layers Layers to parse.
*/
WMSGetFeatureInfo.prototype.setLayers = function(layers) {
setLayers(layers) {
this.layers_ = layers;
};
}
/**
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {Array.<module:ol/Feature>} Features.
* @private
*/
WMSGetFeatureInfo.prototype.readFeatures_ = function(node, objectStack) {
readFeatures_(node, objectStack) {
node.setAttribute('namespaceURI', this.featureNS_);
const localName = node.localName;
/** @type {Array.<module:ol/Feature>} */
@@ -142,50 +137,37 @@ WMSGetFeatureInfo.prototype.readFeatures_ = function(node, objectStack) {
}
}
return features;
};
}
/**
* Read all features from a WMSGetFeatureInfo response.
*
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Options.
* @return {Array.<module:ol/Feature>} Features.
* @api
*/
WMSGetFeatureInfo.prototype.readFeatures;
/**
/**
* @inheritDoc
*/
WMSGetFeatureInfo.prototype.readFeaturesFromNode = function(node, opt_options) {
readFeaturesFromNode(node, opt_options) {
const options = {};
if (opt_options) {
assign(options, this.getReadOptions(node, opt_options));
}
return this.readFeatures_(node, [options]);
};
}
/**
/**
* Not implemented.
* @inheritDoc
*/
WMSGetFeatureInfo.prototype.writeFeatureNode = function(feature, opt_options) {};
writeFeatureNode(feature, opt_options) {}
/**
/**
* Not implemented.
* @inheritDoc
*/
WMSGetFeatureInfo.prototype.writeFeaturesNode = function(features, opt_options) {};
writeFeaturesNode(features, opt_options) {}
/**
/**
* Not implemented.
* @inheritDoc
*/
WMSGetFeatureInfo.prototype.writeGeometryNode = function(geometry, opt_options) {};
writeGeometryNode(geometry, opt_options) {}
}
export default WMSGetFeatureInfo;
src/ol/format/WMTSCapabilities.js
+45 -60
View File
@@ -1,7 +1,6 @@
/**
* @module ol/format/WMTSCapabilities
*/
import {inherits} from '../util.js';
import {boundingExtent} from '../extent.js';
import OWS from '../format/OWS.js';
import {readHref} from '../format/XLink.js';
@@ -10,26 +9,6 @@ import {readString, readNonNegativeInteger, readDecimal} from '../format/xsd.js'
import {pushParseAndPop, makeStructureNS,
makeObjectPropertySetter, makeObjectPropertyPusher, makeArrayPusher} from '../xml.js';
/**
* @classdesc
* Format for reading WMTS capabilities data.
*
* @constructor
* @extends {module:ol/format/XML}
* @api
*/
const WMTSCapabilities = function() {
XML.call(this);
/**
* @type {module:ol/format/OWS}
* @private
*/
this.owsParser_ = new OWS();
};
inherits(WMTSCapabilities, XML);
/**
* @const
@@ -61,6 +40,51 @@ const PARSERS = makeStructureNS(
});
/**
* @classdesc
* Format for reading WMTS capabilities data.
*
* @api
*/
class WMTSCapabilities extends XML {
constructor() {
super();
/**
* @type {module:ol/format/OWS}
* @private
*/
this.owsParser_ = new OWS();
}
/**
* @inheritDoc
*/
readFromDocument(doc) {
for (let n = doc.firstChild; n; n = n.nextSibling) {
if (n.nodeType == Node.ELEMENT_NODE) {
return this.readFromNode(n);
}
}
return null;
}
/**
* @inheritDoc
*/
readFromNode(node) {
const version = node.getAttribute('version').trim();
let WMTSCapabilityObject = this.owsParser_.readFromNode(node);
if (!WMTSCapabilityObject) {
return null;
}
WMTSCapabilityObject['version'] = version;
WMTSCapabilityObject = pushParseAndPop(WMTSCapabilityObject, PARSERS, node, []);
return WMTSCapabilityObject ? WMTSCapabilityObject : null;
}
}
/**
* @const
* @type {Object.<string, Object.<string, module:ol/xml~Parser>>}
@@ -193,45 +217,6 @@ const TM_PARSERS = makeStructureNS(
}));
/**
* Read a WMTS capabilities document.
*
* @function
* @param {Document|Node|string} source The XML source.
* @return {Object} An object representing the WMTS capabilities.
* @api
*/
WMTSCapabilities.prototype.read;
/**
* @inheritDoc
*/
WMTSCapabilities.prototype.readFromDocument = function(doc) {
for (let n = doc.firstChild; n; n = n.nextSibling) {
if (n.nodeType == Node.ELEMENT_NODE) {
return this.readFromNode(n);
}
}
return null;
};
/**
* @inheritDoc
*/
WMTSCapabilities.prototype.readFromNode = function(node) {
const version = node.getAttribute('version').trim();
let WMTSCapabilityObject = this.owsParser_.readFromNode(node);
if (!WMTSCapabilityObject) {
return null;
}
WMTSCapabilityObject['version'] = version;
WMTSCapabilityObject = pushParseAndPop(WMTSCapabilityObject, PARSERS, node, []);
return WMTSCapabilityObject ? WMTSCapabilityObject : null;
};
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
src/ol/format/XML.js
+15 -17
View File
@@ -7,19 +7,17 @@ import {isDocument, isNode, parse} from '../xml.js';
* @classdesc
* Generic format for reading non-feature XML data
*
* @constructor
* @abstract
* @struct
*/
const XML = function() {
};
/**
* @param {Document|Node|string} source Source.
* @return {Object} The parsed result.
class XML {
/**
* Read the source document.
*
* @param {Document|Node|string} source The XML source.
* @return {Object} An object representing the source.
* @api
*/
XML.prototype.read = function(source) {
read(source) {
if (isDocument(source)) {
return this.readFromDocument(/** @type {Document} */ (source));
} else if (isNode(source)) {
@@ -30,21 +28,21 @@ XML.prototype.read = function(source) {
} else {
return null;
}
};
}
/**
/**
* @abstract
* @param {Document} doc Document.
* @return {Object} Object
*/
XML.prototype.readFromDocument = function(doc) {};
readFromDocument(doc) {}
/**
/**
* @abstract
* @param {Node} node Node.
* @return {Object} Object
*/
XML.prototype.readFromNode = function(node) {};
readFromNode(node) {}
}
export default XML;
src/ol/format/XMLFeature.js
+87 -88
View File
@@ -1,7 +1,6 @@
/**
* @module ol/format/XMLFeature
*/
import {inherits} from '../util.js';
import {extend} from '../array.js';
import FeatureFormat from '../format/Feature.js';
import FormatType from '../format/FormatType.js';
@@ -13,36 +12,35 @@ import {isDocument, isNode, parse} from '../xml.js';
* instantiated in apps.
* Base class for XML feature formats.
*
* @constructor
* @abstract
* @extends {module:ol/format/Feature}
*/
const XMLFeature = function() {
class XMLFeature extends FeatureFormat {
constructor() {
super();
/**
* @type {XMLSerializer}
* @private
*/
this.xmlSerializer_ = new XMLSerializer();
}
FeatureFormat.call(this);
};
inherits(XMLFeature, FeatureFormat);
/**
/**
* @inheritDoc
*/
XMLFeature.prototype.getType = function() {
getType() {
return FormatType.XML;
};
}
/**
* @inheritDoc
/**
* Read a single feature.
*
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/Feature} Feature.
* @api
*/
XMLFeature.prototype.readFeature = function(source, opt_options) {
readFeature(source, opt_options) {
if (isDocument(source)) {
return this.readFeatureFromDocument(/** @type {Document} */ (source), opt_options);
} else if (isNode(source)) {
@@ -53,38 +51,41 @@ XMLFeature.prototype.readFeature = function(source, opt_options) {
} else {
return null;
}
};
}
/**
/**
* @param {Document} doc Document.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Options.
* @return {module:ol/Feature} Feature.
*/
XMLFeature.prototype.readFeatureFromDocument = function(doc, opt_options) {
readFeatureFromDocument(doc, opt_options) {
const features = this.readFeaturesFromDocument(doc, opt_options);
if (features.length > 0) {
return features[0];
} else {
return null;
}
};
}
/**
/**
* @param {Node} node Node.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Options.
* @return {module:ol/Feature} Feature.
*/
XMLFeature.prototype.readFeatureFromNode = function(node, opt_options) {
readFeatureFromNode(node, opt_options) {
return null; // not implemented
};
}
/**
* @inheritDoc
/**
* Read all features from a feature collection.
*
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Options.
* @return {Array.<module:ol/Feature>} Features.
* @api
*/
XMLFeature.prototype.readFeatures = function(source, opt_options) {
readFeatures(source, opt_options) {
if (isDocument(source)) {
return this.readFeaturesFromDocument(
/** @type {Document} */ (source), opt_options);
@@ -96,16 +97,15 @@ XMLFeature.prototype.readFeatures = function(source, opt_options) {
} else {
return [];
}
};
}
/**
/**
* @param {Document} doc Document.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Options.
* @protected
* @return {Array.<module:ol/Feature>} Features.
*/
XMLFeature.prototype.readFeaturesFromDocument = function(doc, opt_options) {
readFeaturesFromDocument(doc, opt_options) {
/** @type {Array.<module:ol/Feature>} */
const features = [];
for (let n = doc.firstChild; n; n = n.nextSibling) {
@@ -114,23 +114,21 @@ XMLFeature.prototype.readFeaturesFromDocument = function(doc, opt_options) {
}
}
return features;
};
}
/**
/**
* @abstract
* @param {Node} node Node.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Options.
* @protected
* @return {Array.<module:ol/Feature>} Features.
*/
XMLFeature.prototype.readFeaturesFromNode = function(node, opt_options) {};
readFeaturesFromNode(node, opt_options) {}
/**
/**
* @inheritDoc
*/
XMLFeature.prototype.readGeometry = function(source, opt_options) {
readGeometry(source, opt_options) {
if (isDocument(source)) {
return this.readGeometryFromDocument(
/** @type {Document} */ (source), opt_options);
@@ -142,35 +140,36 @@ XMLFeature.prototype.readGeometry = function(source, opt_options) {
} else {
return null;
}
};
}
/**
/**
* @param {Document} doc Document.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Options.
* @protected
* @return {module:ol/geom/Geometry} Geometry.
*/
XMLFeature.prototype.readGeometryFromDocument = function(doc, opt_options) {
readGeometryFromDocument(doc, opt_options) {
return null; // not implemented
};
}
/**
/**
* @param {Node} node Node.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Options.
* @protected
* @return {module:ol/geom/Geometry} Geometry.
*/
XMLFeature.prototype.readGeometryFromNode = function(node, opt_options) {
readGeometryFromNode(node, opt_options) {
return null; // not implemented
};
}
/**
* @inheritDoc
/**
* Read the projection from the source.
*
* @param {Document|Node|Object|string} source Source.
* @return {module:ol/proj/Projection} Projection.
* @api
*/
XMLFeature.prototype.readProjection = function(source) {
readProjection(source) {
if (isDocument(source)) {
return this.readProjectionFromDocument(/** @type {Document} */ (source));
} else if (isNode(source)) {
@@ -181,83 +180,83 @@ XMLFeature.prototype.readProjection = function(source) {
} else {
return null;
}
};
}
/**
/**
* @param {Document} doc Document.
* @protected
* @return {module:ol/proj/Projection} Projection.
*/
XMLFeature.prototype.readProjectionFromDocument = function(doc) {
readProjectionFromDocument(doc) {
return this.dataProjection;
};
}
/**
/**
* @param {Node} node Node.
* @protected
* @return {module:ol/proj/Projection} Projection.
*/
XMLFeature.prototype.readProjectionFromNode = function(node) {
readProjectionFromNode(node) {
return this.dataProjection;
};
}
/**
/**
* @inheritDoc
*/
XMLFeature.prototype.writeFeature = function(feature, opt_options) {
writeFeature(feature, opt_options) {
const node = this.writeFeatureNode(feature, opt_options);
return this.xmlSerializer_.serializeToString(node);
};
}
/**
/**
* @param {module:ol/Feature} feature Feature.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Options.
* @protected
* @return {Node} Node.
*/
XMLFeature.prototype.writeFeatureNode = function(feature, opt_options) {
writeFeatureNode(feature, opt_options) {
return null; // not implemented
};
}
/**
* @inheritDoc
/**
* Encode an array of features as string.
*
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} Result.
* @api
*/
XMLFeature.prototype.writeFeatures = function(features, opt_options) {
writeFeatures(features, opt_options) {
const node = this.writeFeaturesNode(features, opt_options);
return this.xmlSerializer_.serializeToString(node);
};
}
/**
/**
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Options.
* @return {Node} Node.
*/
XMLFeature.prototype.writeFeaturesNode = function(features, opt_options) {
writeFeaturesNode(features, opt_options) {
return null; // not implemented
};
}
/**
/**
* @inheritDoc
*/
XMLFeature.prototype.writeGeometry = function(geometry, opt_options) {
writeGeometry(geometry, opt_options) {
const node = this.writeGeometryNode(geometry, opt_options);
return this.xmlSerializer_.serializeToString(node);
};
}
/**
/**
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Options.
* @return {Node} Node.
*/
XMLFeature.prototype.writeGeometryNode = function(geometry, opt_options) {
writeGeometryNode(geometry, opt_options) {
return null; // not implemented
};
}
}
export default XMLFeature;
src/ol/format/filter/And.js
+10 -9
View File
@@ -1,23 +1,24 @@
/**
* @module ol/format/filter/And
*/
import {inherits} from '../../util.js';
import LogicalNary from '../filter/LogicalNary.js';
/**
* @classdesc
* Represents a logical `<And>` operator between two or more filter conditions.
*
* @constructor
* @abstract
* @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));
LogicalNary.apply(this, params);
};
class And extends LogicalNary {
inherits(And, LogicalNary);
/**
* @param {...module:ol/format/filter/Filter} conditions Conditions.
*/
constructor(conditions) {
const params = ['And'].concat(Array.prototype.slice.call(arguments));
super(...params);
}
}
export default And;
src/ol/format/filter/Bbox.js
+12 -11
View File
@@ -1,7 +1,6 @@
/**
* @module ol/format/filter/Bbox
*/
import {inherits} from '../../util.js';
import Filter from '../filter/Filter.js';
/**
@@ -9,17 +8,19 @@ import Filter from '../filter/Filter.js';
* Represents a `<BBOX>` operator to test whether a geometry-valued property
* intersects a fixed bounding box
*
* @constructor
* @param {!string} geometryName Geometry name to use.
* @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}
* @api
*/
const Bbox = function(geometryName, extent, opt_srsName) {
class Bbox extends Filter {
Filter.call(this, 'BBOX');
/**
* @param {!string} geometryName Geometry name to use.
* @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.
*/
constructor(geometryName, extent, opt_srsName) {
super('BBOX');
/**
* @type {!string}
@@ -35,8 +36,8 @@ const Bbox = function(geometryName, extent, opt_srsName) {
* @type {string|undefined}
*/
this.srsName = opt_srsName;
};
}
inherits(Bbox, Filter);
}
export default Bbox;
src/ol/format/filter/Comparison.js
+8 -7
View File
@@ -1,7 +1,6 @@
/**
* @module ol/format/filter/Comparison
*/
import {inherits} from '../../util.js';
import Filter from '../filter/Filter.js';
/**
@@ -9,22 +8,24 @@ import Filter from '../filter/Filter.js';
* Abstract class; normally only used for creating subclasses and not instantiated in apps.
* Base class for WFS GetFeature property comparison filters.
*
* @constructor
* @abstract
*/
class Comparison extends Filter {
/**
* @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}
*/
const Comparison = function(tagName, propertyName) {
constructor(tagName, propertyName) {
Filter.call(this, tagName);
super(tagName);
/**
* @type {!string}
*/
this.propertyName = propertyName;
};
}
inherits(Comparison, Filter);
}
export default Comparison;
src/ol/format/filter/ComparisonBinary.js
+9 -7
View File
@@ -1,7 +1,6 @@
/**
* @module ol/format/filter/ComparisonBinary
*/
import {inherits} from '../../util.js';
import Comparison from '../filter/Comparison.js';
/**
@@ -9,17 +8,19 @@ import Comparison from '../filter/Comparison.js';
* Abstract class; normally only used for creating subclasses and not instantiated in apps.
* Base class for WFS GetFeature property binary comparison filters.
*
* @constructor
* @abstract
*/
class ComparisonBinary extends Comparison {
/**
* @param {!string} tagName The XML tag name for this filter.
* @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}
*/
const ComparisonBinary = function(tagName, propertyName, expression, opt_matchCase) {
constructor(tagName, propertyName, expression, opt_matchCase) {
Comparison.call(this, tagName, propertyName);
super(tagName, propertyName);
/**
* @type {!(string|number)}
@@ -30,7 +31,8 @@ const ComparisonBinary = function(tagName, propertyName, expression, opt_matchCa
* @type {boolean|undefined}
*/
this.matchCase = opt_matchCase;
};
}
}
inherits(ComparisonBinary, Comparison);
export default ComparisonBinary;
src/ol/format/filter/Contains.js
+9 -8
View File
@@ -1,27 +1,28 @@
/**
* @module ol/format/filter/Contains
*/
import {inherits} from '../../util.js';
import Spatial from '../filter/Spatial.js';
/**
* @classdesc
* Represents a `<Contains>` operator to test whether a geometry-valued property
* contains a given geometry.
*
* @constructor
*/
class Contains extends Spatial {
/**
* @param {!string} geometryName Geometry name to use.
* @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}
* @api
*/
const Contains = function(geometryName, geometry, opt_srsName) {
constructor(geometryName, geometry, opt_srsName) {
Spatial.call(this, 'Contains', geometryName, geometry, opt_srsName);
super('Contains', geometryName, geometry, opt_srsName);
};
}
}
inherits(Contains, Spatial);
export default Contains;
src/ol/format/filter/During.js
+9 -8
View File
@@ -1,22 +1,22 @@
/**
* @module ol/format/filter/During
*/
import {inherits} from '../../util.js';
import Comparison from '../filter/Comparison.js';
/**
* @classdesc
* Represents a `<During>` comparison operator.
*
* @constructor
*/
class During extends Comparison {
/**
* @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}
* @api
*/
const During = function(propertyName, begin, end) {
Comparison.call(this, 'During', propertyName);
constructor(propertyName, begin, end) {
super('During', propertyName);
/**
* @type {!string}
@@ -27,7 +27,8 @@ const During = function(propertyName, begin, end) {
* @type {!string}
*/
this.end = end;
};
}
}
inherits(During, Comparison);
export default During;
src/ol/format/filter/EqualTo.js
+9 -8
View File
@@ -1,23 +1,24 @@
/**
* @module ol/format/filter/EqualTo
*/
import {inherits} from '../../util.js';
import ComparisonBinary from '../filter/ComparisonBinary.js';
/**
* @classdesc
* Represents a `<PropertyIsEqualTo>` comparison operator.
*
* @constructor
*/
class EqualTo extends ComparisonBinary {
/**
* @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}
* @api
*/
const EqualTo = function(propertyName, expression, opt_matchCase) {
ComparisonBinary.call(this, 'PropertyIsEqualTo', propertyName, expression, opt_matchCase);
};
constructor(propertyName, expression, opt_matchCase) {
super('PropertyIsEqualTo', propertyName, expression, opt_matchCase);
}
}
inherits(EqualTo, ComparisonBinary);
export default EqualTo;
src/ol/format/filter/Filter.js
+10 -8
View File
@@ -8,26 +8,28 @@
* Abstract class; normally only used for creating subclasses and not instantiated in apps.
* Base class for WFS GetFeature filters.
*
* @constructor
* @abstract
* @param {!string} tagName The XML tag name for this filter.
* @struct
*/
const Filter = function(tagName) {
class Filter {
/**
* @param {!string} tagName The XML tag name for this filter.
*/
constructor(tagName) {
/**
* @private
* @type {!string}
*/
this.tagName_ = tagName;
};
}
/**
/**
* The XML tag name for a filter.
* @returns {!string} Name.
*/
Filter.prototype.getTagName = function() {
getTagName() {
return this.tagName_;
};
}
}
export default Filter;
src/ol/format/filter/GreaterThan.js
+9 -8
View File
@@ -1,22 +1,23 @@
/**
* @module ol/format/filter/GreaterThan
*/
import {inherits} from '../../util.js';
import ComparisonBinary from '../filter/ComparisonBinary.js';
/**
* @classdesc
* Represents a `<PropertyIsGreaterThan>` comparison operator.
*
* @constructor
*/
class GreaterThan extends ComparisonBinary {
/**
* @param {!string} propertyName Name of the context property to compare.
* @param {!number} expression The value to compare.
* @extends {module:ol/format/filter/ComparisonBinary}
* @api
*/
const GreaterThan = function(propertyName, expression) {
ComparisonBinary.call(this, 'PropertyIsGreaterThan', propertyName, expression);
};
constructor(propertyName, expression) {
super('PropertyIsGreaterThan', propertyName, expression);
}
}
inherits(GreaterThan, ComparisonBinary);
export default GreaterThan;
src/ol/format/filter/GreaterThanOrEqualTo.js
+9 -8
View File
@@ -1,22 +1,23 @@
/**
* @module ol/format/filter/GreaterThanOrEqualTo
*/
import {inherits} from '../../util.js';
import ComparisonBinary from '../filter/ComparisonBinary.js';
/**
* @classdesc
* Represents a `<PropertyIsGreaterThanOrEqualTo>` comparison operator.
*
* @constructor
*/
class GreaterThanOrEqualTo extends ComparisonBinary {
/**
* @param {!string} propertyName Name of the context property to compare.
* @param {!number} expression The value to compare.
* @extends {module:ol/format/filter/ComparisonBinary}
* @api
*/
const GreaterThanOrEqualTo = function(propertyName, expression) {
ComparisonBinary.call(this, 'PropertyIsGreaterThanOrEqualTo', propertyName, expression);
};
constructor(propertyName, expression) {
super('PropertyIsGreaterThanOrEqualTo', propertyName, expression);
}
}
inherits(GreaterThanOrEqualTo, ComparisonBinary);
export default GreaterThanOrEqualTo;
src/ol/format/filter/Intersects.js
+8 -10
View File
@@ -1,27 +1,25 @@
/**
* @module ol/format/filter/Intersects
*/
import {inherits} from '../../util.js';
import Spatial from '../filter/Spatial.js';
/**
* @classdesc
* Represents a `<Intersects>` operator to test whether a geometry-valued property
* intersects a given geometry.
*
* @constructor
*/
class Intersects extends Spatial {
/**
* @param {!string} geometryName Geometry name to use.
* @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}
* @api
*/
const Intersects = function(geometryName, geometry, opt_srsName) {
constructor(geometryName, geometry, opt_srsName) {
super('Intersects', geometryName, geometry, opt_srsName);
}
Spatial.call(this, 'Intersects', geometryName, geometry, opt_srsName);
}
};
inherits(Intersects, Spatial);
export default Intersects;
src/ol/format/filter/IsBetween.js
+9 -8
View File
@@ -1,22 +1,22 @@
/**
* @module ol/format/filter/IsBetween
*/
import {inherits} from '../../util.js';
import Comparison from '../filter/Comparison.js';
/**
* @classdesc
* Represents a `<PropertyIsBetween>` comparison operator.
*
* @constructor
*/
class IsBetween extends Comparison {
/**
* @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}
* @api
*/
const IsBetween = function(propertyName, lowerBoundary, upperBoundary) {
Comparison.call(this, 'PropertyIsBetween', propertyName);
constructor(propertyName, lowerBoundary, upperBoundary) {
super('PropertyIsBetween', propertyName);
/**
* @type {!number}
@@ -27,7 +27,8 @@ const IsBetween = function(propertyName, lowerBoundary, upperBoundary) {
* @type {!number}
*/
this.upperBoundary = upperBoundary;
};
inherits(IsBetween, Comparison);
}
}
export default IsBetween;
src/ol/format/filter/IsLike.js
+10 -8
View File
@@ -1,14 +1,16 @@
/**
* @module ol/format/filter/IsLike
*/
import {inherits} from '../../util.js';
import Comparison from '../filter/Comparison.js';
/**
* @classdesc
* Represents a `<PropertyIsLike>` comparison operator.
*
* @constructor
*/
class IsLike extends Comparison {
/**
* [constructor description]
* @param {!string} propertyName Name of the context property to compare.
* @param {!string} pattern Text pattern.
* @param {string=} opt_wildCard Pattern character which matches any sequence of
@@ -18,11 +20,10 @@ 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}
* @api
*/
const IsLike = function(propertyName, pattern, opt_wildCard, opt_singleChar, opt_escapeChar, opt_matchCase) {
Comparison.call(this, 'PropertyIsLike', propertyName);
constructor(propertyName, pattern, opt_wildCard, opt_singleChar, opt_escapeChar, opt_matchCase) {
super('PropertyIsLike', propertyName);
/**
* @type {!string}
@@ -48,7 +49,8 @@ const IsLike = function(propertyName, pattern, opt_wildCard, opt_singleChar, opt
* @type {boolean|undefined}
*/
this.matchCase = opt_matchCase;
};
inherits(IsLike, Comparison);
}
}
export default IsLike;
src/ol/format/filter/IsNull.js
+9 -8
View File
@@ -1,21 +1,22 @@
/**
* @module ol/format/filter/IsNull
*/
import {inherits} from '../../util.js';
import Comparison from '../filter/Comparison.js';
/**
* @classdesc
* Represents a `<PropertyIsNull>` comparison operator.
*
* @constructor
*/
class IsNull extends Comparison {
/**
* @param {!string} propertyName Name of the context property to compare.
* @extends {module:ol/format/filter/Comparison}
* @api
*/
const IsNull = function(propertyName) {
Comparison.call(this, 'PropertyIsNull', propertyName);
};
constructor(propertyName) {
super('PropertyIsNull', propertyName);
}
}
inherits(IsNull, Comparison);
export default IsNull;
src/ol/format/filter/LessThan.js
+9 -8
View File
@@ -1,22 +1,23 @@
/**
* @module ol/format/filter/LessThan
*/
import {inherits} from '../../util.js';
import ComparisonBinary from '../filter/ComparisonBinary.js';
/**
* @classdesc
* Represents a `<PropertyIsLessThan>` comparison operator.
*
* @constructor
*/
class LessThan extends ComparisonBinary {
/**
* @param {!string} propertyName Name of the context property to compare.
* @param {!number} expression The value to compare.
* @extends {module:ol/format/filter/ComparisonBinary}
* @api
*/
const LessThan = function(propertyName, expression) {
ComparisonBinary.call(this, 'PropertyIsLessThan', propertyName, expression);
};
constructor(propertyName, expression) {
super('PropertyIsLessThan', propertyName, expression);
}
}
inherits(LessThan, ComparisonBinary);
export default LessThan;
src/ol/format/filter/LessThanOrEqualTo.js
+9 -8
View File
@@ -1,22 +1,23 @@
/**
* @module ol/format/filter/LessThanOrEqualTo
*/
import {inherits} from '../../util.js';
import ComparisonBinary from '../filter/ComparisonBinary.js';
/**
* @classdesc
* Represents a `<PropertyIsLessThanOrEqualTo>` comparison operator.
*
* @constructor
*/
class LessThanOrEqualTo extends ComparisonBinary {
/**
* @param {!string} propertyName Name of the context property to compare.
* @param {!number} expression The value to compare.
* @extends {module:ol/format/filter/ComparisonBinary}
* @api
*/
const LessThanOrEqualTo = function(propertyName, expression) {
ComparisonBinary.call(this, 'PropertyIsLessThanOrEqualTo', propertyName, expression);
};
constructor(propertyName, expression) {
super('PropertyIsLessThanOrEqualTo', propertyName, expression);
}
}
inherits(LessThanOrEqualTo, ComparisonBinary);
export default LessThanOrEqualTo;
src/ol/format/filter/LogicalNary.js
+9 -7
View File
@@ -1,7 +1,6 @@
/**
* @module ol/format/filter/LogicalNary
*/
import {inherits} from '../../util.js';
import {assert} from '../../asserts.js';
import Filter from '../filter/Filter.js';
@@ -10,22 +9,25 @@ import Filter from '../filter/Filter.js';
* Abstract class; normally only used for creating subclasses and not instantiated in apps.
* Base class for WFS GetFeature n-ary logical filters.
*
* @constructor
* @abstract
*/
class LogicalNary extends Filter {
/**
* @param {!string} tagName The XML tag name for this filter.
* @param {...module:ol/format/filter/Filter} conditions Conditions.
* @extends {module:ol/format/filter/Filter}
*/
const LogicalNary = function(tagName, conditions) {
constructor(tagName, conditions) {
Filter.call(this, tagName);
super(tagName);
/**
* @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.
};
}
}
inherits(LogicalNary, Filter);
export default LogicalNary;
src/ol/format/filter/Not.js
+10 -8
View File
@@ -1,27 +1,29 @@
/**
* @module ol/format/filter/Not
*/
import {inherits} from '../../util.js';
import Filter from '../filter/Filter.js';
/**
* @classdesc
* Represents a logical `<Not>` operator for a filter condition.
*
* @constructor
*/
class Not extends Filter {
/**
* @param {!module:ol/format/filter/Filter} condition Filter condition.
* @extends {module:ol/format/filter/Filter}
* @api
*/
const Not = function(condition) {
constructor(condition) {
Filter.call(this, 'Not');
super('Not');
/**
* @type {!module:ol/format/filter/Filter}
*/
this.condition = condition;
};
inherits(Not, Filter);
}
}
export default Not;
src/ol/format/filter/NotEqualTo.js
+9 -8
View File
@@ -1,23 +1,24 @@
/**
* @module ol/format/filter/NotEqualTo
*/
import {inherits} from '../../util.js';
import ComparisonBinary from '../filter/ComparisonBinary.js';
/**
* @classdesc
* Represents a `<PropertyIsNotEqualTo>` comparison operator.
*
* @constructor
*/
class NotEqualTo extends ComparisonBinary {
/**
* @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}
* @api
*/
const NotEqualTo = function(propertyName, expression, opt_matchCase) {
ComparisonBinary.call(this, 'PropertyIsNotEqualTo', propertyName, expression, opt_matchCase);
};
constructor(propertyName, expression, opt_matchCase) {
super('PropertyIsNotEqualTo', propertyName, expression, opt_matchCase);
}
}
inherits(NotEqualTo, ComparisonBinary);
export default NotEqualTo;
src/ol/format/filter/Or.js
+9 -8
View File
@@ -1,22 +1,23 @@
/**
* @module ol/format/filter/Or
*/
import {inherits} from '../../util.js';
import LogicalNary from '../filter/LogicalNary.js';
/**
* @classdesc
* Represents a logical `<Or>` operator between two ore more filter conditions.
*
* @constructor
*/
class Or extends LogicalNary {
/**
* @param {...module:ol/format/filter/Filter} conditions Conditions.
* @extends {module:ol/format/filter/LogicalNary}
* @api
*/
const Or = function(conditions) {
constructor(conditions) {
const params = ['Or'].concat(Array.prototype.slice.call(arguments));
LogicalNary.apply(this, params);
};
super(...params);
}
}
inherits(Or, LogicalNary);
export default Or;
src/ol/format/filter/Spatial.js
+8 -7
View File
@@ -1,7 +1,6 @@
/**
* @module ol/format/filter/Spatial
*/
import {inherits} from '../../util.js';
import Filter from '../filter/Filter.js';
/**
@@ -10,18 +9,20 @@ import Filter from '../filter/Filter.js';
* Represents a spatial operator to test whether a geometry-valued property
* relates to a given geometry.
*
* @constructor
* @abstract
*/
class Spatial extends Filter {
/**
* @param {!string} tagName The XML tag name for this filter.
* @param {!string} geometryName Geometry name to use.
* @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}
*/
const Spatial = function(tagName, geometryName, geometry, opt_srsName) {
constructor(tagName, geometryName, geometry, opt_srsName) {
Filter.call(this, tagName);
super(tagName);
/**
* @type {!string}
@@ -37,8 +38,8 @@ const Spatial = function(tagName, geometryName, geometry, opt_srsName) {
* @type {string|undefined}
*/
this.srsName = opt_srsName;
};
}
inherits(Spatial, Filter);
}
export default Spatial;
src/ol/format/filter/Within.js
+8 -9
View File
@@ -1,27 +1,26 @@
/**
* @module ol/format/filter/Within
*/
import {inherits} from '../../util.js';
import Spatial from '../filter/Spatial.js';
/**
* @classdesc
* Represents a `<Within>` operator to test whether a geometry-valued property
* is within a given geometry.
*
* @constructor
*/
class Within extends Spatial {
/**
* @param {!string} geometryName Geometry name to use.
* @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}
* @api
*/
const Within = function(geometryName, geometry, opt_srsName) {
constructor(geometryName, geometry, opt_srsName) {
super('Within', geometryName, geometry, opt_srsName);
}
Spatial.call(this, 'Within', geometryName, geometry, opt_srsName);
}
};
inherits(Within, Spatial);
export default Within;
src/ol/geom/Circle.js
+53 -67
View File
@@ -1,7 +1,6 @@
/**
* @module ol/geom/Circle
*/
import {inherits} from '../util.js';
import {createOrUpdate, forEachCorner, intersects} from '../extent.js';
import GeometryType from '../geom/GeometryType.js';
import SimpleGeometry from '../geom/SimpleGeometry.js';
@@ -11,43 +10,41 @@ import {deflateCoordinate} from '../geom/flat/deflate.js';
* @classdesc
* Circle geometry.
*
* @constructor
* @extends {!module:ol/geom/SimpleGeometry}
* @param {!module:ol/coordinate~Coordinate} center Center. (For internal use,
* flat coordinates in combination with `opt_layout` and no `opt_radius` are
* also accepted.)
* @param {number=} opt_radius Radius.
* @param {module:ol/geom/GeometryLayout=} opt_layout Layout.
* @api
*/
const Circle = function(center, opt_radius, opt_layout) {
SimpleGeometry.call(this);
class Circle extends SimpleGeometry {
/**
* @param {!module:ol/coordinate~Coordinate} center Center.
* For internal use, flat coordinates in combination with `opt_layout` and no
* `opt_radius` are also accepted.
* @param {number=} opt_radius Radius.
* @param {module:ol/geom/GeometryLayout=} opt_layout Layout.
*/
constructor(center, opt_radius, opt_layout) {
super();
if (opt_layout !== undefined && opt_radius === undefined) {
this.setFlatCoordinates(opt_layout, center);
} else {
const radius = opt_radius ? opt_radius : 0;
this.setCenterAndRadius(center, radius, opt_layout);
}
};
}
inherits(Circle, SimpleGeometry);
/**
/**
* Make a complete copy of the geometry.
* @return {!module:ol/geom/Circle} Clone.
* @override
* @api
*/
Circle.prototype.clone = function() {
clone() {
return new Circle(this.flatCoordinates.slice(), undefined, this.layout);
};
}
/**
/**
* @inheritDoc
*/
Circle.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDistance) {
closestPointXY(x, y, closestPoint, minSquaredDistance) {
const flatCoordinates = this.flatCoordinates;
const dx = x - flatCoordinates[0];
const dy = y - flatCoordinates[1];
@@ -70,78 +67,71 @@ Circle.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDistanc
} else {
return minSquaredDistance;
}
};
}
/**
/**
* @inheritDoc
*/
Circle.prototype.containsXY = function(x, y) {
containsXY(x, y) {
const flatCoordinates = this.flatCoordinates;
const dx = x - flatCoordinates[0];
const dy = y - flatCoordinates[1];
return dx * dx + dy * dy <= this.getRadiusSquared_();
};
}
/**
/**
* Return the center of the circle as {@link module:ol/coordinate~Coordinate coordinate}.
* @return {module:ol/coordinate~Coordinate} Center.
* @api
*/
Circle.prototype.getCenter = function() {
getCenter() {
return this.flatCoordinates.slice(0, this.stride);
};
}
/**
/**
* @inheritDoc
*/
Circle.prototype.computeExtent = function(extent) {
computeExtent(extent) {
const flatCoordinates = this.flatCoordinates;
const radius = flatCoordinates[this.stride] - flatCoordinates[0];
return createOrUpdate(
flatCoordinates[0] - radius, flatCoordinates[1] - radius,
flatCoordinates[0] + radius, flatCoordinates[1] + radius,
extent);
};
}
/**
/**
* Return the radius of the circle.
* @return {number} Radius.
* @api
*/
Circle.prototype.getRadius = function() {
getRadius() {
return Math.sqrt(this.getRadiusSquared_());
};
}
/**
/**
* @private
* @return {number} Radius squared.
*/
Circle.prototype.getRadiusSquared_ = function() {
getRadiusSquared_() {
const dx = this.flatCoordinates[this.stride] - this.flatCoordinates[0];
const dy = this.flatCoordinates[this.stride + 1] - this.flatCoordinates[1];
return dx * dx + dy * dy;
};
}
/**
/**
* @inheritDoc
* @api
*/
Circle.prototype.getType = function() {
getType() {
return GeometryType.CIRCLE;
};
}
/**
/**
* @inheritDoc
* @api
*/
Circle.prototype.intersectsExtent = function(extent) {
intersectsExtent(extent) {
const circleExtent = this.getExtent();
if (intersects(extent, circleExtent)) {
const center = this.getCenter();
@@ -157,15 +147,14 @@ Circle.prototype.intersectsExtent = function(extent) {
}
return false;
};
}
/**
/**
* Set the center of the circle as {@link module:ol/coordinate~Coordinate coordinate}.
* @param {module:ol/coordinate~Coordinate} center Center.
* @api
*/
Circle.prototype.setCenter = function(center) {
setCenter(center) {
const stride = this.stride;
const radius = this.flatCoordinates[stride] - this.flatCoordinates[0];
const flatCoordinates = center.slice();
@@ -175,10 +164,9 @@ Circle.prototype.setCenter = function(center) {
}
this.setFlatCoordinates(this.layout, flatCoordinates);
this.changed();
};
}
/**
/**
* Set the center (as {@link module:ol/coordinate~Coordinate coordinate}) and the radius (as
* number) of the circle.
* @param {!module:ol/coordinate~Coordinate} center Center.
@@ -186,7 +174,7 @@ Circle.prototype.setCenter = function(center) {
* @param {module:ol/geom/GeometryLayout=} opt_layout Layout.
* @api
*/
Circle.prototype.setCenterAndRadius = function(center, radius, opt_layout) {
setCenterAndRadius(center, radius, opt_layout) {
this.setLayout(opt_layout, center, 0);
if (!this.flatCoordinates) {
this.flatCoordinates = [];
@@ -201,30 +189,28 @@ Circle.prototype.setCenterAndRadius = function(center, radius, opt_layout) {
}
flatCoordinates.length = offset;
this.changed();
};
}
/**
/**
* @inheritDoc
*/
Circle.prototype.getCoordinates = function() {};
getCoordinates() {}
/**
/**
* @inheritDoc
*/
Circle.prototype.setCoordinates = function(coordinates, opt_layout) {};
setCoordinates(coordinates, opt_layout) {}
/**
/**
* Set the radius of the circle. The radius is in the units of the projection.
* @param {number} radius Radius.
* @api
*/
Circle.prototype.setRadius = function(radius) {
setRadius(radius) {
this.flatCoordinates[this.stride] = this.flatCoordinates[0] + radius;
this.changed();
};
}
}
/**
src/ol/geom/Geometry.js
+56 -72
View File
@@ -1,7 +1,6 @@
/**
* @module ol/geom/Geometry
*/
import {inherits} from '../util.js';
import BaseObject from '../Object.js';
import {createEmpty, getHeight, returnOrUpdate} from '../extent.js';
import {FALSE} from '../functions.js';
@@ -11,6 +10,12 @@ import Units from '../proj/Units.js';
import {create as createTransform, compose as composeTransform} from '../transform.js';
/**
* @type {module:ol/transform~Transform}
*/
const tmpTransform = createTransform();
/**
* @classdesc
* Abstract base class; normally only used for creating subclasses and not
@@ -20,14 +25,13 @@ import {create as createTransform, compose as composeTransform} from '../transfo
* To get notified of changes to the geometry, register a listener for the
* generic `change` event on your geometry instance.
*
* @constructor
* @abstract
* @extends {module:ol/Object}
* @api
*/
const Geometry = function() {
class Geometry extends BaseObject {
constructor() {
BaseObject.call(this);
super();
/**
* @private
@@ -59,26 +63,16 @@ const Geometry = function() {
*/
this.simplifiedGeometryRevision = 0;
};
}
inherits(Geometry, BaseObject);
/**
* @type {module:ol/transform~Transform}
*/
const tmpTransform = createTransform();
/**
/**
* Make a complete copy of the geometry.
* @abstract
* @return {!module:ol/geom/Geometry} Clone.
*/
Geometry.prototype.clone = function() {};
clone() {}
/**
/**
* @abstract
* @param {number} x X.
* @param {number} y Y.
@@ -86,10 +80,9 @@ Geometry.prototype.clone = function() {};
* @param {number} minSquaredDistance Minimum squared distance.
* @return {number} Minimum squared distance.
*/
Geometry.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDistance) {};
closestPointXY(x, y, closestPoint, minSquaredDistance) {}
/**
/**
* Return the closest point of the geometry to the passed point as
* {@link module:ol/coordinate~Coordinate coordinate}.
* @param {module:ol/coordinate~Coordinate} point Point.
@@ -97,58 +90,46 @@ Geometry.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDista
* @return {module:ol/coordinate~Coordinate} Closest point.
* @api
*/
Geometry.prototype.getClosestPoint = function(point, opt_closestPoint) {
getClosestPoint(point, opt_closestPoint) {
const closestPoint = opt_closestPoint ? opt_closestPoint : [NaN, NaN];
this.closestPointXY(point[0], point[1], closestPoint, Infinity);
return closestPoint;
};
}
/**
/**
* Returns true if this geometry includes the specified coordinate. If the
* coordinate is on the boundary of the geometry, returns false.
* @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
* @return {boolean} Contains coordinate.
* @api
*/
Geometry.prototype.intersectsCoordinate = function(coordinate) {
intersectsCoordinate(coordinate) {
return this.containsXY(coordinate[0], coordinate[1]);
};
}
/**
/**
* @abstract
* @param {module:ol/extent~Extent} extent Extent.
* @protected
* @return {module:ol/extent~Extent} extent Extent.
*/
Geometry.prototype.computeExtent = function(extent) {};
computeExtent(extent) {}
/**
* @param {number} x X.
* @param {number} y Y.
* @return {boolean} Contains (x, y).
*/
Geometry.prototype.containsXY = FALSE;
/**
/**
* Get the extent of the geometry.
* @param {module:ol/extent~Extent=} opt_extent Extent.
* @return {module:ol/extent~Extent} extent Extent.
* @api
*/
Geometry.prototype.getExtent = function(opt_extent) {
getExtent(opt_extent) {
if (this.extentRevision_ != this.getRevision()) {
this.extent_ = this.computeExtent(this.extent_);
this.extentRevision_ = this.getRevision();
}
return returnOrUpdate(this.extent_, opt_extent);
};
}
/**
/**
* Rotate the geometry around a given coordinate. This modifies the geometry
* coordinates in place.
* @abstract
@@ -156,10 +137,9 @@ Geometry.prototype.getExtent = function(opt_extent) {
* @param {module:ol/coordinate~Coordinate} anchor The rotation center.
* @api
*/
Geometry.prototype.rotate = function(angle, anchor) {};
rotate(angle, anchor) {}
/**
/**
* Scale the geometry (with an optional origin). This modifies the geometry
* coordinates in place.
* @abstract
@@ -170,10 +150,9 @@ Geometry.prototype.rotate = function(angle, anchor) {};
* of the geometry extent).
* @api
*/
Geometry.prototype.scale = function(sx, opt_sy, opt_anchor) {};
scale(sx, opt_sy, opt_anchor) {}
/**
/**
* Create a simplified version of this geometry. For linestrings, this uses
* the the {@link
* https://en.wikipedia.org/wiki/Ramer-Douglas-Peucker_algorithm
@@ -185,12 +164,11 @@ Geometry.prototype.scale = function(sx, opt_sy, opt_anchor) {};
* geometry.
* @api
*/
Geometry.prototype.simplify = function(tolerance) {
simplify(tolerance) {
return this.getSimplifiedGeometry(tolerance * tolerance);
};
}
/**
/**
* Create a simplified version of this geometry using the Douglas Peucker
* algorithm.
* @see https://en.wikipedia.org/wiki/Ramer-Douglas-Peucker_algorithm
@@ -198,18 +176,16 @@ Geometry.prototype.simplify = function(tolerance) {
* @param {number} squaredTolerance Squared tolerance.
* @return {module:ol/geom/Geometry} Simplified geometry.
*/
Geometry.prototype.getSimplifiedGeometry = function(squaredTolerance) {};
getSimplifiedGeometry(squaredTolerance) {}
/**
/**
* Get the type of this geometry.
* @abstract
* @return {module:ol/geom/GeometryType} Geometry type.
*/
Geometry.prototype.getType = function() {};
getType() {}
/**
/**
* Apply a transform function to each coordinate of the geometry.
* The geometry is modified in place.
* If you do not want the geometry modified in place, first `clone()` it and
@@ -217,29 +193,26 @@ Geometry.prototype.getType = function() {};
* @abstract
* @param {module:ol/proj~TransformFunction} transformFn Transform.
*/
Geometry.prototype.applyTransform = function(transformFn) {};
applyTransform(transformFn) {}
/**
/**
* Test if the geometry and the passed extent intersect.
* @abstract
* @param {module:ol/extent~Extent} extent Extent.
* @return {boolean} `true` if the geometry and the extent intersect.
*/
Geometry.prototype.intersectsExtent = function(extent) {};
intersectsExtent(extent) {}
/**
/**
* Translate the geometry. This modifies the geometry coordinates in place. If
* instead you want a new geometry, first `clone()` this geometry.
* @abstract
* @param {number} deltaX Delta X.
* @param {number} deltaY Delta Y.
*/
Geometry.prototype.translate = function(deltaX, deltaY) {};
translate(deltaX, deltaY) {}
/**
/**
* Transform each coordinate of the geometry from one coordinate reference
* system to another. The geometry is modified in place.
* For example, a line will be transformed to a line and a circle to a circle.
@@ -254,7 +227,7 @@ Geometry.prototype.translate = function(deltaX, deltaY) {};
* modified in place.
* @api
*/
Geometry.prototype.transform = function(source, destination) {
transform(source, destination) {
source = getProjection(source);
const transformFn = source.getUnits() == Units.TILE_PIXELS ?
function(inCoordinates, outCoordinates, stride) {
@@ -272,5 +245,16 @@ Geometry.prototype.transform = function(source, destination) {
getTransform(source, destination);
this.applyTransform(transformFn);
return this;
};
}
}
/**
* @param {number} x X.
* @param {number} y Y.
* @return {boolean} Contains (x, y).
*/
Geometry.prototype.containsXY = FALSE;
export default Geometry;
src/ol/geom/GeometryCollection.js
+81 -98
View File
@@ -1,7 +1,6 @@
/**
* @module ol/geom/GeometryCollection
*/
import {inherits} from '../util.js';
import {listen, unlisten} from '../events.js';
import EventType from '../events/EventType.js';
import {createOrUpdateEmpty, closestSquaredDistanceXY, extend, getCenter} from '../extent.js';
@@ -13,14 +12,16 @@ import {clear} from '../obj.js';
* @classdesc
* An array of {@link module:ol/geom/Geometry} objects.
*
* @constructor
* @extends {module:ol/geom/Geometry}
* @param {Array.<module:ol/geom/Geometry>=} opt_geometries Geometries.
* @api
*/
const GeometryCollection = function(opt_geometries) {
class GeometryCollection extends Geometry {
Geometry.call(this);
/**
* @param {Array.<module:ol/geom/Geometry>=} opt_geometries Geometries.
*/
constructor(opt_geometries) {
super();
/**
* @private
@@ -29,28 +30,12 @@ const GeometryCollection = function(opt_geometries) {
this.geometries_ = opt_geometries ? opt_geometries : null;
this.listenGeometriesChange_();
};
inherits(GeometryCollection, Geometry);
/**
* @param {Array.<module:ol/geom/Geometry>} geometries Geometries.
* @return {Array.<module:ol/geom/Geometry>} Cloned geometries.
*/
function cloneGeometries(geometries) {
const clonedGeometries = [];
for (let i = 0, ii = geometries.length; i < ii; ++i) {
clonedGeometries.push(geometries[i].clone());
}
return clonedGeometries;
}
/**
/**
* @private
*/
GeometryCollection.prototype.unlistenGeometriesChange_ = function() {
unlistenGeometriesChange_() {
if (!this.geometries_) {
return;
}
@@ -59,13 +44,12 @@ GeometryCollection.prototype.unlistenGeometriesChange_ = function() {
this.geometries_[i], EventType.CHANGE,
this.changed, this);
}
};
}
/**
/**
* @private
*/
GeometryCollection.prototype.listenGeometriesChange_ = function() {
listenGeometriesChange_() {
if (!this.geometries_) {
return;
}
@@ -74,26 +58,24 @@ GeometryCollection.prototype.listenGeometriesChange_ = function() {
this.geometries_[i], EventType.CHANGE,
this.changed, this);
}
};
}
/**
/**
* Make a complete copy of the geometry.
* @return {!module:ol/geom/GeometryCollection} Clone.
* @override
* @api
*/
GeometryCollection.prototype.clone = function() {
clone() {
const geometryCollection = new GeometryCollection(null);
geometryCollection.setGeometries(this.geometries_);
return geometryCollection;
};
}
/**
/**
* @inheritDoc
*/
GeometryCollection.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDistance) {
closestPointXY(x, y, closestPoint, minSquaredDistance) {
if (minSquaredDistance < closestSquaredDistanceXY(this.getExtent(), x, y)) {
return minSquaredDistance;
}
@@ -103,13 +85,12 @@ GeometryCollection.prototype.closestPointXY = function(x, y, closestPoint, minSq
x, y, closestPoint, minSquaredDistance);
}
return minSquaredDistance;
};
}
/**
/**
* @inheritDoc
*/
GeometryCollection.prototype.containsXY = function(x, y) {
containsXY(x, y) {
const geometries = this.geometries_;
for (let i = 0, ii = geometries.length; i < ii; ++i) {
if (geometries[i].containsXY(x, y)) {
@@ -117,44 +98,40 @@ GeometryCollection.prototype.containsXY = function(x, y) {
}
}
return false;
};
}
/**
/**
* @inheritDoc
*/
GeometryCollection.prototype.computeExtent = function(extent) {
computeExtent(extent) {
createOrUpdateEmpty(extent);
const geometries = this.geometries_;
for (let i = 0, ii = geometries.length; i < ii; ++i) {
extend(extent, geometries[i].getExtent());
}
return extent;
};
}
/**
/**
* Return the geometries that make up this geometry collection.
* @return {Array.<module:ol/geom/Geometry>} Geometries.
* @api
*/
GeometryCollection.prototype.getGeometries = function() {
getGeometries() {
return cloneGeometries(this.geometries_);
};
}
/**
/**
* @return {Array.<module:ol/geom/Geometry>} Geometries.
*/
GeometryCollection.prototype.getGeometriesArray = function() {
getGeometriesArray() {
return this.geometries_;
};
}
/**
/**
* @inheritDoc
*/
GeometryCollection.prototype.getSimplifiedGeometry = function(squaredTolerance) {
getSimplifiedGeometry(squaredTolerance) {
if (this.simplifiedGeometryRevision != this.getRevision()) {
clear(this.simplifiedGeometryCache);
this.simplifiedGeometryMaxMinSquaredTolerance = 0;
@@ -190,23 +167,21 @@ GeometryCollection.prototype.getSimplifiedGeometry = function(squaredTolerance)
return this;
}
}
};
}
/**
/**
* @inheritDoc
* @api
*/
GeometryCollection.prototype.getType = function() {
getType() {
return GeometryType.GEOMETRY_COLLECTION;
};
}
/**
/**
* @inheritDoc
* @api
*/
GeometryCollection.prototype.intersectsExtent = function(extent) {
intersectsExtent(extent) {
const geometries = this.geometries_;
for (let i = 0, ii = geometries.length; i < ii; ++i) {
if (geometries[i].intersectsExtent(extent)) {
@@ -214,35 +189,32 @@ GeometryCollection.prototype.intersectsExtent = function(extent) {
}
}
return false;
};
}
/**
/**
* @return {boolean} Is empty.
*/
GeometryCollection.prototype.isEmpty = function() {
isEmpty() {
return this.geometries_.length === 0;
};
}
/**
/**
* @inheritDoc
* @api
*/
GeometryCollection.prototype.rotate = function(angle, anchor) {
rotate(angle, anchor) {
const geometries = this.geometries_;
for (let i = 0, ii = geometries.length; i < ii; ++i) {
geometries[i].rotate(angle, anchor);
}
this.changed();
};
}
/**
/**
* @inheritDoc
* @api
*/
GeometryCollection.prototype.scale = function(sx, opt_sy, opt_anchor) {
scale(sx, opt_sy, opt_anchor) {
let anchor = opt_anchor;
if (!anchor) {
anchor = getCenter(this.getExtent());
@@ -252,64 +224,75 @@ GeometryCollection.prototype.scale = function(sx, opt_sy, opt_anchor) {
geometries[i].scale(sx, opt_sy, anchor);
}
this.changed();
};
}
/**
/**
* Set the geometries that make up this geometry collection.
* @param {Array.<module:ol/geom/Geometry>} geometries Geometries.
* @api
*/
GeometryCollection.prototype.setGeometries = function(geometries) {
setGeometries(geometries) {
this.setGeometriesArray(cloneGeometries(geometries));
};
}
/**
/**
* @param {Array.<module:ol/geom/Geometry>} geometries Geometries.
*/
GeometryCollection.prototype.setGeometriesArray = function(geometries) {
setGeometriesArray(geometries) {
this.unlistenGeometriesChange_();
this.geometries_ = geometries;
this.listenGeometriesChange_();
this.changed();
};
}
/**
/**
* @inheritDoc
* @api
*/
GeometryCollection.prototype.applyTransform = function(transformFn) {
applyTransform(transformFn) {
const geometries = this.geometries_;
for (let i = 0, ii = geometries.length; i < ii; ++i) {
geometries[i].applyTransform(transformFn);
}
this.changed();
};
}
/**
/**
* Translate the geometry.
* @param {number} deltaX Delta X.
* @param {number} deltaY Delta Y.
* @override
* @api
*/
GeometryCollection.prototype.translate = function(deltaX, deltaY) {
translate(deltaX, deltaY) {
const geometries = this.geometries_;
for (let i = 0, ii = geometries.length; i < ii; ++i) {
geometries[i].translate(deltaX, deltaY);
}
this.changed();
};
}
/**
* @inheritDoc
*/
disposeInternal() {
this.unlistenGeometriesChange_();
Geometry.prototype.disposeInternal.call(this);
}
}
/**
* @inheritDoc
* @param {Array.<module:ol/geom/Geometry>} geometries Geometries.
* @return {Array.<module:ol/geom/Geometry>} Cloned geometries.
*/
GeometryCollection.prototype.disposeInternal = function() {
this.unlistenGeometriesChange_();
Geometry.prototype.disposeInternal.call(this);
};
function cloneGeometries(geometries) {
const clonedGeometries = [];
for (let i = 0, ii = geometries.length; i < ii; ++i) {
clonedGeometries.push(geometries[i].clone());
}
return clonedGeometries;
}
export default GeometryCollection;
src/ol/geom/LineString.js
+51 -64
View File
@@ -1,7 +1,6 @@
/**
* @module ol/geom/LineString
*/
import {inherits} from '../util.js';
import {extend} from '../array.js';
import {closestSquaredDistanceXY} from '../extent.js';
import GeometryLayout from '../geom/GeometryLayout.js';
@@ -20,17 +19,18 @@ import {douglasPeucker} from '../geom/flat/simplify.js';
* @classdesc
* Linestring geometry.
*
* @constructor
* @extends {module:ol/geom/SimpleGeometry}
* @param {Array.<module:ol/coordinate~Coordinate>|Array.<number>} coordinates
* Coordinates. (For internal use, flat coordinates in combination with
* `opt_layout` are also accepted).
* @param {module:ol/geom/GeometryLayout=} opt_layout Layout.
* @api
*/
const LineString = function(coordinates, opt_layout) {
class LineString extends SimpleGeometry {
SimpleGeometry.call(this);
/**
* @param {Array.<module:ol/coordinate~Coordinate>|Array.<number>} coordinates Coordinates.
* For internal use, flat coordinates in combination with `opt_layout` are also accepted.
* @param {module:ol/geom/GeometryLayout=} opt_layout Layout.
*/
constructor(coordinates, opt_layout) {
super();
/**
* @private
@@ -62,41 +62,36 @@ const LineString = function(coordinates, opt_layout) {
this.setCoordinates(coordinates, opt_layout);
}
};
}
inherits(LineString, SimpleGeometry);
/**
/**
* Append the passed coordinate to the coordinates of the linestring.
* @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
* @api
*/
LineString.prototype.appendCoordinate = function(coordinate) {
appendCoordinate(coordinate) {
if (!this.flatCoordinates) {
this.flatCoordinates = coordinate.slice();
} else {
extend(this.flatCoordinates, coordinate);
}
this.changed();
};
}
/**
/**
* Make a complete copy of the geometry.
* @return {!module:ol/geom/LineString} Clone.
* @override
* @api
*/
LineString.prototype.clone = function() {
clone() {
return new LineString(this.flatCoordinates.slice(), this.layout);
};
}
/**
/**
* @inheritDoc
*/
LineString.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDistance) {
closestPointXY(x, y, closestPoint, minSquaredDistance) {
if (minSquaredDistance < closestSquaredDistanceXY(this.getExtent(), x, y)) {
return minSquaredDistance;
}
@@ -108,10 +103,9 @@ LineString.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDis
return assignClosestPoint(
this.flatCoordinates, 0, this.flatCoordinates.length, this.stride,
this.maxDelta_, false, x, y, closestPoint, minSquaredDistance);
};
}
/**
/**
* Iterate over each segment, calling the provided callback.
* If the callback returns a truthy value the function returns that
* value immediately. Otherwise the function returns `false`.
@@ -122,12 +116,11 @@ LineString.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDis
* @template T,S
* @api
*/
LineString.prototype.forEachSegment = function(callback) {
forEachSegment(callback) {
return forEachSegment(this.flatCoordinates, 0, this.flatCoordinates.length, this.stride, callback);
};
}
/**
/**
* Returns the coordinate at `m` using linear interpolation, or `null` if no
* such coordinate exists.
*
@@ -141,7 +134,7 @@ LineString.prototype.forEachSegment = function(callback) {
* @return {module:ol/coordinate~Coordinate} Coordinate.
* @api
*/
LineString.prototype.getCoordinateAtM = function(m, opt_extrapolate) {
getCoordinateAtM(m, opt_extrapolate) {
if (this.layout != GeometryLayout.XYM &&
this.layout != GeometryLayout.XYZM) {
return null;
@@ -149,22 +142,20 @@ LineString.prototype.getCoordinateAtM = function(m, opt_extrapolate) {
const extrapolate = opt_extrapolate !== undefined ? opt_extrapolate : false;
return lineStringCoordinateAtM(this.flatCoordinates, 0,
this.flatCoordinates.length, this.stride, m, extrapolate);
};
}
/**
/**
* Return the coordinates of the linestring.
* @return {Array.<module:ol/coordinate~Coordinate>} Coordinates.
* @override
* @api
*/
LineString.prototype.getCoordinates = function() {
getCoordinates() {
return inflateCoordinates(
this.flatCoordinates, 0, this.flatCoordinates.length, this.stride);
};
}
/**
/**
* Return the coordinate at the provided fraction along the linestring.
* The `fraction` is a number between 0 and 1, where 0 is the start of the
* linestring and 1 is the end.
@@ -174,76 +165,70 @@ LineString.prototype.getCoordinates = function() {
* @return {module:ol/coordinate~Coordinate} Coordinate of the interpolated point.
* @api
*/
LineString.prototype.getCoordinateAt = function(fraction, opt_dest) {
getCoordinateAt(fraction, opt_dest) {
return interpolatePoint(
this.flatCoordinates, 0, this.flatCoordinates.length, this.stride,
fraction, opt_dest);
};
}
/**
/**
* Return the length of the linestring on projected plane.
* @return {number} Length (on projected plane).
* @api
*/
LineString.prototype.getLength = function() {
getLength() {
return lineStringLength(
this.flatCoordinates, 0, this.flatCoordinates.length, this.stride);
};
}
/**
/**
* @return {Array.<number>} Flat midpoint.
*/
LineString.prototype.getFlatMidpoint = function() {
getFlatMidpoint() {
if (this.flatMidpointRevision_ != this.getRevision()) {
this.flatMidpoint_ = this.getCoordinateAt(0.5, this.flatMidpoint_);
this.flatMidpointRevision_ = this.getRevision();
}
return this.flatMidpoint_;
};
}
/**
/**
* @inheritDoc
*/
LineString.prototype.getSimplifiedGeometryInternal = function(squaredTolerance) {
getSimplifiedGeometryInternal(squaredTolerance) {
const simplifiedFlatCoordinates = [];
simplifiedFlatCoordinates.length = douglasPeucker(
this.flatCoordinates, 0, this.flatCoordinates.length, this.stride,
squaredTolerance, simplifiedFlatCoordinates, 0);
return new LineString(simplifiedFlatCoordinates, GeometryLayout.XY);
};
}
/**
/**
* @inheritDoc
* @api
*/
LineString.prototype.getType = function() {
getType() {
return GeometryType.LINE_STRING;
};
}
/**
/**
* @inheritDoc
* @api
*/
LineString.prototype.intersectsExtent = function(extent) {
intersectsExtent(extent) {
return intersectsLineString(
this.flatCoordinates, 0, this.flatCoordinates.length, this.stride,
extent);
};
}
/**
/**
* Set the coordinates of the linestring.
* @param {!Array.<module:ol/coordinate~Coordinate>} coordinates Coordinates.
* @param {module:ol/geom/GeometryLayout=} opt_layout Layout.
* @override
* @api
*/
LineString.prototype.setCoordinates = function(coordinates, opt_layout) {
setCoordinates(coordinates, opt_layout) {
this.setLayout(opt_layout, coordinates, 1);
if (!this.flatCoordinates) {
this.flatCoordinates = [];
@@ -251,6 +236,8 @@ LineString.prototype.setCoordinates = function(coordinates, opt_layout) {
this.flatCoordinates.length = deflateCoordinates(
this.flatCoordinates, 0, coordinates, this.stride);
this.changed();
};
}
}
export default LineString;
src/ol/geom/LinearRing.js
+36 -43
View File
@@ -1,7 +1,6 @@
/**
* @module ol/geom/LinearRing
*/
import {inherits} from '../util.js';
import {closestSquaredDistanceXY} from '../extent.js';
import GeometryLayout from '../geom/GeometryLayout.js';
import GeometryType from '../geom/GeometryType.js';
@@ -17,17 +16,18 @@ import {douglasPeucker} from '../geom/flat/simplify.js';
* Linear ring geometry. Only used as part of polygon; cannot be rendered
* on its own.
*
* @constructor
* @extends {module:ol/geom/SimpleGeometry}
* @param {Array.<module:ol/coordinate~Coordinate>|Array.<number>} coordinates
* Coordinates. (For internal use, flat coordinates in combination with
* `opt_layout` are also accepted.)
* @param {module:ol/geom/GeometryLayout=} opt_layout Layout.
* @api
*/
const LinearRing = function(coordinates, opt_layout) {
class LinearRing extends SimpleGeometry {
SimpleGeometry.call(this);
/**
* @param {Array.<module:ol/coordinate~Coordinate>|Array.<number>} coordinates Coordinates.
* For internal use, flat coordinates in combination with `opt_layout` are also accepted.
* @param {module:ol/geom/GeometryLayout=} opt_layout Layout.
*/
constructor(coordinates, opt_layout) {
super();
/**
* @private
@@ -47,26 +47,22 @@ const LinearRing = function(coordinates, opt_layout) {
this.setCoordinates(coordinates, opt_layout);
}
};
}
inherits(LinearRing, SimpleGeometry);
/**
/**
* Make a complete copy of the geometry.
* @return {!module:ol/geom/LinearRing} Clone.
* @override
* @api
*/
LinearRing.prototype.clone = function() {
clone() {
return new LinearRing(this.flatCoordinates.slice(), this.layout);
};
}
/**
/**
* @inheritDoc
*/
LinearRing.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDistance) {
closestPointXY(x, y, closestPoint, minSquaredDistance) {
if (minSquaredDistance < closestSquaredDistanceXY(this.getExtent(), x, y)) {
return minSquaredDistance;
}
@@ -78,66 +74,60 @@ LinearRing.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDis
return assignClosestPoint(
this.flatCoordinates, 0, this.flatCoordinates.length, this.stride,
this.maxDelta_, true, x, y, closestPoint, minSquaredDistance);
};
}
/**
/**
* Return the area of the linear ring on projected plane.
* @return {number} Area (on projected plane).
* @api
*/
LinearRing.prototype.getArea = function() {
getArea() {
return linearRingArea(this.flatCoordinates, 0, this.flatCoordinates.length, this.stride);
};
}
/**
/**
* Return the coordinates of the linear ring.
* @return {Array.<module:ol/coordinate~Coordinate>} Coordinates.
* @override
* @api
*/
LinearRing.prototype.getCoordinates = function() {
getCoordinates() {
return inflateCoordinates(
this.flatCoordinates, 0, this.flatCoordinates.length, this.stride);
};
}
/**
/**
* @inheritDoc
*/
LinearRing.prototype.getSimplifiedGeometryInternal = function(squaredTolerance) {
getSimplifiedGeometryInternal(squaredTolerance) {
const simplifiedFlatCoordinates = [];
simplifiedFlatCoordinates.length = douglasPeucker(
this.flatCoordinates, 0, this.flatCoordinates.length, this.stride,
squaredTolerance, simplifiedFlatCoordinates, 0);
return new LinearRing(simplifiedFlatCoordinates, GeometryLayout.XY);
};
}
/**
/**
* @inheritDoc
* @api
*/
LinearRing.prototype.getType = function() {
getType() {
return GeometryType.LINEAR_RING;
};
}
/**
/**
* @inheritDoc
*/
LinearRing.prototype.intersectsExtent = function(extent) {};
intersectsExtent(extent) {}
/**
/**
* Set the coordinates of the linear ring.
* @param {!Array.<module:ol/coordinate~Coordinate>} coordinates Coordinates.
* @param {module:ol/geom/GeometryLayout=} opt_layout Layout.
* @override
* @api
*/
LinearRing.prototype.setCoordinates = function(coordinates, opt_layout) {
setCoordinates(coordinates, opt_layout) {
this.setLayout(opt_layout, coordinates, 1);
if (!this.flatCoordinates) {
this.flatCoordinates = [];
@@ -145,5 +135,8 @@ LinearRing.prototype.setCoordinates = function(coordinates, opt_layout) {
this.flatCoordinates.length = deflateCoordinates(
this.flatCoordinates, 0, coordinates, this.stride);
this.changed();
};
}
}
export default LinearRing;
src/ol/geom/MultiLineString.js
+50 -61
View File
@@ -1,7 +1,6 @@
/**
* @module ol/geom/MultiLineString
*/
import {inherits} from '../util.js';
import {extend} from '../array.js';
import {closestSquaredDistanceXY} from '../extent.js';
import GeometryLayout from '../geom/GeometryLayout.js';
@@ -19,18 +18,20 @@ import {douglasPeuckerArray} from '../geom/flat/simplify.js';
* @classdesc
* Multi-linestring geometry.
*
* @constructor
* @extends {module:ol/geom/SimpleGeometry}
* @api
*/
class MultiLineString extends SimpleGeometry {
/**
* @param {Array.<Array.<module:ol/coordinate~Coordinate>|module:ol/geom~MultiLineString>|Array.<number>} coordinates
* Coordinates or LineString geometries. (For internal use, flat coordinates in
* combination with `opt_layout` and `opt_ends` are also accepted.)
* @param {module:ol/geom/GeometryLayout=} opt_layout Layout.
* @param {Array.<number>} opt_ends Flat coordinate ends for internal use.
* @api
*/
const MultiLineString = function(coordinates, opt_layout, opt_ends) {
constructor(coordinates, opt_layout, opt_ends) {
SimpleGeometry.call(this);
super();
/**
* @type {Array.<number>}
@@ -71,17 +72,14 @@ const MultiLineString = function(coordinates, opt_layout, opt_ends) {
this.ends_ = ends;
}
};
}
inherits(MultiLineString, SimpleGeometry);
/**
/**
* Append the passed linestring to the multilinestring.
* @param {module:ol/geom/LineString} lineString LineString.
* @api
*/
MultiLineString.prototype.appendLineString = function(lineString) {
appendLineString(lineString) {
if (!this.flatCoordinates) {
this.flatCoordinates = lineString.getFlatCoordinates().slice();
} else {
@@ -89,24 +87,22 @@ MultiLineString.prototype.appendLineString = function(lineString) {
}
this.ends_.push(this.flatCoordinates.length);
this.changed();
};
}
/**
/**
* Make a complete copy of the geometry.
* @return {!module:ol/geom/MultiLineString} Clone.
* @override
* @api
*/
MultiLineString.prototype.clone = function() {
clone() {
return new MultiLineString(this.flatCoordinates.slice(), this.layout, this.ends_.slice());
};
}
/**
/**
* @inheritDoc
*/
MultiLineString.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDistance) {
closestPointXY(x, y, closestPoint, minSquaredDistance) {
if (minSquaredDistance < closestSquaredDistanceXY(this.getExtent(), x, y)) {
return minSquaredDistance;
}
@@ -118,10 +114,9 @@ MultiLineString.prototype.closestPointXY = function(x, y, closestPoint, minSquar
return assignClosestArrayPoint(
this.flatCoordinates, 0, this.ends_, this.stride,
this.maxDelta_, false, x, y, closestPoint, minSquaredDistance);
};
}
/**
/**
* Returns the coordinate at `m` using linear interpolation, or `null` if no
* such coordinate exists.
*
@@ -143,7 +138,7 @@ MultiLineString.prototype.closestPointXY = function(x, y, closestPoint, minSquar
* @return {module:ol/coordinate~Coordinate} Coordinate.
* @api
*/
MultiLineString.prototype.getCoordinateAtM = function(m, opt_extrapolate, opt_interpolate) {
getCoordinateAtM(m, opt_extrapolate, opt_interpolate) {
if ((this.layout != GeometryLayout.XYM &&
this.layout != GeometryLayout.XYZM) ||
this.flatCoordinates.length === 0) {
@@ -153,50 +148,46 @@ MultiLineString.prototype.getCoordinateAtM = function(m, opt_extrapolate, opt_in
const interpolate = opt_interpolate !== undefined ? opt_interpolate : false;
return lineStringsCoordinateAtM(this.flatCoordinates, 0,
this.ends_, this.stride, m, extrapolate, interpolate);
};
}
/**
/**
* Return the coordinates of the multilinestring.
* @return {Array.<Array.<module:ol/coordinate~Coordinate>>} Coordinates.
* @override
* @api
*/
MultiLineString.prototype.getCoordinates = function() {
getCoordinates() {
return inflateCoordinatesArray(
this.flatCoordinates, 0, this.ends_, this.stride);
};
}
/**
/**
* @return {Array.<number>} Ends.
*/
MultiLineString.prototype.getEnds = function() {
getEnds() {
return this.ends_;
};
}
/**
/**
* Return the linestring at the specified index.
* @param {number} index Index.
* @return {module:ol/geom/LineString} LineString.
* @api
*/
MultiLineString.prototype.getLineString = function(index) {
getLineString(index) {
if (index < 0 || this.ends_.length <= index) {
return null;
}
return new LineString(this.flatCoordinates.slice(
index === 0 ? 0 : this.ends_[index - 1], this.ends_[index]), this.layout);
};
}
/**
/**
* Return the linestrings of this multilinestring.
* @return {Array.<module:ol/geom/LineString>} LineStrings.
* @api
*/
MultiLineString.prototype.getLineStrings = function() {
getLineStrings() {
const flatCoordinates = this.flatCoordinates;
const ends = this.ends_;
const layout = this.layout;
@@ -210,13 +201,12 @@ MultiLineString.prototype.getLineStrings = function() {
offset = end;
}
return lineStrings;
};
}
/**
/**
* @return {Array.<number>} Flat midpoints.
*/
MultiLineString.prototype.getFlatMidpoints = function() {
getFlatMidpoints() {
const midpoints = [];
const flatCoordinates = this.flatCoordinates;
let offset = 0;
@@ -230,49 +220,45 @@ MultiLineString.prototype.getFlatMidpoints = function() {
offset = end;
}
return midpoints;
};
}
/**
/**
* @inheritDoc
*/
MultiLineString.prototype.getSimplifiedGeometryInternal = function(squaredTolerance) {
getSimplifiedGeometryInternal(squaredTolerance) {
const simplifiedFlatCoordinates = [];
const simplifiedEnds = [];
simplifiedFlatCoordinates.length = douglasPeuckerArray(
this.flatCoordinates, 0, this.ends_, this.stride, squaredTolerance,
simplifiedFlatCoordinates, 0, simplifiedEnds);
return new MultiLineString(simplifiedFlatCoordinates, GeometryLayout.XY, simplifiedEnds);
};
}
/**
/**
* @inheritDoc
* @api
*/
MultiLineString.prototype.getType = function() {
getType() {
return GeometryType.MULTI_LINE_STRING;
};
}
/**
/**
* @inheritDoc
* @api
*/
MultiLineString.prototype.intersectsExtent = function(extent) {
intersectsExtent(extent) {
return intersectsLineStringArray(
this.flatCoordinates, 0, this.ends_, this.stride, extent);
};
}
/**
/**
* Set the coordinates of the multilinestring.
* @param {!Array.<Array.<module:ol/coordinate~Coordinate>>} coordinates Coordinates.
* @param {module:ol/geom/GeometryLayout=} opt_layout Layout.
* @override
* @api
*/
MultiLineString.prototype.setCoordinates = function(coordinates, opt_layout) {
setCoordinates(coordinates, opt_layout) {
this.setLayout(opt_layout, coordinates, 2);
if (!this.flatCoordinates) {
this.flatCoordinates = [];
@@ -281,5 +267,8 @@ MultiLineString.prototype.setCoordinates = function(coordinates, opt_layout) {
this.flatCoordinates, 0, coordinates, this.stride, this.ends_);
this.flatCoordinates.length = ends.length === 0 ? 0 : ends[ends.length - 1];
this.changed();
};
}
}
export default MultiLineString;
src/ol/geom/MultiPoint.js
+40 -48
View File
@@ -1,7 +1,6 @@
/**
* @module ol/geom/MultiPoint
*/
import {inherits} from '../util.js';
import {extend} from '../array.js';
import {closestSquaredDistanceXY, containsXY} from '../extent.js';
import GeometryType from '../geom/GeometryType.js';
@@ -15,57 +14,53 @@ import {squaredDistance as squaredDx} from '../math.js';
* @classdesc
* Multi-point geometry.
*
* @constructor
* @extends {module:ol/geom/SimpleGeometry}
* @param {Array.<module:ol/coordinate~Coordinate>|Array.<number>} coordinates
* Coordinates. (For internal use, flat coordinates in combination with
* `opt_layout` are also accepted)
* @param {module:ol/geom/GeometryLayout=} opt_layout Layout.
* @api
*/
const MultiPoint = function(coordinates, opt_layout) {
SimpleGeometry.call(this);
class MultiPoint extends SimpleGeometry {
/**
* @param {Array.<module:ol/coordinate~Coordinate>|Array.<number>} coordinates Coordinates.
* For internal use, flat coordinates in combination with `opt_layout` are also accepted.
* @param {module:ol/geom/GeometryLayout=} opt_layout Layout.
*/
constructor(coordinates, opt_layout) {
super();
if (opt_layout && !Array.isArray(coordinates[0])) {
this.setFlatCoordinates(opt_layout, coordinates);
} else {
this.setCoordinates(coordinates, opt_layout);
}
};
}
inherits(MultiPoint, SimpleGeometry);
/**
/**
* Append the passed point to this multipoint.
* @param {module:ol/geom/Point} point Point.
* @api
*/
MultiPoint.prototype.appendPoint = function(point) {
appendPoint(point) {
if (!this.flatCoordinates) {
this.flatCoordinates = point.getFlatCoordinates().slice();
} else {
extend(this.flatCoordinates, point.getFlatCoordinates());
}
this.changed();
};
}
/**
/**
* Make a complete copy of the geometry.
* @return {!module:ol/geom/MultiPoint} Clone.
* @override
* @api
*/
MultiPoint.prototype.clone = function() {
clone() {
const multiPoint = new MultiPoint(this.flatCoordinates.slice(), this.layout);
return multiPoint;
};
}
/**
/**
* @inheritDoc
*/
MultiPoint.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDistance) {
closestPointXY(x, y, closestPoint, minSquaredDistance) {
if (minSquaredDistance < closestSquaredDistanceXY(this.getExtent(), x, y)) {
return minSquaredDistance;
}
@@ -83,43 +78,40 @@ MultiPoint.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDis
}
}
return minSquaredDistance;
};
}
/**
/**
* Return the coordinates of the multipoint.
* @return {Array.<module:ol/coordinate~Coordinate>} Coordinates.
* @override
* @api
*/
MultiPoint.prototype.getCoordinates = function() {
getCoordinates() {
return inflateCoordinates(
this.flatCoordinates, 0, this.flatCoordinates.length, this.stride);
};
}
/**
/**
* Return the point at the specified index.
* @param {number} index Index.
* @return {module:ol/geom/Point} Point.
* @api
*/
MultiPoint.prototype.getPoint = function(index) {
getPoint(index) {
const n = !this.flatCoordinates ? 0 : this.flatCoordinates.length / this.stride;
if (index < 0 || n <= index) {
return null;
}
return new Point(this.flatCoordinates.slice(
index * this.stride, (index + 1) * this.stride), this.layout);
};
}
/**
/**
* Return the points of this multipoint.
* @return {Array.<module:ol/geom/Point>} Points.
* @api
*/
MultiPoint.prototype.getPoints = function() {
getPoints() {
const flatCoordinates = this.flatCoordinates;
const layout = this.layout;
const stride = this.stride;
@@ -130,23 +122,21 @@ MultiPoint.prototype.getPoints = function() {
points.push(point);
}
return points;
};
}
/**
/**
* @inheritDoc
* @api
*/
MultiPoint.prototype.getType = function() {
getType() {
return GeometryType.MULTI_POINT;
};
}
/**
/**
* @inheritDoc
* @api
*/
MultiPoint.prototype.intersectsExtent = function(extent) {
intersectsExtent(extent) {
const flatCoordinates = this.flatCoordinates;
const stride = this.stride;
for (let i = 0, ii = flatCoordinates.length; i < ii; i += stride) {
@@ -157,17 +147,16 @@ MultiPoint.prototype.intersectsExtent = function(extent) {
}
}
return false;
};
}
/**
/**
* Set the coordinates of the multipoint.
* @param {!Array.<module:ol/coordinate~Coordinate>} coordinates Coordinates.
* @param {module:ol/geom/GeometryLayout=} opt_layout Layout.
* @override
* @api
*/
MultiPoint.prototype.setCoordinates = function(coordinates, opt_layout) {
setCoordinates(coordinates, opt_layout) {
this.setLayout(opt_layout, coordinates, 1);
if (!this.flatCoordinates) {
this.flatCoordinates = [];
@@ -175,5 +164,8 @@ MultiPoint.prototype.setCoordinates = function(coordinates, opt_layout) {
this.flatCoordinates.length = deflateCoordinates(
this.flatCoordinates, 0, coordinates, this.stride);
this.changed();
};
}
}
export default MultiPoint;
src/ol/geom/MultiPolygon.js
+60 -78
View File
@@ -1,7 +1,6 @@
/**
* @module ol/geom/MultiPolygon
*/
import {inherits} from '../util.js';
import {extend} from '../array.js';
import {closestSquaredDistanceXY} from '../extent.js';
import GeometryLayout from '../geom/GeometryLayout.js';
@@ -24,19 +23,19 @@ import {quantizeMultiArray} from '../geom/flat/simplify.js';
* @classdesc
* Multi-polygon geometry.
*
* @constructor
* @extends {module:ol/geom/SimpleGeometry}
* @param {Array.<Array.<Array.<module:ol/coordinate~Coordinate>>>|Array.<number>} coordinates
* Coordinates. (For internal use, flat coordinats in combination with
* `opt_layout` and `opt_endss` are also accepted).
* @param {module:ol/geom/GeometryLayout=} opt_layout Layout.
* @param {Array.<number>} opt_endss Array of ends for internal use with flat
* coordinates.
* @api
*/
const MultiPolygon = function(coordinates, opt_layout, opt_endss) {
class MultiPolygon extends SimpleGeometry {
SimpleGeometry.call(this);
/**
* @param {Array.<Array.<Array.<module:ol/coordinate~Coordinate>>>|Array.<number>} coordinates Coordinates.
* For internal use, flat coordinats in combination with `opt_layout` and `opt_endss` are also accepted.
* @param {module:ol/geom/GeometryLayout=} opt_layout Layout.
* @param {Array.<number>} opt_endss Array of ends for internal use with flat coordinates.
*/
constructor(coordinates, opt_layout, opt_endss) {
super();
/**
* @type {Array.<Array.<number>>}
@@ -108,17 +107,14 @@ const MultiPolygon = function(coordinates, opt_layout, opt_endss) {
this.setCoordinates(coordinates, opt_layout);
}
};
}
inherits(MultiPolygon, SimpleGeometry);
/**
/**
* Append the passed polygon to this multipolygon.
* @param {module:ol/geom/Polygon} polygon Polygon.
* @api
*/
MultiPolygon.prototype.appendPolygon = function(polygon) {
appendPolygon(polygon) {
/** @type {Array.<number>} */
let ends;
if (!this.flatCoordinates) {
@@ -135,16 +131,15 @@ MultiPolygon.prototype.appendPolygon = function(polygon) {
}
this.endss_.push(ends);
this.changed();
};
}
/**
/**
* Make a complete copy of the geometry.
* @return {!module:ol/geom/MultiPolygon} Clone.
* @override
* @api
*/
MultiPolygon.prototype.clone = function() {
clone() {
const len = this.endss_.length;
const newEndss = new Array(len);
for (let i = 0; i < len; ++i) {
@@ -153,13 +148,12 @@ MultiPolygon.prototype.clone = function() {
return new MultiPolygon(
this.flatCoordinates.slice(), this.layout, newEndss);
};
}
/**
/**
* @inheritDoc
*/
MultiPolygon.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDistance) {
closestPointXY(x, y, closestPoint, minSquaredDistance) {
if (minSquaredDistance < closestSquaredDistanceXY(this.getExtent(), x, y)) {
return minSquaredDistance;
}
@@ -171,28 +165,25 @@ MultiPolygon.prototype.closestPointXY = function(x, y, closestPoint, minSquaredD
return assignClosestMultiArrayPoint(
this.getOrientedFlatCoordinates(), 0, this.endss_, this.stride,
this.maxDelta_, true, x, y, closestPoint, minSquaredDistance);
};
}
/**
/**
* @inheritDoc
*/
MultiPolygon.prototype.containsXY = function(x, y) {
containsXY(x, y) {
return linearRingssContainsXY(this.getOrientedFlatCoordinates(), 0, this.endss_, this.stride, x, y);
};
}
/**
/**
* Return the area of the multipolygon on projected plane.
* @return {number} Area (on projected plane).
* @api
*/
MultiPolygon.prototype.getArea = function() {
getArea() {
return linearRingssArea(this.getOrientedFlatCoordinates(), 0, this.endss_, this.stride);
};
}
/**
/**
* Get the coordinate array for this geometry. This array has the structure
* of a GeoJSON coordinate array for multi-polygons.
*
@@ -206,7 +197,7 @@ MultiPolygon.prototype.getArea = function() {
* @override
* @api
*/
MultiPolygon.prototype.getCoordinates = function(opt_right) {
getCoordinates(opt_right) {
let flatCoordinates;
if (opt_right !== undefined) {
flatCoordinates = this.getOrientedFlatCoordinates().slice();
@@ -218,21 +209,19 @@ MultiPolygon.prototype.getCoordinates = function(opt_right) {
return inflateMultiCoordinatesArray(
flatCoordinates, 0, this.endss_, this.stride);
};
}
/**
/**
* @return {Array.<Array.<number>>} Endss.
*/
MultiPolygon.prototype.getEndss = function() {
getEndss() {
return this.endss_;
};
}
/**
/**
* @return {Array.<number>} Flat interior points.
*/
MultiPolygon.prototype.getFlatInteriorPoints = function() {
getFlatInteriorPoints() {
if (this.flatInteriorPointsRevision_ != this.getRevision()) {
const flatCenters = linearRingssCenter(
this.flatCoordinates, 0, this.endss_, this.stride);
@@ -242,24 +231,22 @@ MultiPolygon.prototype.getFlatInteriorPoints = function() {
this.flatInteriorPointsRevision_ = this.getRevision();
}
return this.flatInteriorPoints_;
};
}
/**
/**
* Return the interior points as {@link module:ol/geom/MultiPoint multipoint}.
* @return {module:ol/geom/MultiPoint} Interior points as XYM coordinates, where M is
* the length of the horizontal intersection that the point belongs to.
* @api
*/
MultiPolygon.prototype.getInteriorPoints = function() {
getInteriorPoints() {
return new MultiPoint(this.getFlatInteriorPoints().slice(), GeometryLayout.XYM);
};
}
/**
/**
* @return {Array.<number>} Oriented flat coordinates.
*/
MultiPolygon.prototype.getOrientedFlatCoordinates = function() {
getOrientedFlatCoordinates() {
if (this.orientedRevision_ != this.getRevision()) {
const flatCoordinates = this.flatCoordinates;
if (linearRingsAreOriented(
@@ -274,13 +261,12 @@ MultiPolygon.prototype.getOrientedFlatCoordinates = function() {
this.orientedRevision_ = this.getRevision();
}
return this.orientedFlatCoordinates_;
};
}
/**
/**
* @inheritDoc
*/
MultiPolygon.prototype.getSimplifiedGeometryInternal = function(squaredTolerance) {
getSimplifiedGeometryInternal(squaredTolerance) {
const simplifiedFlatCoordinates = [];
const simplifiedEndss = [];
simplifiedFlatCoordinates.length = quantizeMultiArray(
@@ -288,16 +274,15 @@ MultiPolygon.prototype.getSimplifiedGeometryInternal = function(squaredTolerance
Math.sqrt(squaredTolerance),
simplifiedFlatCoordinates, 0, simplifiedEndss);
return new MultiPolygon(simplifiedFlatCoordinates, GeometryLayout.XY, simplifiedEndss);
};
}
/**
/**
* Return the polygon at the specified index.
* @param {number} index Index.
* @return {module:ol/geom/Polygon} Polygon.
* @api
*/
MultiPolygon.prototype.getPolygon = function(index) {
getPolygon(index) {
if (index < 0 || this.endss_.length <= index) {
return null;
}
@@ -316,15 +301,14 @@ MultiPolygon.prototype.getPolygon = function(index) {
}
}
return new Polygon(this.flatCoordinates.slice(offset, end), this.layout, ends);
};
}
/**
/**
* Return the polygons of this multipolygon.
* @return {Array.<module:ol/geom/Polygon>} Polygons.
* @api
*/
MultiPolygon.prototype.getPolygons = function() {
getPolygons() {
const layout = this.layout;
const flatCoordinates = this.flatCoordinates;
const endss = this.endss_;
@@ -343,36 +327,33 @@ MultiPolygon.prototype.getPolygons = function() {
offset = end;
}
return polygons;
};
}
/**
/**
* @inheritDoc
* @api
*/
MultiPolygon.prototype.getType = function() {
getType() {
return GeometryType.MULTI_POLYGON;
};
}
/**
/**
* @inheritDoc
* @api
*/
MultiPolygon.prototype.intersectsExtent = function(extent) {
intersectsExtent(extent) {
return intersectsLinearRingMultiArray(
this.getOrientedFlatCoordinates(), 0, this.endss_, this.stride, extent);
};
}
/**
/**
* Set the coordinates of the multipolygon.
* @param {!Array.<Array.<Array.<module:ol/coordinate~Coordinate>>>} coordinates Coordinates.
* @param {module:ol/geom/GeometryLayout=} opt_layout Layout.
* @override
* @api
*/
MultiPolygon.prototype.setCoordinates = function(coordinates, opt_layout) {
setCoordinates(coordinates, opt_layout) {
this.setLayout(opt_layout, coordinates, 3);
if (!this.flatCoordinates) {
this.flatCoordinates = [];
@@ -387,7 +368,8 @@ MultiPolygon.prototype.setCoordinates = function(coordinates, opt_layout) {
0 : lastEnds[lastEnds.length - 1];
}
this.changed();
};
}
}
export default MultiPolygon;
src/ol/geom/Point.js
+32 -38
View File
@@ -1,7 +1,6 @@
/**
* @module ol/geom/Point
*/
import {inherits} from '../util.js';
import {createOrUpdateFromCoordinate, containsXY} from '../extent.js';
import GeometryType from '../geom/GeometryType.js';
import SimpleGeometry from '../geom/SimpleGeometry.js';
@@ -12,36 +11,34 @@ import {squaredDistance as squaredDx} from '../math.js';
* @classdesc
* Point geometry.
*
* @constructor
* @extends {module:ol/geom/SimpleGeometry}
* @param {module:ol/coordinate~Coordinate} coordinates Coordinates.
* @param {module:ol/geom/GeometryLayout=} opt_layout Layout.
* @api
*/
const Point = function(coordinates, opt_layout) {
SimpleGeometry.call(this);
class Point extends SimpleGeometry {
/**
* @param {module:ol/coordinate~Coordinate} coordinates Coordinates.
* @param {module:ol/geom/GeometryLayout=} opt_layout Layout.
*/
constructor(coordinates, opt_layout) {
super();
this.setCoordinates(coordinates, opt_layout);
};
}
inherits(Point, SimpleGeometry);
/**
/**
* Make a complete copy of the geometry.
* @return {!module:ol/geom/Point} Clone.
* @override
* @api
*/
Point.prototype.clone = function() {
clone() {
const point = new Point(this.flatCoordinates.slice(), this.layout);
return point;
};
}
/**
/**
* @inheritDoc
*/
Point.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDistance) {
closestPointXY(x, y, closestPoint, minSquaredDistance) {
const flatCoordinates = this.flatCoordinates;
const squaredDistance = squaredDx(x, y, flatCoordinates[0], flatCoordinates[1]);
if (squaredDistance < minSquaredDistance) {
@@ -54,51 +51,46 @@ Point.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDistance
} else {
return minSquaredDistance;
}
};
}
/**
/**
* Return the coordinate of the point.
* @return {module:ol/coordinate~Coordinate} Coordinates.
* @override
* @api
*/
Point.prototype.getCoordinates = function() {
getCoordinates() {
return !this.flatCoordinates ? [] : this.flatCoordinates.slice();
};
}
/**
/**
* @inheritDoc
*/
Point.prototype.computeExtent = function(extent) {
computeExtent(extent) {
return createOrUpdateFromCoordinate(this.flatCoordinates, extent);
};
}
/**
/**
* @inheritDoc
* @api
*/
Point.prototype.getType = function() {
getType() {
return GeometryType.POINT;
};
}
/**
/**
* @inheritDoc
* @api
*/
Point.prototype.intersectsExtent = function(extent) {
intersectsExtent(extent) {
return containsXY(extent, this.flatCoordinates[0], this.flatCoordinates[1]);
};
}
/**
/**
* @inheritDoc
* @api
*/
Point.prototype.setCoordinates = function(coordinates, opt_layout) {
setCoordinates(coordinates, opt_layout) {
this.setLayout(opt_layout, coordinates, 0);
if (!this.flatCoordinates) {
this.flatCoordinates = [];
@@ -106,6 +98,8 @@ Point.prototype.setCoordinates = function(coordinates, opt_layout) {
this.flatCoordinates.length = deflateCoordinate(
this.flatCoordinates, 0, coordinates, this.stride);
this.changed();
};
}
}
export default Point;
src/ol/geom/Polygon.js
+62 -79
View File
@@ -1,7 +1,6 @@
/**
* @module ol/geom/Polygon
*/
import {inherits} from '../util.js';
import {extend} from '../array.js';
import {closestSquaredDistanceXY, getCenter} from '../extent.js';
import GeometryLayout from '../geom/GeometryLayout.js';
@@ -25,8 +24,11 @@ import {modulo} from '../math.js';
* @classdesc
* Polygon geometry.
*
* @constructor
* @extends {module:ol/geom/SimpleGeometry}
* @api
*/
class Polygon extends SimpleGeometry {
/**
* @param {!Array.<Array.<module:ol/coordinate~Coordinate>>|!Array.<number>} coordinates
* Array of linear rings that define the polygon. The first linear ring of the
* array defines the outer-boundary or surface of the polygon. Each subsequent
@@ -35,13 +37,11 @@ import {modulo} from '../math.js';
* equivalent. (For internal use, flat coordinates in combination with
* `opt_layout` and `opt_ends` are also accepted.)
* @param {module:ol/geom/GeometryLayout=} opt_layout Layout.
* @param {Array.<number>=} opt_ends Ends (for internal use with flat
* coordinates).
* @api
* @param {Array.<number>=} opt_ends Ends (for internal use with flat coordinates).
*/
const Polygon = function(coordinates, opt_layout, opt_ends) {
constructor(coordinates, opt_layout, opt_ends) {
SimpleGeometry.call(this);
super();
/**
* @type {Array.<number>}
@@ -92,17 +92,14 @@ const Polygon = function(coordinates, opt_layout, opt_ends) {
this.setCoordinates(coordinates, opt_layout);
}
};
}
inherits(Polygon, SimpleGeometry);
/**
/**
* Append the passed linear ring to this polygon.
* @param {module:ol/geom/LinearRing} linearRing Linear ring.
* @api
*/
Polygon.prototype.appendLinearRing = function(linearRing) {
appendLinearRing(linearRing) {
if (!this.flatCoordinates) {
this.flatCoordinates = linearRing.getFlatCoordinates().slice();
} else {
@@ -110,24 +107,22 @@ Polygon.prototype.appendLinearRing = function(linearRing) {
}
this.ends_.push(this.flatCoordinates.length);
this.changed();
};
}
/**
/**
* Make a complete copy of the geometry.
* @return {!module:ol/geom/Polygon} Clone.
* @override
* @api
*/
Polygon.prototype.clone = function() {
clone() {
return new Polygon(this.flatCoordinates.slice(), this.layout, this.ends_.slice());
};
}
/**
/**
* @inheritDoc
*/
Polygon.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDistance) {
closestPointXY(x, y, closestPoint, minSquaredDistance) {
if (minSquaredDistance < closestSquaredDistanceXY(this.getExtent(), x, y)) {
return minSquaredDistance;
}
@@ -139,28 +134,25 @@ Polygon.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDistan
return assignClosestArrayPoint(
this.flatCoordinates, 0, this.ends_, this.stride,
this.maxDelta_, true, x, y, closestPoint, minSquaredDistance);
};
}
/**
/**
* @inheritDoc
*/
Polygon.prototype.containsXY = function(x, y) {
containsXY(x, y) {
return linearRingsContainsXY(this.getOrientedFlatCoordinates(), 0, this.ends_, this.stride, x, y);
};
}
/**
/**
* Return the area of the polygon on projected plane.
* @return {number} Area (on projected plane).
* @api
*/
Polygon.prototype.getArea = function() {
getArea() {
return linearRingsArea(this.getOrientedFlatCoordinates(), 0, this.ends_, this.stride);
};
}
/**
/**
* Get the coordinate array for this geometry. This array has the structure
* of a GeoJSON coordinate array for polygons.
*
@@ -174,7 +166,7 @@ Polygon.prototype.getArea = function() {
* @override
* @api
*/
Polygon.prototype.getCoordinates = function(opt_right) {
getCoordinates(opt_right) {
let flatCoordinates;
if (opt_right !== undefined) {
flatCoordinates = this.getOrientedFlatCoordinates().slice();
@@ -186,21 +178,19 @@ Polygon.prototype.getCoordinates = function(opt_right) {
return inflateCoordinatesArray(
flatCoordinates, 0, this.ends_, this.stride);
};
}
/**
/**
* @return {Array.<number>} Ends.
*/
Polygon.prototype.getEnds = function() {
getEnds() {
return this.ends_;
};
}
/**
/**
* @return {Array.<number>} Interior point.
*/
Polygon.prototype.getFlatInteriorPoint = function() {
getFlatInteriorPoint() {
if (this.flatInteriorPointRevision_ != this.getRevision()) {
const flatCenter = getCenter(this.getExtent());
this.flatInteriorPoint_ = getInteriorPointOfArray(
@@ -209,33 +199,30 @@ Polygon.prototype.getFlatInteriorPoint = function() {
this.flatInteriorPointRevision_ = this.getRevision();
}
return this.flatInteriorPoint_;
};
}
/**
/**
* Return an interior point of the polygon.
* @return {module:ol/geom/Point} Interior point as XYM coordinate, where M is the
* length of the horizontal intersection that the point belongs to.
* @api
*/
Polygon.prototype.getInteriorPoint = function() {
getInteriorPoint() {
return new Point(this.getFlatInteriorPoint(), GeometryLayout.XYM);
};
}
/**
/**
* Return the number of rings of the polygon, this includes the exterior
* ring and any interior rings.
*
* @return {number} Number of rings.
* @api
*/
Polygon.prototype.getLinearRingCount = function() {
getLinearRingCount() {
return this.ends_.length;
};
}
/**
/**
* Return the Nth linear ring of the polygon geometry. Return `null` if the
* given index is out of range.
* The exterior linear ring is available at index `0` and the interior rings
@@ -245,21 +232,20 @@ Polygon.prototype.getLinearRingCount = function() {
* @return {module:ol/geom/LinearRing} Linear ring.
* @api
*/
Polygon.prototype.getLinearRing = function(index) {
getLinearRing(index) {
if (index < 0 || this.ends_.length <= index) {
return null;
}
return new LinearRing(this.flatCoordinates.slice(
index === 0 ? 0 : this.ends_[index - 1], this.ends_[index]), this.layout);
};
}
/**
/**
* Return the linear rings of the polygon.
* @return {Array.<module:ol/geom/LinearRing>} Linear rings.
* @api
*/
Polygon.prototype.getLinearRings = function() {
getLinearRings() {
const layout = this.layout;
const flatCoordinates = this.flatCoordinates;
const ends = this.ends_;
@@ -272,13 +258,12 @@ Polygon.prototype.getLinearRings = function() {
offset = end;
}
return linearRings;
};
}
/**
/**
* @return {Array.<number>} Oriented flat coordinates.
*/
Polygon.prototype.getOrientedFlatCoordinates = function() {
getOrientedFlatCoordinates() {
if (this.orientedRevision_ != this.getRevision()) {
const flatCoordinates = this.flatCoordinates;
if (linearRingIsOriented(
@@ -293,13 +278,12 @@ Polygon.prototype.getOrientedFlatCoordinates = function() {
this.orientedRevision_ = this.getRevision();
}
return this.orientedFlatCoordinates_;
};
}
/**
/**
* @inheritDoc
*/
Polygon.prototype.getSimplifiedGeometryInternal = function(squaredTolerance) {
getSimplifiedGeometryInternal(squaredTolerance) {
const simplifiedFlatCoordinates = [];
const simplifiedEnds = [];
simplifiedFlatCoordinates.length = quantizeArray(
@@ -307,36 +291,33 @@ Polygon.prototype.getSimplifiedGeometryInternal = function(squaredTolerance) {
Math.sqrt(squaredTolerance),
simplifiedFlatCoordinates, 0, simplifiedEnds);
return new Polygon(simplifiedFlatCoordinates, GeometryLayout.XY, simplifiedEnds);
};
}
/**
/**
* @inheritDoc
* @api
*/
Polygon.prototype.getType = function() {
getType() {
return GeometryType.POLYGON;
};
}
/**
/**
* @inheritDoc
* @api
*/
Polygon.prototype.intersectsExtent = function(extent) {
intersectsExtent(extent) {
return intersectsLinearRingArray(
this.getOrientedFlatCoordinates(), 0, this.ends_, this.stride, extent);
};
}
/**
/**
* Set the coordinates of the polygon.
* @param {!Array.<Array.<module:ol/coordinate~Coordinate>>} coordinates Coordinates.
* @param {module:ol/geom/GeometryLayout=} opt_layout Layout.
* @override
* @api
*/
Polygon.prototype.setCoordinates = function(coordinates, opt_layout) {
setCoordinates(coordinates, opt_layout) {
this.setLayout(opt_layout, coordinates, 2);
if (!this.flatCoordinates) {
this.flatCoordinates = [];
@@ -345,7 +326,9 @@ Polygon.prototype.setCoordinates = function(coordinates, opt_layout) {
this.flatCoordinates, 0, coordinates, this.stride, this.ends_);
this.flatCoordinates.length = ends.length === 0 ? 0 : ends[ends.length - 1];
this.changed();
};
}
}
export default Polygon;
src/ol/geom/SimpleGeometry.js
+216 -235
View File
@@ -1,7 +1,6 @@
/**
* @module ol/geom/SimpleGeometry
*/
import {inherits} from '../util.js';
import {FALSE} from '../functions.js';
import {createOrUpdateFromFlatCoordinates, getCenter} from '../extent.js';
import Geometry from '../geom/Geometry.js';
@@ -14,14 +13,13 @@ import {clear} from '../obj.js';
* Abstract base class; only used for creating subclasses; do not instantiate
* in apps, as cannot be rendered.
*
* @constructor
* @abstract
* @extends {module:ol/geom/Geometry}
* @api
*/
const SimpleGeometry = function() {
class SimpleGeometry extends Geometry {
constructor() {
Geometry.call(this);
super();
/**
* @protected
@@ -41,9 +39,220 @@ const SimpleGeometry = function() {
*/
this.flatCoordinates = null;
};
}
inherits(SimpleGeometry, Geometry);
/**
* @inheritDoc
*/
computeExtent(extent) {
return createOrUpdateFromFlatCoordinates(this.flatCoordinates,
0, this.flatCoordinates.length, this.stride, extent);
}
/**
* @abstract
* @return {Array} Coordinates.
*/
getCoordinates() {}
/**
* Return the first coordinate of the geometry.
* @return {module:ol/coordinate~Coordinate} First coordinate.
* @api
*/
getFirstCoordinate() {
return this.flatCoordinates.slice(0, this.stride);
}
/**
* @return {Array.<number>} Flat coordinates.
*/
getFlatCoordinates() {
return this.flatCoordinates;
}
/**
* Return the last coordinate of the geometry.
* @return {module:ol/coordinate~Coordinate} Last point.
* @api
*/
getLastCoordinate() {
return this.flatCoordinates.slice(this.flatCoordinates.length - this.stride);
}
/**
* Return the {@link module:ol/geom/GeometryLayout~GeometryLayout layout} of the geometry.
* @return {module:ol/geom/GeometryLayout} Layout.
* @api
*/
getLayout() {
return this.layout;
}
/**
* @inheritDoc
*/
getSimplifiedGeometry(squaredTolerance) {
if (this.simplifiedGeometryRevision != this.getRevision()) {
clear(this.simplifiedGeometryCache);
this.simplifiedGeometryMaxMinSquaredTolerance = 0;
this.simplifiedGeometryRevision = this.getRevision();
}
// If squaredTolerance is negative or if we know that simplification will not
// have any effect then just return this.
if (squaredTolerance < 0 ||
(this.simplifiedGeometryMaxMinSquaredTolerance !== 0 &&
squaredTolerance <= this.simplifiedGeometryMaxMinSquaredTolerance)) {
return this;
}
const key = squaredTolerance.toString();
if (this.simplifiedGeometryCache.hasOwnProperty(key)) {
return this.simplifiedGeometryCache[key];
} else {
const simplifiedGeometry =
this.getSimplifiedGeometryInternal(squaredTolerance);
const simplifiedFlatCoordinates = simplifiedGeometry.getFlatCoordinates();
if (simplifiedFlatCoordinates.length < this.flatCoordinates.length) {
this.simplifiedGeometryCache[key] = simplifiedGeometry;
return simplifiedGeometry;
} else {
// Simplification did not actually remove any coordinates. We now know
// that any calls to getSimplifiedGeometry with a squaredTolerance less
// than or equal to the current squaredTolerance will also not have any
// effect. This allows us to short circuit simplification (saving CPU
// cycles) and prevents the cache of simplified geometries from filling
// up with useless identical copies of this geometry (saving memory).
this.simplifiedGeometryMaxMinSquaredTolerance = squaredTolerance;
return this;
}
}
}
/**
* @param {number} squaredTolerance Squared tolerance.
* @return {module:ol/geom/SimpleGeometry} Simplified geometry.
* @protected
*/
getSimplifiedGeometryInternal(squaredTolerance) {
return this;
}
/**
* @return {number} Stride.
*/
getStride() {
return this.stride;
}
/**
* @param {module:ol/geom/GeometryLayout} layout Layout.
* @param {Array.<number>} flatCoordinates Flat coordinates.
*/
setFlatCoordinates(layout, flatCoordinates) {
this.stride = getStrideForLayout(layout);
this.layout = layout;
this.flatCoordinates = flatCoordinates;
}
/**
* @abstract
* @param {!Array} coordinates Coordinates.
* @param {module:ol/geom/GeometryLayout=} opt_layout Layout.
*/
setCoordinates(coordinates, opt_layout) {}
/**
* @param {module:ol/geom/GeometryLayout|undefined} layout Layout.
* @param {Array} coordinates Coordinates.
* @param {number} nesting Nesting.
* @protected
*/
setLayout(layout, coordinates, nesting) {
/** @type {number} */
let stride;
if (layout) {
stride = getStrideForLayout(layout);
} else {
for (let i = 0; i < nesting; ++i) {
if (coordinates.length === 0) {
this.layout = GeometryLayout.XY;
this.stride = 2;
return;
} else {
coordinates = /** @type {Array} */ (coordinates[0]);
}
}
stride = coordinates.length;
layout = getLayoutForStride(stride);
}
this.layout = layout;
this.stride = stride;
}
/**
* @inheritDoc
* @api
*/
applyTransform(transformFn) {
if (this.flatCoordinates) {
transformFn(this.flatCoordinates, this.flatCoordinates, this.stride);
this.changed();
}
}
/**
* @inheritDoc
* @api
*/
rotate(angle, anchor) {
const flatCoordinates = this.getFlatCoordinates();
if (flatCoordinates) {
const stride = this.getStride();
rotate(
flatCoordinates, 0, flatCoordinates.length,
stride, angle, anchor, flatCoordinates);
this.changed();
}
}
/**
* @inheritDoc
* @api
*/
scale(sx, opt_sy, opt_anchor) {
let sy = opt_sy;
if (sy === undefined) {
sy = sx;
}
let anchor = opt_anchor;
if (!anchor) {
anchor = getCenter(this.getExtent());
}
const flatCoordinates = this.getFlatCoordinates();
if (flatCoordinates) {
const stride = this.getStride();
scale(
flatCoordinates, 0, flatCoordinates.length,
stride, sx, sy, anchor, flatCoordinates);
this.changed();
}
}
/**
* @inheritDoc
* @api
*/
translate(deltaX, deltaY) {
const flatCoordinates = this.getFlatCoordinates();
if (flatCoordinates) {
const stride = this.getStride();
translate(
flatCoordinates, 0, flatCoordinates.length, stride,
deltaX, deltaY, flatCoordinates);
this.changed();
}
}
}
/**
@@ -88,234 +297,6 @@ export function getStrideForLayout(layout) {
SimpleGeometry.prototype.containsXY = FALSE;
/**
* @inheritDoc
*/
SimpleGeometry.prototype.computeExtent = function(extent) {
return createOrUpdateFromFlatCoordinates(this.flatCoordinates,
0, this.flatCoordinates.length, this.stride, extent);
};
/**
* @abstract
* @return {Array} Coordinates.
*/
SimpleGeometry.prototype.getCoordinates = function() {};
/**
* Return the first coordinate of the geometry.
* @return {module:ol/coordinate~Coordinate} First coordinate.
* @api
*/
SimpleGeometry.prototype.getFirstCoordinate = function() {
return this.flatCoordinates.slice(0, this.stride);
};
/**
* @return {Array.<number>} Flat coordinates.
*/
SimpleGeometry.prototype.getFlatCoordinates = function() {
return this.flatCoordinates;
};
/**
* Return the last coordinate of the geometry.
* @return {module:ol/coordinate~Coordinate} Last point.
* @api
*/
SimpleGeometry.prototype.getLastCoordinate = function() {
return this.flatCoordinates.slice(this.flatCoordinates.length - this.stride);
};
/**
* Return the {@link module:ol/geom/GeometryLayout~GeometryLayout layout} of the geometry.
* @return {module:ol/geom/GeometryLayout} Layout.
* @api
*/
SimpleGeometry.prototype.getLayout = function() {
return this.layout;
};
/**
* @inheritDoc
*/
SimpleGeometry.prototype.getSimplifiedGeometry = function(squaredTolerance) {
if (this.simplifiedGeometryRevision != this.getRevision()) {
clear(this.simplifiedGeometryCache);
this.simplifiedGeometryMaxMinSquaredTolerance = 0;
this.simplifiedGeometryRevision = this.getRevision();
}
// If squaredTolerance is negative or if we know that simplification will not
// have any effect then just return this.
if (squaredTolerance < 0 ||
(this.simplifiedGeometryMaxMinSquaredTolerance !== 0 &&
squaredTolerance <= this.simplifiedGeometryMaxMinSquaredTolerance)) {
return this;
}
const key = squaredTolerance.toString();
if (this.simplifiedGeometryCache.hasOwnProperty(key)) {
return this.simplifiedGeometryCache[key];
} else {
const simplifiedGeometry =
this.getSimplifiedGeometryInternal(squaredTolerance);
const simplifiedFlatCoordinates = simplifiedGeometry.getFlatCoordinates();
if (simplifiedFlatCoordinates.length < this.flatCoordinates.length) {
this.simplifiedGeometryCache[key] = simplifiedGeometry;
return simplifiedGeometry;
} else {
// Simplification did not actually remove any coordinates. We now know
// that any calls to getSimplifiedGeometry with a squaredTolerance less
// than or equal to the current squaredTolerance will also not have any
// effect. This allows us to short circuit simplification (saving CPU
// cycles) and prevents the cache of simplified geometries from filling
// up with useless identical copies of this geometry (saving memory).
this.simplifiedGeometryMaxMinSquaredTolerance = squaredTolerance;
return this;
}
}
};
/**
* @param {number} squaredTolerance Squared tolerance.
* @return {module:ol/geom/SimpleGeometry} Simplified geometry.
* @protected
*/
SimpleGeometry.prototype.getSimplifiedGeometryInternal = function(squaredTolerance) {
return this;
};
/**
* @return {number} Stride.
*/
SimpleGeometry.prototype.getStride = function() {
return this.stride;
};
/**
* @param {module:ol/geom/GeometryLayout} layout Layout.
* @param {Array.<number>} flatCoordinates Flat coordinates.
*/
SimpleGeometry.prototype.setFlatCoordinates = function(layout, flatCoordinates) {
this.stride = getStrideForLayout(layout);
this.layout = layout;
this.flatCoordinates = flatCoordinates;
};
/**
* @abstract
* @param {!Array} coordinates Coordinates.
* @param {module:ol/geom/GeometryLayout=} opt_layout Layout.
*/
SimpleGeometry.prototype.setCoordinates = function(coordinates, opt_layout) {};
/**
* @param {module:ol/geom/GeometryLayout|undefined} layout Layout.
* @param {Array} coordinates Coordinates.
* @param {number} nesting Nesting.
* @protected
*/
SimpleGeometry.prototype.setLayout = function(layout, coordinates, nesting) {
/** @type {number} */
let stride;
if (layout) {
stride = getStrideForLayout(layout);
} else {
for (let i = 0; i < nesting; ++i) {
if (coordinates.length === 0) {
this.layout = GeometryLayout.XY;
this.stride = 2;
return;
} else {
coordinates = /** @type {Array} */ (coordinates[0]);
}
}
stride = coordinates.length;
layout = getLayoutForStride(stride);
}
this.layout = layout;
this.stride = stride;
};
/**
* @inheritDoc
* @api
*/
SimpleGeometry.prototype.applyTransform = function(transformFn) {
if (this.flatCoordinates) {
transformFn(this.flatCoordinates, this.flatCoordinates, this.stride);
this.changed();
}
};
/**
* @inheritDoc
* @api
*/
SimpleGeometry.prototype.rotate = function(angle, anchor) {
const flatCoordinates = this.getFlatCoordinates();
if (flatCoordinates) {
const stride = this.getStride();
rotate(
flatCoordinates, 0, flatCoordinates.length,
stride, angle, anchor, flatCoordinates);
this.changed();
}
};
/**
* @inheritDoc
* @api
*/
SimpleGeometry.prototype.scale = function(sx, opt_sy, opt_anchor) {
let sy = opt_sy;
if (sy === undefined) {
sy = sx;
}
let anchor = opt_anchor;
if (!anchor) {
anchor = getCenter(this.getExtent());
}
const flatCoordinates = this.getFlatCoordinates();
if (flatCoordinates) {
const stride = this.getStride();
scale(
flatCoordinates, 0, flatCoordinates.length,
stride, sx, sy, anchor, flatCoordinates);
this.changed();
}
};
/**
* @inheritDoc
* @api
*/
SimpleGeometry.prototype.translate = function(deltaX, deltaY) {
const flatCoordinates = this.getFlatCoordinates();
if (flatCoordinates) {
const stride = this.getStride();
translate(
flatCoordinates, 0, flatCoordinates.length, stride,
deltaX, deltaY, flatCoordinates);
this.changed();
}
};
/**
* @param {module:ol/geom/SimpleGeometry} simpleGeometry Simple geometry.
* @param {module:ol/transform~Transform} transform Transform.

Some files were not shown because too many files have changed in this diff Show More