| | 1 | /* Copyright (c) 2006-2008 MetaCarta, Inc., published under the Clear BSD |
|---|
| | 2 | * license. See http://svn.openlayers.org/trunk/openlayers/license.txt for the |
|---|
| | 3 | * full text of the license. */ |
|---|
| | 4 | |
|---|
| | 5 | /** |
|---|
| | 6 | * @requires OpenLayers/Filter.js |
|---|
| | 7 | */ |
|---|
| | 8 | |
|---|
| | 9 | /** |
|---|
| | 10 | * Class: OpenLayers.Filter.Spatial |
|---|
| | 11 | * This class represents a spatial filter. |
|---|
| | 12 | * Currently implemented: BBOX, DWithin and Intersects |
|---|
| | 13 | * |
|---|
| | 14 | * Inherits from |
|---|
| | 15 | * - <OpenLayers.Filter> |
|---|
| | 16 | */ |
|---|
| | 17 | OpenLayers.Filter.Spatial = OpenLayers.Class(OpenLayers.Filter, { |
|---|
| | 18 | |
|---|
| | 19 | /** |
|---|
| | 20 | * APIProperty: type |
|---|
| | 21 | * {String} type: type of spatial filter. This is one of |
|---|
| | 22 | * - OpenLayers.Filter.Spatial.BBOX = "BBOX"; |
|---|
| | 23 | * - OpenLayers.Filter.Spatial.INTERSECTS = "INTERSECTS"; |
|---|
| | 24 | * - OpenLayers.Filter.Spatial.DWITHIN = "DWITHIN"; |
|---|
| | 25 | */ |
|---|
| | 26 | type: null, |
|---|
| | 27 | |
|---|
| | 28 | /** |
|---|
| | 29 | * APIProperty: property |
|---|
| | 30 | * {String} |
|---|
| | 31 | * name of the context property to compare |
|---|
| | 32 | */ |
|---|
| | 33 | property: null, |
|---|
| | 34 | |
|---|
| | 35 | /** |
|---|
| | 36 | * APIProperty: value |
|---|
| | 37 | * {<OpenLayers.Geometry>} |
|---|
| | 38 | * The geometry to pass into the spatial filter |
|---|
| | 39 | */ |
|---|
| | 40 | value: null, |
|---|
| | 41 | |
|---|
| | 42 | /** |
|---|
| | 43 | * APIProperty: distance |
|---|
| | 44 | * {Number} |
|---|
| | 45 | * The distance to use in a DWithin spatial filter |
|---|
| | 46 | */ |
|---|
| | 47 | distance: null, |
|---|
| | 48 | |
|---|
| | 49 | /** |
|---|
| | 50 | * APIProperty: distanceUnits |
|---|
| | 51 | * {String} |
|---|
| | 52 | * The units to use for the distance, e.g. m |
|---|
| | 53 | */ |
|---|
| | 54 | distanceUnits: null, |
|---|
| | 55 | |
|---|
| | 56 | |
|---|
| | 57 | /** |
|---|
| | 58 | * Constructor: OpenLayers.Filter.Spatial |
|---|
| | 59 | * Creates a spatial filter. |
|---|
| | 60 | * |
|---|
| | 61 | * Parameters: |
|---|
| | 62 | * options - {Object} An optional object with properties to set on the |
|---|
| | 63 | * filter |
|---|
| | 64 | * |
|---|
| | 65 | * Returns: |
|---|
| | 66 | * {<OpenLayers.Filter.Spatial>} |
|---|
| | 67 | */ |
|---|
| | 68 | initialize: function(options) { |
|---|
| | 69 | OpenLayers.Filter.prototype.initialize.apply(this, [options]); |
|---|
| | 70 | }, |
|---|
| | 71 | |
|---|
| | 72 | CLASS_NAME: "OpenLayers.Filter.Spatial" |
|---|
| | 73 | }); |
|---|
| | 74 | |
|---|
| | 75 | |
|---|
| | 76 | OpenLayers.Filter.Spatial.BBOX = "BBOX"; |
|---|
| | 77 | OpenLayers.Filter.Spatial.INTERSECTS = "INTERSECTS"; |
|---|
| | 78 | OpenLayers.Filter.Spatial.DWITHIN = "DWITHIN"; |