Jump to Content

CoverageApi

Index

Interfaces

Functions

Functions

getDataCoverageAdminAreas

getDataCoverageAdminAreas(builder: RequestBuilder, params: {</span>datalevel<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>layerId<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}): Promise<CatalogAdminAreas>

- Defined in @here/olp-sdk-dataservice-api/lib/coverage-api.ts:102

summary
Retrieve Admin Areas showing DataCoverage in world for provided layer Id and version

Parameters
- builder: RequestBuilder
- params: {</span>datalevel<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>layerId<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}
  - datalevel: string
  - layerId: string
Returns Promise<CatalogAdminAreas>

getDataCoverageSizeMap

getDataCoverageSizeMap(builder: RequestBuilder, params: {</span>datalevel<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">number</span><span class="typedoc-tsd-signature-symbol">; </span>layerId<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}): Promise<Response>

- Defined in @here/olp-sdk-dataservice-api/lib/coverage-api.ts:131

summary
Retrieve SizeMap data showing DataCoverage in world for provided layer id and version. API shows heatmap based on the partition size

Parameters
- builder: RequestBuilder
- params: {</span>datalevel<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">number</span><span class="typedoc-tsd-signature-symbol">; </span>layerId<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}
  - Optional datalevel?: number
  - layerId: string
Returns Promise<Response>

getDataCoverageSummary

getDataCoverageSummary(builder: RequestBuilder, params: {</span>layerId<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}): Promise<CoverageApi.LayerSummary>

- Defined in @here/olp-sdk-dataservice-api/lib/coverage-api.ts:158

summary
Retrieve Layer size data for provided layer id and version

Parameters
- builder: RequestBuilder
- params: {</span>layerId<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}
  - layerId: string
Returns Promise<CoverageApi.LayerSummary>

getDataCoverageTile

getDataCoverageTile(builder: RequestBuilder, params: {</span>datalevel<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">number</span><span class="typedoc-tsd-signature-symbol">; </span>layerId<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}): Promise<Response>

- Defined in @here/olp-sdk-dataservice-api/lib/coverage-api.ts:186

summary
Retrieve BitMap showing DataCoverage in world for provided layer id and version. API shows data coverage by partitions, so the user can see where on the world map there is a data for the specified catalog layer

Parameters
- builder: RequestBuilder
- params: {</span>datalevel<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">number</span><span class="typedoc-tsd-signature-symbol">; </span>layerId<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}
  - Optional datalevel?: number
  - layerId: string
Returns Promise<Response>

getDataCoverageTimeMap

getDataCoverageTimeMap(builder: RequestBuilder, params: {</span>catalogHRN<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>datalevel<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">number</span><span class="typedoc-tsd-signature-symbol">; </span>layerId<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}): Promise<Response>

- Defined in @here/olp-sdk-dataservice-api/lib/coverage-api.ts:214

summary
Retrieve TimeMap showing DataCoverage in world for provided layer id and version

Parameters
- builder: RequestBuilder
- params: {</span>catalogHRN<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>datalevel<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">number</span><span class="typedoc-tsd-signature-symbol">; </span>layerId<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}
  - catalogHRN: string
  - Optional datalevel?: number
  - layerId: string
Returns Promise<Response>

On this page