CoverageApi | @here/olp-sdk-ts

Index

Interfaces

Functions

getDataCoverageAdminAreas

getDataCoverageAdminAreas(builder: RequestBuilder, params: { datalevel: string; layerId: string }): 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: { datalevel: string; layerId: string }
  - datalevel: string
  - layerId: string
Returns Promise<CatalogAdminAreas>

getDataCoverageSizeMap

getDataCoverageSizeMap(builder: RequestBuilder, params: { datalevel?: number; layerId: string }): 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: { datalevel?: number; layerId: string }
  - Optional datalevel?: number
  - layerId: string
Returns Promise<Response>

getDataCoverageSummary

getDataCoverageSummary(builder: RequestBuilder, params: { layerId: string }): 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: { layerId: string }
  - layerId: string
Returns Promise<CoverageApi.LayerSummary>

getDataCoverageTile

getDataCoverageTile(builder: RequestBuilder, params: { datalevel?: number; layerId: string }): 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: { datalevel?: number; layerId: string }
  - Optional datalevel?: number
  - layerId: string
Returns Promise<Response>

getDataCoverageTimeMap

getDataCoverageTimeMap(builder: RequestBuilder, params: { catalogHRN: string; datalevel?: number; layerId: string }): 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: { catalogHRN: string; datalevel?: number; layerId: string }
  - catalogHRN: string
  - Optional datalevel?: number
  - layerId: string
Returns Promise<Response>

Index

Interfaces

Functions

Functions

getDataCoverageAdminAreas

Parameters

builder: RequestBuilder

params: { datalevel: string; layerId: string }

datalevel: string

layerId: string

Returns Promise<CatalogAdminAreas>

getDataCoverageSizeMap

Parameters

builder: RequestBuilder

params: { datalevel?: number; layerId: string }

Optional datalevel?: number

layerId: string

Returns Promise<Response>

getDataCoverageSummary

Parameters

builder: RequestBuilder

params: { layerId: string }

layerId: string

Returns Promise<CoverageApi.LayerSummary>

getDataCoverageTile

Parameters

builder: RequestBuilder

params: { datalevel?: number; layerId: string }

Optional datalevel?: number

layerId: string

Returns Promise<Response>

getDataCoverageTimeMap

Parameters

builder: RequestBuilder

params: { catalogHRN: string; datalevel?: number; layerId: string }

catalogHRN: string

Optional datalevel?: number

layerId: string

Returns Promise<Response>