Namespace: customLocation

H.service.extension.customLocation

This namespace contains classes related to the "Bring Your Own Data" use case of the HERE Fleet Telematics API.

It enables creation, modification, fetching and rendering of the custom data layers.

Classes

Service
Table
TileProvider

Members

H.service.extension.customLocation.Permission string Deprecated : since 3.1.63.0 static

The access permissions types which can be granted to other app_ids.

Properties:
Name Description
READ
WRITE
EXPORT
See:

H.service.extension.customLocation.Storage string Deprecated : since 3.1.63.0 static

The storage type of a custom data layer.

Properties:
Name Description
READONLY
UPDATABLE
See:

Type Definitions

H.service.extension.customLocation.Grant Object Deprecated : since 3.1.63.0

An object that contains access permissions for a data layer that are granted for a specified app_id.

Properties:
Name Type Description
grantedAppId string

The ID of the Application for which the permissions are specified.
permissions Array.<!H.service.extension.customLocation.Permission>

The access rights that are granted. An empty list means no permissions are granted.
See:

H.service.extension.customLocation.LayerConfig Object Deprecated : since 3.1.63.0

A LayerConfig is an object that contains a configuration for a custom data layer.

Properties:
Name Type Argument Description
layerId string

The unique ID of the layer.
rowFilter H.service.extension.RowFilter <optional>

An optional function to filter out rows from the tile response. If defined, it must be a pure function.
rowFilterContext Object <optional>

The JavaScript execution context of the rowFilter function. The this within the rowFilter will be the specified object. For performance reasons it is recommended that this object contains only the necessary information. Functions are not allowed.
columns Array.<string> <optional>

An optional list of column names to keep for each row. By default all columns are kept.

H.service.extension.customLocation.MetaInfo Object Deprecated : since 3.1.63.0

An object that contains meta information of a data layer.

Properties:
Name Type Description
layerId string

The id of the data layer. It must conform to the naming rules /^[A-Z][A-Z0-9_]*$/.
columnNames Array.<string>

The ordered list of names for the data layer's attribute columns. Each column name must conform to the naming rules /^[A-Z][A-Z0-9_]*$/. A data layer has two special intrinsic columns which must be always specified:

  1. "GEOMETRY_ID" This column must be specified as the second last column if the MetaInfo is used to create a new data layer H.service.extension.customLocation.Service#createLayer It represents the ID of a record (a.k.a. row) within a data layer.
  2. "WKT" This column must be specified as the last column if the MetaInfo is used to create a new data layer H.service.extension.customLocation.Service#createLayer It represents the geometry data of a data record and must be always the last column. The backend stores this data formatted as a Well-Known-Text (WKT) string but the client API converts it automatically into a specific implementation of the H.geo.AbstractGeometry and vice versa.
level undefined | number

The level of detail. It specifies the level were the tiles stored in the backend. If not defined, the default level of the backend is used (see API Reference for more details.
storage undefined | H.service.extension.customLocation.Storage

The storage type of the data layer. It can be only set if the MetaInfo is used to create a new data layer (see H.service.extension.customLocation.Service#createLayer). If not defined, the default storage type of the backend is used.
grants undefined | !Array.<!H.service.extension.customLocation.Grant>

The settings to grant other app_ids access the data layer. See API Reference fore more details.
lastUpdateTimestamp undefined | number

A read-only property that provide the timestamp in ms (since Jan 01 1970 UTC) when the data layer was modified on the backend.
Example
myMetaInfo = {
    layerId: "MY_LAYER",
    columnNames: ["NAME", "ADDRESS", "GEOMETRY_ID", "WKT"]
  }