@deltares/fews-web-oc-composables
@deltares/fews-web-oc-composables / UsePiTimeSeriesReturn
Interface: UsePiTimeSeriesReturn
Defined in: usePiTimeSeries/index.ts:140
Properties
cancel
cancel: () =>
void
Defined in: usePiTimeSeries/index.ts:179
Cancels the running requests of this instance.
Returns
void
entries
entries:
Readonly<ShallowRef<Record<string,PiTimeSeriesEntry>>>
Defined in: usePiTimeSeries/index.ts:144
The state per request key.
errors
errors:
ComputedRef<Record<string,Error>>
Defined in: usePiTimeSeries/index.ts:154
The errors per request key.
fetch
fetch: () =>
Promise<void>
Defined in: usePiTimeSeries/index.ts:174
Fetches all time series immediately.
Returns
Promise<void>
lastRefreshAt
lastRefreshAt:
Readonly<Ref<Date|undefined>>
Defined in: usePiTimeSeries/index.ts:199
The time at which the most recent refresh completed.
lastTriggerPolicy
lastTriggerPolicy:
Readonly<Ref<RefreshPolicy|undefined>>
Defined in: usePiTimeSeries/index.ts:204
The policy that caused the most recent refresh.
loading
loading:
ComputedRef<boolean>
Defined in: usePiTimeSeries/index.ts:159
Whether any request is loading without a previous response.
loadingKeys
loadingKeys:
ComputedRef<string[]>
Defined in: usePiTimeSeries/index.ts:169
The keys of the requests that are in progress.
pauseRefresh
pauseRefresh: () =>
void
Defined in: usePiTimeSeries/index.ts:189
Pauses automatic refreshes.
Returns
void
refreshing
refreshing:
ComputedRef<boolean>
Defined in: usePiTimeSeries/index.ts:164
Whether any request is refreshing a previous response.
requestRefresh
requestRefresh: () =>
void
Defined in: usePiTimeSeries/index.ts:184
Requests a refresh through the refresh coordinator.
Returns
void
responses
responses:
ComputedRef<Record<string,TimeSeriesResponse>>
Defined in: usePiTimeSeries/index.ts:149
The available responses per request key.
resumeRefresh
resumeRefresh: () =>
void
Defined in: usePiTimeSeries/index.ts:194
Resumes automatic refreshes after they have been paused.
Returns
void