arlas-wui-toolkit / Exports / ArlasExploreApi

Class: ArlasExploreApi

Hierarchy

  • ExploreApi

↳ ArlasExploreApi

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new ArlasExploreApi(conf, basePath, fetch)

Parameters

Name Type
conf Configuration
basePath string
fetch any

Overrides

ExploreApi.constructor

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:80

Properties

basePath

• Protected basePath: string

Inherited from

ExploreApi.basePath

Defined in

node_modules/arlas-api/api.d.ts:36

configuration

• Protected configuration: Configuration

Inherited from

ExploreApi.configuration

Defined in

node_modules/arlas-api/api.d.ts:38

fetch

• Protected fetch: FetchAPI

Inherited from

ExploreApi.fetch

Defined in

node_modules/arlas-api/api.d.ts:37

Methods

aggregate

▸ aggregate(collection, agg, f?, q?, dateformat?, righthand?, pretty?, flat?, max_age_cache?, options?): Promise<AggregationResponse>

Aggregate the elements in the collection(s), given the filters and the aggregation parameters

Summary

Aggregate

Throws

Memberof

ExploreApi

Parameters

Name Type Description
collection string collection
agg string[] The agg parameter should be given in the following formats: {type}:{field}:interval-{interval}:format-{format}:collect_field-{collect_field}:collect_fct-{function}:order-{order}:on-{on}:size-{size}:fetch_hits-{fetch_hits values} Where : - {type}:{field} part is mandatory. - interval must be specified only when aggregation type is datehistogram, histogram, geotile and geohash. - format is optional for datehistogram, and must not be specified for the other types. - (collect_field,collect_fct) couple is optional for all aggregation types. - It's possible to apply multiple metric aggregations by defining multiple (collect_field,collect_fct) couples. - (collect_field,collect_fct) couples should be unique in that case. - (order,on) couple is optional for all aggregation types. - size is optional for term and geohash/geotile, and must not be specified for the other types. - include is optional for term, and must not be specified for the other types. - {type} possible values are : datehistogram, histogram, geohash, geotile and term. - {interval} possible values depends on {type}. If {type} = datehistogram, then {interval} = {size}(year,quarter,month,week,day,hour,minute,second). Size value must be equal to 1 for year,quarter,month and week unities. If {type} = histogram, then {interval} = {size}. If {type} = geohash, then {interval} = {size}. It's an integer between 1 and 12. Lower the length, greater is the surface of aggregation. If {type} = geotile, then {interval} = {size}. It's an integer corresponding to zoom level of the aggregation, that should be larger than or equal to {z} in the path param, and no bigger than {z}+6. If {type} = term, then interval-{interval} is not needed. - format-{format} is the date format for key aggregation. The default value is yyyy-MM-dd-hh:mm:ss. - {collect_fct} is the aggregation function to apply to collections on the specified {collect_field}. {collect_fct} possible values are : avg,cardinality,max,min,sum - {order} is set to sort the aggregation buckets on the field name, on the count of the buckets or on the the result of a metric sub-aggregation. Its values are 'asc' or 'desc'. - {on} is set to specify whether the {order} is on the field name, on the count of the aggregation or on the result of a metric sub-aggregation. Its values are 'field', 'count' or 'result'. - If {on} is equal to `result` and two or more (collect_field,collect_fct) couples are specified, then the order is applied on the first `collect_fct` that is different from geobbox and geocentroid - {size} Defines how many buckets should be returned. - {include} Specifies the values for which buckets will be created. This values are comma separated. If one value is specified then regular expressions can be used (only in this case) and buckets matching them will be created. If more than one value are specified then only buckets matching the exact values will be created. - aggregated_geometries > What it does: Allows to specify a list of aggregated forms of geometries that represent the bucket. > Syntax: `aggregated_geometries-{COMMA_SEPARATED_AGGREGATED_GEOMETRIES}`. > Available aggregated geometries: `centroid, bbox, cell, cell_center`. - centroid: returns the centroid of data inside the bucket. - bbox: returns the data extent (bbox) in each bucket. - cell: returns the cell extent (zxy or geohash) of each bucket. This form is supported for geohash and geotile aggregation type only. - cell_center: returns the cell center of each bucket. This form is supported for geohash and geotile aggregation type only. > Response: the aggregated geometries are returned in `geometries` list in the json response. Each object inside this list has : the reference to the aggregated form, the geojson geometry and an attribute `is_raw` set to false > Example: `aggregated_geometries-bbox,cell` - raw_geometries > What it does: Allows to specify a list of raw geometries provided by hits that represent the bucket and that are elected by a sort > Syntax: `raw_geometries-{GEOMETRY_FIELD}({COMMA_SEPERATED_SORT_FIELDS});{GEOMETRY_FIELD2}({COMMA_SEPERATED_SORT_FIELDS2})`. > Available raw geometries: any field of the collection whose type is geo-point or geo-shape. - sort fields are optional. If no sort is specified, an ascending sort on `collection.params.timestamp_path` is applied - a sort field can be preceded by '-' for descending sort. Otherwise the sort is ascending > Response: the aggregated geometries are returned in `geometries` list in the json response. Each object inside this list has : the reference to the geometry path, the used sort, the geojson geometry and an attribute `is_raw` set to true > Example: `raw_geometries-geo_field1,geo_field2 || raw_geometries-geo_field(-field1,field2)` || raw_geometries-geo_field1(field1);geo_field2(field2,field3) - fetch_hits > What it does: Specifies the number of hits to retrieve inside each aggregation bucket and which fields to include in the hits. > Syntax: `fetch_hits-{sizeOfHitsToFetch}(+{field1}, {field2}, -{field3}, ...)`. > Note 1: `{sizeOfHitsToFetch}` is optional, if not specified, 1 is considered as default. > Note 2: `{field}` can be preceded by + or - for ascending or descending sort of the hits. Order matters. > Example: `fetch_hits-3(-timestamp, geometry)`. Fetches the 3 last positions for each bucket. agg parameter is multiple. Every agg parameter specified is a subaggregation of the previous one : order matters. For more details, check https://gitlab.com/GISAIA.ARLAS/ARLAS-server/blob/master/doc/api/API-definition.md.
f? string[] A triplet for filtering the result. Multiple filter can be provided in distinct parameters (AND operator is applied) or in the same parameter separated by semi-colons (OR operator is applied). The order does not matter. - A triplet is composed of a field name, a comparison operator and a value. The possible values of the comparison operator are : Operator -- Description -- value type :eq: -- {fieldName} equals {comma separated values}. OR operation is applied for the specified values -- numeric or strings :ne: -- {fieldName} must not equal {comma separated values }. AND operation is applied for the specified values -- numeric or strings :like: -- {fieldName} is like {value} -- numeric or strings :gte: -- {fieldName} is greater than or equal to {value} -- numeric :gt: -- {fieldName} is greater than {value} -- numeric :lte: -- {fieldName} is less than or equal to {value} -- numeric :lt: -- {fieldName} is less than {value} -- numeric :range: -- {fieldName} is between `{comma separated [min<max] values}`. OR operation is applied for the specified ranges -- numeric or strings. If the field's type is date, then min & max should be timestamps in millisecond or a Date expression :within: -- {GeofieldName}` is within the `{given WKT string or the given BBOX }` -- a WKT string or the BBOX string : `\"west, south, east, north\"` :notwithin: -- {GeofieldName} is not within the `{given WKT string or the given BBOX }` -- a WKT string or the BBOX string : `\"west, south, east, north\"` :intersects: -- {GeofieldName} intersects the `{given WKT string or the given BBOX }` | a WKT string or the BBOX string : `\"west, south, east, north\"` :notintersects: -- {GeofieldName} does not intersect the `{given WKT string or the given }` -- a WKT string or the BBOX string : `\"west, south, east, north\"`
q? string[] A full text search. Optionally, it's possible to search on a field using this syntax: {fieldname}:{text}
dateformat? string The format of dates. This parameter should be set only if a date field is queried in `f` param; when using `gt`, `lt`, `gte`, `lte` and `range` operations
righthand? boolean If righthand = true, the passed WKT should be counter clock-wise; otherwise, ARLAS-server will attempt to parse it as the \"Complementary\" Polygon on the other facet of the planet. Inversely, If righthand = false, the passed WKT should be clock-wise; otherwise, ARLAS-server will attempt to parse it as the \"Complementary\" Polygon on the other facet of the planet.
pretty? boolean Pretty print
flat? boolean Flats the property map: only key/value on one level
max_age_cache? number max-age-cache
options? any Override http request option.

Returns

Promise<AggregationResponse>

Inherited from

ExploreApi.aggregate

Defined in

node_modules/arlas-api/api.d.ts:2315

aggregatePost

▸ aggregatePost(collection, body?, pretty?, max_age_cache?, options?): Promise<AggregationResponse>

Aggregate the elements in the collection(s), given the filters and the aggregation parameters

Summary

Aggregate

Throws

Memberof

ExploreApi

Parameters

Name Type Description
collection string collection
body? AggregationsRequest
pretty? boolean Pretty print
max_age_cache? number max-age-cache
options? any Override http request option.

Returns

Promise<AggregationResponse>

Inherited from

ExploreApi.aggregatePost

Defined in

node_modules/arlas-api/api.d.ts:2327

compute

▸ compute(collection, field, metric, f?, q?, dateformat?, righthand?, pretty?, max_age_cache?, options?): Promise<ComputationResponse>

Computes the given metric on a field in the collection, given the filters

Summary

Compute

Throws

Memberof

ExploreApi

Parameters

