ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #2269 from probins/select

Browse Source 
Improve docs for interaction.Select
This commit is contained in:
Éric Lemoine
2014-07-03 17:07:03 +02:00
parent 4fed441eda 49aabda1b9
commit 76e1ca67a4
2 changed files with 22 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
externs/olx.js
View File

@@ -1918,8 +1918,8 @@ olx.interaction.SelectOptions;
/**
* A function that takes an {@link ol.MapBrowserEvent} and returns a boolean
* to indicate whether that event should be handled.
* By default, this is {@link ol.events.condition.never}, though note that the
* default toggle condition allows features to be added.
* By default, this is {@link ol.events.condition.never}. Use this if you want
* to use different events for add and remove instead of `toggle`.
* @type {ol.events.ConditionType|undefined}
*/
olx.interaction.SelectOptions.prototype.addCondition;
@@ -1928,7 +1928,12 @@ olx.interaction.SelectOptions.prototype.addCondition;
/**
* A function that takes an {@link ol.MapBrowserEvent} and returns a boolean
* to indicate whether that event should be handled.
* By default, {@link ol.events.condition.singleClick} toggles the selection.
* This is the event for the selected features as a whole. By default, this is
* {@link ol.events.condition.singleClick}. Clicking on a feature selects that
* feature and removes any that were in the selection. Clicking outside any
* feature removes all from the selection.
* See `toggle`, `add`, `remove` options for adding/removing extra features to/
* from the selection.
* @type {ol.events.ConditionType|undefined}
*/
olx.interaction.SelectOptions.prototype.condition;
@@ -1946,7 +1951,7 @@ olx.interaction.SelectOptions.prototype.layers;
/**
* FeatureOverlay style.
* Style for the selected features (those in the FeatureOverlay).
* @type {ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction|undefined}
*/
olx.interaction.SelectOptions.prototype.style;
@@ -1955,7 +1960,8 @@ olx.interaction.SelectOptions.prototype.style;
/**
* A function that takes an {@link ol.MapBrowserEvent} and returns a boolean
* to indicate whether that event should be handled.
* By default, this is {@link ol.events.condition.never}.
* By default, this is {@link ol.events.condition.never}. Use this if you want
* to use different events for add and remove instead of `toggle`.
* @type {ol.events.ConditionType|undefined}
*/
olx.interaction.SelectOptions.prototype.removeCondition;
@@ -1964,8 +1970,12 @@ olx.interaction.SelectOptions.prototype.removeCondition;
/**
* A function that takes an {@link ol.MapBrowserEvent} and returns a boolean
* to indicate whether that event should be handled.
* By default, {@link ol.events.condition.shiftKeyOnly} toggles the
* feature in the current selection.
* This is in addition to the `condition` event. By default,
* {@link ol.events.condition.shiftKeyOnly}, i.e. pressing `shift` as well as
* the `condition` event, adds that feature to the current selection if it is
* not currently selected, and removes it if it is.
* See `add` and `remove` if you want to use different events instead of a
* toggle.
* @type {ol.events.ConditionType|undefined}
*/
olx.interaction.SelectOptions.prototype.toggleCondition;

6
src/ol/interaction/selectinteraction.js
View File

@@ -16,7 +16,10 @@ goog.require('ol.interaction.Interaction');
/**
* @classdesc
* Handles selection of vector data.
* Handles selection of vector data. A {@link ol.FeatureOverlay} is maintained
* internally to store the selected feature(s). Which features are selected is
* determined by the `condition` option, and optionally the `toggle` or
* `add`/`remove` options.
*
* @constructor
* @extends {ol.interaction.Interaction}
@@ -102,6 +105,7 @@ goog.inherits(ol.interaction.Select, ol.interaction.Interaction);
/**
* Get the selected features.
* @return {ol.Collection} Features collection.
* @todo api
*/