Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Type Aliases

Estimated: boolean

True if the value is only an estimation; false otherwise.

SearchParams: { key: string; operator: "=" | "!=" | ">=" | "<=" | "<" | ">" | "@>"; value: string | number | ".null" }[]

Functions

  • deleteFeature(builder: RequestBuilder, params: { featureId: string; layerId: string }): Promise<Response>
  • deleteFeatures(builder: RequestBuilder, params: { id?: string[]; layerId: string }): Promise<Response>
  • getFeature(builder: RequestBuilder, params: { featureId: string; force2D?: boolean; layerId: string; selection?: string | string[] }): Promise<Feature>
  • Retrieves the feature with the provided identifier.

    summary

    Get a feature by ID.

    Parameters

    • builder: RequestBuilder
    • params: { featureId: string; force2D?: boolean; layerId: string; selection?: string | string[] }
      • featureId: string
      • Optional force2D?: boolean
      • layerId: string
      • Optional selection?: string | string[]

    Returns Promise<Feature>

  • getFeatures(builder: RequestBuilder, params: { force2D?: boolean; id: string | string[]; layerId: string; selection?: string | string[] }): Promise<FeatureCollection>
  • Returns all of the features found for the provided list of ids. The response is always a FeatureCollection, even if there are no features with the provided ids.

    summary

    Get features by ID.

    Parameters

    • builder: RequestBuilder
    • params: { force2D?: boolean; id: string | string[]; layerId: string; selection?: string | string[] }
      • Optional force2D?: boolean
      • id: string | string[]
      • layerId: string
      • Optional selection?: string | string[]

    Returns Promise<FeatureCollection>

  • getFeaturesByBBox(builder: RequestBuilder, params: { bbox?: number[]; clip?: boolean; clustering?: string; clusteringParams?: {}; force2D?: boolean; layerId: string; limit?: number; params?: SearchParams; selection?: string | string[]; skipCache?: boolean }): Promise<FeatureCollection>
  • Return the features which are inside a bounding box stipulated by bbox parameter.

    summary

    Get features by bounding box.

    Parameters

    • builder: RequestBuilder
    • params: { bbox?: number[]; clip?: boolean; clustering?: string; clusteringParams?: {}; force2D?: boolean; layerId: string; limit?: number; params?: SearchParams; selection?: string | string[]; skipCache?: boolean }

      Additional feature filters which compares the feature's property's value with the one specified in the query, resulting in a subset of features. The usage of multiple property names represents an AND operation. The usage of a comma (,) separating the properties values, represents an OR operation. Properties initiated with 'f.' are used to access values which are added by default in the stored feature. The possible values are: 'f.id', 'f.createdAt' and 'f.updatedAt'. Properties initiated with 'p.' are used to access values in the stored feature which are under the 'properties' property. Use it as a shorthand accessor for 'properties' values. The format should follow the specification below

      ?p.property_name_1=property_value_1&f.special_property_name_1=special_property_value_1
      

      For example, the above query, the Features will be filtered by 'property' AND 'special property' equals to their respective values.

      While in the following example ?p.property_name_1=value_1,value_2 The resulting Features list will contain all elements having value_1 OR value_2.

      Additionally to the operators used in the examples above, the query can be written, with the same semantic, by using the long operators: "=gte=", "=lte=", "=gt=", "=lt=" and "=cs=".

      The below queries yield the same result:

      ?p.property_name_1>=10
      ?p.property_name_1=gte=10

      The available operators are: "=" - equals "!=" - not equals ">=" or "=gte=" - greater than or equals "<=" or "=lte=" - less than or equals ">" or "=gt=" - greater than "<" or "=lt=" - less than "@>" or "=cs=" - contains

      • Optional bbox?: number[]
      • Optional clip?: boolean
      • Optional clustering?: string
      • Optional clusteringParams?: {}
        • [key: string]: string | number
      • Optional force2D?: boolean
      • layerId: string
      • Optional limit?: number
      • Optional params?: SearchParams
      • Optional selection?: string | string[]
      • Optional skipCache?: boolean

    Returns Promise<FeatureCollection>

  • getFeaturesBySpatial(builder: RequestBuilder, params: { force2D?: boolean; lat?: number; layerId: string; limit?: number; lng?: number; params?: SearchParams; radius?: number; refCatalogHrn?: string; refFeatureId?: string; refLayerId?: string; selection?: string | string[]; skipCache?: boolean }): Promise<FeatureCollection>
  • List the features which are inside the specified radius. The origin radius point is calculated based either on latitude & longitude or by specifying a feature's geometry.

    summary

    Get features with radius search.

    Parameters

    • builder: RequestBuilder
    • params: { force2D?: boolean; lat?: number; layerId: string; limit?: number; lng?: number; params?: SearchParams; radius?: number; refCatalogHrn?: string; refFeatureId?: string; refLayerId?: string; selection?: string | string[]; skipCache?: boolean }

      Additional feature filters which compares the feature's property's value with the one specified in the query, resulting in a subset of features. The usage of multiple property names represents an AND operation. The usage of a comma (,) separating the properties values, represents an OR operation. Properties initiated with 'f.' are used to access values which are added by default in the stored feature. The possible values are: 'f.id', 'f.createdAt' and 'f.updatedAt'. Properties initiated with 'p.' are used to access values in the stored feature which are under the 'properties' property. Use it as a shorthand accessor for 'properties' values. The format should follow the specification below

      ?p.property_name_1=property_value_1&f.special_property_name_1=special_property_value_1
      

      For example, the above query, the Features will be filtered by 'property' AND 'special property' equals to their respective values.

      While in the following example ?p.property_name_1=value_1,value_2 The resulting Features list will contain all elements having value_1 OR value_2.

      Additionally to the operators used in the examples above, the query can be written, with the same semantic, by using the long operators: "=gte=", "=lte=", "=gt=", "=lt=" and "=cs=".

      The below queries yield the same result:

      ?p.property_name_1>=10
      ?p.property_name_1=gte=10

      The available operators are: "=" - equals "!=" - not equals ">=" or "=gte=" - greater than or equals "<=" or "=lte=" - less than or equals ">" or "=gt=" - greater than "<" or "=lt=" - less than "@>" or "=cs=" - contains

      • Optional force2D?: boolean
      • Optional lat?: number
      • layerId: string
      • Optional limit?: number
      • Optional lng?: number
      • Optional params?: SearchParams
      • Optional radius?: number
      • Optional refCatalogHrn?: string
      • Optional refFeatureId?: string
      • Optional refLayerId?: string
      • Optional selection?: string | string[]
      • Optional skipCache?: boolean

    Returns Promise<FeatureCollection>

  • List the features which are inside the specified radius. The origin point is calculated based on the geometry provided as payload.

    summary

    Get features which intersects the provided geometry.

    Parameters

    • builder: RequestBuilder
    • params: { body?: Feature | FeatureCollection | Geometry | LineString | MultiLineString | MultiPoint | MultiPolygon | Point | Polygon; force2D?: boolean; layerId: string; limit?: number; params?: SearchParams; radius?: number; selection?: string | string[]; skipCache?: boolean }

      Additional feature filters which compares the feature's property's value with the one specified in the query, resulting in a subset of features. The usage of multiple property names represents an AND operation. The usage of a comma (,) separating the properties values, represents an OR operation. Properties initiated with 'f.' are used to access values which are added by default in the stored feature. The possible values are: 'f.id', 'f.createdAt' and 'f.updatedAt'. Properties initiated with 'p.' are used to access values in the stored feature which are under the 'properties' property. Use it as a shorthand accessor for 'properties' values. The format should follow the specification below

      ?p.property_name_1=property_value_1&f.special_property_name_1=special_property_value_1
      

      For example, the above query, the Features will be filtered by 'property' AND 'special property' equals to their respective values.

      While in the following example ?p.property_name_1=value_1,value_2 The resulting Features list will contain all elements having value_1 OR value_2.

      Additionally to the operators used in the examples above, the query can be written, with the same semantic, by using the long operators: "=gte=", "=lte=", "=gt=", "=lt=" and "=cs=".

      The below queries yield the same result:

      ?p.property_name_1>=10
      ?p.property_name_1=gte=10

      The available operators are: "=" - equals "!=" - not equals ">=" or "=gte=" - greater than or equals "<=" or "=lte=" - less than or equals ">" or "=gt=" - greater than "<" or "=lt=" - less than "@>" or "=cs=" - contains

    Returns Promise<FeatureCollection>

  • getFeaturesByTile(builder: RequestBuilder, params: { clip?: boolean; clustering?: string; clusteringParams?: {}; force2D?: boolean; layerId: string; limit?: number; margin?: number; params?: SearchParams; selection?: string | string[]; skipCache?: boolean; tileId: string; tileType: string }): Promise<FeatureCollection>
  • Get features in tile

    Parameters

    • builder: RequestBuilder
    • params: { clip?: boolean; clustering?: string; clusteringParams?: {}; force2D?: boolean; layerId: string; limit?: number; margin?: number; params?: SearchParams; selection?: string | string[]; skipCache?: boolean; tileId: string; tileType: string }

      Additional feature filters which compares the feature's property's value with the one specified in the query, resulting in a subset of features. The usage of multiple property names represents an AND operation. The usage of a comma (,) separating the properties values, represents an OR operation. Properties initiated with 'f.' are used to access values which are added by default in the stored feature. The possible values are: 'f.id', 'f.createdAt' and 'f.updatedAt'. Properties initiated with 'p.' are used to access values in the stored feature which are under the 'properties' property. Use it as a shorthand accessor for 'properties' values. The format should follow the specification below

      ?p.property_name_1=property_value_1&f.special_property_name_1=special_property_value_1
      

      For example, the above query, the Features will be filtered by 'property' AND 'special property' equals to their respective values.

      While in the following example ?p.property_name_1=value_1,value_2 The resulting Features list will contain all elements having value_1 OR value_2.

      Additionally to the operators used in the examples above, the query can be written, with the same semantic, by using the long operators: "=gte=", "=lte=", "=gt=", "=lt=" and "=cs=".

      The below queries yield the same result:

      ?p.property_name_1>=10
      ?p.property_name_1=gte=10

      The available operators are: "=" - equals "!=" - not equals ">=" or "=gte=" - greater than or equals "<=" or "=lte=" - less than or equals ">" or "=gt=" - greater than "<" or "=lt=" - less than "@>" or "=cs=" - contains

      • Optional clip?: boolean
      • Optional clustering?: string
      • Optional clusteringParams?: {}
        • [key: string]: string | number
      • Optional force2D?: boolean
      • layerId: string
      • Optional limit?: number
      • Optional margin?: number
      • Optional params?: SearchParams
      • Optional selection?: string | string[]
      • Optional skipCache?: boolean
      • tileId: string
      • tileType: string

    Returns Promise<FeatureCollection>

  • iterateFeatures(builder: RequestBuilder, params: { force2D?: boolean; layerId: string; limit?: number; pageToken?: string; part?: number[]; selection?: string | string[]; skipCache?: boolean; sort?: string | string[] }): Promise<FeatureCollectionIterable>
  • Iterates all of the features in the layer. The features in the response are ordered so that no feature is returned twice. If there are more features, which could be loaded, the response FeatureCollection will contain the root attribute nextPageToken. The value of this attribute can be passed as a query parameter for the following request in order to continue the iteration from the marked position.

    summary

    Iterate features in the layer.

    Parameters

    • builder: RequestBuilder
    • params: { force2D?: boolean; layerId: string; limit?: number; pageToken?: string; part?: number[]; selection?: string | string[]; skipCache?: boolean; sort?: string | string[] }
      • Optional force2D?: boolean
      • layerId: string
      • Optional limit?: number
      • Optional pageToken?: string
      • Optional part?: number[]
      • Optional selection?: string | string[]
      • Optional skipCache?: boolean
      • Optional sort?: string | string[]

    Returns Promise<FeatureCollectionIterable>

  • Searches for features in the layer. The results are unordered and the request does not allow to continue the search, which is the main difference when compared to the iterate request.

    summary

    Search for features.

    Parameters

    • builder: RequestBuilder
    • params: { force2D?: boolean; layerId: string; limit?: number; params?: SearchParams; selection?: string | string[]; skipCache?: boolean }

      Additional feature filters which compares the feature's property's value with the one specified in the query, resulting in a subset of features. The usage of multiple property names represents an AND operation. The usage of a comma (,) separating the properties values, represents an OR operation. Properties initiated with 'f.' are used to access values which are added by default in the stored feature. The possible values are: 'f.id', 'f.createdAt' and 'f.updatedAt'. Properties initiated with 'p.' are used to access values in the stored feature which are under the 'properties' property. Use it as a shorthand accessor for 'properties' values. The format should follow the specification below

      ?p.property_name_1=property_value_1&f.special_property_name_1=special_property_value_1
      

      For example, the above query, the Features will be filtered by 'property' AND 'special property' equals to their respective values.

      While in the following example ?p.property_name_1=value_1,value_2 The resulting Features list will contain all elements having value_1 OR value_2.

      Additionally to the operators used in the examples above, the query can be written, with the same semantic, by using the long operators: "=gte=", "=lte=", "=gt=", "=lt=" and "=cs=".

      The below queries yield the same result:

      ?p.property_name_1>=10
      ?p.property_name_1=gte=10

      The available operators are: "=" - equals "!=" - not equals ">=" or "=gte=" - greater than or equals "<=" or "=lte=" - less than or equals ">" or "=gt=" - greater than "<" or "=lt=" - less than "@>" or "=cs=" - contains

      • Optional force2D?: boolean
      • layerId: string
      • Optional limit?: number
      • Optional params?: SearchParams
      • Optional selection?: string | string[]
      • Optional skipCache?: boolean

    Returns Promise<FeatureCollection>

Generated using TypeDoc