Name Type Description
collection string collection
field string The field on which the metric is calculated.
metric string The metric to compute : `max, min, avg, sum, cardinality, spanning, geobbox, geocentroid`.
f? string[] A triplet for filtering the result. Multiple filter can be provided in distinct parameters (AND operator is applied) or in the same parameter separated by semi-colons (OR operator is applied). The order does not matter. - A triplet is composed of a field name, a comparison operator and a value. The possible values of the comparison operator are : Operator -- Description -- value type :eq: -- {fieldName} equals {comma separated values}. OR operation is applied for the specified values -- numeric or strings :ne: -- {fieldName} must not equal {comma separated values }. AND operation is applied for the specified values -- numeric or strings :like: -- {fieldName} is like {value} -- numeric or strings :gte: -- {fieldName} is greater than or equal to {value} -- numeric :gt: -- {fieldName} is greater than {value} -- numeric :lte: -- {fieldName} is less than or equal to {value} -- numeric :lt: -- {fieldName} is less than {value} -- numeric :range: -- {fieldName} is between `{comma separated [min<max] values}`. OR operation is applied for the specified ranges -- numeric or strings. If the field's type is date, then min & max should be timestamps in millisecond or a Date expression :within: -- {GeofieldName}` is within the `{given WKT string or the given BBOX }` -- a WKT string or the BBOX string : `\"west, south, east, north\"` :notwithin: -- {GeofieldName} is not within the `{given WKT string or the given BBOX }` -- a WKT string or the BBOX string : `\"west, south, east, north\"` :intersects: -- {GeofieldName} intersects the `{given WKT string or the given BBOX }` | a WKT string or the BBOX string : `\"west, south, east, north\"` :notintersects: -- {GeofieldName} does not intersect the `{given WKT string or the given }` -- a WKT string or the BBOX string : `\"west, south, east, north\"`
q? string[] A full text search. Optionally, it's possible to search on a field using this syntax: {fieldname}:{text}
dateformat? string The format of dates. This parameter should be set only if a date field is queried in `f` param; when using `gt`, `lt`, `gte`, `lte` and `range` operations
righthand? boolean If righthand = true, the passed WKT should be counter clock-wise; otherwise, ARLAS-server will attempt to parse it as the \"Complementary\" Polygon on the other facet of the planet. Inversely, If righthand = false, the passed WKT should be clock-wise; otherwise, ARLAS-server will attempt to parse it as the \"Complementary\" Polygon on the other facet of the planet.
pretty? boolean Pretty print
max_age_cache? number max-age-cache
options? any Override http request option.

Returns

Promise<ComputationResponse>

Inherited from

ExploreApi.compute

Defined in

node_modules/arlas-api/api.d.ts:2344

computePost

▸ computePost(collection, body?, pretty?, max_age_cache?, options?): Promise<ComputationResponse>

Computes the given metric on a field in the collection, given the filters

Summary

Compute

Throws

Memberof

ExploreApi

Parameters

Name Type Description
collection string collection
body? ComputationRequest
pretty? boolean Pretty print
max_age_cache? number max-age-cache
options? any Override http request option.

Returns

Promise<ComputationResponse>

Inherited from

ExploreApi.computePost

Defined in

node_modules/arlas-api/api.d.ts:2356

count

▸ count(collection, f?, q?, dateformat?, righthand?, pretty?, max_age_cache?, options?): Promise<Hits>

Count the number of elements found in the collection(s), given the filters

Summary

Count

Throws

Memberof

ExploreApi

Parameters

Name Type Description
collection string collections
f? string[] A triplet for filtering the result. Multiple filter can be provided in distinct parameters (AND operator is applied) or in the same parameter separated by semi-colons (OR operator is applied). The order does not matter. - A triplet is composed of a field name, a comparison operator and a value. The possible values of the comparison operator are : Operator -- Description -- value type :eq: -- {fieldName} equals {comma separated values}. OR operation is applied for the specified values -- numeric or strings :ne: -- {fieldName} must not equal {comma separated values }. AND operation is applied for the specified values -- numeric or strings :like: -- {fieldName} is like {value} -- numeric or strings :gte: -- {fieldName} is greater than or equal to {value} -- numeric :gt: -- {fieldName} is greater than {value} -- numeric :lte: -- {fieldName} is less than or equal to {value} -- numeric :lt: -- {fieldName} is less than {value} -- numeric :range: -- {fieldName} is between `{comma separated [min<max] values}`. OR operation is applied for the specified ranges -- numeric or strings. If the field's type is date, then min & max should be timestamps in millisecond or a Date expression :within: -- {GeofieldName}` is within the `{given WKT string or the given BBOX }` -- a WKT string or the BBOX string : `\"west, south, east, north\"` :notwithin: -- {GeofieldName} is not within the `{given WKT string or the given BBOX }` -- a WKT string or the BBOX string : `\"west, south, east, north\"` :intersects: -- {GeofieldName} intersects the `{given WKT string or the given BBOX }` | a WKT string or the BBOX string : `\"west, south, east, north\"` :notintersects: -- {GeofieldName} does not intersect the `{given WKT string or the given }` -- a WKT string or the BBOX string : `\"west, south, east, north\"`
q? string[] A full text search. Optionally, it's possible to search on a field using this syntax: {fieldname}:{text}
dateformat? string The format of dates. This parameter should be set only if a date field is queried in `f` param; when using `gt`, `lt`, `gte`, `lte` and `range` operations
righthand? boolean If righthand = true, the passed WKT should be counter clock-wise; otherwise, ARLAS-server will attempt to parse it as the \"Complementary\" Polygon on the other facet of the planet. Inversely, If righthand = false, the passed WKT should be clock-wise; otherwise, ARLAS-server will attempt to parse it as the \"Complementary\" Polygon on the other facet of the planet.
pretty? boolean Pretty print
max_age_cache? number max-age-cache
options? any Override http request option.

Returns

Promise<Hits>

Inherited from

ExploreApi.count

Defined in

node_modules/arlas-api/api.d.ts:2371

countPost

▸ countPost(collection, pretty?, body?, options?): Promise<Hits>

Count the number of elements found in the collection(s), given the filters

Summary

Count

Throws

Memberof

ExploreApi

Parameters

Name Type Description
collection string collections
pretty? boolean Pretty print
body? Count
options? any Override http request option.

Returns

Promise<Hits>

Inherited from

ExploreApi.countPost

Defined in

node_modules/arlas-api/api.d.ts:2382

describe

▸ describe(collection, pretty?, max_age_cache?, options?): Promise<CollectionReferenceDescription>

Describe the structure and the content of the given collection.

Summary

Describe

Throws

Memberof

ExploreApi

Parameters

Name Type Description
collection string collection
pretty? boolean Pretty print
max_age_cache? number max-age-cache
options? any Override http request option.

Returns

Promise<CollectionReferenceDescription>

Inherited from

ExploreApi.describe

Defined in

node_modules/arlas-api/api.d.ts:2393

geoaggregate

▸ geoaggregate(collection, agg, f?, q?, dateformat?, righthand?, pretty?, flat?, max_age_cache?, options?): Promise<FeatureCollection>

Aggregate the elements in the collection(s) as features, given the filters and the aggregation parameters.

Summary

GeoAggregate

Throws

Memberof

ExploreApi

Parameters

