Module
GeoPoint
GeoPoint ( p )
Defines a point
|
Method Summary
| Returns | Name | Description |
|---|---|---|
String | _type() | The type of ejs object. For internal use only. |
Object | array(a) | Sets the GeoPoint from an array point. The array must contain only 2 values. The first value is the lat and the 2nd value is the lon. Example: [41.12, -71.34] |
Object | geohash(hash,precision) | Sets the GeoPoint as a GeoHash. The hash is a string of alpha-numeric characters with a precision length that defaults to 12. Example: "drm3btev3e86" |
Object | properties(obj) | Sets the GeoPoint as properties on an object. The object must have a 'lat' and 'lon' or a 'geohash' property. Example: {lat: 41.12, lon: -71.34} or {geohash: "drm3btev3e86"} |
Object | string(s) | Sets the GeoPoint as a string. The format is "lat,lon". Example: "41.12,-71.34" |
String | toJSON() | Retrieves the internal script object. This is typically used by
internal API functions so use with caution. |
Method Detail
array
Object array ( a )
Sets the GeoPoint from an array point. The array must contain only
2 values. The first value is the lat and the 2nd value is the lon.
Example:
[41.12, -71.34]
|
geohash
Object geohash ( hash, precision )
Sets the GeoPoint as a GeoHash. The hash is a string of
alpha-numeric characters with a precision length that defaults to 12.
Example:
"drm3btev3e86"
|
properties
Object properties ( obj )
Sets the GeoPoint as properties on an object. The object must have
a 'lat' and 'lon' or a 'geohash' property.
Example:
{lat: 41.12, lon: -71.34} or {geohash: "drm3btev3e86"}
|
string
Object string ( s )
Sets the GeoPoint as a string. The format is "lat,lon".
Example:
"41.12,-71.34"
|
toJSON
String toJSON ( )
Retrieves the internal script object. This is typically used by
internal API functions so use with caution.
|