Fix jsdoc references
This commit is contained in:
@@ -9,9 +9,9 @@ import {getHeight} from './extent.js';
|
|||||||
import {listenOnce, unlistenByKey} from './events.js';
|
import {listenOnce, unlistenByKey} from './events.js';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A function that takes an {@link module:ol/Image~Image} for the image and a
|
* A function that takes an {@link module:ol/Image~ImageWrapper} for the image and a
|
||||||
* `{string}` for the src as arguments. It is supposed to make it so the
|
* `{string}` for the src as arguments. It is supposed to make it so the
|
||||||
* underlying image {@link module:ol/Image~Image#getImage} is assigned the
|
* underlying image {@link module:ol/Image~ImageWrapper#getImage} is assigned the
|
||||||
* content specified by the src. If not specified, the default is
|
* content specified by the src. If not specified, the default is
|
||||||
*
|
*
|
||||||
* function(image, src) {
|
* function(image, src) {
|
||||||
|
|||||||
@@ -30,7 +30,7 @@ import {defaults as defaultInteractions} from './interaction.js';
|
|||||||
* target: 'map'
|
* target: 'map'
|
||||||
* });
|
* });
|
||||||
*
|
*
|
||||||
* The above snippet creates a map using a {@link module:ol/layer/Tile} to
|
* The above snippet creates a map using a {@link module:ol/layer/Tile~TileLayer} to
|
||||||
* display {@link module:ol/source/OSM~OSM} OSM data and render it to a DOM
|
* display {@link module:ol/source/OSM~OSM} OSM data and render it to a DOM
|
||||||
* element with the id `map`.
|
* element with the id `map`.
|
||||||
*
|
*
|
||||||
@@ -47,8 +47,8 @@ import {defaults as defaultInteractions} from './interaction.js';
|
|||||||
* accessed by `getLayerGroup` and `setLayerGroup`. Layers entered in the
|
* accessed by `getLayerGroup` and `setLayerGroup`. Layers entered in the
|
||||||
* options are added to this group, and `addLayer` and `removeLayer` change the
|
* options are added to this group, and `addLayer` and `removeLayer` change the
|
||||||
* layer collection in the group. `getLayers` is a convenience function for
|
* layer collection in the group. `getLayers` is a convenience function for
|
||||||
* `getLayerGroup().getLayers()`. Note that {@link module:ol/layer/Group~Group}
|
* `getLayerGroup().getLayers()`. Note that {@link module:ol/layer/Group~LayerGroup}
|
||||||
* is a subclass of {@link module:ol/layer/Base}, so layers entered in the
|
* is a subclass of {@link module:ol/layer/Base~BaseLayer}, so layers entered in the
|
||||||
* options or added with `addLayer` can be groups, which can contain further
|
* options or added with `addLayer` can be groups, which can contain further
|
||||||
* groups, and so on.
|
* groups, and so on.
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -4,7 +4,7 @@
|
|||||||
import {clear} from './obj.js';
|
import {clear} from './obj.js';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Key to use with {@link module:ol/Observable~Observable#unByKey}.
|
* Key to use with {@link module:ol/Observable.unByKey}.
|
||||||
* @typedef {Object} EventsKey
|
* @typedef {Object} EventsKey
|
||||||
* @property {ListenerFunction} listener Listener.
|
* @property {ListenerFunction} listener Listener.
|
||||||
* @property {import("./events/Target.js").EventTargetLike} target Target.
|
* @property {import("./events/Target.js").EventTargetLike} target Target.
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import {MAC, WEBKIT} from '../has.js';
|
|||||||
import {assert} from '../asserts.js';
|
import {assert} from '../asserts.js';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A function that takes an {@link module:ol/MapBrowserEvent} and returns a
|
* A function that takes an {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a
|
||||||
* `{boolean}`. If the condition is met, true should be returned.
|
* `{boolean}`. If the condition is met, true should be returned.
|
||||||
*
|
*
|
||||||
* @typedef {function(this: ?, import("../MapBrowserEvent.js").default): boolean} Condition
|
* @typedef {function(this: ?, import("../MapBrowserEvent.js").default): boolean} Condition
|
||||||
|
|||||||
@@ -17,11 +17,11 @@ let withCredentials = false;
|
|||||||
*
|
*
|
||||||
* This function takes up to 5 arguments. These are an {@link module:ol/extent~Extent} representing
|
* This function takes up to 5 arguments. These are an {@link module:ol/extent~Extent} representing
|
||||||
* the area to be loaded, a `{number}` representing the resolution (map units per pixel), an
|
* the area to be loaded, a `{number}` representing the resolution (map units per pixel), an
|
||||||
* {@link module:ol/proj/Projection} for the projection, an optional success callback that should get
|
* {@link module:ol/proj/Projection~Projection} for the projection, an optional success callback that should get
|
||||||
* the loaded features passed as an argument and an optional failure callback with no arguments. If
|
* the loaded features passed as an argument and an optional failure callback with no arguments. If
|
||||||
* the callbacks are not used, the corresponding vector source will not fire `'featuresloadend'` and
|
* the callbacks are not used, the corresponding vector source will not fire `'featuresloadend'` and
|
||||||
* `'featuresloaderror'` events. `this` within the function is bound to the
|
* `'featuresloaderror'` events. `this` within the function is bound to the
|
||||||
* {@link module:ol/source/Vector} it's called from.
|
* {@link module:ol/source/Vector~VectorSource} it's called from.
|
||||||
*
|
*
|
||||||
* The function is responsible for loading the features and adding them to the
|
* The function is responsible for loading the features and adding them to the
|
||||||
* source.
|
* source.
|
||||||
@@ -40,7 +40,7 @@ let withCredentials = false;
|
|||||||
*
|
*
|
||||||
* This function takes an {@link module:ol/extent~Extent} representing the area
|
* This function takes an {@link module:ol/extent~Extent} representing the area
|
||||||
* to be loaded, a `{number}` representing the resolution (map units per pixel)
|
* to be loaded, a `{number}` representing the resolution (map units per pixel)
|
||||||
* and an {@link module:ol/proj/Projection} for the projection as
|
* and an {@link module:ol/proj/Projection~Projection} for the projection as
|
||||||
* arguments and returns a `{string}` representing the URL.
|
* arguments and returns a `{string}` representing the URL.
|
||||||
* @typedef {function(import("./extent.js").Extent, number, import("./proj/Projection.js").default): string} FeatureUrlFunction
|
* @typedef {function(import("./extent.js").Extent, number, import("./proj/Projection.js").default): string} FeatureUrlFunction
|
||||||
* @api
|
* @api
|
||||||
|
|||||||
@@ -148,9 +148,9 @@ const TRANSACTION_SERIALIZERS = {
|
|||||||
* @property {import("../extent.js").Extent} [bbox] Extent to use for the BBOX filter. The `geometryName`
|
* @property {import("../extent.js").Extent} [bbox] Extent to use for the BBOX filter. The `geometryName`
|
||||||
* option must be set.
|
* option must be set.
|
||||||
* @property {import("./filter/Filter.js").default} [filter] Filter condition. See
|
* @property {import("./filter/Filter.js").default} [filter] Filter condition. See
|
||||||
* {@link module:ol/format/Filter} for more information.
|
* {@link module:ol/format/filter} for more information.
|
||||||
* @property {string} [resultType] Indicates what response should be returned,
|
* @property {string} [resultType] Indicates what response should be returned,
|
||||||
* E.g. `hits` only includes the `numberOfFeatures` attribute in the response and no features.
|
* e.g. `hits` only includes the `numberOfFeatures` attribute in the response and no features.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ import RenderBox from '../render/Box.js';
|
|||||||
import {mouseActionButton} from '../events/condition.js';
|
import {mouseActionButton} from '../events/condition.js';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A function that takes a {@link module:ol/MapBrowserEvent} and two
|
* A function that takes a {@link module:ol/MapBrowserEvent~MapBrowserEvent} and two
|
||||||
* {@link module:ol/pixel~Pixel}s and returns a `{boolean}`. If the condition is met,
|
* {@link module:ol/pixel~Pixel}s and returns a `{boolean}`. If the condition is met,
|
||||||
* true should be returned.
|
* true should be returned.
|
||||||
* @typedef {function(this: ?, import("../MapBrowserEvent.js").default, import("../pixel.js").Pixel, import("../pixel.js").Pixel):boolean} EndCondition
|
* @typedef {function(this: ?, import("../MapBrowserEvent.js").default, import("../pixel.js").Pixel, import("../pixel.js").Pixel):boolean} EndCondition
|
||||||
|
|||||||
@@ -1165,7 +1165,7 @@ function getDefaultStyleFunction() {
|
|||||||
/**
|
/**
|
||||||
* Create a `geometryFunction` for `type: 'Circle'` that will create a regular
|
* Create a `geometryFunction` for `type: 'Circle'` that will create a regular
|
||||||
* polygon with a user specified number of sides and start angle instead of a
|
* polygon with a user specified number of sides and start angle instead of a
|
||||||
* `import("../geom/Circle.js").Circle` geometry.
|
* {@link import("../geom/Circle.js").Circle} geometry.
|
||||||
* @param {number} [opt_sides] Number of sides of the regular polygon.
|
* @param {number} [opt_sides] Number of sides of the regular polygon.
|
||||||
* Default is 32.
|
* Default is 32.
|
||||||
* @param {number} [opt_angle] Angle of the first point in counter-clockwise
|
* @param {number} [opt_angle] Angle of the first point in counter-clockwise
|
||||||
|
|||||||
@@ -121,7 +121,7 @@ class PointerInteraction extends Interaction {
|
|||||||
handleDragEvent(mapBrowserEvent) {}
|
handleDragEvent(mapBrowserEvent) {}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Handles the {@link module:ol/MapBrowserEvent map browser event} and may call into
|
* Handles the {@link module:ol/MapBrowserEvent~MapBrowserEvent map browser event} and may call into
|
||||||
* other functions, if event sequences like e.g. 'drag' or 'down-up' etc. are
|
* other functions, if event sequences like e.g. 'drag' or 'down-up' etc. are
|
||||||
* detected.
|
* detected.
|
||||||
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Map browser event.
|
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Map browser event.
|
||||||
|
|||||||
@@ -27,9 +27,9 @@ const SelectEventType = {
|
|||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A function that takes an {@link module:ol/Feature} or
|
* A function that takes an {@link module:ol/Feature~Feature} or
|
||||||
* {@link module:ol/render/Feature} and an
|
* {@link module:ol/render/Feature~RenderFeature} and an
|
||||||
* {@link module:ol/layer/Layer} and returns `true` if the feature may be
|
* {@link module:ol/layer/Layer~Layer} and returns `true` if the feature may be
|
||||||
* selected or `false` otherwise.
|
* selected or `false` otherwise.
|
||||||
* @typedef {function(import("../Feature.js").FeatureLike, import("../layer/Layer.js").default<import("../source/Source").default>):boolean} FilterFunction
|
* @typedef {function(import("../Feature.js").FeatureLike, import("../layer/Layer.js").default<import("../source/Source").default>):boolean} FilterFunction
|
||||||
*/
|
*/
|
||||||
@@ -83,8 +83,8 @@ const SelectEventType = {
|
|||||||
* used by the interaction is returned by
|
* used by the interaction is returned by
|
||||||
* {@link module:ol/interaction/Select~Select#getFeatures}.
|
* {@link module:ol/interaction/Select~Select#getFeatures}.
|
||||||
* @property {FilterFunction} [filter] A function
|
* @property {FilterFunction} [filter] A function
|
||||||
* that takes an {@link module:ol/Feature} and an
|
* that takes an {@link module:ol/Feature~Feature} and an
|
||||||
* {@link module:ol/layer/Layer} and returns `true` if the feature may be
|
* {@link module:ol/layer/Layer~Layer} and returns `true` if the feature may be
|
||||||
* selected or `false` otherwise.
|
* selected or `false` otherwise.
|
||||||
* @property {number} [hitTolerance=0] Hit-detection tolerance. Pixels inside
|
* @property {number} [hitTolerance=0] Hit-detection tolerance. Pixels inside
|
||||||
* the radius around the given position will be checked for features.
|
* the radius around the given position will be checked for features.
|
||||||
@@ -309,7 +309,7 @@ class Select extends Interaction {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the associated {@link module:ol/layer/Vector~Vector vector layer} of
|
* Returns the associated {@link module:ol/layer/Vector~VectorLayer vector layer} of
|
||||||
* a selected feature.
|
* a selected feature.
|
||||||
* @param {import("../Feature.js").FeatureLike} feature Feature
|
* @param {import("../Feature.js").FeatureLike} feature Feature
|
||||||
* @return {import('../layer/Vector.js').default} Layer.
|
* @return {import('../layer/Vector.js').default} Layer.
|
||||||
|
|||||||
@@ -34,9 +34,9 @@ const TranslateEventType = {
|
|||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A function that takes an {@link module:ol/Feature} or
|
* A function that takes an {@link module:ol/Feature~Feature} or
|
||||||
* {@link module:ol/render/Feature} and an
|
* {@link module:ol/render/Feature~RenderFeature} and an
|
||||||
* {@link module:ol/layer/Layer} and returns `true` if the feature may be
|
* {@link module:ol/layer/Layer~Layer} and returns `true` if the feature may be
|
||||||
* translated or `false` otherwise.
|
* translated or `false` otherwise.
|
||||||
* @typedef {function(import("../Feature.js").FeatureLike, import("../layer/Layer.js").default<import("../source/Source").default>):boolean} FilterFunction
|
* @typedef {function(import("../Feature.js").FeatureLike, import("../layer/Layer.js").default<import("../source/Source").default>):boolean} FilterFunction
|
||||||
*/
|
*/
|
||||||
@@ -55,8 +55,8 @@ const TranslateEventType = {
|
|||||||
* absent, all visible layers will be considered translatable.
|
* absent, all visible layers will be considered translatable.
|
||||||
* Not used if `features` is provided.
|
* Not used if `features` is provided.
|
||||||
* @property {FilterFunction} [filter] A function
|
* @property {FilterFunction} [filter] A function
|
||||||
* that takes an {@link module:ol/Feature} and an
|
* that takes an {@link module:ol/Feature~Feature} and an
|
||||||
* {@link module:ol/layer/Layer} and returns `true` if the feature may be
|
* {@link module:ol/layer/Layer~Layer} and returns `true` if the feature may be
|
||||||
* translated or `false` otherwise. Not used if `features` is provided.
|
* translated or `false` otherwise. Not used if `features` is provided.
|
||||||
* @property {number} [hitTolerance=0] Hit-detection tolerance. Pixels inside the radius around the given position
|
* @property {number} [hitTolerance=0] Hit-detection tolerance. Pixels inside the radius around the given position
|
||||||
* will be checked for features.
|
* will be checked for features.
|
||||||
|
|||||||
@@ -73,7 +73,7 @@ import {assign} from '../obj.js';
|
|||||||
* @property {import("../PluggableMap.js").default} [map] Sets the layer as overlay on a map. The map will not manage
|
* @property {import("../PluggableMap.js").default} [map] Sets the layer as overlay on a map. The map will not manage
|
||||||
* this layer in its layers collection, and the layer will be rendered on top. This is useful for
|
* this layer in its layers collection, and the layer will be rendered on top. This is useful for
|
||||||
* temporary layers. The standard way to add a layer to a map and have it managed by the map is to
|
* temporary layers. The standard way to add a layer to a map and have it managed by the map is to
|
||||||
* use {@link module:ol/Map#addLayer}.
|
* use {@link module:ol/Map~Map#addLayer}.
|
||||||
* @property {boolean} [useInterimTilesOnError=true] Use interim tiles on error.
|
* @property {boolean} [useInterimTilesOnError=true] Use interim tiles on error.
|
||||||
* @property {number} [cacheSize=512] The internal texture cache size. This needs to be large enough to render
|
* @property {number} [cacheSize=512] The internal texture cache size. This needs to be large enough to render
|
||||||
* two zoom levels worth of tiles.
|
* two zoom levels worth of tiles.
|
||||||
|
|||||||
@@ -25,8 +25,8 @@ import {getTransformFromProjections, getUserProjection} from './proj.js';
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* A function to be used when sorting features before rendering.
|
* A function to be used when sorting features before rendering.
|
||||||
* It takes two instances of {@link module:ol/Feature} or
|
* It takes two instances of {@link module:ol/Feature~Feature} or
|
||||||
* {@link module:ol/render/Feature} and returns a `{number}`.
|
* {@link module:ol/render/Feature~RenderFeature} and returns a `{number}`.
|
||||||
*
|
*
|
||||||
* @typedef {function(import("./Feature.js").FeatureLike, import("./Feature.js").FeatureLike):number} OrderFunction
|
* @typedef {function(import("./Feature.js").FeatureLike, import("./Feature.js").FeatureLike):number} OrderFunction
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -28,8 +28,8 @@ import {getUid} from '../util.js';
|
|||||||
* overlapping icons. As a tradoff, the cluster feature's position will no longer be
|
* overlapping icons. As a tradoff, the cluster feature's position will no longer be
|
||||||
* the center of all its features.
|
* the center of all its features.
|
||||||
* @property {function(Feature):Point} [geometryFunction]
|
* @property {function(Feature):Point} [geometryFunction]
|
||||||
* Function that takes an {@link module:ol/Feature} as argument and returns an
|
* Function that takes an {@link module:ol/Feature~Feature} as argument and returns an
|
||||||
* {@link module:ol/geom/Point} as cluster calculation point for the feature. When a
|
* {@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
|
* feature should not be considered for clustering, the function should return
|
||||||
* `null`. The default, which works when the underlying source contains point
|
* `null`. The default, which works when the underlying source contains point
|
||||||
* features only, is
|
* 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
|
* See {@link module:ol/geom/Polygon~Polygon#getInteriorPoint} for a way to get a cluster
|
||||||
* calculation point for polygons.
|
* calculation point for polygons.
|
||||||
* @property {function(Point, Array<Feature>):Feature} [createCluster]
|
* @property {function(Point, Array<Feature>):Feature} [createCluster]
|
||||||
* Function that takes the cluster's center {@link module:ol/geom/Point} and an array
|
* Function that takes the cluster's center {@link module:ol/geom/Point~Point} and an array
|
||||||
* of {@link module:ol/Feature} included in this cluster. Must return a
|
* of {@link module:ol/Feature~Feature} included in this cluster. Must return a
|
||||||
* {@link module:ol/Feature} that will be used to render. Default implementation is:
|
* {@link module:ol/Feature~Feature} that will be used to render. Default implementation is:
|
||||||
* ```js
|
* ```js
|
||||||
* function(point, features) {
|
* function(point, features) {
|
||||||
* return new Feature({
|
* return new Feature({
|
||||||
@@ -143,7 +143,7 @@ class Cluster extends VectorSource {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Remove all features from the source.
|
* 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
|
* @api
|
||||||
*/
|
*/
|
||||||
clear(opt_fast) {
|
clear(opt_fast) {
|
||||||
|
|||||||
@@ -29,9 +29,9 @@ import {
|
|||||||
* @property {import("./Source.js").AttributionLike} [attributions] Attributions.
|
* @property {import("./Source.js").AttributionLike} [attributions] Attributions.
|
||||||
* @property {FunctionType} [canvasFunction] Canvas function.
|
* @property {FunctionType} [canvasFunction] Canvas function.
|
||||||
* The function returning the canvas element used by the source
|
* 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,
|
* 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
|
* projection. The canvas returned by this function is cached by the source. If
|
||||||
* the value returned by the function is later changed then
|
* the value returned by the function is later changed then
|
||||||
* `changed` should be called on the source for the source to
|
* `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
|
* 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
|
* the same id is already there. The reason for this behavior is to avoid
|
||||||
* feature duplication when using bbox or tile loading strategies.
|
* 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
|
* meaning that if a feature with a duplicate id is added in the collection, it will
|
||||||
* be removed from it right away.
|
* be removed from it right away.
|
||||||
* @param {import("../Feature.js").default<Geometry>} feature Feature to add.
|
* @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`
|
* Get the features collection associated with this source. Will be `null`
|
||||||
* unless the source was configured with `useSpatialIndex` set to `false`, or
|
* 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.
|
* @return {Collection<import("../Feature.js").default<Geometry>>|null} The collection of features.
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -91,11 +91,11 @@ import {toSize} from '../size.js';
|
|||||||
/**
|
/**
|
||||||
* @classdesc
|
* @classdesc
|
||||||
* Class for layer sources providing vector data divided into a tile grid, to be
|
* 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.
|
* 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
|
* Features are optimized for rendering, their geometries are clipped at or near
|
||||||
* tile boundaries and simplified for a view resolution. See
|
* 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.
|
* editing.
|
||||||
*
|
*
|
||||||
* @fires import("./Tile.js").TileSourceEvent
|
* @fires import("./Tile.js").TileSourceEvent
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ import {asString} from '../color.js';
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @classdesc
|
* @classdesc
|
||||||
* Singleton class. Available through {@link module:ol/style/IconImageCache~shared}.
|
* Singleton class. Available through {@link module:ol/style/IconImageCache.shared}.
|
||||||
*/
|
*/
|
||||||
class IconImageCache {
|
class IconImageCache {
|
||||||
constructor() {
|
constructor() {
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ import Stroke from './Stroke.js';
|
|||||||
import {assert} from '../asserts.js';
|
import {assert} from '../asserts.js';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A function that takes an {@link module:ol/Feature} and a `{number}`
|
* A function that takes an {@link module:ol/Feature~Feature} and a `{number}`
|
||||||
* representing the view's resolution. The function should return a
|
* representing the view's resolution. The function should return a
|
||||||
* {@link module:ol/style/Style~Style} or an array of them. This way e.g. a
|
* {@link module:ol/style/Style~Style} or an array of them. This way e.g. a
|
||||||
* vector layer can be styled. If the function returns `undefined`, the
|
* vector layer can be styled. If the function returns `undefined`, the
|
||||||
@@ -24,8 +24,8 @@ import {assert} from '../asserts.js';
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A function that takes an {@link module:ol/Feature} as argument and returns an
|
* A function that takes an {@link module:ol/Feature~Feature} as argument and returns an
|
||||||
* {@link module:ol/geom/Geometry} that will be rendered and styled for the feature.
|
* {@link module:ol/geom/Geometry~Geometry} that will be rendered and styled for the feature.
|
||||||
*
|
*
|
||||||
* @typedef {function(import("../Feature.js").FeatureLike):
|
* @typedef {function(import("../Feature.js").FeatureLike):
|
||||||
* (import("../geom/Geometry.js").default|import("../render/Feature.js").default|undefined)} GeometryFunction
|
* (import("../geom/Geometry.js").default|import("../render/Feature.js").default|undefined)} GeometryFunction
|
||||||
|
|||||||
@@ -603,7 +603,7 @@ class TileGrid {
|
|||||||
/**
|
/**
|
||||||
* Get the tile size for a zoom level. The type of the return value matches the
|
* Get the tile size for a zoom level. The type of the return value matches the
|
||||||
* `tileSize` or `tileSizes` that the tile grid was configured with. To always
|
* `tileSize` or `tileSizes` that the tile grid was configured with. To always
|
||||||
* get an `import("../size.js").Size`, run the result through `import("../size.js").Size.toSize()`.
|
* get an {@link import("../size.js").Size}, run the result through {@link module:ol/size.toSize}.
|
||||||
* @param {number} z Z.
|
* @param {number} z Z.
|
||||||
* @return {number|import("../size.js").Size} Tile size.
|
* @return {number|import("../size.js").Size} Tile size.
|
||||||
* @api
|
* @api
|
||||||
|
|||||||
@@ -264,7 +264,7 @@ function releaseCanvas(key) {
|
|||||||
* ### Specifying attributes
|
* ### Specifying attributes
|
||||||
*
|
*
|
||||||
* The GPU only receives the data as arrays of numbers. These numbers must be handled differently depending on what it describes (position, texture coordinate...).
|
* The GPU only receives the data as arrays of numbers. These numbers must be handled differently depending on what it describes (position, texture coordinate...).
|
||||||
* Attributes are used to specify these uses. Use {@link enableAttributeArray_} and either
|
* Attributes are used to specify these uses. Use {@link module:ol/webgl/Helper~WebGLHelper#enableAttributes endableAttributes} and either
|
||||||
* the default attribute names in {@link module:ol/webgl/Helper.DefaultAttrib} or custom ones.
|
* the default attribute names in {@link module:ol/webgl/Helper.DefaultAttrib} or custom ones.
|
||||||
*
|
*
|
||||||
* Please note that you will have to specify the type and offset of the attributes in the data array. You can refer to the documentation of [WebGLRenderingContext.vertexAttribPointer](https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/vertexAttribPointer) for more explanation.
|
* Please note that you will have to specify the type and offset of the attributes in the data array. You can refer to the documentation of [WebGLRenderingContext.vertexAttribPointer](https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/vertexAttribPointer) for more explanation.
|
||||||
@@ -303,7 +303,6 @@ function releaseCanvas(key) {
|
|||||||
*
|
*
|
||||||
* For an example usage of this class, refer to {@link module:ol/renderer/webgl/PointsLayer~WebGLPointsLayerRenderer}.
|
* For an example usage of this class, refer to {@link module:ol/renderer/webgl/PointsLayer~WebGLPointsLayerRenderer}.
|
||||||
*
|
*
|
||||||
*
|
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
class WebGLHelper extends Disposable {
|
class WebGLHelper extends Disposable {
|
||||||
|
|||||||
Reference in New Issue
Block a user