Name Type Description
collection string collection
agg string[] The agg parameter should be given in the following formats: {type}:{field}:interval-{interval}:format-{format}:collect_field-{collect_field}:collect_fct-{function}:order-{order}:on-{on}:size-{size}:raw_geometries-{raw_geometries values}:aggregated_geometries-{aggregated_geometries values}:fetch_hits-{fetch_hits values} Where : - {type}:{field} part is mandatory. - interval must be specified only when aggregation type is datehistogram, histogram, geotile and geohash. - format is optional for datehistogram, and must not be specified for the other types. - (collect_field,collect_fct) couple is optional for all aggregation types. - (order,on) couple is optional for all aggregation types. - size is optional for term and geohash/geotile, and must not be specified for the other types. - include is optional for term, and must not be specified for the other types. - {type} possible values are : geohash, geotile, datehistogram, histogram and term. geohash or geotile must be the main aggregation. - {interval} possible values depends on {type}. If {type} = datehistogram, then {interval} = {size}(year,quarter,month,week,day,hour,minute,second). Size value must be equal to 1 for year,quarter,month and week unities. If {type} = histogram, then {interval} = {size}. If {type} = geohash, then {interval} = {size}. It's an integer between 1 and 12. Lower the length, greater is the surface of aggregation. If {type} = geotile, then {interval} = {size}. It's an integer corresponding to zoom level of the aggregation, that should be larger than or equal to {z} in the path param, and no bigger than {z}+6 (max 29). If {type} = term, then interval-{interval} is not needed. - format-{format} is the date format for key aggregation. The default value is yyyy-MM-dd-hh:mm:ss. - {collect_fct} is the aggregation function to apply to collections on the specified {collect_field}. {collect_fct} possible values are : avg,cardinality,max,min,sum,geobbox,geocentroid - (collect_field,collect_fct) should both be specified, except when collect_fct = `geobbox` or `geocentroid`, it could be specified alone. The metrics `geobbox` and `geocentroid` are returned as features collections. - {order} is set to sort the aggregation buckets on the field name, on the count of the buckets or on the the result of a metric sub-aggregation. Its values are 'asc' or 'desc'. - {on} is set to specify whether the {order} is on the field name, on the count of the aggregation or on the result of a metric sub-aggregation. Its values are 'field', 'count' or 'result'. - When {on} = `result`, then (collect_field,collect_fct) should be specified. Except when {collect_fct} = `geobbox` or `geocentroid`, then {on}=`result` is prohibited - {size} Defines how many buckets should be returned. - {include} Specifies the values for which buckets will be created. This values are comma separated. If one value is specified then regular expressions can be used (only in this case) and buckets matching them will be created. If more than one value are specified then only buckets matching the exact values will be created. - aggregated_geometries > What it does: Allows to specify a list of aggregated forms of geometries that represent the bucket. > Syntax: `aggregated_geometries-{COMMA_SEPARATED_AGGREGATED_GEOMETRIES}`. > Available aggregated geometries: `centroid, bbox, cell, cell_center`. - centroid: returns the centroid of data inside the bucket. - bbox: returns the data extent (bbox) in each bucket. - cell: returns the cell (zxy or geohash) extent of each bucket. This form is supported for geohash and geotile aggregation type only. - cell_center: returns the cell center of each bucket. This form is supported for geohash and geotile aggregation type only. > Response: Each bucket of the aggregation will be represented with as many features (in a feature collection) as there are specified aggregated geometries. The properties of each feature has : - geometry_ref attribute that informs which aggregated form is returned - geometry_type attribute set to aggregated > Example: `aggregated_geometries-bbox,geohash` - raw_geometries > What it does: Allows to specify a list of raw geometries provided by hits that represent the bucket and that are elected by a sort > Syntax: `raw_geometries-{GEOMETRY_FIELD}({COMMA_SEPERATED_SORT_FIELDS});{GEOMETRY_FIELD2}({COMMA_SEPERATED_SORT_FIELDS2})`. > Available raw geometries: any field of the collection whose type is geo-point or geo-shape. - sort fields are optional. If no sort is specified, an ascending sort on `collection.params.timestamp_path` is applied - a sort field can be preceded by '-' for descending sort. Otherwise the sort is ascending > Response: each bucket of the aggregation will be represented with as many features (in a feature collection) as there are specified raw geometries. The properties of each feature has : - geometry_ref attribute that informs which geometry path is returned - geometry_type attribute set to raw - geometry_sort attribute that informs how the geometry path is fetched (with what sort) > Example: `raw_geometries-geo_field1,geo_field2 || raw_geometries-geo_field(-field1,field2)` || raw_geometries-geo_field1(field1);geo_field2(field2,field3) - fetch_hits > What it does: Specifies the number of hits to retrieve inside each aggregation bucket and which fields to include in the hits. > Syntax: `fetch_hits-{sizeOfHitsToFetch}(+{field1}, {field2}, -{field3}, ...)`. > Note 1: `{sizeOfHitsToFetch}` is optional, if not specified, 1 is considered as default. > Note 2: `{field}` can be preceded by + or - for ascending or descending sort of the hits. Order matters. > Example: `fetch_hits-3(-timestamp, geometry)`. Fetches the 3 last positions for each bucket. agg parameter is multiple. The first (main) aggregation must be geohash or geotile. Every agg parameter specified is a subaggregation of the previous one : order matters. For more details, check https://github.com/gisaia/ARLAS-server/blob/master/docs/arlas-api-exploration.md
f? string[] A triplet for filtering the result. Multiple filter can be provided in distinct parameters (AND operator is applied) or in the same parameter separated by semi-colons (OR operator is applied). The order does not matter. - A triplet is composed of a field name, a comparison operator and a value. The possible values of the comparison operator are : Operator -- Description -- value type :eq: -- {fieldName} equals {comma separated values}. OR operation is applied for the specified values -- numeric or strings :ne: -- {fieldName} must not equal {comma separated values }. AND operation is applied for the specified values -- numeric or strings :like: -- {fieldName} is like {value} -- numeric or strings :gte: -- {fieldName} is greater than or equal to {value} -- numeric :gt: -- {fieldName} is greater than {value} -- numeric :lte: -- {fieldName} is less than or equal to {value} -- numeric :lt: -- {fieldName} is less than {value} -- numeric :range: -- {fieldName} is between `{comma separated [min<max] values}`. OR operation is applied for the specified ranges -- numeric or strings. If the field's type is date, then min & max should be timestamps in millisecond or a Date expression :within: -- {GeofieldName}` is within the `{given WKT string or the given BBOX }` -- a WKT string or the BBOX string : `\"west, south, east, north\"` :notwithin: -- {GeofieldName} is not within the `{given WKT string or the given BBOX }` -- a WKT string or the BBOX string : `\"west, south, east, north\"` :intersects: -- {GeofieldName} intersects the `{given WKT string or the given BBOX }` | a WKT string or the BBOX string : `\"west, south, east, north\"` :notintersects: -- {GeofieldName} does not intersect the `{given WKT string or the given }` -- a WKT string or the BBOX string : `\"west, south, east, north\"`
q? string[] A full text search. Optionally, it's possible to search on a field using this syntax: {fieldname}:{text}
dateformat? string The format of dates. This parameter should be set only if a date field is queried in `f` param; when using `gt`, `lt`, `gte`, `lte` and `range` operations
righthand? boolean If righthand = true, the passed WKT should be counter clock-wise; otherwise, ARLAS-server will attempt to parse it as the \"Complementary\" Polygon on the other facet of the planet. Inversely, If righthand = false, the passed WKT should be clock-wise; otherwise, ARLAS-server will attempt to parse it as the \"Complementary\" Polygon on the other facet of the planet.
pretty? boolean Pretty print
flat? boolean Flats the property map: only key/value on one level
max_age_cache? number max-age-cache
options? any Override http request option.

Returns

Promise<FeatureCollection>

Inherited from

ExploreApi.geoaggregate

Defined in

node_modules/arlas-api/api.d.ts:2410

geoaggregatePost

▸ geoaggregatePost(collection, body?, pretty?, max_age_cache?, options?): Promise<FeatureCollection>

Aggregate the elements in the collection(s) as features, given the filters and the aggregation parameters.

Summary

GeoAggregate

Throws

Memberof

ExploreApi

Parameters

Name Type Description
collection string collection
body? AggregationsRequest
pretty? boolean Pretty print
max_age_cache? number max-age-cache
options? any Override http request option.

Returns

Promise<FeatureCollection>

Inherited from

ExploreApi.geoaggregatePost

Defined in

node_modules/arlas-api/api.d.ts:2422

geohashgeoaggregate

▸ geohashgeoaggregate(collection, geohash, agg?, f?, q?, dateformat?, righthand?, pretty?, flat?, max_age_cache?, options?): Promise<FeatureCollection>

Aggregate the elements in the collection(s) and localized in the given geohash as features, given the filters and the aggregation parameters.

Summary

GeoAggregate on a geohash

Throws

Memberof

ExploreApi

Parameters

Name Type Description
collection string collection
geohash string geohash
agg? string[] The agg parameter should be given in the following formats: {type}:{field}:interval-{interval}:format-{format}:collect_field-{collect_field}:collect_fct-{function}:order-{order}:on-{on}:size-{size}:raw_geometries-{raw_geometries values}:aggregated_geometries-{aggregated_geometries values}:fetch_hits-{fetch_hits values} Where : - {type}:{field} part is mandatory. - interval must be specified only when aggregation type is datehistogram, histogram, geotile and geohash. - format is optional for datehistogram, and must not be specified for the other types. - (collect_field,collect_fct) couple is optional for all aggregation types. - (order,on) couple is optional for all aggregation types. - size is optional for term and geohash/geotile, and must not be specified for the other types. - include is optional for term, and must not be specified for the other types. - {type} possible values are : geohash, geotile, datehistogram, histogram and term. geohash or geotile must be the main aggregation. - {interval} possible values depends on {type}. If {type} = datehistogram, then {interval} = {size}(year,quarter,month,week,day,hour,minute,second). Size value must be equal to 1 for year,quarter,month and week unities. If {type} = histogram, then {interval} = {size}. If {type} = geohash, then {interval} = {size}. It's an integer between 1 and 12. Lower the length, greater is the surface of aggregation. If {type} = geotile, then {interval} = {size}. It's an integer corresponding to zoom level of the aggregation, that should be larger than or equal to {z} in the path param, and no bigger than {z}+6 (max 29). If {type} = term, then interval-{interval} is not needed. - format-{format} is the date format for key aggregation. The default value is yyyy-MM-dd-hh:mm:ss. - {collect_fct} is the aggregation function to apply to collections on the specified {collect_field}. {collect_fct} possible values are : avg,cardinality,max,min,sum,geobbox,geocentroid - (collect_field,collect_fct) should both be specified, except when collect_fct = `geobbox` or `geocentroid`, it could be specified alone. The metrics `geobbox` and `geocentroid` are returned as features collections. - {order} is set to sort the aggregation buckets on the field name, on the count of the buckets or on the the result of a metric sub-aggregation. Its values are 'asc' or 'desc'. - {on} is set to specify whether the {order} is on the field name, on the count of the aggregation or on the result of a metric sub-aggregation. Its values are 'field', 'count' or 'result'. - When {on} = `result`, then (collect_field,collect_fct) should be specified. Except when {collect_fct} = `geobbox` or `geocentroid`, then {on}=`result` is prohibited - {size} Defines how many buckets should be returned. - {include} Specifies the values for which buckets will be created. This values are comma separated. If one value is specified then regular expressions can be used (only in this case) and buckets matching them will be created. If more than one value are specified then only buckets matching the exact values will be created. - aggregated_geometries > What it does: Allows to specify a list of aggregated forms of geometries that represent the bucket. > Syntax: `aggregated_geometries-{COMMA_SEPARATED_AGGREGATED_GEOMETRIES}`. > Available aggregated geometries: `centroid, bbox, cell, cell_center`. - centroid: returns the centroid of data inside the bucket. - bbox: returns the data extent (bbox) in each bucket. - cell: returns the cell (zxy or geohash) extent of each bucket. This form is supported for geohash and geotile aggregation type only. - cell_center: returns the cell center of each bucket. This form is supported for geohash and geotile aggregation type only. > Response: Each bucket of the aggregation will be represented with as many features (in a feature collection) as there are specified aggregated geometries. The properties of each feature has : - geometry_ref attribute that informs which aggregated form is returned - geometry_type attribute set to aggregated > Example: `aggregated_geometries-bbox,geohash` - raw_geometries > What it does: Allows to specify a list of raw geometries provided by hits that represent the bucket and that are elected by a sort > Syntax: `raw_geometries-{GEOMETRY_FIELD}({COMMA_SEPERATED_SORT_FIELDS});{GEOMETRY_FIELD2}({COMMA_SEPERATED_SORT_FIELDS2})`. > Available raw geometries: any field of the collection whose type is geo-point or geo-shape. - sort fields are optional. If no sort is specified, an ascending sort on `collection.params.timestamp_path` is applied - a sort field can be preceded by '-' for descending sort. Otherwise the sort is ascending > Response: each bucket of the aggregation will be represented with as many features (in a feature collection) as there are specified raw geometries. The properties of each feature has : - geometry_ref attribute that informs which geometry path is returned - geometry_type attribute set to raw - geometry_sort attribute that informs how the geometry path is fetched (with what sort) > Example: `raw_geometries-geo_field1,geo_field2 || raw_geometries-geo_field(-field1,field2)` || raw_geometries-geo_field1(field1);geo_field2(field2,field3) - fetch_hits > What it does: Specifies the number of hits to retrieve inside each aggregation bucket and which fields to include in the hits. > Syntax: `fetch_hits-{sizeOfHitsToFetch}(+{field1}, {field2}, -{field3}, ...)`. > Note 1: `{sizeOfHitsToFetch}` is optional, if not specified, 1 is considered as default. > Note 2: `{field}` can be preceded by + or - for ascending or descending sort of the hits. Order matters. > Example: `fetch_hits-3(-timestamp, geometry)`. Fetches the 3 last positions for each bucket. agg parameter is multiple. The first (main) aggregation must be geohash or geotile. Every agg parameter specified is a subaggregation of the previous one : order matters. For more details, check https://github.com/gisaia/ARLAS-server/blob/master/docs/arlas-api-exploration.md
f? string[] A triplet for filtering the result. Multiple filter can be provided in distinct parameters (AND operator is applied) or in the same parameter separated by semi-colons (OR operator is applied). The order does not matter. - A triplet is composed of a field name, a comparison operator and a value. The possible values of the comparison operator are : Operator -- Description -- value type :eq: -- {fieldName} equals {comma separated values}. OR operation is applied for the specified values -- numeric or strings :ne: -- {fieldName} must not equal {comma separated values }. AND operation is applied for the specified values -- numeric or strings :like: -- {fieldName} is like {value} -- numeric or strings :gte: -- {fieldName} is greater than or equal to {value} -- numeric :gt: -- {fieldName} is greater than {value} -- numeric :lte: -- {fieldName} is less than or equal to {value} -- numeric :lt: -- {fieldName} is less than {value} -- numeric :range: -- {fieldName} is between `{comma separated [min<max] values}`. OR operation is applied for the specified ranges -- numeric or strings. If the field's type is date, then min & max should be timestamps in millisecond or a Date expression :within: -- {GeofieldName}` is within the `{given WKT string or the given BBOX }` -- a WKT string or the BBOX string : `\"west, south, east, north\"` :notwithin: -- {GeofieldName} is not within the `{given WKT string or the given BBOX }` -- a WKT string or the BBOX string : `\"west, south, east, north\"` :intersects: -- {GeofieldName} intersects the `{given WKT string or the given BBOX }` | a WKT string or the BBOX string : `\"west, south, east, north\"` :notintersects: -- {GeofieldName} does not intersect the `{given WKT string or the given }` -- a WKT string or the BBOX string : `\"west, south, east, north\"`
q? string[] A full text search. Optionally, it's possible to search on a field using this syntax: {fieldname}:{text}
dateformat? string The format of dates. This parameter should be set only if a date field is queried in `f` param; when using `gt`, `lt`, `gte`, `lte` and `range` operations
righthand? boolean If righthand = true, the passed WKT should be counter clock-wise; otherwise, ARLAS-server will attempt to parse it as the \"Complementary\" Polygon on the other facet of the planet. Inversely, If righthand = false, the passed WKT should be clock-wise; otherwise, ARLAS-server will attempt to parse it as the \"Complementary\" Polygon on the other facet of the planet.
pretty? boolean Pretty print
flat? boolean Flats the property map: only key/value on one level
max_age_cache? number max-age-cache
options? any Override http request option.

