FEWS Web OC

@deltares/fews-web-oc-composables

@deltares/fews-web-oc-composables / PiTimeSeriesQueryOptions

Interface: PiTimeSeriesQueryOptions ​

Defined in: lib/timeseries/applyTimeSeriesQueryOptions.ts:1

Properties ​

convertDatum? ​

optional convertDatum?: boolean

Defined in: lib/timeseries/applyTimeSeriesQueryOptions.ts:20

Converts values to the datum of the location.

endTime? ​

optional endTime?: Date | null

Defined in: lib/timeseries/applyTimeSeriesQueryOptions.ts:10

Overrides the end time of every request.

onlyHeaders? ​

optional onlyHeaders?: boolean

Defined in: lib/timeseries/applyTimeSeriesQueryOptions.ts:30

Returns only time series headers, without events.

startTime? ​

optional startTime?: Date | null

Defined in: lib/timeseries/applyTimeSeriesQueryOptions.ts:5

Overrides the start time of every request.

thinning? ​

optional thinning?: boolean

Defined in: lib/timeseries/applyTimeSeriesQueryOptions.ts:15

Requests thinned data with a resolution based on the estimated chart width.

useDisplayUnits? ​

optional useDisplayUnits?: boolean

Defined in: lib/timeseries/applyTimeSeriesQueryOptions.ts:25

Returns values in display units instead of the stored units.