Module type for ol.render.Feature

This commit is contained in:
Frederic Junod
2018-04-20 14:53:56 +02:00
parent 3c0c4cd155
commit 7701c5fd3a
21 changed files with 105 additions and 128 deletions

View File

@@ -27,7 +27,7 @@ import RenderFeature from '../render/Feature.js';
* @property {function((module:ol/geom/Geometry~Geometry|Object.<string,*>)=)|function(module:ol/geom/GeometryType~GeometryType,Array.<number>,(Array.<number>|Array.<Array.<number>>),Object.<string,*>,number)} [featureClass]
* Class for features returned by {@link ol.format.MVT#readFeatures}. Set to
* {@link module:ol/Feature~Feature} to get full editing and geometry support at the cost of
* decreased rendering performance. The default is {@link ol.render.Feature},
* decreased rendering performance. The default is {@link module:ol/render/Feature~RenderFeature},
* which is optimized for rendering and hit detection.
* @property {string} [geometryName='geometry'] Geometry name to use when creating
* features.
@@ -297,7 +297,7 @@ function getGeometryType(type, numEnds) {
* @param {ol.ext.PBF} pbf PBF
* @param {Object} rawFeature Raw Mapbox feature.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/Feature~Feature|ol.render.Feature} Feature.
* @return {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} Feature.
*/
MVT.prototype.createFeature_ = function(pbf, rawFeature, opt_options) {
const type = rawFeature.type;
@@ -387,7 +387,7 @@ MVT.prototype.readFeatures = function(source, opt_options) {
const pbf = new PBF(/** @type {ArrayBuffer} */ (source));
const pbfLayers = pbf.readFields(layersPBFReader, {});
/** @type {Array.<module:ol/Feature~Feature|ol.render.Feature>} */
/** @type {Array.<module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature>} */
const features = [];
for (const name in pbfLayers) {
if (layers && layers.indexOf(name) == -1) {

View File

@@ -207,7 +207,7 @@ RenderFeature.prototype.getFlatCoordinates =
/**
* For API compatibility with {@link module:ol/Feature~Feature}, this method is useful when
* determining the geometry type in style function (see {@link #getType}).
* @return {ol.render.Feature} Feature.
* @return {module:ol/render/Feature~RenderFeature} Feature.
* @api
*/
RenderFeature.prototype.getGeometry = function() {
@@ -227,7 +227,7 @@ RenderFeature.prototype.getProperties = function() {
/**
* Get the feature for working with its geometry.
* @return {ol.render.Feature} Feature.
* @return {module:ol/render/Feature~RenderFeature} Feature.
*/
RenderFeature.prototype.getSimplifiedGeometry =
RenderFeature.prototype.getGeometry;

View File

@@ -17,7 +17,7 @@ const VectorContext = function() {
* Render a geometry with a custom renderer.
*
* @param {module:ol/geom/SimpleGeometry~SimpleGeometry} geometry Geometry.
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
* @param {Function} renderer Renderer.
*/
VectorContext.prototype.drawCustom = function(geometry, feature, renderer) {};
@@ -62,54 +62,50 @@ VectorContext.prototype.drawGeometryCollection = function(geometryCollectionGeom
/**
* @param {module:ol/geom/LineString~LineString|ol.render.Feature} lineStringGeometry Line
* string geometry.
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/geom/LineString~LineString|module:ol/render/Feature~RenderFeature} lineStringGeometry Line string geometry.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
*/
VectorContext.prototype.drawLineString = function(lineStringGeometry, feature) {};
/**
* @param {module:ol/geom/MultiLineString~MultiLineString|ol.render.Feature} multiLineStringGeometry
* MultiLineString geometry.
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/geom/MultiLineString~MultiLineString|module:ol/render/Feature~RenderFeature} multiLineStringGeometry MultiLineString geometry.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
*/
VectorContext.prototype.drawMultiLineString = function(multiLineStringGeometry, feature) {};
/**
* @param {module:ol/geom/MultiPoint~MultiPoint|ol.render.Feature} multiPointGeometry MultiPoint
* geometry.
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/geom/MultiPoint~MultiPoint|module:ol/render/Feature~RenderFeature} multiPointGeometry MultiPoint geometry.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
*/
VectorContext.prototype.drawMultiPoint = function(multiPointGeometry, feature) {};
/**
* @param {module:ol/geom/MultiPolygon~MultiPolygon} multiPolygonGeometry MultiPolygon geometry.
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
*/
VectorContext.prototype.drawMultiPolygon = function(multiPolygonGeometry, feature) {};
/**
* @param {module:ol/geom/Point~Point|ol.render.Feature} pointGeometry Point geometry.
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/geom/Point~Point|module:ol/render/Feature~RenderFeature} pointGeometry Point geometry.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
*/
VectorContext.prototype.drawPoint = function(pointGeometry, feature) {};
/**
* @param {module:ol/geom/Polygon~Polygon|ol.render.Feature} polygonGeometry Polygon
* geometry.
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/geom/Polygon~Polygon|module:ol/render/Feature~RenderFeature} polygonGeometry Polygon geometry.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
*/
VectorContext.prototype.drawPolygon = function(polygonGeometry, feature) {};
/**
* @param {module:ol/geom/Geometry~Geometry|ol.render.Feature} geometry Geometry.
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/geom/Geometry~Geometry|module:ol/render/Feature~RenderFeature} geometry Geometry.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
*/
VectorContext.prototype.drawText = function(geometry, feature) {};

View File

@@ -450,7 +450,7 @@ CanvasImmediateRenderer.prototype.setStyle = function(style) {
* Render a geometry into the canvas. Call
* {@link ol.render.canvas.Immediate#setStyle} first to set the rendering style.
*
* @param {module:ol/geom/Geometry~Geometry|ol.render.Feature} geometry The geometry to render.
* @param {module:ol/geom/Geometry~Geometry|module:ol/render/Feature~RenderFeature} geometry The geometry to render.
* @override
* @api
*/
@@ -526,7 +526,7 @@ CanvasImmediateRenderer.prototype.drawGeometryCollection = function(geometry) {
* Render a Point geometry into the canvas. Rendering is immediate and uses
* the current style.
*
* @param {module:ol/geom/Point~Point|ol.render.Feature} geometry Point geometry.
* @param {module:ol/geom/Point~Point|module:ol/render/Feature~RenderFeature} geometry Point geometry.
* @override
*/
CanvasImmediateRenderer.prototype.drawPoint = function(geometry) {
@@ -545,7 +545,7 @@ CanvasImmediateRenderer.prototype.drawPoint = function(geometry) {
* Render a MultiPoint geometry into the canvas. Rendering is immediate and
* uses the current style.
*
* @param {module:ol/geom/MultiPoint~MultiPoint|ol.render.Feature} geometry MultiPoint geometry.
* @param {module:ol/geom/MultiPoint~MultiPoint|module:ol/render/Feature~RenderFeature} geometry MultiPoint geometry.
* @override
*/
CanvasImmediateRenderer.prototype.drawMultiPoint = function(geometry) {
@@ -564,7 +564,7 @@ CanvasImmediateRenderer.prototype.drawMultiPoint = function(geometry) {
* Render a LineString into the canvas. Rendering is immediate and uses
* the current style.
*
* @param {module:ol/geom/LineString~LineString|ol.render.Feature} geometry LineString geometry.
* @param {module:ol/geom/LineString~LineString|module:ol/render/Feature~RenderFeature} geometry LineString geometry.
* @override
*/
CanvasImmediateRenderer.prototype.drawLineString = function(geometry) {
@@ -591,8 +591,7 @@ CanvasImmediateRenderer.prototype.drawLineString = function(geometry) {
* Render a MultiLineString geometry into the canvas. Rendering is immediate
* and uses the current style.
*
* @param {module:ol/geom/MultiLineString~MultiLineString|ol.render.Feature} geometry MultiLineString
* geometry.
* @param {module:ol/geom/MultiLineString~MultiLineString|module:ol/render/Feature~RenderFeature} geometry MultiLineString geometry.
* @override
*/
CanvasImmediateRenderer.prototype.drawMultiLineString = function(geometry) {
@@ -624,7 +623,7 @@ CanvasImmediateRenderer.prototype.drawMultiLineString = function(geometry) {
* Render a Polygon geometry into the canvas. Rendering is immediate and uses
* the current style.
*
* @param {module:ol/geom/Polygon~Polygon|ol.render.Feature} geometry Polygon geometry.
* @param {module:ol/geom/Polygon~Polygon|module:ol/render/Feature~RenderFeature} geometry Polygon geometry.
* @override
*/
CanvasImmediateRenderer.prototype.drawPolygon = function(geometry) {

View File

@@ -201,7 +201,7 @@ CanvasPolygonReplay.prototype.finish = function() {
/**
* @private
* @param {module:ol/geom/Geometry~Geometry|ol.render.Feature} geometry Geometry.
* @param {module:ol/geom/Geometry~Geometry|module:ol/render/Feature~RenderFeature} geometry Geometry.
*/
CanvasPolygonReplay.prototype.setFillStrokeStyles_ = function(geometry) {
const state = this.state;

View File

@@ -439,8 +439,8 @@ CanvasReplay.prototype.drawCustom = function(geometry, feature, renderer) {
/**
* @protected
* @param {module:ol/geom/Geometry~Geometry|ol.render.Feature} geometry Geometry.
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/geom/Geometry~Geometry|module:ol/render/Feature~RenderFeature} geometry Geometry.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
*/
CanvasReplay.prototype.beginGeometry = function(geometry, feature) {
this.beginGeometryInstruction1_ = [CanvasInstruction.BEGIN_GEOMETRY, feature, 0];
@@ -487,7 +487,7 @@ CanvasReplay.prototype.setStrokeStyle_ = function(context, instruction) {
/**
* @param {module:ol/render/canvas~DeclutterGroup} declutterGroup Declutter group.
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
*/
CanvasReplay.prototype.renderDeclutter_ = function(declutterGroup, feature) {
if (declutterGroup && declutterGroup.length > 5) {
@@ -529,7 +529,7 @@ CanvasReplay.prototype.renderDeclutter_ = function(declutterGroup, feature) {
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features
* to skip.
* @param {Array.<*>} instructions Instructions array.
* @param {function((module:ol/Feature~Feature|ol.render.Feature)): T|undefined}
* @param {function((module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature)): T|undefined}
* featureCallback Feature callback.
* @param {module:ol/extent~Extent=} opt_hitExtent Only check features that intersect this
* extent.
@@ -575,14 +575,14 @@ CanvasReplay.prototype.replay_ = function(
// When the batch size gets too big, performance decreases. 200 is a good
// balance between batch size and number of fill/stroke instructions.
const batchSize = this.instructions != instructions || this.overlaps ? 0 : 200;
let /** @type {module:ol/Feature~Feature|ol.render.Feature} */ feature;
let /** @type {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} */ feature;
let x, y;
while (i < ii) {
const instruction = instructions[i];
const type = /** @type {ol.render.canvas.Instruction} */ (instruction[0]);
switch (type) {
case CanvasInstruction.BEGIN_GEOMETRY:
feature = /** @type {module:ol/Feature~Feature|ol.render.Feature} */ (instruction[1]);
feature = /** @type {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} */ (instruction[1]);
if ((skipFeatures &&
skippedFeaturesHash[getUid(feature).toString()]) ||
!feature.getGeometry()) {
@@ -751,7 +751,7 @@ CanvasReplay.prototype.replay_ = function(
break;
case CanvasInstruction.END_GEOMETRY:
if (featureCallback !== undefined) {
feature = /** @type {module:ol/Feature~Feature|ol.render.Feature} */ (instruction[1]);
feature = /** @type {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} */ (instruction[1]);
const result = featureCallback(feature);
if (result) {
return result;
@@ -861,7 +861,7 @@ CanvasReplay.prototype.replay = function(
* @param {number} viewRotation View rotation.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features
* to skip.
* @param {function((module:ol/Feature~Feature|ol.render.Feature)): T=} opt_featureCallback
* @param {function((module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature)): T=} opt_featureCallback
* Feature callback.
* @param {module:ol/extent~Extent=} opt_hitExtent Only check features that intersect this
* extent.
@@ -958,7 +958,7 @@ CanvasReplay.prototype.setFillStrokeStyle = function(fillStyle, strokeStyle) {
/**
* @param {module:ol/render/canvas~FillStrokeState} state State.
* @param {module:ol/geom/Geometry~Geometry|ol.render.Feature} geometry Geometry.
* @param {module:ol/geom/Geometry~Geometry|module:ol/render/Feature~RenderFeature} geometry Geometry.
* @return {Array.<*>} Fill instruction.
*/
CanvasReplay.prototype.createFill = function(state, geometry) {
@@ -996,8 +996,8 @@ CanvasReplay.prototype.createStroke = function(state) {
/**
* @param {module:ol/render/canvas~FillStrokeState} state State.
* @param {function(this:ol.render.canvas.Replay, module:ol/render/canvas~FillStrokeState, (module:ol/geom/Geometry~Geometry|ol.render.Feature)):Array.<*>} createFill Create fill.
* @param {module:ol/geom/Geometry~Geometry|ol.render.Feature} geometry Geometry.
* @param {function(this:ol.render.canvas.Replay, module:ol/render/canvas~FillStrokeState, (module:ol/geom/Geometry~Geometry|module:ol/render/Feature~RenderFeature)):Array.<*>} createFill Create fill.
* @param {module:ol/geom/Geometry~Geometry|module:ol/render/Feature~RenderFeature} geometry Geometry.
*/
CanvasReplay.prototype.updateFillStyle = function(state, createFill, geometry) {
const fillStyle = state.fillStyle;
@@ -1044,8 +1044,8 @@ CanvasReplay.prototype.updateStrokeStyle = function(state, applyStroke) {
/**
* @param {module:ol/geom/Geometry~Geometry|ol.render.Feature} geometry Geometry.
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/geom/Geometry~Geometry|module:ol/render/Feature~RenderFeature} geometry Geometry.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
*/
CanvasReplay.prototype.endGeometry = function(geometry, feature) {
this.beginGeometryInstruction1_[2] = this.instructions.length;

View File

@@ -286,12 +286,9 @@ CanvasReplayGroup.prototype.finish = function() {
* @param {number} resolution Resolution.
* @param {number} rotation Rotation.
* @param {number} hitTolerance Hit tolerance in pixels.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features
* to skip.
* @param {function((module:ol/Feature~Feature|ol.render.Feature)): T} callback Feature
* callback.
* @param {Object.<string, module:ol/render/canvas~DeclutterGroup>} declutterReplays Declutter
* replays.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features to skip.
* @param {function((module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature)): T} callback Feature callback.
* @param {Object.<string, module:ol/render/canvas~DeclutterGroup>} declutterReplays Declutter replays.
* @return {T|undefined} Callback result.
* @template T
*/
@@ -335,7 +332,7 @@ CanvasReplayGroup.prototype.forEachFeatureAtCoordinate = function(
let replayType;
/**
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
* @return {?} Callback result.
*/
function featureCallback(feature) {
@@ -453,12 +450,10 @@ CanvasReplayGroup.prototype.isEmpty = function() {
* @param {CanvasRenderingContext2D} context Context.
* @param {module:ol/transform~Transform} transform Transform.
* @param {number} viewRotation View rotation.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features
* to skip.
* @param {Array.<ol.render.ReplayType>=} opt_replayTypes Ordered replay types
* to replay. Default is {@link ol.render.replay.ORDER}
* @param {Object.<string, module:ol/render/canvas~DeclutterGroup>=} opt_declutterReplays Declutter
* replays.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features to skip.
* @param {Array.<ol.render.ReplayType>=} opt_replayTypes Ordered replay types to replay.
* Default is {@link ol.render.replay.ORDER}
* @param {Object.<string, module:ol/render/canvas~DeclutterGroup>=} opt_declutterReplays Declutter replays.
*/
CanvasReplayGroup.prototype.replay = function(context,
transform, viewRotation, skippedFeaturesHash, opt_replayTypes, opt_declutterReplays) {

View File

@@ -89,7 +89,7 @@ inherits(WebGLImmediateRenderer, VectorContext);
/**
* @param {ol.render.webgl.ReplayGroup} replayGroup Replay group.
* @param {module:ol/geom/Geometry~Geometry|ol.render.Feature} geometry Geometry.
* @param {module:ol/geom/Geometry~Geometry|module:ol/render/Feature~RenderFeature} geometry Geometry.
* @private
*/
WebGLImmediateRenderer.prototype.drawText_ = function(replayGroup, geometry) {
@@ -130,7 +130,7 @@ WebGLImmediateRenderer.prototype.setStyle = function(style) {
* Render a geometry into the canvas. Call
* {@link ol.render.webgl.Immediate#setStyle} first to set the rendering style.
*
* @param {module:ol/geom/Geometry~Geometry|ol.render.Feature} geometry The geometry to render.
* @param {module:ol/geom/Geometry~Geometry|module:ol/render/Feature~RenderFeature} geometry The geometry to render.
* @override
* @api
*/

View File

@@ -396,7 +396,7 @@ WebGLLineStringReplay.prototype.drawPolygonCoordinates = function(
/**
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
* @param {number=} opt_index Index count.
*/
WebGLLineStringReplay.prototype.setPolygonStyle = function(feature, opt_index) {

View File

@@ -95,7 +95,7 @@ const WebGLReplay = function(tolerance, maxExtent) {
/**
* Start index per feature (the feature).
* @protected
* @type {Array.<module:ol/Feature~Feature|ol.render.Feature>}
* @type {Array.<module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature>}
*/
this.startIndicesFeature = [];
@@ -170,8 +170,7 @@ WebGLReplay.prototype.shutDownProgram = function(gl, locations) {};
* @protected
* @param {WebGLRenderingContext} gl gl.
* @param {module:ol/webgl/Context~WebGLContext} context Context.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features
* to skip.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features to skip.
* @param {boolean} hitDetection Hit detection mode.
*/
WebGLReplay.prototype.drawReplay = function(gl, context, skippedFeaturesHash, hitDetection) {};
@@ -182,11 +181,9 @@ WebGLReplay.prototype.drawReplay = function(gl, context, skippedFeaturesHash, hi
* @protected
* @param {WebGLRenderingContext} gl gl.
* @param {module:ol/webgl/Context~WebGLContext} context Context.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features
* to skip.
* @param {function((module:ol/Feature~Feature|ol.render.Feature)): T|undefined} featureCallback Feature callback.
* @param {module:ol/extent~Extent=} opt_hitExtent Hit extent: Only features intersecting
* this extent are checked.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features to skip.
* @param {function((module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature)): T|undefined} featureCallback Feature callback.
* @param {module:ol/extent~Extent=} opt_hitExtent Hit extent: Only features intersecting this extent are checked.
* @return {T|undefined} Callback result.
* @template T
*/
@@ -197,9 +194,8 @@ WebGLReplay.prototype.drawHitDetectionReplayOneByOne = function(gl, context, ski
* @protected
* @param {WebGLRenderingContext} gl gl.
* @param {module:ol/webgl/Context~WebGLContext} context Context.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features
* to skip.
* @param {function((module:ol/Feature~Feature|ol.render.Feature)): T|undefined} featureCallback Feature callback.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features to skip.
* @param {function((module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature)): T|undefined} featureCallback Feature callback.
* @param {boolean} oneByOne Draw features one-by-one for the hit-detecion.
* @param {module:ol/extent~Extent=} opt_hitExtent Hit extent: Only features intersecting
* this extent are checked.
@@ -224,9 +220,8 @@ WebGLReplay.prototype.drawHitDetectionReplay = function(gl, context, skippedFeat
* @protected
* @param {WebGLRenderingContext} gl gl.
* @param {module:ol/webgl/Context~WebGLContext} context Context.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features
* to skip.
* @param {function((module:ol/Feature~Feature|ol.render.Feature)): T|undefined} featureCallback Feature callback.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features to skip.
* @param {function((module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature)): T|undefined} featureCallback Feature callback.
* @return {T|undefined} Callback result.
* @template T
*/
@@ -252,9 +247,8 @@ WebGLReplay.prototype.drawHitDetectionReplayAll = function(gl, context, skippedF
* @param {module:ol/size~Size} size Size.
* @param {number} pixelRatio Pixel ratio.
* @param {number} opacity Global opacity.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features
* to skip.
* @param {function((module:ol/Feature~Feature|ol.render.Feature)): T|undefined} featureCallback Feature callback.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features to skip.
* @param {function((module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature)): T|undefined} featureCallback Feature callback.
* @param {boolean} oneByOne Draw features one-by-one for the hit-detecion.
* @param {module:ol/extent~Extent=} opt_hitExtent Hit extent: Only features intersecting
* this extent are checked.

View File

@@ -158,8 +158,7 @@ WebGLReplayGroup.prototype.isEmpty = function() {
* @param {module:ol/size~Size} size Size.
* @param {number} pixelRatio Pixel ratio.
* @param {number} opacity Global opacity.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features
* to skip.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features to skip.
*/
WebGLReplayGroup.prototype.replay = function(context,
center, resolution, rotation, size, pixelRatio,
@@ -193,9 +192,8 @@ WebGLReplayGroup.prototype.replay = function(context,
* @param {module:ol/size~Size} size Size.
* @param {number} pixelRatio Pixel ratio.
* @param {number} opacity Global opacity.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features
* to skip.
* @param {function((module:ol/Feature~Feature|ol.render.Feature)): T|undefined} featureCallback Feature callback.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features to skip.
* @param {function((module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature)): T|undefined} featureCallback Feature callback.
* @param {boolean} oneByOne Draw features one-by-one for the hit-detecion.
* @param {module:ol/extent~Extent=} opt_hitExtent Hit extent: Only features intersecting
* this extent are checked.
@@ -239,9 +237,8 @@ WebGLReplayGroup.prototype.replayHitDetection_ = function(context,
* @param {module:ol/size~Size} size Size.
* @param {number} pixelRatio Pixel ratio.
* @param {number} opacity Global opacity.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features
* to skip.
* @param {function((module:ol/Feature~Feature|ol.render.Feature)): T|undefined} callback Feature callback.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features to skip.
* @param {function((module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature)): T|undefined} callback Feature callback.
* @return {T|undefined} Callback result.
* @template T
*/
@@ -268,7 +265,7 @@ WebGLReplayGroup.prototype.forEachFeatureAtCoordinate = function(
coordinate, resolution, rotation, HIT_DETECTION_SIZE,
pixelRatio, opacity, skippedFeaturesHash,
/**
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
* @return {?} Callback result.
*/
function(feature) {
@@ -294,8 +291,7 @@ WebGLReplayGroup.prototype.forEachFeatureAtCoordinate = function(
* @param {module:ol/size~Size} size Size.
* @param {number} pixelRatio Pixel ratio.
* @param {number} opacity Global opacity.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features
* to skip.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features to skip.
* @return {boolean} Is there a feature at the given coordinate?
*/
WebGLReplayGroup.prototype.hasFeatureAtCoordinate = function(
@@ -309,7 +305,7 @@ WebGLReplayGroup.prototype.hasFeatureAtCoordinate = function(
coordinate, resolution, rotation, HIT_DETECTION_SIZE,
pixelRatio, opacity, skippedFeaturesHash,
/**
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
* @return {boolean} Is there a feature?
*/
function(feature) {

View File

@@ -36,7 +36,7 @@ inherits(LayerRenderer, Observable);
* @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
* @param {module:ol/PluggableMap~FrameState} frameState Frame state.
* @param {number} hitTolerance Hit tolerance in pixels.
* @param {function(this: S, (module:ol/Feature~Feature|ol.render.Feature), module:ol/layer/Layer~Layer): T}
* @param {function(this: S, (module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature), module:ol/layer/Layer~Layer): T}
* callback Feature callback.
* @param {S} thisArg Value to use as `this` when executing `callback`.
* @return {T|undefined} Callback result.

View File

@@ -111,7 +111,7 @@ function expireIconCache(map, frameState) {
* @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
* @param {module:ol/PluggableMap~FrameState} frameState FrameState.
* @param {number} hitTolerance Hit tolerance in pixels.
* @param {function(this: S, (module:ol/Feature~Feature|ol.render.Feature),
* @param {function(this: S, (module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature),
* module:ol/layer/Layer~Layer): T} callback Feature callback.
* @param {S} thisArg Value to use as `this` when executing `callback`.
* @param {function(this: U, module:ol/layer/Layer~Layer): boolean} layerFilter Layer filter
@@ -129,7 +129,7 @@ MapRenderer.prototype.forEachFeatureAtCoordinate = function(coordinate, frameSta
const viewResolution = viewState.resolution;
/**
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
* @param {module:ol/layer/Layer~Layer} layer Layer.
* @return {?} Callback result.
*/

View File

@@ -107,7 +107,7 @@ IntermediateCanvasRenderer.prototype.forEachFeatureAtCoordinate = function(coord
return source.forEachFeatureAtCoordinate(
coordinate, resolution, rotation, hitTolerance, skippedFeatureUids,
/**
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
* @return {?} Callback result.
*/
function(feature) {

View File

@@ -255,7 +255,7 @@ CanvasVectorLayerRenderer.prototype.forEachFeatureAtCoordinate = function(coordi
const features = {};
const result = this.replayGroup_.forEachFeatureAtCoordinate(coordinate, resolution, rotation, hitTolerance, {},
/**
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
* @return {?} Callback result.
*/
function(feature) {

View File

@@ -195,7 +195,7 @@ CanvasVectorTileLayerRenderer.prototype.createReplayGroup_ = function(tile, fram
const squaredTolerance = getSquaredRenderTolerance(resolution, pixelRatio);
/**
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
* @this {ol.renderer.canvas.VectorTileLayer}
*/
const render = function(feature) {
@@ -290,7 +290,7 @@ CanvasVectorTileLayerRenderer.prototype.forEachFeatureAtCoordinate = function(co
replayGroup = sourceTile.getReplayGroup(layer, tile.tileCoord.toString());
found = found || replayGroup.forEachFeatureAtCoordinate(coordinate, resolution, rotation, hitTolerance, {},
/**
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
* @return {?} Callback result.
*/
function(feature) {
@@ -444,10 +444,9 @@ CanvasVectorTileLayerRenderer.prototype.postCompose = function(context, frameSta
/**
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
* @param {number} squaredTolerance Squared tolerance.
* @param {(module:ol/style/Style~Style|Array.<module:ol/style/Style~Style>)} styles The style or array of
* styles.
* @param {(module:ol/style/Style~Style|Array.<module:ol/style/Style~Style>)} styles The style or array of styles.
* @param {ol.render.canvas.ReplayGroup} replayGroup Replay group.
* @return {boolean} `true` if an image is loading.
*/

View File

@@ -33,8 +33,8 @@ const GEOMETRY_RENDERERS = {
/**
* @param {module:ol/Feature~Feature|ol.render.Feature} feature1 Feature 1.
* @param {module:ol/Feature~Feature|ol.render.Feature} feature2 Feature 2.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature1 Feature 1.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature2 Feature 2.
* @return {number} Order.
*/
export function defaultOrder(feature1, feature2) {
@@ -88,7 +88,7 @@ function renderCircleGeometry(replayGroup, geometry, style, feature) {
/**
* @param {ol.render.ReplayGroup} replayGroup Replay group.
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
* @param {module:ol/style/Style~Style} style Style.
* @param {number} squaredTolerance Squared tolerance.
* @param {function(this: T, module:ol/events/Event~Event)} listener Listener function.
@@ -120,7 +120,7 @@ export function renderFeature(replayGroup, feature, style, squaredTolerance, lis
/**
* @param {ol.render.ReplayGroup} replayGroup Replay group.
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
* @param {module:ol/style/Style~Style} style Style.
* @param {number} squaredTolerance Squared tolerance.
*/
@@ -144,7 +144,7 @@ function renderFeatureInternal(replayGroup, feature, style, squaredTolerance) {
* @param {ol.render.ReplayGroup} replayGroup Replay group.
* @param {module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {module:ol/style/Style~Style} style Style.
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
*/
function renderGeometry(replayGroup, geometry, style, feature) {
if (geometry.getType() == GeometryType.GEOMETRY_COLLECTION) {
@@ -178,9 +178,9 @@ function renderGeometryCollectionGeometry(replayGroup, geometry, style, feature)
/**
* @param {ol.render.ReplayGroup} replayGroup Replay group.
* @param {module:ol/geom/LineString~LineString|ol.render.Feature} geometry Geometry.
* @param {module:ol/geom/LineString~LineString|module:ol/render/Feature~RenderFeature} geometry Geometry.
* @param {module:ol/style/Style~Style} style Style.
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
*/
function renderLineStringGeometry(replayGroup, geometry, style, feature) {
const strokeStyle = style.getStroke();
@@ -200,9 +200,9 @@ function renderLineStringGeometry(replayGroup, geometry, style, feature) {
/**
* @param {ol.render.ReplayGroup} replayGroup Replay group.
* @param {module:ol/geom/MultiLineString~MultiLineString|ol.render.Feature} geometry Geometry.
* @param {module:ol/geom/MultiLineString~MultiLineString|module:ol/render/Feature~RenderFeature} geometry Geometry.
* @param {module:ol/style/Style~Style} style Style.
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
*/
function renderMultiLineStringGeometry(replayGroup, geometry, style, feature) {
const strokeStyle = style.getStroke();
@@ -245,9 +245,9 @@ function renderMultiPolygonGeometry(replayGroup, geometry, style, feature) {
/**
* @param {ol.render.ReplayGroup} replayGroup Replay group.
* @param {module:ol/geom/Point~Point|ol.render.Feature} geometry Geometry.
* @param {module:ol/geom/Point~Point|module:ol/render/Feature~RenderFeature} geometry Geometry.
* @param {module:ol/style/Style~Style} style Style.
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
*/
function renderPointGeometry(replayGroup, geometry, style, feature) {
const imageStyle = style.getImage();
@@ -270,9 +270,9 @@ function renderPointGeometry(replayGroup, geometry, style, feature) {
/**
* @param {ol.render.ReplayGroup} replayGroup Replay group.
* @param {module:ol/geom/MultiPoint~MultiPoint|ol.render.Feature} geometry Geometry.
* @param {module:ol/geom/MultiPoint~MultiPoint|module:ol/render/Feature~RenderFeature} geometry Geometry.
* @param {module:ol/style/Style~Style} style Style.
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
*/
function renderMultiPointGeometry(replayGroup, geometry, style, feature) {
const imageStyle = style.getImage();
@@ -295,9 +295,9 @@ function renderMultiPointGeometry(replayGroup, geometry, style, feature) {
/**
* @param {ol.render.ReplayGroup} replayGroup Replay group.
* @param {module:ol/geom/Polygon~Polygon|ol.render.Feature} geometry Geometry.
* @param {module:ol/geom/Polygon~Polygon|module:ol/render/Feature~RenderFeature} geometry Geometry.
* @param {module:ol/style/Style~Style} style Style.
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
*/
function renderPolygonGeometry(replayGroup, geometry, style, feature) {
const fillStyle = style.getFill();

View File

@@ -113,7 +113,7 @@ WebGLImageLayerRenderer.prototype.forEachFeatureAtCoordinate = function(coordina
coordinate, resolution, rotation, hitTolerance, skippedFeatureUids,
/**
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
* @return {?} Callback result.
*/
function(feature) {

View File

@@ -148,7 +148,7 @@ WebGLVectorLayerRenderer.prototype.forEachFeatureAtCoordinate = function(coordin
frameState.size, frameState.pixelRatio, layerState.opacity,
{},
/**
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
* @return {?} Callback result.
*/
function(feature) {

View File

@@ -114,8 +114,7 @@ Source.prototype.adaptAttributions_ = function(attributionLike) {
* @param {number} rotation Rotation.
* @param {number} hitTolerance Hit tolerance in pixels.
* @param {Object.<string, boolean>} skippedFeatureUids Skipped feature uids.
* @param {function((module:ol/Feature~Feature|ol.render.Feature)): T} callback Feature
* callback.
* @param {function((module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature)): T} callback Feature callback.
* @return {T|undefined} Callback result.
* @template T
*/

View File

@@ -11,8 +11,8 @@ import Stroke from '../style/Stroke.js';
* A function that takes an {@link module:ol/Feature~Feature} as argument and returns an
* {@link module:ol/geom/Geometry~Geometry} that will be rendered and styled for the feature.
*
* @typedef {function((module:ol/Feature~Feature|ol.render.Feature)):
* (module:ol/geom/Geometry~Geometry|ol.render.Feature|undefined)} GeometryFunction
* @typedef {function((module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature)):
* (module:ol/geom/Geometry~Geometry|module:ol/render/Feature~RenderFeature|undefined)} GeometryFunction
*/
@@ -344,7 +344,7 @@ let defaultStyles = null;
/**
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
* @param {number} resolution Resolution.
* @return {Array.<module:ol/style/Style~Style>} Style.
*/
@@ -451,9 +451,8 @@ export function createEditingStyle() {
/**
* Function that is called with a feature and returns its default geometry.
* @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature to get the geometry
* for.
* @return {module:ol/geom/Geometry~Geometry|ol.render.Feature|undefined} Geometry to render.
* @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature to get the geometry for.
* @return {module:ol/geom/Geometry~Geometry|module:ol/render/Feature~RenderFeature|undefined} Geometry to render.
*/
function defaultGeometryFunction(feature) {
return feature.getGeometry();