Returns

Promise<FeatureCollection>

Inherited from

ExploreApi.geohashgeoaggregate

Defined in

node_modules/arlas-api/api.d.ts:2440

geosearch

▸ geosearch(collection, f?, q?, dateformat?, righthand?, pretty?, flat?, include?, exclude?, returned_geometries?, size?, from?, sort?, after?, before?, max_age_cache?, options?): Promise<FeatureCollection>

Search and return the elements found in the collection(s) as features, given the filters

Summary

GeoSearch

Throws

Memberof

ExploreApi

Parameters

Name Type Description
collection string collection
f? string[] A triplet for filtering the result. Multiple filter can be provided in distinct parameters (AND operator is applied) or in the same parameter separated by semi-colons (OR operator is applied). The order does not matter. - A triplet is composed of a field name, a comparison operator and a value. The possible values of the comparison operator are : Operator -- Description -- value type :eq: -- {fieldName} equals {comma separated values}. OR operation is applied for the specified values -- numeric or strings :ne: -- {fieldName} must not equal {comma separated values }. AND operation is applied for the specified values -- numeric or strings :like: -- {fieldName} is like {value} -- numeric or strings :gte: -- {fieldName} is greater than or equal to {value} -- numeric :gt: -- {fieldName} is greater than {value} -- numeric :lte: -- {fieldName} is less than or equal to {value} -- numeric :lt: -- {fieldName} is less than {value} -- numeric :range: -- {fieldName} is between `{comma separated [min<max] values}`. OR operation is applied for the specified ranges -- numeric or strings. If the field's type is date, then min & max should be timestamps in millisecond or a Date expression :within: -- {GeofieldName}` is within the `{given WKT string or the given BBOX }` -- a WKT string or the BBOX string : `\"west, south, east, north\"` :notwithin: -- {GeofieldName} is not within the `{given WKT string or the given BBOX }` -- a WKT string or the BBOX string : `\"west, south, east, north\"` :intersects: -- {GeofieldName} intersects the `{given WKT string or the given BBOX }` | a WKT string or the BBOX string : `\"west, south, east, north\"` :notintersects: -- {GeofieldName} does not intersect the `{given WKT string or the given }` -- a WKT string or the BBOX string : `\"west, south, east, north\"`
q? string[] A full text search. Optionally, it's possible to search on a field using this syntax: {fieldname}:{text}
dateformat? string The format of dates. This parameter should be set only if a date field is queried in `f` param; when using `gt`, `lt`, `gte`, `lte` and `range` operations
righthand? boolean If righthand = true, the passed WKT should be counter clock-wise; otherwise, ARLAS-server will attempt to parse it as the \"Complementary\" Polygon on the other facet of the planet. Inversely, If righthand = false, the passed WKT should be clock-wise; otherwise, ARLAS-server will attempt to parse it as the \"Complementary\" Polygon on the other facet of the planet.
pretty? boolean Pretty print
flat? boolean Flats the property map: only key/value on one level
include? string[] List the name patterns of the field to be included in the result. Separate patterns with a comma.
exclude? string[] List the name patterns of the field to be excluded in the result. Separate patterns with a comma.
returned_geometries? string Comma separated geometry field_paths to be included in the result. If not specified, only geometry_path is returned. If geometry_path is null, then centroid_path is returned
size? number The maximum number of entries or sub-entries to be returned. The default value is 10
from? number From index to start the search from. Defaults to 0.
sort? string[] Sorts the resulted hits on the given fields and/or by distance to a given point: > Syntax: `{field1},{field2},-{field3},geodistance:{lat} {lon},{field4} ...`. > Note 1: `{field}` can be preceded by '-' for descending sort. By default, sort is ascending. > Note 2: The order of fields matters. > Note 3 geodistance sort: Sorts the hits centroids by distance to the given {lat} {lon} (ascending distance sort). It can be specified at most 1 time. > Example 1: sort=`age,-timestamp`. Resulted hits are sorted by age. For same age hits, they are decreasingly sorted in time. > Example 2: sort=`age,geodistance:89 179`. Resulted hits are sorted by age. For same age hits, they are sorted by closest distance to the point(89°,179°)
after? string List of values of fields present in sort param that are used to search after. > What it does: Retrieve the data placed after the pointed element, given the provided order (sort). > Restriction 1: after param works only combined with sort param. > Syntax: `after={value1},{value2},...,{valueN} & sort={field1},{field2},...,{fieldN}`. > Note 1: {value1}` and `{value2}` are the values of `{field1}` and `{field2}` in the last hit returned in the previous search > Note 2: The order of fields and values matters. {value1},{value2} must be in the same order of {field1},{field2} in sort param > Note 3: The last field `{fieldN}` must be the id field specified in the collection collection.params.idPath (returned as md.id) and `{valueN}` its corresponding value. > Example: sort=`-date,id` & after=`01/02/2019,abcd1234`. Gets the following hits of the previous search that stopped at date 01/02/2019 and id abcd1234*. > Restriction 2: from param must be set to 0 or kept unset
before? string Same idea that after param, but to retrieve the data placed before the pointed element, given the provided order (sort).
max_age_cache? number max-age-cache
options? any Override http request option.

Returns

Promise<FeatureCollection>

Inherited from

ExploreApi.geosearch

Defined in

node_modules/arlas-api/api.d.ts:2464

geosearchPost

▸ geosearchPost(collection, body?, pretty?, max_age_cache?, options?): Promise<FeatureCollection>

Search and return the elements found in the collection(s) as features, given the filters

Summary

GeoSearch

Throws

Memberof

ExploreApi

Parameters

Name Type Description
collection string collection
body? Search
pretty? boolean Pretty print
max_age_cache? number max-age-cache
options? any Override http request option.

Returns

Promise<FeatureCollection>

Inherited from

ExploreApi.geosearchPost

Defined in

node_modules/arlas-api/api.d.ts:2476

geotilegeoaggregate

▸ geotilegeoaggregate(collection, z, x, y, agg?, f?, q?, dateformat?, righthand?, pretty?, flat?, max_age_cache?, options?): Promise<FeatureCollection>

Aggregate the elements in the collection(s) and localized in the given tile as features, given the filters and the aggregation parameters.

Summary

GeoAggregate on a geotile

Throws

Memberof

ExploreApi

Parameters

Name Type Description
collection string collection
z number z
x number x
y number y
agg? string[] The agg parameter should be given in the following formats: {type}:{field}:interval-{interval}:format-{format}:collect_field-{collect_field}:collect_fct-{function}:order-{order}:on-{on}:size-{size}:raw_geometries-{raw_geometries values}:aggregated_geometries-{aggregated_geometries values}:fetch_hits-{fetch_hits values} Where : - {type}:{field} part is mandatory. - interval must be specified only when aggregation type is datehistogram, histogram, geotile and geohash. - format is optional for datehistogram, and must not be specified for the other types. - (collect_field,collect_fct) couple is optional for all aggregation types. - (order,on) couple is optional for all aggregation types. - size is optional for term and geohash/geotile, and must not be specified for the other types. - include is optional for term, and must not be specified for the other types. - {type} possible values are : geohash, geotile, datehistogram, histogram and term. geohash or geotile must be the main aggregation. - {interval} possible values depends on {type}. If {type} = datehistogram, then {interval} = {size}(year,quarter,month,week,day,hour,minute,second). Size value must be equal to 1 for year,quarter,month and week unities. If {type} = histogram, then {interval} = {size}. If {type} = geohash, then {interval} = {size}. It's an integer between 1 and 12. Lower the length, greater is the surface of aggregation. If {type} = geotile, then {interval} = {size}. It's an integer corresponding to zoom level of the aggregation, that should be larger than or equal to {z} in the path param, and no bigger than {z}+6 (max 29). If {type} = term, then interval-{interval} is not needed. - format-{format} is the date format for key aggregation. The default value is yyyy-MM-dd-hh:mm:ss. - {collect_fct} is the aggregation function to apply to collections on the specified {collect_field}. {collect_fct} possible values are : avg,cardinality,max,min,sum,geobbox,geocentroid - (collect_field,collect_fct) should both be specified, except when collect_fct = `geobbox` or `geocentroid`, it could be specified alone. The metrics `geobbox` and `geocentroid` are returned as features collections. - {order} is set to sort the aggregation buckets on the field name, on the count of the buckets or on the the result of a metric sub-aggregation. Its values are 'asc' or 'desc'. - {on} is set to specify whether the {order} is on the field name, on the count of the aggregation or on the result of a metric sub-aggregation. Its values are 'field', 'count' or 'result'. - When {on} = `result`, then (collect_field,collect_fct) should be specified. Except when {collect_fct} = `geobbox` or `geocentroid`, then {on}=`result` is prohibited - {size} Defines how many buckets should be returned. - {include} Specifies the values for which buckets will be created. This values are comma separated. If one value is specified then regular expressions can be used (only in this case) and buckets matching them will be created. If more than one value are specified then only buckets matching the exact values will be created. - aggregated_geometries > What it does: Allows to specify a list of aggregated forms of geometries that represent the bucket. > Syntax: `aggregated_geometries-{COMMA_SEPARATED_AGGREGATED_GEOMETRIES}`. > Available aggregated geometries: `centroid, bbox, cell, cell_center`. - centroid: returns the centroid of data inside the bucket. - bbox: returns the data extent (bbox) in each bucket. - cell: returns the cell (zxy or geohash) extent of each bucket. This form is supported for geohash and geotile aggregation type only. - cell_center: returns the cell center of each bucket. This form is supported for geohash and geotile aggregation type only. > Response: Each bucket of the aggregation will be represented with as many features (in a feature collection) as there are specified aggregated geometries. The properties of each feature has : - geometry_ref attribute that informs which aggregated form is returned - geometry_type attribute set to aggregated > Example: `aggregated_geometries-bbox,geohash` - raw_geometries > What it does: Allows to specify a list of raw geometries provided by hits that represent the bucket and that are elected by a sort > Syntax: `raw_geometries-{GEOMETRY_FIELD}({COMMA_SEPERATED_SORT_FIELDS});{GEOMETRY_FIELD2}({COMMA_SEPERATED_SORT_FIELDS2})`. > Available raw geometries: any field of the collection whose type is geo-point or geo-shape. - sort fields are optional. If no sort is specified, an ascending sort on `collection.params.timestamp_path` is applied - a sort field can be preceded by '-' for descending sort. Otherwise the sort is ascending > Response: each bucket of the aggregation will be represented with as many features (in a feature collection) as there are specified raw geometries. The properties of each feature has : - geometry_ref attribute that informs which geometry path is returned - geometry_type attribute set to raw - geometry_sort attribute that informs how the geometry path is fetched (with what sort) > Example: `raw_geometries-geo_field1,geo_field2 || raw_geometries-geo_field(-field1,field2)` || raw_geometries-geo_field1(field1);geo_field2(field2,field3) - fetch_hits > What it does: Specifies the number of hits to retrieve inside each aggregation bucket and which fields to include in the hits. > Syntax: `fetch_hits-{sizeOfHitsToFetch}(+{field1}, {field2}, -{field3}, ...)`. > Note 1: `{sizeOfHitsToFetch}` is optional, if not specified, 1 is considered as default. > Note 2: `{field}` can be preceded by + or - for ascending or descending sort of the hits. Order matters. > Example: `fetch_hits-3(-timestamp, geometry)`. Fetches the 3 last positions for each bucket. agg parameter is multiple. The first (main) aggregation must be geohash or geotile. Every agg parameter specified is a subaggregation of the previous one : order matters. For more details, check https://github.com/gisaia/ARLAS-server/blob/master/docs/arlas-api-exploration.md
f? string[] A triplet for filtering the result. Multiple filter can be provided in distinct parameters (AND operator is applied) or in the same parameter separated by semi-colons (OR operator is applied). The order does not matter. - A triplet is composed of a field name, a comparison operator and a value. The possible values of the comparison operator are : Operator -- Description -- value type :eq: -- {fieldName} equals {comma separated values}. OR operation is applied for the specified values -- numeric or strings :ne: -- {fieldName} must not equal {comma separated values }. AND operation is applied for the specified values -- numeric or strings :like: -- {fieldName} is like {value} -- numeric or strings :gte: -- {fieldName} is greater than or equal to {value} -- numeric :gt: -- {fieldName} is greater than {value} -- numeric :lte: -- {fieldName} is less than or equal to {value} -- numeric :lt: -- {fieldName} is less than {value} -- numeric :range: -- {fieldName} is between `{comma separated [min<max] values}`. OR operation is applied for the specified ranges -- numeric or strings. If the field's type is date, then min & max should be timestamps in millisecond or a Date expression :within: -- {GeofieldName}` is within the `{given WKT string or the given BBOX }` -- a WKT string or the BBOX string : `\"west, south, east, north\"` :notwithin: -- {GeofieldName} is not within the `{given WKT string or the given BBOX }` -- a WKT string or the BBOX string : `\"west, south, east, north\"` :intersects: -- {GeofieldName} intersects the `{given WKT string or the given BBOX }` | a WKT string or the BBOX string : `\"west, south, east, north\"` :notintersects: -- {GeofieldName} does not intersect the `{given WKT string or the given }` -- a WKT string or the BBOX string : `\"west, south, east, north\"`
q? string[] A full text search. Optionally, it's possible to search on a field using this syntax: {fieldname}:{text}
dateformat? string The format of dates. This parameter should be set only if a date field is queried in `f` param; when using `gt`, `lt`, `gte`, `lte` and `range` operations
righthand? boolean If righthand = true, the passed WKT should be counter clock-wise; otherwise, ARLAS-server will attempt to parse it as the \"Complementary\" Polygon on the other facet of the planet. Inversely, If righthand = false, the passed WKT should be clock-wise; otherwise, ARLAS-server will attempt to parse it as the \"Complementary\" Polygon on the other facet of the planet.
pretty? boolean Pretty print
flat? boolean Flats the property map: only key/value on one level
max_age_cache? number max-age-cache
options? any Override http request option.

