Add "filter" option to Select interaction

2015-03-26 09:35:39 +01:00
parent 2c04e4c071
commit 1f0c21ac60
2 changed files with 33 additions and 4 deletions
@@ -2584,7 +2584,8 @@ olx.interaction.PointerOptions.prototype.handleUpEvent;
 *     style: (ol.style.Style|Array.<ol.style.Style>|ol.style.StyleFunction|undefined),
 *     removeCondition: (ol.events.ConditionType|undefined),
 *     toggleCondition: (ol.events.ConditionType|undefined),
- *     multi: (boolean|undefined)}}
+ *     multi: (boolean|undefined),
+ *     filter: (ol.interaction.SelectFilterFunction|undefined)}}
 * @api
 */
 olx.interaction.SelectOptions;
@@ -2670,6 +2671,14 @@ olx.interaction.SelectOptions.prototype.toggleCondition;
 */
 olx.interaction.SelectOptions.prototype.multi;

+/**
+ * A function that takes an {@link ol.Feature} and an {@link ol.layer.Layer} and
+ * returns `true` if the feature may be selected or `false` otherwise.
+ * @type {ol.interaction.SelectFilterFunction|undefined}
+ * @api
+ */
+olx.interaction.SelectOptions.prototype.filter;
+

 /**
 * Namespace.