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

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

View File

@@ -9,7 +9,7 @@ import CanvasReplay from '../canvas/Replay.js';
* @constructor
* @extends {ol.render.canvas.Replay}
* @param {number} tolerance Tolerance.
* @param {ol.Extent} maxExtent Maximum extent.
* @param {module:ol/extent~Extent} maxExtent Maximum extent.
* @param {number} resolution Resolution.
* @param {number} pixelRatio Pixel ratio.
* @param {boolean} overlaps The replay can have overlapping geometries.

View File

@@ -30,8 +30,8 @@ import {create as createTransform, compose as composeTransform} from '../../tran
* @extends {ol.render.VectorContext}
* @param {CanvasRenderingContext2D} context Context.
* @param {number} pixelRatio Pixel ratio.
* @param {ol.Extent} extent Extent.
* @param {ol.Transform} transform Transform.
* @param {module:ol/extent~Extent} extent Extent.
* @param {module:ol/transform~Transform} transform Transform.
* @param {number} viewRotation View rotation.
* @struct
*/
@@ -52,13 +52,13 @@ const CanvasImmediateRenderer = function(context, pixelRatio, extent, transform,
/**
* @private
* @type {ol.Extent}
* @type {module:ol/extent~Extent}
*/
this.extent_ = extent;
/**
* @private
* @type {ol.Transform}
* @type {module:ol/transform~Transform}
*/
this.transform_ = transform;
@@ -232,7 +232,7 @@ const CanvasImmediateRenderer = function(context, pixelRatio, extent, transform,
/**
* @private
* @type {ol.Transform}
* @type {module:ol/transform~Transform}
*/
this.tmpLocalTransform_ = createTransform();

View File

@@ -9,7 +9,7 @@ import CanvasReplay from '../canvas/Replay.js';
* @constructor
* @extends {ol.render.canvas.Replay}
* @param {number} tolerance Tolerance.
* @param {ol.Extent} maxExtent Maximum extent.
* @param {module:ol/extent~Extent} maxExtent Maximum extent.
* @param {number} resolution Resolution.
* @param {number} pixelRatio Pixel ratio.
* @param {boolean} overlaps The replay can have overlapping geometries.

View File

@@ -15,7 +15,7 @@ import CanvasReplay from '../canvas/Replay.js';
* @constructor
* @extends {ol.render.canvas.Replay}
* @param {number} tolerance Tolerance.
* @param {ol.Extent} maxExtent Maximum extent.
* @param {module:ol/extent~Extent} maxExtent Maximum extent.
* @param {number} resolution Resolution.
* @param {number} pixelRatio Pixel ratio.
* @param {boolean} overlaps The replay can have overlapping geometries.

View File

@@ -32,7 +32,7 @@ import {
* @constructor
* @extends {ol.render.VectorContext}
* @param {number} tolerance Tolerance.
* @param {ol.Extent} maxExtent Maximum extent.
* @param {module:ol/extent~Extent} maxExtent Maximum extent.
* @param {number} resolution Resolution.
* @param {number} pixelRatio Pixel ratio.
* @param {boolean} overlaps The replay can have overlapping geometries.
@@ -49,7 +49,7 @@ const CanvasReplay = function(tolerance, maxExtent, resolution, pixelRatio, over
/**
* @private
* @type {ol.Extent}
* @type {module:ol/extent~Extent}
*/
this.tmpExtent_ = createEmpty();
@@ -62,7 +62,7 @@ const CanvasReplay = function(tolerance, maxExtent, resolution, pixelRatio, over
/**
* @protected
* @const
* @type {ol.Extent}
* @type {module:ol/extent~Extent}
*/
this.maxExtent = maxExtent;
@@ -93,7 +93,7 @@ const CanvasReplay = function(tolerance, maxExtent, resolution, pixelRatio, over
/**
* @private
* @type {ol.Coordinate}
* @type {module:ol/coordinate~Coordinate}
*/
this.fillOrigin_;
@@ -111,7 +111,7 @@ const CanvasReplay = function(tolerance, maxExtent, resolution, pixelRatio, over
/**
* @private
* @type {ol.Extent}
* @type {module:ol/extent~Extent}
*/
this.bufferedMaxExtent_ = null;
@@ -129,13 +129,13 @@ const CanvasReplay = function(tolerance, maxExtent, resolution, pixelRatio, over
/**
* @private
* @type {!Object.<number,ol.Coordinate|Array.<ol.Coordinate>|Array.<Array.<ol.Coordinate>>>}
* @type {!Object.<number,module:ol/coordinate~Coordinate|Array.<module:ol/coordinate~Coordinate>|Array.<Array.<module:ol/coordinate~Coordinate>>>}
*/
this.coordinateCache_ = {};
/**
* @private
* @type {!ol.Transform}
* @type {!module:ol/transform~Transform}
*/
this.renderedTransform_ = createTransform();
@@ -165,13 +165,13 @@ const CanvasReplay = function(tolerance, maxExtent, resolution, pixelRatio, over
/**
* @private
* @type {!ol.Transform}
* @type {!module:ol/transform~Transform}
*/
this.tmpLocalTransform_ = createTransform();
/**
* @private
* @type {!ol.Transform}
* @type {!module:ol/transform~Transform}
*/
this.resetTransform = createTransform();
};
@@ -181,10 +181,10 @@ inherits(CanvasReplay, VectorContext);
/**
* @param {CanvasRenderingContext2D} context Context.
* @param {ol.Coordinate} p1 1st point of the background box.
* @param {ol.Coordinate} p2 2nd point of the background box.
* @param {ol.Coordinate} p3 3rd point of the background box.
* @param {ol.Coordinate} p4 4th point of the background box.
* @param {module:ol/coordinate~Coordinate} p1 1st point of the background box.
* @param {module:ol/coordinate~Coordinate} p2 2nd point of the background box.
* @param {module:ol/coordinate~Coordinate} p3 3rd point of the background box.
* @param {module:ol/coordinate~Coordinate} p4 4th point of the background box.
* @param {Array.<*>} fillInstruction Fill instruction.
* @param {Array.<*>} strokeInstruction Stroke instruction.
*/
@@ -245,13 +245,13 @@ CanvasReplay.prototype.replayImage_ = function(context, x, y, image,
const boxX = x - padding[3];
const boxY = y - padding[0];
/** @type {ol.Coordinate} */
/** @type {module:ol/coordinate~Coordinate} */
let p1;
/** @type {ol.Coordinate} */
/** @type {module:ol/coordinate~Coordinate} */
let p2;
/** @type {ol.Coordinate} */
/** @type {module:ol/coordinate~Coordinate} */
let p3;
/** @type {ol.Coordinate} */
/** @type {module:ol/coordinate~Coordinate} */
let p4;
if (fillStroke || rotation !== 0) {
p1 = [boxX, boxY];
@@ -534,13 +534,13 @@ CanvasReplay.prototype.renderDeclutter_ = function(declutterGroup, feature) {
/**
* @private
* @param {CanvasRenderingContext2D} context Context.
* @param {ol.Transform} transform Transform.
* @param {module:ol/transform~Transform} transform Transform.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features
* to skip.
* @param {Array.<*>} instructions Instructions array.
* @param {function((ol.Feature|ol.render.Feature)): T|undefined}
* featureCallback Feature callback.
* @param {ol.Extent=} opt_hitExtent Only check features that intersect this
* @param {module:ol/extent~Extent=} opt_hitExtent Only check features that intersect this
* extent.
* @return {T|undefined} Callback result.
* @template T
@@ -851,7 +851,7 @@ CanvasReplay.prototype.replay_ = function(
/**
* @param {CanvasRenderingContext2D} context Context.
* @param {ol.Transform} transform Transform.
* @param {module:ol/transform~Transform} transform Transform.
* @param {number} viewRotation View rotation.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features
* to skip.
@@ -866,13 +866,13 @@ CanvasReplay.prototype.replay = function(
/**
* @param {CanvasRenderingContext2D} context Context.
* @param {ol.Transform} transform Transform.
* @param {module:ol/transform~Transform} transform Transform.
* @param {number} viewRotation View rotation.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features
* to skip.
* @param {function((ol.Feature|ol.render.Feature)): T=} opt_featureCallback
* Feature callback.
* @param {ol.Extent=} opt_hitExtent Only check features that intersect this
* @param {module:ol/extent~Extent=} opt_hitExtent Only check features that intersect this
* extent.
* @return {T|undefined} Callback result.
* @template T
@@ -1077,7 +1077,7 @@ CanvasReplay.prototype.finish = UNDEFINED;
* Get the buffered rendering extent. Rendering will be clipped to the extent
* provided to the constructor. To account for symbolizers that may intersect
* this extent, we calculate a buffered extent (e.g. based on stroke width).
* @return {ol.Extent} The buffered rendering extent.
* @return {module:ol/extent~Extent} The buffered rendering extent.
* @protected
*/
CanvasReplay.prototype.getBufferedMaxExtent = function() {

View File

@@ -20,7 +20,7 @@ import {create as createTransform, compose as composeTransform} from '../../tran
/**
* @type {Object.<ol.render.ReplayType,
* function(new: ol.render.canvas.Replay, number, ol.Extent,
* function(new: ol.render.canvas.Replay, number, module:ol/extent~Extent,
* number, number, boolean, Array.<ol.DeclutterGroup>)>}
*/
const BATCH_CONSTRUCTORS = {
@@ -37,7 +37,7 @@ const BATCH_CONSTRUCTORS = {
* @constructor
* @extends {ol.render.ReplayGroup}
* @param {number} tolerance Tolerance.
* @param {ol.Extent} maxExtent Max extent.
* @param {module:ol/extent~Extent} maxExtent Max extent.
* @param {number} resolution Resolution.
* @param {number} pixelRatio Pixel ratio.
* @param {boolean} overlaps The replay group can have overlapping geometries.
@@ -70,7 +70,7 @@ const CanvasReplayGroup = function(
/**
* @private
* @type {ol.Extent}
* @type {module:ol/extent~Extent}
*/
this.maxExtent_ = maxExtent;
@@ -112,7 +112,7 @@ const CanvasReplayGroup = function(
/**
* @private
* @type {ol.Transform}
* @type {module:ol/transform~Transform}
*/
this.hitDetectionTransform_ = createTransform();
};
@@ -238,7 +238,7 @@ CanvasReplayGroup.prototype.addDeclutter = function(group) {
/**
* @param {CanvasRenderingContext2D} context Context.
* @param {ol.Transform} transform Transform.
* @param {module:ol/transform~Transform} transform Transform.
*/
CanvasReplayGroup.prototype.clip = function(context, transform) {
const flatClipCoords = this.getClipCoords(transform);
@@ -282,7 +282,7 @@ CanvasReplayGroup.prototype.finish = function() {
/**
* @param {ol.Coordinate} coordinate Coordinate.
* @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
* @param {number} resolution Resolution.
* @param {number} rotation Rotation.
* @param {number} hitTolerance Hit tolerance in pixels.
@@ -315,7 +315,7 @@ CanvasReplayGroup.prototype.forEachFeatureAtCoordinate = function(
}
/**
* @type {ol.Extent}
* @type {module:ol/extent~Extent}
*/
let hitExtent;
if (this.renderBuffer_ !== undefined) {
@@ -396,7 +396,7 @@ CanvasReplayGroup.prototype.forEachFeatureAtCoordinate = function(
/**
* @param {ol.Transform} transform Transform.
* @param {module:ol/transform~Transform} transform Transform.
* @return {Array.<number>} Clip coordinates.
*/
CanvasReplayGroup.prototype.getClipCoords = function(transform) {
@@ -451,7 +451,7 @@ CanvasReplayGroup.prototype.isEmpty = function() {
/**
* @param {CanvasRenderingContext2D} context Context.
* @param {ol.Transform} transform Transform.
* @param {module:ol/transform~Transform} transform Transform.
* @param {number} viewRotation View rotation.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features
* to skip.

View File

@@ -18,7 +18,7 @@ import TextPlacement from '../../style/TextPlacement.js';
* @constructor
* @extends {ol.render.canvas.Replay}
* @param {number} tolerance Tolerance.
* @param {ol.Extent} maxExtent Maximum extent.
* @param {module:ol/extent~Extent} maxExtent Maximum extent.
* @param {number} resolution Resolution.
* @param {number} pixelRatio Pixel ratio.
* @param {boolean} overlaps The replay can have overlapping geometries.