Returns

Promise<FeatureCollection>

Inherited from

ExploreApi.geotilegeoaggregate

Defined in

node_modules/arlas-api/api.d.ts:2496

getArlasHit

▸ getArlasHit(collection, identifier, pretty?, flat?, max_age_cache?, options?): Promise<ArlasHit>

Returns a raw indexed document.

Summary

Get an Arlas document

Throws

Memberof

ExploreApi

Parameters

Name Type Description
collection string collection
identifier string identifier
pretty? boolean Pretty print
flat? boolean Flats the property map: only key/value on one level
max_age_cache? number max-age-cache
options? any Override http request option.

Returns

Promise<ArlasHit>

Inherited from

ExploreApi.getArlasHit

Defined in

node_modules/arlas-api/api.d.ts:2509

list

▸ list(pretty?, max_age_cache?, options?): Promise<CollectionReferenceDescription[]>

List the collections configured in ARLAS.

Summary

List

Throws

Memberof

ExploreApi

Parameters

Name Type Description
pretty? boolean Pretty print
max_age_cache? number max-age-cache
options? any Override http request option.

Returns

Promise<CollectionReferenceDescription[]>

Inherited from

ExploreApi.list

Defined in

node_modules/arlas-api/api.d.ts:2519

▸ search(collection, f?, q?, dateformat?, righthand?, pretty?, flat?, include?, exclude?, returned_geometries?, size?, from?, sort?, after?, before?, max_age_cache?, options?): Promise<Hits>

Search and return the elements found in the collection, given the filters

Summary

Search

Throws

Memberof

ExploreApi

Parameters

