Maps API for JavaScript Developer's Guide

H.service.extension.customLocation.MetaInfo

Type Definition Summary

An object that contains meta information of a CLE data layer.

[ For full details, see the Type Definition Details ]

Property Summary

Table 1. Properties
Properties

layerId

The ID of the data layer. It must conform to the CLE naming rules /^[A-Z][A-Z0-9_]*$/.

columnNames

The ordered list of names for the data layer's attribute columns. Each column name must conform to the CLE naming rules /^[A-Z][A-Z0-9_]*$/. A CLE 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 CLE 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 CLE record and must be always the last column. The backend stores this data formatted as a Well-Known-Text (WKT) string but the client CLE API converts the WKT string automatically into a H.geo.AbstractGeometry and vice versa.

level

The level of detail. It specifies the level were the tiles stored in the CLE backend. If not defined, the default level of the CLE backend is used (see CLE API Reference for more details.

storage

The storage type of the CLE 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 CLE backend is used.

grants

The settings to grant other App-IDs access the CLE data layer (see CLE API Reference fore more details)

lastUpdateTimestamp

A read-only property that provide the timestamp in ms (since Jan 01 1970 UTC) when the data layer was modified on the backend.

Type Definition Description

An object that contains meta information of a CLE data layer.

Example

  myMetaInfo = {
  layerId: "MY_LAYER",
  columnNames: ["NAME", "ADDRESS", "GEOMETRY_ID", "WKT"]
  }

Property Details

layerId: {!string}

The ID of the data layer. It must conform to the CLE 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 CLE naming rules /^[A-Z][A-Z0-9_]*$/. A CLE 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 CLE 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 CLE record and must be always the last column. The backend stores this data formatted as a Well-Known-Text (WKT) string but the client CLE API converts the WKT string automatically into a H.geo.AbstractGeometry and vice versa.

level: {(undefined | !number)}

The level of detail. It specifies the level were the tiles stored in the CLE backend. If not defined, the default level of the CLE backend is used (see CLE API Reference for more details.

storage: {(undefined | !H.service.extension.customLocation.Storage)}

The storage type of the CLE 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 CLE backend is used.

grants: {(undefined | !Array<!H.service.extension.customLocation.Grant>)}

The settings to grant other App-IDs access the CLE data layer (see CLE 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.