FEWS Web OC

@deltares/fews-web-oc-composables

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

Interface: UsePiLocationsReturn ​

Defined in: usePiLocations/index.ts:103

Properties ​

cancel ​

cancel: () => void

Defined in: usePiLocations/index.ts:152

Cancels the currently running locations request, if any.

Returns ​

void

error ​

error: Readonly<Ref<Error | null>>

Defined in: usePiLocations/index.ts:127

The error from the most recent locations request, or null when there is no error.

fetch ​

fetch: () => Promise<void>

Defined in: usePiLocations/index.ts:147

Fetches locations immediately using the current filter.

  • Identical pending requests within this instance share the same promise.

Returns ​

Promise<void>

A promise that resolves when the request completes or is cancelled.

geojson ​

geojson: Readonly<Ref<FeatureCollection<Geometry, PiLocation>>>

Defined in: usePiLocations/index.ts:112

The currently loaded locations as geojson.

hasAttempted ​

hasAttempted: Readonly<Ref<boolean>>

Defined in: usePiLocations/index.ts:133

Whether a request has completed for the current filter, successfully or not.

hasLoaded ​

hasLoaded: Readonly<Ref<boolean>>

Defined in: usePiLocations/index.ts:130

Whether a successful result is available for the current filter.

isEmpty ​

isEmpty: ComputedRef<boolean>

Defined in: usePiLocations/index.ts:138

Whether locations have been loaded successfully and the result is empty.

lastRefreshAt ​

lastRefreshAt: Readonly<Ref<Date | undefined>>

Defined in: usePiLocations/index.ts:172

The time at which the most recent refresh completed successfully.

lastTriggerPolicy ​

lastTriggerPolicy: Readonly<Ref<RefreshPolicy | undefined>>

Defined in: usePiLocations/index.ts:177

The policy that caused the most recent refresh.

loading ​

loading: Readonly<Ref<boolean>>

Defined in: usePiLocations/index.ts:117

Whether a request is in progress without a successful result for the current filter.

locations ​

locations: Readonly<Ref<PiLocation[]>>

Defined in: usePiLocations/index.ts:107

The currently loaded locations.

pauseRefresh ​

pauseRefresh: () => void

Defined in: usePiLocations/index.ts:162

Pauses automatic refreshes.

Returns ​

void

refreshing ​

refreshing: Readonly<Ref<boolean>>

Defined in: usePiLocations/index.ts:122

Whether a request is in progress with a successful result for the current filter.

requestRefresh ​

requestRefresh: () => void

Defined in: usePiLocations/index.ts:157

Requests a refresh through the refresh coordinator.

Returns ​

void

resumeRefresh ​

resumeRefresh: () => void

Defined in: usePiLocations/index.ts:167

Resumes automatic refreshes after they have been paused.

Returns ​

void