Fix type typos
This commit is contained in:
@@ -30,7 +30,7 @@ import PointerInteraction from '../interaction/Pointer.js';
|
||||
*
|
||||
* @constructor
|
||||
* @extends {module:ol/interaction/Pointer~Pointer}
|
||||
* @param {ol/interaction/DragRotate~Options=} opt_options Options.
|
||||
* @param {module:ol/interaction/DragRotate~Options=} opt_options Options.
|
||||
* @api
|
||||
*/
|
||||
const DragRotate = function(opt_options) {
|
||||
|
||||
@@ -32,7 +32,7 @@ import DragBox from '../interaction/DragBox.js';
|
||||
*
|
||||
* @constructor
|
||||
* @extends {module:ol/interaction/DragBox~DragBox}
|
||||
* @param {ol/interaction/DragZoom~Options=} opt_options Options.
|
||||
* @param {module:ol/interaction/DragZoom~Options=} opt_options Options.
|
||||
* @api
|
||||
*/
|
||||
const DragZoom = function(opt_options) {
|
||||
|
||||
@@ -80,7 +80,7 @@ inherits(ExtentInteractionEvent, Event);
|
||||
* @constructor
|
||||
* @extends {module:ol/interaction/Pointer~Pointer}
|
||||
* @fires module:ol/interaction/Extent~Event
|
||||
* @param {ol/interaction/Extent~Options=} opt_options Options.
|
||||
* @param {module:ol/interaction/Extent~Options=} opt_options Options.
|
||||
* @api
|
||||
*/
|
||||
const ExtentInteraction = function(opt_options) {
|
||||
|
||||
@@ -50,7 +50,7 @@ export const Mode = {
|
||||
*
|
||||
* @constructor
|
||||
* @extends {module:ol/interaction/Interaction~Interaction}
|
||||
* @param {module:olx/interaction/MouseWheelZoom~Options=} opt_options Options.
|
||||
* @param {module:ol/interaction/MouseWheelZoom~Options=} opt_options Options.
|
||||
* @api
|
||||
*/
|
||||
const MouseWheelZoom = function(opt_options) {
|
||||
|
||||
@@ -151,7 +151,7 @@ function handleUpEvent(mapBrowserEvent) {
|
||||
|
||||
|
||||
/**
|
||||
* @param {module:ol/MapBrowserPointerEvent/MapBrowserPointerEvent} mapBrowserEvent Event.
|
||||
* @param {module:ol/MapBrowserPointerEvent~MapBrowserPointerEvent} mapBrowserEvent Event.
|
||||
* @return {boolean} Start drag sequence?
|
||||
* @this {module:ol/interaction/PinchZoom~PinchZoom}
|
||||
*/
|
||||
|
||||
@@ -80,7 +80,7 @@ const SelectEventType = {
|
||||
* @property {boolean} [multi=false] A boolean that determines if the default
|
||||
* behaviour should select only single features or all (overlapping) features at
|
||||
* the clicked map position. The default of `false` means single select.
|
||||
* @property {module:ol/collection/Collection~Collection.<module:ol/Feature~Feature>} [features]
|
||||
* @property {module:ol/Collection~Collection.<module:ol/Feature~Feature>} [features]
|
||||
* Collection where the interaction will place selected features. Optional. If
|
||||
* not set the interaction will create a collection. In any case the collection
|
||||
* used by the interaction is returned by
|
||||
@@ -278,7 +278,7 @@ Select.prototype.addFeatureLayerAssociation_ = function(feature, layer) {
|
||||
|
||||
/**
|
||||
* Get the selected features.
|
||||
* @return {module:ol/collection/Collection~Collection.<module:ol/Feature~Feature>} Features collection.
|
||||
* @return {module:ol/Collection~Collection.<module:ol/Feature~Feature>} Features collection.
|
||||
* @api
|
||||
*/
|
||||
Select.prototype.getFeatures = function() {
|
||||
@@ -456,7 +456,7 @@ function getDefaultStyleFunction() {
|
||||
|
||||
|
||||
/**
|
||||
* @param {module:ol/collection/Collection~CollectionEvent} evt Event.
|
||||
* @param {module:ol/Collection~CollectionEvent} evt Event.
|
||||
* @private
|
||||
*/
|
||||
Select.prototype.addFeature_ = function(evt) {
|
||||
@@ -468,7 +468,7 @@ Select.prototype.addFeature_ = function(evt) {
|
||||
|
||||
|
||||
/**
|
||||
* @param {module:ol/collection/Collection~CollectionEvent} evt Event.
|
||||
* @param {module:ol/Collection~CollectionEvent} evt Event.
|
||||
* @private
|
||||
*/
|
||||
Select.prototype.removeFeature_ = function(evt) {
|
||||
|
||||
@@ -35,7 +35,7 @@ import RBush from '../structs/RBush.js';
|
||||
|
||||
/**
|
||||
* @typedef {Object} Options
|
||||
* @property {module:ol/collection/Collection~Collection.<module:ol/Feature~Feature>|undefined} features Snap to these features. Either this option or source should be provided.
|
||||
* @property {module:ol/Collection~Collection.<module:ol/Feature~Feature>|undefined} features Snap to these features. Either this option or source should be provided.
|
||||
* @property {boolean|undefined} edge Snap to edges. Default is `true`.
|
||||
* @property {boolean|undefined} vertex Snap to vertices. Default is `true`.
|
||||
* @property {number|undefined} pixelTolerance Pixel tolerance for considering the pointer close enough to a segment or
|
||||
@@ -47,7 +47,7 @@ import RBush from '../structs/RBush.js';
|
||||
/**
|
||||
* @classdesc
|
||||
* Handles snapping of vector features while modifying or drawing them. The
|
||||
* features can come from a {@link module:ol/source/Vector~Vector} or {@link module:ol/collection/Collection~Collection}
|
||||
* features can come from a {@link module:ol/source/Vector~Vector} or {@link module:ol/Collection~Collection}
|
||||
* Any interaction object that allows the user to interact
|
||||
* with the features using the mouse can benefit from the snapping, as long
|
||||
* as it is added before.
|
||||
@@ -97,7 +97,7 @@ const Snap = function(opt_options) {
|
||||
this.edge_ = options.edge !== undefined ? options.edge : true;
|
||||
|
||||
/**
|
||||
* @type {module:ol/collection/Collection~Collection.<module:ol/Feature~Feature>}
|
||||
* @type {module:ol/Collection~Collection.<module:ol/Feature~Feature>}
|
||||
* @private
|
||||
*/
|
||||
this.features_ = options.features ? options.features : null;
|
||||
@@ -228,7 +228,7 @@ Snap.prototype.forEachFeatureRemove_ = function(feature) {
|
||||
|
||||
|
||||
/**
|
||||
* @return {module:ol/collection/Collection~Collection.<module:ol/Feature~Feature>|Array.<module:ol/Feature~Feature>} Features.
|
||||
* @return {module:ol/Collection~Collection.<module:ol/Feature~Feature>|Array.<module:ol/Feature~Feature>} Features.
|
||||
* @private
|
||||
*/
|
||||
Snap.prototype.getFeatures_ = function() {
|
||||
@@ -238,12 +238,12 @@ Snap.prototype.getFeatures_ = function() {
|
||||
} else if (this.source_) {
|
||||
features = this.source_.getFeatures();
|
||||
}
|
||||
return /** @type {!Array.<module:ol/Feature~Feature>|!module:ol/collection/Collection~Collection.<module:ol/Feature~Feature>} */ (features);
|
||||
return /** @type {!Array.<module:ol/Feature~Feature>|!module:ol/Collection~Collection.<module:ol/Feature~Feature>} */ (features);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* @param {module:ol/source/Vector~Vector.Event|module:ol/collection/Collection~CollectionEvent} evt Event.
|
||||
* @param {module:ol/source/Vector~Vector.Event|module:ol/Collection~CollectionEvent} evt Event.
|
||||
* @private
|
||||
*/
|
||||
Snap.prototype.handleFeatureAdd_ = function(evt) {
|
||||
@@ -258,7 +258,7 @@ Snap.prototype.handleFeatureAdd_ = function(evt) {
|
||||
|
||||
|
||||
/**
|
||||
* @param {module:ol/source/Vector~Vector.Event|module:ol/collection/Collection~CollectionEvent} evt Event.
|
||||
* @param {module:ol/source/Vector~Vector.Event|module:ol/Collection~CollectionEvent} evt Event.
|
||||
* @private
|
||||
*/
|
||||
Snap.prototype.handleFeatureRemove_ = function(evt) {
|
||||
|
||||
@@ -39,7 +39,7 @@ const TranslateEventType = {
|
||||
|
||||
/**
|
||||
* @typedef {Object} interaction_TranslateOptions
|
||||
* @property {module:ol/collection/Collection~Collection.<module:ol/Feature~Feature>|undefined} features Only features contained in this collection will be able to be translated. If
|
||||
* @property {module:ol/Collection~Collection.<module:ol/Feature~Feature>|undefined} features Only features contained in this collection will be able to be translated. If
|
||||
* not specified, all features on the map will be able to be translated.
|
||||
* @property {undefined|Array.<module:ol/layer/Layer~Layer>|function(module:ol/layer/Layer~Layer): boolean} layers A list of layers from which features should be
|
||||
* translated. Alternatively, a filter function can be provided. The
|
||||
@@ -61,7 +61,7 @@ const TranslateEventType = {
|
||||
* @extends {module:ol/events/Event~Event}
|
||||
* @implements {oli.interaction.TranslateEvent}
|
||||
* @param {module:ol/interaction/Translate~TranslateEventType} type Type.
|
||||
* @param {module:ol/collection/Collection~Collection.<module:ol/Feature~Feature>} features The features translated.
|
||||
* @param {module:ol/Collection~Collection.<module:ol/Feature~Feature>} features The features translated.
|
||||
* @param {module:ol/coordinate~Coordinate} coordinate The event coordinate.
|
||||
*/
|
||||
export const TranslateEvent = function(type, features, coordinate) {
|
||||
@@ -70,7 +70,7 @@ export const TranslateEvent = function(type, features, coordinate) {
|
||||
|
||||
/**
|
||||
* The features being translated.
|
||||
* @type {module:ol/collection/Collection~Collection.<module:ol/Feature~Feature>}
|
||||
* @type {module:ol/Collection~Collection.<module:ol/Feature~Feature>}
|
||||
* @api
|
||||
*/
|
||||
this.features = features;
|
||||
@@ -116,7 +116,7 @@ const Translate = function(opt_options) {
|
||||
|
||||
|
||||
/**
|
||||
* @type {module:ol/collection/Collection~Collection.<module:ol/Feature~Feature>}
|
||||
* @type {module:ol/Collection~Collection.<module:ol/Feature~Feature>}
|
||||
* @private
|
||||
*/
|
||||
this.features_ = options.features !== undefined ? options.features : null;
|
||||
|
||||
Reference in New Issue
Block a user