FEWS Web OC

@deltares/fews-web-oc-composables

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

Interface: UseWmsReturn ​

Defined in: useWms/useWmsLayerCapabilities.ts:39

Extends ​

Properties ​

cancel ​

cancel: () => void

Defined in: useWms/options.ts:76

Cancels the currently running request, if any.

Returns ​

void

Inherited from ​

UseWmsRequestReturn.cancel

capabilities ​

capabilities: Readonly<Ref<GetCapabilitiesResponse | undefined>>

Defined in: useWms/useWmsLayerCapabilities.ts:57

The full WMS GetCapabilities response, or undefined when no layer is selected, or the request has not resolved yet.

error ​

error: Readonly<Ref<Error | null>>

Defined in: useWms/options.ts:61

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

Inherited from ​

UseWmsRequestReturn.error

fetch ​

fetch: () => Promise<void>

Defined in: useWms/options.ts:73

Fetches the requested WMS data immediately.

Returns ​

Promise<void>

Inherited from ​

UseWmsRequestReturn.fetch

hasAttempted ​

hasAttempted: Readonly<Ref<boolean>>

Defined in: useWms/options.ts:70

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

Inherited from ​

UseWmsRequestReturn.hasAttempted

hasLoaded ​

hasLoaded: Readonly<Ref<boolean>>

Defined in: useWms/options.ts:64

Whether a successful response is available for the current inputs.

Inherited from ​

UseWmsRequestReturn.hasLoaded

lastRefreshAt ​

lastRefreshAt: Readonly<Ref<Date | undefined>>

Defined in: useWms/options.ts:88

Time at which the most recent refresh completed successfully.

Inherited from ​

UseWmsRequestReturn.lastRefreshAt

lastTriggerPolicy ​

lastTriggerPolicy: Readonly<Ref<RefreshPolicy | undefined>>

Defined in: useWms/options.ts:91

Policy that caused the most recent refresh.

Inherited from ​

UseWmsRequestReturn.lastTriggerPolicy

layerCapabilities ​

layerCapabilities: Readonly<Ref<Layer | undefined>>

Defined in: useWms/useWmsLayerCapabilities.ts:44

The WMS capabilities of the requested layer, or undefined when no layer is selected, or the request has not resolved yet.

loadCapabilities ​

loadCapabilities: () => Promise<void>

Defined in: useWms/useWmsLayerCapabilities.ts:63

Reloads the capabilities and times. Called automatically when request options change or a refresh is triggered.

Returns ​

Promise<void>

loading ​

loading: Readonly<Ref<boolean>>

Defined in: useWms/options.ts:55

Whether the initial request is in progress.

Inherited from ​

UseWmsRequestReturn.loading

pauseRefresh ​

pauseRefresh: () => void

Defined in: useWms/options.ts:82

Pauses automatic refreshes.

Returns ​

void

Inherited from ​

UseWmsRequestReturn.pauseRefresh

refreshing ​

refreshing: Readonly<Ref<boolean>>

Defined in: useWms/options.ts:58

Whether a subsequent request is in progress.

Inherited from ​

UseWmsRequestReturn.refreshing

requestRefresh ​

requestRefresh: () => void

Defined in: useWms/options.ts:79

Requests a refresh through the refresh coordinator.

Returns ​

void

Inherited from ​

UseWmsRequestReturn.requestRefresh

resumeRefresh ​

resumeRefresh: () => void

Defined in: useWms/options.ts:85

Resumes automatic refreshes.

Returns ​

void

Inherited from ​

UseWmsRequestReturn.resumeRefresh

times ​

times: Readonly<Ref<Date[] | undefined>>

Defined in: useWms/useWmsLayerCapabilities.ts:51

The available time values for the layer, restricted to the layer's firstValueTime/lastValueTime range (if present), or undefined when no layer is selected.