Fix jsdoc references
This commit is contained in:
@@ -28,8 +28,8 @@ import {getUid} from '../util.js';
|
||||
* overlapping icons. As a tradoff, the cluster feature's position will no longer be
|
||||
* the center of all its features.
|
||||
* @property {function(Feature):Point} [geometryFunction]
|
||||
* Function that takes an {@link module:ol/Feature} as argument and returns an
|
||||
* {@link module:ol/geom/Point} as cluster calculation point for the feature. When a
|
||||
* Function that takes an {@link module:ol/Feature~Feature} as argument and returns an
|
||||
* {@link module:ol/geom/Point~Point} as cluster calculation point for the feature. When a
|
||||
* feature should not be considered for clustering, the function should return
|
||||
* `null`. The default, which works when the underlying source contains point
|
||||
* features only, is
|
||||
@@ -41,9 +41,9 @@ import {getUid} from '../util.js';
|
||||
* See {@link module:ol/geom/Polygon~Polygon#getInteriorPoint} for a way to get a cluster
|
||||
* calculation point for polygons.
|
||||
* @property {function(Point, Array<Feature>):Feature} [createCluster]
|
||||
* Function that takes the cluster's center {@link module:ol/geom/Point} and an array
|
||||
* of {@link module:ol/Feature} included in this cluster. Must return a
|
||||
* {@link module:ol/Feature} that will be used to render. Default implementation is:
|
||||
* Function that takes the cluster's center {@link module:ol/geom/Point~Point} and an array
|
||||
* of {@link module:ol/Feature~Feature} included in this cluster. Must return a
|
||||
* {@link module:ol/Feature~Feature} that will be used to render. Default implementation is:
|
||||
* ```js
|
||||
* function(point, features) {
|
||||
* return new Feature({
|
||||
@@ -143,7 +143,7 @@ class Cluster extends VectorSource {
|
||||
|
||||
/**
|
||||
* Remove all features from the source.
|
||||
* @param {boolean} [opt_fast] Skip dispatching of {@link module:ol/source/Vector.VectorSourceEvent#removefeature} events.
|
||||
* @param {boolean} [opt_fast] Skip dispatching of {@link module:ol/source/VectorEventType~VectorEventType#removefeature} events.
|
||||
* @api
|
||||
*/
|
||||
clear(opt_fast) {
|
||||
|
||||
@@ -29,9 +29,9 @@ import {
|
||||
* @property {import("./Source.js").AttributionLike} [attributions] Attributions.
|
||||
* @property {FunctionType} [canvasFunction] Canvas function.
|
||||
* The function returning the canvas element used by the source
|
||||
* as an image. The arguments passed to the function are: `{import("../extent.js").Extent}` the
|
||||
* as an image. The arguments passed to the function are: {@link import("../extent.js").Extent} the
|
||||
* image extent, `{number}` the image resolution, `{number}` the pixel ratio of the map,
|
||||
* `{import("../size.js").Size}` the image size, and `{import("../proj/Projection.js").Projection}` the image
|
||||
* {@link import("../size.js").Size} the image size, and {@link import("../proj/Projection.js").default} the image
|
||||
* projection. The canvas returned by this function is cached by the source. If
|
||||
* the value returned by the function is later changed then
|
||||
* `changed` should be called on the source for the source to
|
||||
|
||||
@@ -327,7 +327,7 @@ class VectorSource extends Source {
|
||||
* instead. A feature will not be added to the source if feature with
|
||||
* the same id is already there. The reason for this behavior is to avoid
|
||||
* feature duplication when using bbox or tile loading strategies.
|
||||
* Note: this also applies if an {@link module:ol/Collection} is used for features,
|
||||
* Note: this also applies if an {@link module:ol/Collection~Collection} is used for features,
|
||||
* meaning that if a feature with a duplicate id is added in the collection, it will
|
||||
* be removed from it right away.
|
||||
* @param {import("../Feature.js").default<Geometry>} feature Feature to add.
|
||||
@@ -684,7 +684,7 @@ class VectorSource extends Source {
|
||||
/**
|
||||
* Get the features collection associated with this source. Will be `null`
|
||||
* unless the source was configured with `useSpatialIndex` set to `false`, or
|
||||
* with an {@link module:ol/Collection} as `features`.
|
||||
* with an {@link module:ol/Collection~Collection} as `features`.
|
||||
* @return {Collection<import("../Feature.js").default<Geometry>>|null} The collection of features.
|
||||
* @api
|
||||
*/
|
||||
|
||||
@@ -91,11 +91,11 @@ import {toSize} from '../size.js';
|
||||
/**
|
||||
* @classdesc
|
||||
* Class for layer sources providing vector data divided into a tile grid, to be
|
||||
* used with {@link module:ol/layer/VectorTile~VectorTile}. Although this source receives tiles
|
||||
* used with {@link module:ol/layer/VectorTile~VectorTileLayer}. Although this source receives tiles
|
||||
* with vector features from the server, it is not meant for feature editing.
|
||||
* Features are optimized for rendering, their geometries are clipped at or near
|
||||
* tile boundaries and simplified for a view resolution. See
|
||||
* {@link module:ol/source/Vector} for vector sources that are suitable for feature
|
||||
* {@link module:ol/source/Vector~VectorSource} for vector sources that are suitable for feature
|
||||
* editing.
|
||||
*
|
||||
* @fires import("./Tile.js").TileSourceEvent
|
||||
|
||||
Reference in New Issue
Block a user