Merge pull request #13298 from ahocevar/webglpoints-assert-point

Document geometry type
This commit is contained in:
Andreas Hocevar
2022-01-30 18:42:44 +01:00
committed by GitHub
2 changed files with 4 additions and 4 deletions
+1 -1
View File
@@ -33,7 +33,7 @@ import {createCanvasContext2D} from '../dom.js';
* @property {string|function(import("../Feature.js").default):number} [weight='weight'] The feature * @property {string|function(import("../Feature.js").default):number} [weight='weight'] The feature
* attribute to use for the weight or a function that returns a weight from a feature. Weight values * attribute to use for the weight or a function that returns a weight from a feature. Weight values
* should range from 0 to 1 (and values outside will be clamped to that range). * should range from 0 to 1 (and values outside will be clamped to that range).
* @property {import("../source/Vector.js").default} [source] Source. * @property {import("../source/Vector.js").default<import("../geom/Point.js").default>} [source] Point source.
* @property {Object<string, *>} [properties] Arbitrary observable properties. Can be accessed with `#get()` and `#set()`. * @property {Object<string, *>} [properties] Arbitrary observable properties. Can be accessed with `#get()` and `#set()`.
*/ */
+3 -3
View File
@@ -7,7 +7,7 @@ import {assign} from '../obj.js';
import {parseLiteralStyle} from '../webgl/ShaderBuilder.js'; import {parseLiteralStyle} from '../webgl/ShaderBuilder.js';
/** /**
* @template {import("../source/Vector.js").default} VectorSourceType * @template {import("../source/Vector.js").default<import("../geom/Point.js").default>} VectorSourceType
* @typedef {Object} Options * @typedef {Object} Options
* @property {import('../style/literal.js').LiteralStyle} style Literal style to apply to the layer features. * @property {import('../style/literal.js').LiteralStyle} style Literal style to apply to the layer features.
* @property {string} [className='ol-layer'] A CSS class name to set to the layer element. * @property {string} [className='ol-layer'] A CSS class name to set to the layer element.
@@ -27,7 +27,7 @@ import {parseLiteralStyle} from '../webgl/ShaderBuilder.js';
* visible. * visible.
* @property {number} [maxZoom] The maximum view zoom level (inclusive) at which this layer will * @property {number} [maxZoom] The maximum view zoom level (inclusive) at which this layer will
* be visible. * be visible.
* @property {VectorSourceType} [source] Source. * @property {VectorSourceType} [source] Point source.
* @property {boolean} [disableHitDetection=false] Setting this to true will provide a slight performance boost, but will * @property {boolean} [disableHitDetection=false] Setting this to true will provide a slight performance boost, but will
* prevent all hit detection on the layer. * prevent all hit detection on the layer.
* @property {Object<string, *>} [properties] Arbitrary observable properties. Can be accessed with `#get()` and `#set()`. * @property {Object<string, *>} [properties] Arbitrary observable properties. Can be accessed with `#get()` and `#set()`.
@@ -68,7 +68,7 @@ import {parseLiteralStyle} from '../webgl/ShaderBuilder.js';
* property on the layer object; for example, setting `title: 'My Title'` in the * property on the layer object; for example, setting `title: 'My Title'` in the
* options means that `title` is observable, and has get/set accessors. * options means that `title` is observable, and has get/set accessors.
* *
* @template {import("../source/Vector.js").default} VectorSourceType * @template {import("../source/Vector.js").default<import("../geom/Point.js").default>} VectorSourceType
* @extends {Layer<VectorSourceType, WebGLPointsLayerRenderer>} * @extends {Layer<VectorSourceType, WebGLPointsLayerRenderer>}
* @fires import("../render/Event.js").RenderEvent * @fires import("../render/Event.js").RenderEvent
*/ */