v5 v4

Class: Pois

cercalia.service.Pois

new cercalia.service.Pois(options)

temp/jsdocinputdirs/cercalia.service.pois.js, line 11

POIs service constructor.

Use this class for getting POIs specifying the IDs, or getting a POI list from an area (WKT or map bounds (cercalia.Bounds)) and the POI category

Name Type Description
options

Opciones Geocoding

Name Type Description
bounds cercalia.Bounds | undefined optional

Bounds to search categories inside
buffer number | undefined optional
categories Array.<string> | undefined optional

List of categories to obtain. The 'pois' option must be null.
gridsize string | undefined optional
height number | undefined optional

Height in píxels.
pois Array.<string> | undefined optional

POIs IDs list to obtain. If this option is included, the categories property will be ignored. Does not apply any other constructor options.
searchByScale Boolean | undefined optional

Specify if you need to group POIs depending on parameters: bounds, width and height.
width number | undefined optional

Width, in píxels.
wkt string | undefined optional

Get all the POIs from selected categories, that intersects a polygon, in WKT format

Methods

abortLast()

temp/jsdocinputdirs/cercalia.service.pois.js, line 376

Abort the last AJAX request if it hasn't been resolved.

doPoisRequest(callbackFn)

temp/jsdocinputdirs/cercalia.service.pois.js, line 255

Execute the server request and the callback function to be processed with the response

Name Type Description
callbackFn function

Funcion callback

getBounds(){cercalia.LonLat}

temp/jsdocinputdirs/cercalia.service.pois.js, line 160

Returns the WKT of the spatial query

Returns:
Coordinate

getClass(){string}

temp/jsdocinputdirs/cercalia.service.pois.js, line 390

Returns the object type.

getGridsize(){number}

temp/jsdocinputdirs/cercalia.service.pois.js, line 239
Returns:
gridsize

getHeigth(){number}

temp/jsdocinputdirs/cercalia.service.pois.js, line 224
Returns:
height

getQueryCategories(){Array.<string>}

temp/jsdocinputdirs/cercalia.service.pois.js, line 124

Returns the POIs categories to search

Returns:
categories list string

getQueryPois(){Array.<string>}

temp/jsdocinputdirs/cercalia.service.pois.js, line 107

Returns the POIs list

Returns:
Returns a POI IDs array

getResponse(){Object}

temp/jsdocinputdirs/cercalia.service.pois.js, line 184

Returns the response with the 'geocode' function request

Returns:
response

getWidth(){number}

temp/jsdocinputdirs/cercalia.service.pois.js, line 209
Returns:
width

getWkt(){Array.<string>}

temp/jsdocinputdirs/cercalia.service.pois.js, line 141

Returns the map area corresponding to the spatial query. The format is WKT

Returns:
Geometria WKT (string)

isSearchbyScale(){boolean}

temp/jsdocinputdirs/cercalia.service.pois.js, line 201
Returns:
boolean that shows if POIs by scale search is used

setBounds(wkt)

temp/jsdocinputdirs/cercalia.service.pois.js, line 169

Set the polygon for the spatial query. String WKT format. If spatial query use map bounds, the WKT will be ignored and must be reset next time

Name Type Description
wkt cercalia.LonLat

WKT string

setGridsize(gridsize)

temp/jsdocinputdirs/cercalia.service.pois.js, line 246
Name Type Description
gridsize number

setHeight(height)

temp/jsdocinputdirs/cercalia.service.pois.js, line 231
Name Type Description
height number

setQueryCategories(pois)

temp/jsdocinputdirs/cercalia.service.pois.js, line 115

Set the POIs list to search.

Name Type Description
pois Array.<string>

POIs ID list, in an array

setQueryPois(categories)

temp/jsdocinputdirs/cercalia.service.pois.js, line 132

Set the POIs categories to search.

Name Type Description
categories Array.<string>

categories list string

setSearchbyScale(searchByScale)

temp/jsdocinputdirs/cercalia.service.pois.js, line 192
Name Type Description
searchByScale boolean

setWidth(width)

temp/jsdocinputdirs/cercalia.service.pois.js, line 216
Name Type Description
width number

setWkt(wkt)

temp/jsdocinputdirs/cercalia.service.pois.js, line 150

Set the polygon for the spatial query. String WKT format If spatial query use a WKT, the map bounds will be ignored and must be reset next time

Name Type Description
wkt Array.<string>

WKT geometry