Name Type Description
collection string collection
f? string[] A triplet for filtering the result. Multiple filter can be provided in distinct parameters (AND operator is applied) or in the same parameter separated by semi-colons (OR operator is applied). The order does not matter. - A triplet is composed of a field name, a comparison operator and a value. The possible values of the comparison operator are : Operator -- Description -- value type :eq: -- {fieldName} equals {comma separated values}. OR operation is applied for the specified values -- numeric or strings :ne: -- {fieldName} must not equal {comma separated values }. AND operation is applied for the specified values -- numeric or strings :like: -- {fieldName} is like {value} -- numeric or strings :gte: -- {fieldName} is greater than or equal to {value} -- numeric :gt: -- {fieldName} is greater than {value} -- numeric :lte: -- {fieldName} is less than or equal to {value} -- numeric :lt: -- {fieldName} is less than {value} -- numeric :range: -- {fieldName} is between `{comma separated [min<max] values}`. OR operation is applied for the specified ranges -- numeric or strings. If the field's type is date, then min & max should be timestamps in millisecond or a Date expression :within: -- {GeofieldName}` is within the `{given WKT string or the given BBOX }` -- a WKT string or the BBOX string : `\"west, south, east, north\"` :notwithin: -- {GeofieldName} is not within the `{given WKT string or the given BBOX }` -- a WKT string or the BBOX string : `\"west, south, east, north\"` :intersects: -- {GeofieldName} intersects the `{given WKT string or the given BBOX }` | a WKT string or the BBOX string : `\"west, south, east, north\"` :notintersects: -- {GeofieldName} does not intersect the `{given WKT string or the given }` -- a WKT string or the BBOX string : `\"west, south, east, north\"`
q? string[] A full text search. Optionally, it's possible to search on a field using this syntax: {fieldname}:{text}
dateformat? string The format of dates. This parameter should be set only if a date field is queried in `f` param; when using `gt`, `lt`, `gte`, `lte` and `range` operations
righthand? boolean If righthand = true, the passed WKT should be counter clock-wise; otherwise, ARLAS-server will attempt to parse it as the \"Complementary\" Polygon on the other facet of the planet. Inversely, If righthand = false, the passed WKT should be clock-wise; otherwise, ARLAS-server will attempt to parse it as the \"Complementary\" Polygon on the other facet of the planet.
pretty? boolean Pretty print
flat? boolean Flats the property map: only key/value on one level
include? string[] List the name patterns of the field to be included in the result. Separate patterns with a comma.
exclude? string[] List the name patterns of the field to be excluded in the result. Separate patterns with a comma.
returned_geometries? string Comma separated geometry field_paths to be included in the result. If not specified, only geometry_path is returned. If geometry_path is null, then centroid_path is returned
size? number The maximum number of entries or sub-entries to be returned. The default value is 10
from? number From index to start the search from. Defaults to 0.
sort? string Sorts the resulted hits on the given fields and/or by distance to a given point: > Syntax: `{field1},{field2},-{field3},geodistance:{lat} {lon},{field4} ...`. > Note 1: `{field}` can be preceded by '-' for descending sort. By default, sort is ascending. > Note 2: The order of fields matters. > Note 3 geodistance sort: Sorts the hits centroids by distance to the given {lat} {lon} (ascending distance sort). It can be specified at most 1 time. > Example 1: sort=`age,-timestamp`. Resulted hits are sorted by age. For same age hits, they are decreasingly sorted in time. > Example 2: sort=`age,geodistance:89 179`. Resulted hits are sorted by age. For same age hits, they are sorted by closest distance to the point(89°,179°)
after? string List of values of fields present in sort param that are used to search after. > What it does: Retrieve the data placed after the pointed element, given the provided order (sort). > Restriction 1: after param works only combined with sort param. > Syntax: `after={value1},{value2},...,{valueN} & sort={field1},{field2},...,{fieldN}`. > Note 1: {value1}` and `{value2}` are the values of `{field1}` and `{field2}` in the last hit returned in the previous search > Note 2: The order of fields and values matters. {value1},{value2} must be in the same order of {field1},{field2} in sort param > Note 3: The last field `{fieldN}` must be the id field specified in the collection collection.params.idPath (returned as md.id) and `{valueN}` its corresponding value. > Example: sort=`-date,id` & after=`01/02/2019,abcd1234`. Gets the following hits of the previous search that stopped at date 01/02/2019 and id abcd1234*. > Restriction 2: from param must be set to 0 or kept unset
before? string Same idea that after param, but to retrieve the data placed before the pointed element, given the provided order (sort).
max_age_cache? number max-age-cache
options? any Override http request option.

Returns

Promise<Hits>

Inherited from

ExploreApi.search

Defined in

node_modules/arlas-api/api.d.ts:2543

searchPost

▸ searchPost(collection, body?, pretty?, max_age_cache?, options?): Promise<Hits>

Search and return the elements found in the collection, given the filters

Summary

Search

Throws

Memberof

ExploreApi

Parameters

Name Type Description
collection string collection
body? Search
pretty? boolean Pretty print
max_age_cache? number max-age-cache
options? any Override http request option.

Returns

Promise<Hits>

Inherited from

ExploreApi.searchPost

Defined in

node_modules/arlas-api/api.d.ts:2555

shapeaggregate

▸ shapeaggregate(collection, agg, f?, q?, dateformat?, righthand?, pretty?, max_age_cache?, options?): Promise<Response>

Aggregate the elements in the collection(s) as features, given the filters and the aggregation parameters, and returns a shapefile of it.

Summary

ShapeAggregate

Throws

Memberof

ExploreApi

Parameters

Name Type Description
collection string collection
agg string[] The agg parameter should be given in the following formats: {type}:{field}:interval-{interval}:format-{format}:collect_field-{collect_field}:collect_fct-{function}:order-{order}:on-{on}:size-{size}:raw_geometries-{raw_geometries values}:aggregated_geometries-{aggregated_geometries values}:fetch_hits-{fetch_hits values} Where : - {type}:{field} part is mandatory. - interval must be specified only when aggregation type is datehistogram, histogram, geotile and geohash. - format is optional for datehistogram, and must not be specified for the other types. - (collect_field,collect_fct) couple is optional for all aggregation types. - (order,on) couple is optional for all aggregation types. - size is optional for term and geohash/geotile, and must not be specified for the other types. - include is optional for term, and must not be specified for the other types. - {type} possible values are : geohash, geotile, datehistogram, histogram and term. geohash or geotile must be the main aggregation. - {interval} possible values depends on {type}. If {type} = datehistogram, then {interval} = {size}(year,quarter,month,week,day,hour,minute,second). Size value must be equal to 1 for year,quarter,month and week unities. If {type} = histogram, then {interval} = {size}. If {type} = geohash, then {interval} = {size}. It's an integer between 1 and 12. Lower the length, greater is the surface of aggregation. If {type} = geotile, then {interval} = {size}. It's an integer corresponding to zoom level of the aggregation, that should be larger than or equal to {z} in the path param, and no bigger than {z}+6 (max 29). If {type} = term, then interval-{interval} is not needed. - format-{format} is the date format for key aggregation. The default value is yyyy-MM-dd-hh:mm:ss. - {collect_fct} is the aggregation function to apply to collections on the specified {collect_field}. {collect_fct} possible values are : avg,cardinality,max,min,sum,geobbox,geocentroid - (collect_field,collect_fct) should both be specified, except when collect_fct = `geobbox` or `geocentroid`, it could be specified alone. The metrics `geobbox` and `geocentroid` are returned as features collections. - {order} is set to sort the aggregation buckets on the field name, on the count of the buckets or on the the result of a metric sub-aggregation. Its values are 'asc' or 'desc'. - {on} is set to specify whether the {order} is on the field name, on the count of the aggregation or on the result of a metric sub-aggregation. Its values are 'field', 'count' or 'result'. - When {on} = `result`, then (collect_field,collect_fct) should be specified. Except when {collect_fct} = `geobbox` or `geocentroid`, then {on}=`result` is prohibited - {size} Defines how many buckets should be returned. - {include} Specifies the values for which buckets will be created. This values are comma separated. If one value is specified then regular expressions can be used (only in this case) and buckets matching them will be created. If more than one value are specified then only buckets matching the exact values will be created. - aggregated_geometries > What it does: Allows to specify a list of aggregated forms of geometries that represent the bucket. > Syntax: `aggregated_geometries-{COMMA_SEPARATED_AGGREGATED_GEOMETRIES}`. > Available aggregated geometries: `centroid, bbox, cell, cell_center`. - centroid: returns the centroid of data inside the bucket. - bbox: returns the data extent (bbox) in each bucket. - cell: returns the cell (zxy or geohash) extent of each bucket. This form is supported for geohash and geotile aggregation type only. - cell_center: returns the cell center of each bucket. This form is supported for geohash and geotile aggregation type only. > Response: Each bucket of the aggregation will be represented with as many features (in a feature collection) as there are specified aggregated geometries. The properties of each feature has : - geometry_ref attribute that informs which aggregated form is returned - geometry_type attribute set to aggregated > Example: `aggregated_geometries-bbox,geohash` - raw_geometries > What it does: Allows to specify a list of raw geometries provided by hits that represent the bucket and that are elected by a sort > Syntax: `raw_geometries-{GEOMETRY_FIELD}({COMMA_SEPERATED_SORT_FIELDS});{GEOMETRY_FIELD2}({COMMA_SEPERATED_SORT_FIELDS2})`. > Available raw geometries: any field of the collection whose type is geo-point or geo-shape. - sort fields are optional. If no sort is specified, an ascending sort on `collection.params.timestamp_path` is applied - a sort field can be preceded by '-' for descending sort. Otherwise the sort is ascending > Response: each bucket of the aggregation will be represented with as many features (in a feature collection) as there are specified raw geometries. The properties of each feature has : - geometry_ref attribute that informs which geometry path is returned - geometry_type attribute set to raw - geometry_sort attribute that informs how the geometry path is fetched (with what sort) > Example: `raw_geometries-geo_field1,geo_field2 || raw_geometries-geo_field(-field1,field2)` || raw_geometries-geo_field1(field1);geo_field2(field2,field3) - fetch_hits > What it does: Specifies the number of hits to retrieve inside each aggregation bucket and which fields to include in the hits. > Syntax: `fetch_hits-{sizeOfHitsToFetch}(+{field1}, {field2}, -{field3}, ...)`. > Note 1: `{sizeOfHitsToFetch}` is optional, if not specified, 1 is considered as default. > Note 2: `{field}` can be preceded by + or - for ascending or descending sort of the hits. Order matters. > Example: `fetch_hits-3(-timestamp, geometry)`. Fetches the 3 last positions for each bucket. agg parameter is multiple. The first (main) aggregation must be geohash or geotile. Every agg parameter specified is a subaggregation of the previous one : order matters. For more details, check https://github.com/gisaia/ARLAS-server/blob/master/docs/arlas-api-exploration.md
f? string[] A triplet for filtering the result. Multiple filter can be provided in distinct parameters (AND operator is applied) or in the same parameter separated by semi-colons (OR operator is applied). The order does not matter. - A triplet is composed of a field name, a comparison operator and a value. The possible values of the comparison operator are : Operator -- Description -- value type :eq: -- {fieldName} equals {comma separated values}. OR operation is applied for the specified values -- numeric or strings :ne: -- {fieldName} must not equal {comma separated values }. AND operation is applied for the specified values -- numeric or strings :like: -- {fieldName} is like {value} -- numeric or strings :gte: -- {fieldName} is greater than or equal to {value} -- numeric :gt: -- {fieldName} is greater than {value} -- numeric :lte: -- {fieldName} is less than or equal to {value} -- numeric :lt: -- {fieldName} is less than {value} -- numeric :range: -- {fieldName} is between `{comma separated [min<max] values}`. OR operation is applied for the specified ranges -- numeric or strings. If the field's type is date, then min & max should be timestamps in millisecond or a Date expression :within: -- {GeofieldName}` is within the `{given WKT string or the given BBOX }` -- a WKT string or the BBOX string : `\"west, south, east, north\"` :notwithin: -- {GeofieldName} is not within the `{given WKT string or the given BBOX }` -- a WKT string or the BBOX string : `\"west, south, east, north\"` :intersects: -- {GeofieldName} intersects the `{given WKT string or the given BBOX }` | a WKT string or the BBOX string : `\"west, south, east, north\"` :notintersects: -- {GeofieldName} does not intersect the `{given WKT string or the given }` -- a WKT string or the BBOX string : `\"west, south, east, north\"`
q? string[] A full text search. Optionally, it's possible to search on a field using this syntax: {fieldname}:{text}
dateformat? string The format of dates. This parameter should be set only if a date field is queried in `f` param; when using `gt`, `lt`, `gte`, `lte` and `range` operations
righthand? boolean If righthand = true, the passed WKT should be counter clock-wise; otherwise, ARLAS-server will attempt to parse it as the \"Complementary\" Polygon on the other facet of the planet. Inversely, If righthand = false, the passed WKT should be clock-wise; otherwise, ARLAS-server will attempt to parse it as the \"Complementary\" Polygon on the other facet of the planet.
pretty? boolean Pretty print
max_age_cache? number max-age-cache
options? any Override http request option.

