GuidesTypeScript API ReferencePython v2 API Reference

CoverageApi | @here/olp-sdk-ts

CoverageApi | @here/olp-sdk-ts
Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CoverageApi

Index

Interfaces

Functions

Functions

getDataCoverageAdminAreas

getDataCoverageSizeMap

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

getDataCoverageTile

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

Legend

  • Namespace
  • Variable
  • Function
  • Type alias
  • Class
  • Class with type parameter
  • Enumeration
  • Interface

Settings

Theme

Generated using TypeDoc