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

Get rid of olx.js and typedef.js typedefs for ol

Browse Source
This commit is contained in:
Andreas Hocevar
2018-03-08 18:42:57 +01:00
parent 8f0ffe2043
commit 95d6251dbb
198 changed files with 2262 additions and 2698 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/ol/interaction/DragAndDrop.js
View File

@@ -101,7 +101,7 @@ const DragAndDrop = function(opt_options) {
/**
* @private
* @type {Array.<ol.EventsKey>}
* @type {Array.<module:ol/events~EventsKey>}
*/
this.dropListenKeys_ = null;

10
src/ol/interaction/DragBox.js
View File

@@ -43,7 +43,7 @@ const DragBoxEventType = {
* this type.
*
* @param {string} type The event type.
* @param {ol.Coordinate} coordinate The event coordinate.
* @param {module:ol/coordinate~Coordinate} coordinate The event coordinate.
* @param {ol.MapBrowserEvent} mapBrowserEvent Originating event.
* @extends {ol.events.Event}
* @constructor
@@ -55,7 +55,7 @@ const DragBoxEvent = function(type, coordinate, mapBrowserEvent) {
/**
* The coordinate of the drag event.
* @const
* @type {ol.Coordinate}
* @type {module:ol/coordinate~Coordinate}
* @api
*/
this.coordinate = coordinate;
@@ -112,7 +112,7 @@ const DragBox = function(opt_options) {
this.minArea_ = options.minArea !== undefined ? options.minArea : 64;
/**
* @type {ol.Pixel}
* @type {module:ol~Pixel}
* @private
*/
this.startPixel_ = null;
@@ -139,8 +139,8 @@ inherits(DragBox, PointerInteraction);
* should fire.
* @param {ol.MapBrowserEvent} mapBrowserEvent The originating MapBrowserEvent
* leading to the box end.
* @param {ol.Pixel} startPixel The starting pixel of the box.
* @param {ol.Pixel} endPixel The end pixel of the box.
* @param {module:ol~Pixel} startPixel The starting pixel of the box.
* @param {module:ol~Pixel} endPixel The end pixel of the box.
* @return {boolean} Whether or not the boxend condition should be fired.
* @this {ol.interaction.DragBox}
*/

4
src/ol/interaction/DragPan.js
View File

@@ -35,7 +35,7 @@ const DragPan = function(opt_options) {
this.kinetic_ = options.kinetic;
/**
* @type {ol.Pixel}
* @type {module:ol~Pixel}
*/
this.lastCentroid = null;
@@ -106,7 +106,7 @@ function handleUpEvent(mapBrowserEvent) {
if (!this.noKinetic_ && this.kinetic_ && this.kinetic_.end()) {
const distance = this.kinetic_.getDistance();
const angle = this.kinetic_.getAngle();
const center = /** @type {!ol.Coordinate} */ (view.getCenter());
const center = /** @type {!module:ol/coordinate~Coordinate} */ (view.getCenter());
const centerpx = map.getPixelFromCoordinate(center);
const dest = map.getCoordinateFromPixel([
centerpx[0] - distance * Math.cos(angle),

2
src/ol/interaction/DragZoom.js
View File

@@ -56,7 +56,7 @@ DragZoom.prototype.onBoxEnd = function() {
const view = /** @type {!ol.View} */ (map.getView());
const size = /** @type {!ol.Size} */ (map.getSize());
const size = /** @type {!module:ol/size~Size} */ (map.getSize());
let extent = this.getGeometry().getExtent();

16
src/ol/interaction/Draw.js
View File

@@ -113,7 +113,7 @@ const Draw = function(options) {
this.shouldHandle_ = false;
/**
* @type {ol.Pixel}
* @type {module:ol~Pixel}
* @private
*/
this.downPx_ = null;
@@ -209,7 +209,7 @@ const Draw = function(options) {
if (!geometryFunction) {
if (this.type_ === GeometryType.CIRCLE) {
/**
* @param {!Array.<ol.Coordinate>} coordinates
* @param {!Array.<module:ol/coordinate~Coordinate>} coordinates
* The coordinates.
* @param {ol.geom.SimpleGeometry=} opt_geometry Optional geometry.
* @return {ol.geom.SimpleGeometry} A geometry.
@@ -233,7 +233,7 @@ const Draw = function(options) {
Constructor = Polygon;
}
/**
* @param {!Array.<ol.Coordinate>} coordinates
* @param {!Array.<module:ol/coordinate~Coordinate>} coordinates
* The coordinates.
* @param {ol.geom.SimpleGeometry=} opt_geometry Optional geometry.
* @return {ol.geom.SimpleGeometry} A geometry.
@@ -274,7 +274,7 @@ const Draw = function(options) {
/**
* Finish coordinate for the feature (first point for polygons, last point for
* linestrings).
* @type {ol.Coordinate}
* @type {module:ol/coordinate~Coordinate}
* @private
*/
this.finishCoordinate_ = null;
@@ -295,7 +295,7 @@ const Draw = function(options) {
/**
* Sketch coordinates. Used when drawing a line or polygon.
* @type {ol.Coordinate|Array.<ol.Coordinate>|Array.<Array.<ol.Coordinate>>}
* @type {module:ol/coordinate~Coordinate|Array.<module:ol/coordinate~Coordinate>|Array.<Array.<module:ol/coordinate~Coordinate>>}
* @private
*/
this.sketchCoords_ = null;
@@ -309,7 +309,7 @@ const Draw = function(options) {
/**
* Sketch line coordinates. Used when drawing a polygon or circle.
* @type {Array.<ol.Coordinate>}
* @type {Array.<module:ol/coordinate~Coordinate>}
* @private
*/
this.sketchLineCoords_ = null;
@@ -374,7 +374,7 @@ inherits(Draw, PointerInteraction);
/**
* @return {ol.StyleFunction} Styles.
* @return {module:ol/style~StyleFunction} Styles.
*/
function getDefaultStyleFunction() {
const styles = createEditingStyle();
@@ -662,7 +662,7 @@ Draw.prototype.modifyDrawing_ = function(event) {
}
last[0] = coordinate[0];
last[1] = coordinate[1];
this.geometryFunction_(/** @type {!Array.<ol.Coordinate>} */ (this.sketchCoords_), geometry);
this.geometryFunction_(/** @type {!Array.<module:ol/coordinate~Coordinate>} */ (this.sketchCoords_), geometry);
if (this.sketchPoint_) {
const sketchPointGeom = /** @type {ol.geom.Point} */ (this.sketchPoint_.getGeometry());
sketchPointGeom.setCoordinates(coordinate);

38
src/ol/interaction/Extent.js
View File

@@ -25,7 +25,7 @@ import {createEditingStyle} from '../style/Style.js';
*
* @constructor
* @implements {oli.ExtentEvent}
* @param {ol.Extent} extent the new extent
* @param {module:ol/extent~Extent} extent the new extent
* @extends {ol.events.Event}
*/
const ExtentInteractionEvent = function(extent) {
@@ -33,7 +33,7 @@ const ExtentInteractionEvent = function(extent) {
/**
* The current extent.
* @type {ol.Extent}
* @type {module:ol/extent~Extent}
* @api
*/
this.extent = extent;
@@ -60,14 +60,14 @@ const ExtentInteraction = function(opt_options) {
/**
* Extent of the drawn box
* @type {ol.Extent}
* @type {module:ol/extent~Extent}
* @private
*/
this.extent_ = null;
/**
* Handler for pointer move events
* @type {function (ol.Coordinate): ol.Extent|null}
* @type {function (module:ol/coordinate~Coordinate): module:ol/extent~Extent|null}
* @private
*/
this.pointerHandler_ = null;
@@ -260,7 +260,7 @@ function handleUpEvent(mapBrowserEvent) {
/**
* Returns the default style for the drawn bbox
*
* @return {ol.StyleFunction} Default Extent style
* @return {module:ol/style~StyleFunction} Default Extent style
*/
function getDefaultExtentStyleFunction() {
const style = createEditingStyle();
@@ -272,7 +272,7 @@ function getDefaultExtentStyleFunction() {
/**
* Returns the default style for the pointer
*
* @return {ol.StyleFunction} Default pointer style
* @return {module:ol/style~StyleFunction} Default pointer style
*/
function getDefaultPointerStyleFunction() {
const style = createEditingStyle();
@@ -282,8 +282,8 @@ function getDefaultPointerStyleFunction() {
}
/**
* @param {ol.Coordinate} fixedPoint corner that will be unchanged in the new extent
* @returns {function (ol.Coordinate): ol.Extent} event handler
* @param {module:ol/coordinate~Coordinate} fixedPoint corner that will be unchanged in the new extent
* @returns {function (module:ol/coordinate~Coordinate): module:ol/extent~Extent} event handler
*/
function getPointHandler(fixedPoint) {
return function(point) {
@@ -292,9 +292,9 @@ function getPointHandler(fixedPoint) {
}
/**
* @param {ol.Coordinate} fixedP1 first corner that will be unchanged in the new extent
* @param {ol.Coordinate} fixedP2 second corner that will be unchanged in the new extent
* @returns {function (ol.Coordinate): ol.Extent|null} event handler
* @param {module:ol/coordinate~Coordinate} fixedP1 first corner that will be unchanged in the new extent
* @param {module:ol/coordinate~Coordinate} fixedP2 second corner that will be unchanged in the new extent
* @returns {function (module:ol/coordinate~Coordinate): module:ol/extent~Extent|null} event handler
*/
function getEdgeHandler(fixedP1, fixedP2) {
if (fixedP1[0] == fixedP2[0]) {
@@ -311,8 +311,8 @@ function getEdgeHandler(fixedP1, fixedP2) {
}
/**
* @param {ol.Extent} extent extent
* @returns {Array<Array<ol.Coordinate>>} extent line segments
* @param {module:ol/extent~Extent} extent extent
* @returns {Array<Array<module:ol/coordinate~Coordinate>>} extent line segments
*/
function getSegments(extent) {
return [
@@ -324,9 +324,9 @@ function getSegments(extent) {
}
/**
* @param {ol.Pixel} pixel cursor location
* @param {module:ol~Pixel} pixel cursor location
* @param {ol.PluggableMap} map map
* @returns {ol.Coordinate|null} snapped vertex on extent
* @returns {module:ol/coordinate~Coordinate|null} snapped vertex on extent
* @private
*/
ExtentInteraction.prototype.snapToVertex_ = function(pixel, map) {
@@ -381,7 +381,7 @@ ExtentInteraction.prototype.handlePointerMove_ = function(mapBrowserEvent) {
};
/**
* @param {ol.Extent} extent extent
* @param {module:ol/extent~Extent} extent extent
* @returns {ol.Feature} extent as featrue
* @private
*/
@@ -408,7 +408,7 @@ ExtentInteraction.prototype.createOrUpdateExtentFeature_ = function(extent) {
/**
* @param {ol.Coordinate} vertex location of feature
* @param {module:ol/coordinate~Coordinate} vertex location of feature
* @returns {ol.Feature} vertex as feature
* @private
*/
@@ -438,7 +438,7 @@ ExtentInteraction.prototype.setMap = function(map) {
/**
* Returns the current drawn extent in the view projection
*
* @return {ol.Extent} Drawn extent in the view projection.
* @return {module:ol/extent~Extent} Drawn extent in the view projection.
* @api
*/
ExtentInteraction.prototype.getExtent = function() {
@@ -448,7 +448,7 @@ ExtentInteraction.prototype.getExtent = function() {
/**
* Manually sets the drawn extent, using the view projection.
*
* @param {ol.Extent} extent Extent
* @param {module:ol/extent~Extent} extent Extent
* @api
*/
ExtentInteraction.prototype.setExtent = function(extent) {

12
src/ol/interaction/Interaction.js
View File

@@ -103,7 +103,7 @@ Interaction.prototype.setMap = function(map) {
/**
* @param {module:ol/View~View} view View.
* @param {module:ol/types~Coordinate} delta Delta.
* @param {module:ol/coordinate~Coordinate} delta Delta.
* @param {number=} opt_duration Duration.
*/
export function pan(view, delta, opt_duration) {
@@ -127,7 +127,7 @@ export function pan(view, delta, opt_duration) {
/**
* @param {module:ol/View~View} view View.
* @param {number|undefined} rotation Rotation.
* @param {module:ol/types~Coordinate=} opt_anchor Anchor coordinate.
* @param {module:ol/coordinate~Coordinate=} opt_anchor Anchor coordinate.
* @param {number=} opt_duration Duration.
*/
export function rotate(view, rotation, opt_anchor, opt_duration) {
@@ -139,7 +139,7 @@ export function rotate(view, rotation, opt_anchor, opt_duration) {
/**
* @param {module:ol/View~View} view View.
* @param {number|undefined} rotation Rotation.
* @param {module:ol/types~Coordinate=} opt_anchor Anchor coordinate.
* @param {module:ol/coordinate~Coordinate=} opt_anchor Anchor coordinate.
* @param {number=} opt_duration Duration.
*/
export function rotateWithoutConstraints(view, rotation, opt_anchor, opt_duration) {
@@ -163,7 +163,7 @@ export function rotateWithoutConstraints(view, rotation, opt_anchor, opt_duratio
/**
* @param {module:ol/View~View} view View.
* @param {number|undefined} resolution Resolution to go to.
* @param {module:ol/types~Coordinate=} opt_anchor Anchor coordinate.
* @param {module:ol/coordinate~Coordinate=} opt_anchor Anchor coordinate.
* @param {number=} opt_duration Duration.
* @param {number=} opt_direction Zooming direction; > 0 indicates
* zooming out, in which case the constraints system will select
@@ -183,7 +183,7 @@ export function zoom(view, resolution, opt_anchor, opt_duration, opt_direction)
/**
* @param {module:ol/View~View} view View.
* @param {number} delta Delta from previous zoom level.
* @param {module:ol/types~Coordinate=} opt_anchor Anchor coordinate.
* @param {module:ol/coordinate~Coordinate=} opt_anchor Anchor coordinate.
* @param {number=} opt_duration Duration.
*/
export function zoomByDelta(view, delta, opt_anchor, opt_duration) {
@@ -221,7 +221,7 @@ export function zoomByDelta(view, delta, opt_anchor, opt_duration) {
/**
* @param {module:ol/View~View} view View.
* @param {number|undefined} resolution Resolution to go to.
* @param {module:ol/types~Coordinate=} opt_anchor Anchor coordinate.
* @param {module:ol/coordinate~Coordinate=} opt_anchor Anchor coordinate.
* @param {number=} opt_duration Duration.
*/
export function zoomWithoutConstraints(view, resolution, opt_anchor, opt_duration) {

16
src/ol/interaction/Modify.js
View File

@@ -151,7 +151,7 @@ const Modify = function(options) {
this.vertexSegments_ = null;
/**
* @type {ol.Pixel}
* @type {module:ol~Pixel}
* @private
*/
this.lastPixel_ = [0, 0];
@@ -620,7 +620,7 @@ Modify.prototype.writeGeometryCollectionGeometry_ = function(feature, geometry)
/**
* @param {ol.Coordinate} coordinates Coordinates.
* @param {module:ol/coordinate~Coordinate} coordinates Coordinates.
* @return {ol.Feature} Vertex feature.
* @private
*/
@@ -876,7 +876,7 @@ Modify.prototype.handlePointerMove_ = function(evt) {
/**
* @param {ol.Pixel} pixel Pixel
* @param {module:ol~Pixel} pixel Pixel
* @param {ol.PluggableMap} map Map.
* @private
*/
@@ -946,7 +946,7 @@ Modify.prototype.handlePointerAtPixel_ = function(pixel, map) {
/**
* Returns the distance from a point to a line segment.
*
* @param {ol.Coordinate} pointCoordinates The coordinates of the point from
* @param {module:ol/coordinate~Coordinate} pointCoordinates The coordinates of the point from
* which to calculate the distance.
* @param {ol.ModifySegmentDataType} segmentData The object describing the line
* segment we are calculating the distance to.
@@ -972,11 +972,11 @@ function pointDistanceToSegmentDataSquared(pointCoordinates, segmentData) {
/**
* Returns the point closest to a given line segment.
*
* @param {ol.Coordinate} pointCoordinates The point to which a closest point
* @param {module:ol/coordinate~Coordinate} pointCoordinates The point to which a closest point
* should be found.
* @param {ol.ModifySegmentDataType} segmentData The object describing the line
* segment which should contain the closest point.
* @return {ol.Coordinate} The point closest to the specified line segment.
* @return {module:ol/coordinate~Coordinate} The point closest to the specified line segment.
*/
function closestOnSegmentData(pointCoordinates, segmentData) {
const geometry = segmentData.geometry;
@@ -991,7 +991,7 @@ function closestOnSegmentData(pointCoordinates, segmentData) {
/**
* @param {ol.ModifySegmentDataType} segmentData Segment data.
* @param {ol.Coordinate} vertex Vertex.
* @param {module:ol/coordinate~Coordinate} vertex Vertex.
* @private
*/
Modify.prototype.insertVertex_ = function(segmentData, vertex) {
@@ -1223,7 +1223,7 @@ Modify.prototype.updateSegmentIndices_ = function(
/**
* @return {ol.StyleFunction} Styles.
* @return {module:ol/style~StyleFunction} Styles.
*/
function getDefaultStyleFunction() {
const style = createEditingStyle();

2
src/ol/interaction/MouseWheelZoom.js
View File

@@ -82,7 +82,7 @@ const MouseWheelZoom = function(opt_options) {
/**
* @private
* @type {?ol.Coordinate}
* @type {?module:ol/coordinate~Coordinate}
*/
this.lastAnchor_ = null;

2
src/ol/interaction/PinchRotate.js
View File

@@ -30,7 +30,7 @@ const PinchRotate = function(opt_options) {
/**
* @private
* @type {ol.Coordinate}
* @type {module:ol/coordinate~Coordinate}
*/
this.anchor_ = null;

2
src/ol/interaction/PinchZoom.js
View File

@@ -35,7 +35,7 @@ const PinchZoom = function(opt_options) {
/**
* @private
* @type {ol.Coordinate}
* @type {module:ol/coordinate~Coordinate}
*/
this.anchor_ = null;

2
src/ol/interaction/Pointer.js
View File

@@ -115,7 +115,7 @@ inherits(PointerInteraction, Interaction);
/**
* @param {Array.<ol.pointer.PointerEvent>} pointerEvents List of events.
* @return {ol.Pixel} Centroid pixel.
* @return {module:ol~Pixel} Centroid pixel.
*/
export function centroid(pointerEvents) {
const length = pointerEvents.length;

2
src/ol/interaction/Select.js
View File

@@ -371,7 +371,7 @@ Select.prototype.setMap = function(map) {
/**
* @return {ol.StyleFunction} Styles.
* @return {module:ol/style~StyleFunction} Styles.
*/
function getDefaultStyleFunction() {
const styles = createEditingStyle();

12
src/ol/interaction/Snap.js
View File

@@ -74,13 +74,13 @@ const Snap = function(opt_options) {
this.features_ = options.features ? options.features : null;
/**
* @type {Array.<ol.EventsKey>}
* @type {Array.<module:ol/events~EventsKey>}
* @private
*/
this.featuresListenerKeys_ = [];
/**
* @type {Object.<number, ol.EventsKey>}
* @type {Object.<number, module:ol/events~EventsKey>}
* @private
*/
this.featureChangeListenerKeys_ = {};
@@ -88,7 +88,7 @@ const Snap = function(opt_options) {
/**
* Extents are preserved so indexed segment can be quickly removed
* when its feature geometry changes
* @type {Object.<number, ol.Extent>}
* @type {Object.<number, module:ol/extent~Extent>}
* @private
*/
this.indexedFeaturesExtents_ = {};
@@ -104,7 +104,7 @@ const Snap = function(opt_options) {
/**
* Used for distance sorting in sortByDistance_
* @type {ol.Coordinate}
* @type {module:ol/coordinate~Coordinate}
* @private
*/
this.pixelCoordinate_ = null;
@@ -334,8 +334,8 @@ Snap.prototype.shouldStopEvent = FALSE;
/**
* @param {ol.Pixel} pixel Pixel
* @param {ol.Coordinate} pixelCoordinate Coordinate
* @param {module:ol~Pixel} pixel Pixel
* @param {module:ol/coordinate~Coordinate} pixelCoordinate Coordinate
* @param {ol.PluggableMap} map Map.
* @return {ol.SnapResultType} Snap result
*/

8
src/ol/interaction/Translate.js
View File

@@ -47,7 +47,7 @@ const TranslateEventType = {
* @implements {oli.interaction.TranslateEvent}
* @param {ol.interaction.TranslateEventType} type Type.
* @param {ol.Collection.<ol.Feature>} features The features translated.
* @param {ol.Coordinate} coordinate The event coordinate.
* @param {module:ol/coordinate~Coordinate} coordinate The event coordinate.
*/
export const TranslateEvent = function(type, features, coordinate) {
@@ -63,7 +63,7 @@ export const TranslateEvent = function(type, features, coordinate) {
/**
* The coordinate of the drag event.
* @const
* @type {ol.Coordinate}
* @type {module:ol/coordinate~Coordinate}
* @api
*/
this.coordinate = coordinate;
@@ -94,7 +94,7 @@ const Translate = function(opt_options) {
/**
* The last position we translated to.
* @type {ol.Coordinate}
* @type {module:ol/coordinate~Coordinate}
* @private
*/
this.lastCoordinate_ = null;
@@ -241,7 +241,7 @@ function handleMoveEvent(event) {
/**
* Tests to see if the given coordinates intersects any of our selected
* features.
* @param {ol.Pixel} pixel Pixel coordinate to test for intersection.
* @param {module:ol~Pixel} pixel Pixel coordinate to test for intersection.
* @param {ol.PluggableMap} map Map to test the intersection on.
* @return {ol.Feature} Returns the feature found at the specified pixel
* coordinates.