Returns

Promise<Response>

Inherited from

ExploreApi.shapeaggregate

Defined in

node_modules/arlas-api/api.d.ts:2571

shapeaggregatePost

▸ shapeaggregatePost(collection, body?, pretty?, max_age_cache?, options?): Promise<Response>

Aggregate the elements in the collection(s) as features, given the filters and the aggregation parameters, and returns a shapefile of it.

Summary

ShapeAggregate

Throws

Memberof

ExploreApi

Parameters

Name Type Description
collection string collection
body? AggregationsRequest
pretty? boolean Pretty print
max_age_cache? number max-age-cache
options? any Override http request option.

Returns

Promise<Response>

Inherited from

ExploreApi.shapeaggregatePost

Defined in

node_modules/arlas-api/api.d.ts:2583

shapesearch

▸ shapesearch(collection, f?, q?, dateformat?, righthand?, pretty?, include?, exclude?, returned_geometries?, size?, from?, sort?, after?, before?, max_age_cache?, options?): Promise<Response>

Search and return the elements found in the collection(s) as features, given the filters, exported as a Shapefile

Summary

ShapeSearch

Throws

Memberof

ExploreApi

Parameters

Name Type Description
collection string collection
f? string[] A triplet for filtering the result. Multiple filter can be provided in distinct parameters (AND operator is applied) or in the same parameter separated by semi-colons (OR operator is applied). The order does not matter. - A triplet is composed of a field name, a comparison operator and a value. The possible values of the comparison operator are : Operator -- Description -- value type :eq: -- {fieldName} equals {comma separated values}. OR operation is applied for the specified values -- numeric or strings :ne: -- {fieldName} must not equal {comma separated values }. AND operation is applied for the specified values -- numeric or strings :like: -- {fieldName} is like {value} -- numeric or strings :gte: -- {fieldName} is greater than or equal to {value} -- numeric :gt: -- {fieldName} is greater than {value} -- numeric :lte: -- {fieldName} is less than or equal to {value} -- numeric :lt: -- {fieldName} is less than {value} -- numeric :range: -- {fieldName} is between `{comma separated [min<max] values}`. OR operation is applied for the specified ranges -- numeric or strings. If the field's type is date, then min & max should be timestamps in millisecond or a Date expression :within: -- {GeofieldName}` is within the `{given WKT string or the given BBOX }` -- a WKT string or the BBOX string : `\"west, south, east, north\"` :notwithin: -- {GeofieldName} is not within the `{given WKT string or the given BBOX }` -- a WKT string or the BBOX string : `\"west, south, east, north\"` :intersects: -- {GeofieldName} intersects the `{given WKT string or the given BBOX }` | a WKT string or the BBOX string : `\"west, south, east, north\"` :notintersects: -- {GeofieldName} does not intersect the `{given WKT string or the given }` -- a WKT string or the BBOX string : `\"west, south, east, north\"`
q? string[] A full text search. Optionally, it's possible to search on a field using this syntax: {fieldname}:{text}
dateformat? string The format of dates. This parameter should be set only if a date field is queried in `f` param; when using `gt`, `lt`, `gte`, `lte` and `range` operations
righthand? boolean If righthand = true, the passed WKT should be counter clock-wise; otherwise, ARLAS-server will attempt to parse it as the \"Complementary\" Polygon on the other facet of the planet. Inversely, If righthand = false, the passed WKT should be clock-wise; otherwise, ARLAS-server will attempt to parse it as the \"Complementary\" Polygon on the other facet of the planet.
pretty? boolean Pretty print
include? string[] List the name patterns of the field to be included in the result. Separate patterns with a comma.
exclude? string[] List the name patterns of the field to be excluded in the result. Separate patterns with a comma.
returned_geometries? string Comma separated geometry field_paths to be included in the result. If not specified, only geometry_path is returned. If geometry_path is null, then centroid_path is returned
size? number The maximum number of entries or sub-entries to be returned. The default value is 10
from? number From index to start the search from. Defaults to 0.
sort? string[] Sorts the resulted hits on the given fields and/or by distance to a given point: > Syntax: `{field1},{field2},-{field3},geodistance:{lat} {lon},{field4} ...`. > Note 1: `{field}` can be preceded by '-' for descending sort. By default, sort is ascending. > Note 2: The order of fields matters. > Note 3 geodistance sort: Sorts the hits centroids by distance to the given {lat} {lon} (ascending distance sort). It can be specified at most 1 time. > Example 1: sort=`age,-timestamp`. Resulted hits are sorted by age. For same age hits, they are decreasingly sorted in time. > Example 2: sort=`age,geodistance:89 179`. Resulted hits are sorted by age. For same age hits, they are sorted by closest distance to the point(89°,179°)
after? string List of values of fields present in sort param that are used to search after. > What it does: Retrieve the data placed after the pointed element, given the provided order (sort). > Restriction 1: after param works only combined with sort param. > Syntax: `after={value1},{value2},...,{valueN} & sort={field1},{field2},...,{fieldN}`. > Note 1: {value1}` and `{value2}` are the values of `{field1}` and `{field2}` in the last hit returned in the previous search > Note 2: The order of fields and values matters. {value1},{value2} must be in the same order of {field1},{field2} in sort param > Note 3: The last field `{fieldN}` must be the id field specified in the collection collection.params.idPath (returned as md.id) and `{valueN}` its corresponding value. > Example: sort=`-date,id` & after=`01/02/2019,abcd1234`. Gets the following hits of the previous search that stopped at date 01/02/2019 and id abcd1234*. > Restriction 2: from param must be set to 0 or kept unset
before? string Same idea that after param, but to retrieve the data placed before the pointed element, given the provided order (sort).
max_age_cache? number max-age-cache
options? any Override http request option.

Returns

Promise<Response>

Inherited from

ExploreApi.shapesearch

Defined in

node_modules/arlas-api/api.d.ts:2606

shapesearchPost

▸ shapesearchPost(collection, body?, pretty?, max_age_cache?, options?): Promise<Response>

Search and return the elements found in the collection(s) as features, given the filters, exported as a Shapefile

Summary

ShapeSearch

Throws

Memberof

ExploreApi

Parameters

Name Type Description
collection string collection
body? Search
pretty? boolean Pretty print
max_age_cache? number max-age-cache
options? any Override http request option.

Returns

Promise<Response>

Inherited from

ExploreApi.shapesearchPost

Defined in

node_modules/arlas-api/api.d.ts:2618

suggest

▸ suggest(collections, f?, q?, pretty?, size?, from?, field?, max_age_cache?, options?): Promise<Response>

Suggest the the n (n=size) most relevant terms given the filters

Summary

Suggest

Throws

Memberof

ExploreApi

Parameters

Name Type Description
collections string collections, comma separated
f? string[] A triplet for filtering the result. Multiple filter can be provided. The order does not matter. - A triplet is composed of a field name, a comparison operator and a value. The possible values of the comparison operator are : Operator | Description | value type : | {fieldName} equals {value} | numeric or strings :gte: | {fieldName} is greater than or equal to {value} | numeric :gt: | {fieldName} is greater than {value} | numeric :lte: | {fieldName} is less than or equal to {value} | numeric :lt: | {fieldName} is less than {value} | numeric - The AND operator is applied between filters having different fieldNames. - The OR operator is applied on filters having the same fieldName. - If the fieldName starts with - then a must not filter is used - If the fieldName starts with - then a must not filter is used For more details, check https://gitlab.com/GISAIA.ARLAS/ARLAS-server/blob/master/doc/api/API-definition.md
q? string A full text search
pretty? boolean Pretty print
size? number The maximum number of entries or sub-entries to be returned. The default value is 10
from? number From index to start the search from. Defaults to 0.
field? string Name of the field to be used for retrieving the most relevant terms
max_age_cache? number max-age-cache
options? any Override http request option.

Returns

Promise<Response>

Inherited from

ExploreApi.suggest

Defined in

node_modules/arlas-api/api.d.ts:2634

tiledgeosearch

▸ tiledgeosearch(collection, x, y, z, f?, q?, dateformat?, righthand?, pretty?, flat?, include?, exclude?, returned_geometries?, size?, from?, sort?, after?, before?, max_age_cache?, options?): Promise<FeatureCollection>

Search and return the elements found in the collection(s) and localized in the given tile(x,y,z) as features, given the filters

Summary

Tiled GeoSearch

Throws

Memberof

ExploreApi

Parameters

Name Type Description
collection string collection
x number x
y number y
z number z
f? string[] A triplet for filtering the result. Multiple filter can be provided in distinct parameters (AND operator is applied) or in the same parameter separated by semi-colons (OR operator is applied). The order does not matter. - A triplet is composed of a field name, a comparison operator and a value. The possible values of the comparison operator are : Operator -- Description -- value type :eq: -- {fieldName} equals {comma separated values}. OR operation is applied for the specified values -- numeric or strings :ne: -- {fieldName} must not equal {comma separated values }. AND operation is applied for the specified values -- numeric or strings :like: -- {fieldName} is like {value} -- numeric or strings :gte: -- {fieldName} is greater than or equal to {value} -- numeric :gt: -- {fieldName} is greater than {value} -- numeric :lte: -- {fieldName} is less than or equal to {value} -- numeric :lt: -- {fieldName} is less than {value} -- numeric :range: -- {fieldName} is between `{comma separated [min<max] values}`. OR operation is applied for the specified ranges -- numeric or strings. If the field's type is date, then min & max should be timestamps in millisecond or a Date expression :within: -- {GeofieldName}` is within the `{given WKT string or the given BBOX }` -- a WKT string or the BBOX string : `\"west, south, east, north\"` :notwithin: -- {GeofieldName} is not within the `{given WKT string or the given BBOX }` -- a WKT string or the BBOX string : `\"west, south, east, north\"` :intersects: -- {GeofieldName} intersects the `{given WKT string or the given BBOX }` | a WKT string or the BBOX string : `\"west, south, east, north\"` :notintersects: -- {GeofieldName} does not intersect the `{given WKT string or the given }` -- a WKT string or the BBOX string : `\"west, south, east, north\"`
q? string[] A full text search. Optionally, it's possible to search on a field using this syntax: {fieldname}:{text}
dateformat? string The format of dates. This parameter should be set only if a date field is queried in `f` param; when using `gt`, `lt`, `gte`, `lte` and `range` operations
righthand? boolean If righthand = true, the passed WKT should be counter clock-wise; otherwise, ARLAS-server will attempt to parse it as the \"Complementary\" Polygon on the other facet of the planet. Inversely, If righthand = false, the passed WKT should be clock-wise; otherwise, ARLAS-server will attempt to parse it as the \"Complementary\" Polygon on the other facet of the planet.
pretty? boolean Pretty print
flat? boolean Flats the property map: only key/value on one level
include? string[] List the name patterns of the field to be included in the result. Separate patterns with a comma.
exclude? string[] List the name patterns of the field to be excluded in the result. Separate patterns with a comma.
returned_geometries? string Comma separated geometry field_paths to be included in the result. If not specified, only geometry_path is returned. If geometry_path is null, then centroid_path is returned
size? number The maximum number of entries or sub-entries to be returned. The default value is 10
from? number From index to start the search from. Defaults to 0.
sort? string[] Sorts the resulted hits on the given fields and/or by distance to a given point: > Syntax: `{field1},{field2},-{field3},geodistance:{lat} {lon},{field4} ...`. > Note 1: `{field}` can be preceded by '-' for descending sort. By default, sort is ascending. > Note 2: The order of fields matters. > Note 3 geodistance sort: Sorts the hits centroids by distance to the given {lat} {lon} (ascending distance sort). It can be specified at most 1 time. > Example 1: sort=`age,-timestamp`. Resulted hits are sorted by age. For same age hits, they are decreasingly sorted in time. > Example 2: sort=`age,geodistance:89 179`. Resulted hits are sorted by age. For same age hits, they are sorted by closest distance to the point(89°,179°)
after? string List of values of fields present in sort param that are used to search after. > What it does: Retrieve the data placed after the pointed element, given the provided order (sort). > Restriction 1: after param works only combined with sort param. > Syntax: `after={value1},{value2},...,{valueN} & sort={field1},{field2},...,{fieldN}`. > Note 1: {value1}` and `{value2}` are the values of `{field1}` and `{field2}` in the last hit returned in the previous search > Note 2: The order of fields and values matters. {value1},{value2} must be in the same order of {field1},{field2} in sort param > Note 3: The last field `{fieldN}` must be the id field specified in the collection collection.params.idPath (returned as md.id) and `{valueN}` its corresponding value. > Example: sort=`-date,id` & after=`01/02/2019,abcd1234`. Gets the following hits of the previous search that stopped at date 01/02/2019 and id abcd1234*. > Restriction 2: from param must be set to 0 or kept unset
before? string Same idea that after param, but to retrieve the data placed before the pointed element, given the provided order (sort).
max_age_cache? number max-age-cache
options? any Override http request option.

Returns

Promise<FeatureCollection>

Inherited from

ExploreApi.tiledgeosearch

Defined in

node_modules/arlas-api/api.d.ts:2661

tiledgeosearch1

▸ tiledgeosearch1(collection, x, y, z, f?, q?, dateformat?, righthand?, size?, from?, sort?, after?, before?, sampling?, coverage?, max_age_cache?, options?): Promise<Response>

Search and return the elements found in the collection(s) and localized in the given tile(x,y,z) as features, given the filters

Summary

Tiled GeoSearch

Throws

Memberof

ExploreApi

Parameters

Name Type Description
collection string collection
x number x
y number y
z number z
f? string[] A triplet for filtering the result. Multiple filter can be provided in distinct parameters (AND operator is applied) or in the same parameter separated by semi-colons (OR operator is applied). The order does not matter. - A triplet is composed of a field name, a comparison operator and a value. The possible values of the comparison operator are : Operator -- Description -- value type :eq: -- {fieldName} equals {comma separated values}. OR operation is applied for the specified values -- numeric or strings :ne: -- {fieldName} must not equal {comma separated values }. AND operation is applied for the specified values -- numeric or strings :like: -- {fieldName} is like {value} -- numeric or strings :gte: -- {fieldName} is greater than or equal to {value} -- numeric :gt: -- {fieldName} is greater than {value} -- numeric :lte: -- {fieldName} is less than or equal to {value} -- numeric :lt: -- {fieldName} is less than {value} -- numeric :range: -- {fieldName} is between `{comma separated [min<max] values}`. OR operation is applied for the specified ranges -- numeric or strings. If the field's type is date, then min & max should be timestamps in millisecond or a Date expression :within: -- {GeofieldName}` is within the `{given WKT string or the given BBOX }` -- a WKT string or the BBOX string : `\"west, south, east, north\"` :notwithin: -- {GeofieldName} is not within the `{given WKT string or the given BBOX }` -- a WKT string or the BBOX string : `\"west, south, east, north\"` :intersects: -- {GeofieldName} intersects the `{given WKT string or the given BBOX }` | a WKT string or the BBOX string : `\"west, south, east, north\"` :notintersects: -- {GeofieldName} does not intersect the `{given WKT string or the given }` -- a WKT string or the BBOX string : `\"west, south, east, north\"`
q? string[] A full text search. Optionally, it's possible to search on a field using this syntax: {fieldname}:{text}
dateformat? string The format of dates. This parameter should be set only if a date field is queried in `f` param; when using `gt`, `lt`, `gte`, `lte` and `range` operations
righthand? boolean If righthand = true, the passed WKT should be counter clock-wise; otherwise, ARLAS-server will attempt to parse it as the \"Complementary\" Polygon on the other facet of the planet. Inversely, If righthand = false, the passed WKT should be clock-wise; otherwise, ARLAS-server will attempt to parse it as the \"Complementary\" Polygon on the other facet of the planet.
size? number The maximum number of entries or sub-entries to be returned. The default value is 10
from? number From index to start the search from. Defaults to 0.
sort? string[] Sorts the resulted hits on the given fields and/or by distance to a given point: > Syntax: `{field1},{field2},-{field3},geodistance:{lat} {lon},{field4} ...`. > Note 1: `{field}` can be preceded by '-' for descending sort. By default, sort is ascending. > Note 2: The order of fields matters. > Note 3 geodistance sort: Sorts the hits centroids by distance to the given {lat} {lon} (ascending distance sort). It can be specified at most 1 time. > Example 1: sort=`age,-timestamp`. Resulted hits are sorted by age. For same age hits, they are decreasingly sorted in time. > Example 2: sort=`age,geodistance:89 179`. Resulted hits are sorted by age. For same age hits, they are sorted by closest distance to the point(89°,179°)
after? string List of values of fields present in sort param that are used to search after. > What it does: Retrieve the data placed after the pointed element, given the provided order (sort). > Restriction 1: after param works only combined with sort param. > Syntax: `after={value1},{value2},...,{valueN} & sort={field1},{field2},...,{fieldN}`. > Note 1: {value1}` and `{value2}` are the values of `{field1}` and `{field2}` in the last hit returned in the previous search > Note 2: The order of fields and values matters. {value1},{value2} must be in the same order of {field1},{field2} in sort param > Note 3: The last field `{fieldN}` must be the id field specified in the collection collection.params.idPath (returned as md.id) and `{valueN}` its corresponding value. > Example: sort=`-date,id` & after=`01/02/2019,abcd1234`. Gets the following hits of the previous search that stopped at date 01/02/2019 and id abcd1234*. > Restriction 2: from param must be set to 0 or kept unset
before? string Same idea that after param, but to retrieve the data placed before the pointed element, given the provided order (sort).
sampling? number Size of the sampling for testing transparency: 1: test every pixel, 10: test 1 pixel every 10 pixels, etc.
coverage? number Percentage (]0-100]) of acceptable transparent pixels. Higher the percentage, more tiles could be used for filling the tile
max_age_cache? number max-age-cache
options? any Override http request option.

Returns

Promise<Response>

Inherited from

ExploreApi.tiledgeosearch1

Defined in

node_modules/arlas-api/api.d.ts:2685