StatisticsClient | @here/olp-sdk-ts
Class StatisticsClient
Hierarchy
- StatisticsClient
Index
Constructors
Methods
Constructors
constructor
Creates the StatisticsClient instance.
Parameters
settings: OlpClientSettings
The OlpClientSettings instance.
Returns StatisticsClient
The StatisticsClient instance.
Methods
get
Depending on the map type that you specify in the StatisticsRequest instance, gets the StatisticsRequest instance with one of the following settings:
- BITMAP – fetches a bitmap that represents the availability of data in partitions.
- SIZEMAP – fetches a heatmap that represents a partition size.
- TIMEMAP – fetches a heatmap that represents partition update time.
Parameters
statisticsRequest: StatisticsRequest
The StatisticsRequest instance with the requested settings.
Returns Promise<Response>
The [StatisticsRequest]] instance with the requested settings.
get
Fetches and returns a layer summary from the platform Statistics Service.
Parameters
summaryRequest: SummaryRequest
Parameters that are needed to fetch the layer summary. Includes catalogHrn and layerId.
Returns Promise<CoverageApi.LayerSummary>
A promise with the layer summary.
Generated using TypeDoc
A client for the platform Statistics Service.