FEWS Web OC

@deltares/fews-web-oc-composables

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

Interface: UseWmsLegendOptions ​

Defined in: useWms/useWmsLegend.ts:29

Extends ​

Properties ​

colorScaleRange? ​

optional colorScaleRange?: MaybeRefOrGetter<string>

Defined in: useWms/useWmsLegend.ts:37

Optional "min,max" color scale range override.

enabled? ​

optional enabled?: Ref<boolean, boolean>

Defined in: useWms/options.ts:41

Controls whether requests and automatic refreshes are enabled.

Default ​

ts
ref(true)

Inherited from ​

UseWmsOptions.enabled

layerName ​

layerName: MaybeRefOrGetter<string | undefined>

Defined in: useWms/useWmsLegend.ts:31

Name of the layer to load the legend for.

refresh? ​

optional refresh?: UseWmsRefreshOptions

Defined in: useWms/options.ts:50

Configuration for automatic request refreshing.

Inherited from ​

UseWmsOptions.refresh

style? ​

optional style?: MaybeRefOrGetter<Style>

Defined in: useWms/useWmsLegend.ts:40

Optional WMS style to render the legend with.

useDisplayUnits ​

useDisplayUnits: MaybeRefOrGetter<boolean>

Defined in: useWms/useWmsLegend.ts:34

Whether to render the legend using display units.

webservice? ​

optional webservice?: PiWebserviceOptions

Defined in: useWms/options.ts:47

Optional webservice configuration for standalone usage. When omitted, the host-provided webservice context is used.

Inherited from ​

UseWmsOptions.webservice