Module
GeoPolygonFilter
GeoPolygonFilter ( fieldName )
Filter results to those which are contained within the polygon of points.
|
Method Summary
| Returns | Name | Description |
|---|---|---|
String | _type() | The type of ejs object. For internal use only. |
Object | cache(trueFalse) | Enable or disable caching of the filter |
Object | cacheKey(key) | Sets the cache key. |
Object | field(f) | Sets the fields to filter against. |
Object | name(name) | Sets the filter name. |
Object | normalize(trueFalse) | If the lat/long points should be normalized to lie within their respective normalized ranges. Normalized ranges are: lon = -180 (exclusive) to 180 (inclusive) range lat = -90 to 90 (both inclusive) range |
Object | points(pointsArray) | Sets a series of points that represent a polygon. If passed a
single GeoPoint object, it is added to the current
list of points. If passed an array of GeoPoint
objects it replaces all current values. |
Object | toJSON() | Returns the filter object. |
Method Detail
cache
Object cache ( trueFalse )
Enable or disable caching of the filter
|
cacheKey
Object cacheKey ( key )
Sets the cache key.
|
field
Object field ( f )
Sets the fields to filter against.
|
name
Object name ( name )
Sets the filter name.
|
normalize
Object normalize ( trueFalse )
If the lat/long points should be normalized to lie within their
respective normalized ranges.
Normalized ranges are:
lon = -180 (exclusive) to 180 (inclusive) range
lat = -90 to 90 (both inclusive) range
|
points
Object points ( pointsArray )
Sets a series of points that represent a polygon. If passed a
single GeoPoint object, it is added to the current
list of points. If passed an array of GeoPoint
objects it replaces all current values.
|