Class JsonDataProvider

A data provider that fetches data from a JSON file.

The JSON file should be an array of objects, where each object represents a single "row" of data.

Example

format of a JSON file:

 [{
     "region": "12",
     "date": "2022-01-01",
     "metric1": 0.1
  },
 {
     "region": "25",
     "date": "2022-01-01",
     "metric1": 0.5
 }]

Hierarchy

SimpleMetricDataProviderBase
- JsonDataProvider

Index

Constructors

constructor

new JsonDataProvider(providerId: string, options: JsonDataProviderOptions): JsonDataProvider
Parameters
- providerId: string
- options: JsonDataProviderOptions
Returns JsonDataProvider
Overrides SimpleMetricDataProviderBase.constructor
- Defined in src/metrics/data_providers/JsonDataProvider.ts:62

Properties

`Private` dataRowsByRegionId

dataRowsByRegionId: undefined | Promise<{
[regionId: string]: DataRow[];
}>

`Private` `Optional` `Readonly` dateField

dateField?: string

`Readonly` id

id: string

A unique provider id to associate with the provider (e.g. "mock"). This ID can be used from a MetricDataReference in a metric to reference the data from this provider.

`Private` `Readonly` regionDb

regionDb: RegionDB

`Private` `Readonly` regionField

regionField: string

`Private` `Optional` `Readonly` url

url?: string

Methods

fetchData

fetchData(regions: Region[], metrics: Metric[], includeTimeseries: boolean, metricCatalog: MetricCatalog): Promise<MultiRegionMultiMetricDataStore<unknown>>
Fetches all of the data for the specified regions and metrics, optionally including timeseries metric data if available.

Returns
The fetched data for the specified regions and metrics.
Parameters
- regions: Region[]
  
  One or more regions to fetch data for.
- metrics: Metric[]
  
  One or more metrics to fetch data for.
- includeTimeseries: boolean
  
  Whether to fetch timeseries data.
- metricCatalog: MetricCatalog
  
  The metric catalog using this data provider. The data provider can call back into the catalog if it needs to fetch dependent data.
Returns Promise<MultiRegionMultiMetricDataStore<unknown>>
Inherited from SimpleMetricDataProviderBase.fetchData
- Defined in src/metrics/data_providers/SimpleMetricDataProviderBase.ts:40

fetchDataForRegionAndMetric

fetchDataForRegionAndMetric(region: Region, metric: Metric): Promise<MetricData<unknown>>
Method to be overridden by subclasses to fetch the specified MetricData.

Returns
The MetricData for the given metric and region.
Parameters
- region: Region
  
  The region to get data for.
- metric: Metric
  
  The metric to get data for.
Returns Promise<MetricData<unknown>>
Overrides SimpleMetricDataProviderBase.fetchDataForRegionAndMetric
- Defined in src/metrics/data_providers/JsonDataProvider.ts:96

`Private` getDataForCache

getDataForCache(jsonData?: DataRow[]): Promise<{
[regionId: string]: DataRow[];
}>
Parameters
- Optional jsonData: DataRow[]
Returns Promise<{
[regionId: string]: DataRow[];
}>
- Defined in src/metrics/data_providers/JsonDataProvider.ts:77

Class JsonDataProvider

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

providerId: string

options: JsonDataProviderOptions

Returns JsonDataProvider

Properties

Private dataRowsByRegionId

Private Optional Readonly dateField

Readonly id

Private Readonly regionDb

Private Readonly regionField

Private Optional Readonly url

Methods

fetchData

Returns

Parameters

regions: Region[]

metrics: Metric[]

includeTimeseries: boolean

metricCatalog: MetricCatalog

Returns Promise<MultiRegionMultiMetricDataStore<unknown>>

fetchDataForRegionAndMetric

Returns

Parameters

region: Region

metric: Metric

Returns Promise<MetricData<unknown>>

Private getDataForCache

Parameters

Optional jsonData: DataRow[]

Returns Promise<{ [regionId: string]: DataRow[]; }>

Settings

Member Visibility

Theme

`Private` dataRowsByRegionId

`Private` `Optional` `Readonly` dateField

`Readonly` id

`Private` `Readonly` regionDb

`Private` `Readonly` regionField

`Private` `Optional` `Readonly` url

`Private` getDataForCache

`Optional` jsonData: DataRow[]

Returns Promise<{
[regionId: string]: DataRow[];
}>