No olx and ol types for ol/interaction/Modify

This commit is contained in:
ahocevar
2018-03-16 16:30:00 +01:00
parent 438ec66c4c
commit d6b177e847
4 changed files with 91 additions and 174 deletions
-91
View File
@@ -46,97 +46,6 @@ olx.interaction.TranslateOptions.prototype.layers;
olx.interaction.TranslateOptions.prototype.hitTolerance;
/**
* @typedef {{
* condition: (ol.EventsConditionType|undefined),
* deleteCondition: (ol.EventsConditionType|undefined),
* insertVertexCondition: (ol.EventsConditionType|undefined),
* pixelTolerance: (number|undefined),
* style: (ol.style.Style|Array.<ol.style.Style>|ol.StyleFunction|undefined),
* source: (ol.source.Vector|undefined),
* features: (ol.Collection.<module:ol/Feature~Feature>|undefined),
* wrapX: (boolean|undefined)
* }}
*/
olx.interaction.ModifyOptions;
/**
* A function that takes an {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a boolean
* to indicate whether that event will be considered to add or move a vertex
* to the sketch.
* Default is {@link ol.events.condition.primaryAction}.
* @type {ol.EventsConditionType|undefined}
* @api
*/
olx.interaction.ModifyOptions.prototype.condition;
/**
* A function that takes an {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a boolean
* to indicate whether that event should be handled.
* By default, {@link ol.events.condition.singleClick} with
* {@link ol.events.condition.altKeyOnly} results in a vertex deletion.
* @type {ol.EventsConditionType|undefined}
* @api
*/
olx.interaction.ModifyOptions.prototype.deleteCondition;
/**
* A function that takes an {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a boolean
* to indicate whether a new vertex can be added to the sketch features.
* Default is {@link ol.events.condition.always}
* @type {ol.EventsConditionType|undefined}
* @api
*/
olx.interaction.ModifyOptions.prototype.insertVertexCondition;
/**
* Pixel tolerance for considering the pointer close enough to a segment or
* vertex for editing. Default is `10`.
* @type {number|undefined}
* @api
*/
olx.interaction.ModifyOptions.prototype.pixelTolerance;
/**
* Style used for the features being modified. By default the default edit
* style is used (see {@link ol.style}).
* @type {ol.style.Style|Array.<ol.style.Style>|ol.StyleFunction|undefined}
* @api
*/
olx.interaction.ModifyOptions.prototype.style;
/**
* The vector source with features to modify. If a vector source is not
* provided, a feature collection must be provided with the features option.
* @type {ol.source.Vector|undefined}
* @api
*/
olx.interaction.ModifyOptions.prototype.source;
/**
* The features the interaction works on. If a feature collection is not
* provided, a vector source must be provided with the source option.
* @type {ol.Collection.<module:ol/Feature~Feature>|undefined}
* @api
*/
olx.interaction.ModifyOptions.prototype.features;
/**
* Wrap the world horizontally on the sketch overlay. Default is `false`.
* @type {boolean|undefined}
* @api
*/
olx.interaction.ModifyOptions.prototype.wrapX;
/**
* @typedef {{constrainResolution: (boolean|undefined),
* condition: (ol.EventsConditionType|undefined),
-25
View File
@@ -14,31 +14,6 @@
*/
/**
* @typedef {Object} interaction_ModifyOptions
* @property {ol.EventsConditionType|undefined} condition A function that takes an {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a boolean
* to indicate whether that event will be considered to add or move a vertex
* to the sketch.
* Default is {@link ol.events.condition.primaryAction}.
* @property {ol.EventsConditionType|undefined} deleteCondition A function that takes an {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a boolean
* to indicate whether that event should be handled.
* By default, {@link ol.events.condition.singleClick} with
* {@link ol.events.condition.altKeyOnly} results in a vertex deletion.
* @property {ol.EventsConditionType|undefined} insertVertexCondition A function that takes an {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a boolean
* to indicate whether a new vertex can be added to the sketch features.
* Default is {@link ol.events.condition.always}
* @property {number|undefined} pixelTolerance Pixel tolerance for considering the pointer close enough to a segment or
* vertex for editing. Default is `10`.
* @property {ol.style.Style|Array.<ol.style.Style>|ol.StyleFunction|undefined} style Style used for the features being modified. By default the default edit
* style is used (see {@link ol.style}).
* @property {ol.source.Vector|undefined} source The vector source with features to modify. If a vector source is not
* provided, a feature collection must be provided with the features option.
* @property {ol.Collection.<module:ol/Feature~Feature>|undefined} features The features the interaction works on. If a feature collection is not
* provided, a vector source must be provided with the source option.
* @property {boolean|undefined} wrapX Wrap the world horizontally on the sketch overlay. Default is `false`.
*/
/**
* @typedef {Object} interaction_MouseWheelZoomOptions
* @property {ol.EventsConditionType|undefined} condition A function that takes an {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a boolean