MapContextLayerWms ​
Extends ​
Properties ​
| Property | Type | Description | Inherited from |
|---|---|---|---|
attributions? | string | Attributions for the layer. Optional but strongly recommended: remember to attribute your map! | MapContextBaseLayer.attributions |
clickable? | boolean | Whether data on the layer can be picked up using the feature-click event. Default value is true. Set to false to save performance. | MapContextBaseLayer.clickable |
customParams? | Record<string, string> | Vendor-specific WMS parameters that are appended as-is to every GetMap request. Use this for non-standard server extensions such as NcWMS (COLORSCALERANGE, LOGSCALE). Keys are case-sensitive; they are passed without transformation. | - |
elevationValue? | LayerDimensionValue | value of the built-in ELEVATION dimension to request; can be a single value, a list of discrete values, an interval, or a list of intervals | - |
extras? | object | This property can be used to store anything application-specific on layers; as its content may occasionally be serialized to JSON for change detection purposes, it is not recommended to store Functions or other non-serializable entities | MapContextBaseLayer.extras |
filter? | string | An OGC encoded filter (e.g. an OGC <Filter> document) applied verbatim to the WMS GetMap FILTER parameter. Use it to restrict the features rendered by the layer. The value is passed through as-is; the SDK does not validate or transform it. | - |
format? | string | The image format MIME type to use for WMS requests, e.g. "image/png" or "image/jpeg". If not specified, the WMS server's default format will be used. | - |
hoverable? | boolean | Whether features on the layer can be picked up using the feature-hover event. Mostly has an effect only for vector layers. Default value is false. | MapContextBaseLayer.hoverable |
id? | string | number | An optional identifier for the layer; if provided, will improve performance when the layers is updated through a context diff. | MapContextBaseLayer.id |
label? | string | Optional label for the layer, typically used to represent the layer in a layer list or when showing a popup above a feature. | MapContextBaseLayer.label |
name | string | - | - |
opacity? | number | Opacity level; between 0 and 1. Default value is 1 (fully opaque). | MapContextBaseLayer.opacity |
otherDimensionValues? | Record<string, string | number | TimeInterval | ValueInterval | WmsLayerDimensionValue[] | string[]> | value of any other dimension to request (either scalar or temporal); key is the dimension name, it will be prefixed by DIM_ in the request | - |
referrerPolicy? | ReferrerPolicy | Controls the Referer header sent with tile/image requests. See the MDN documentation for possible values. Support depends on the layer type and the map library used. | MapContextBaseLayer.referrerPolicy |
style? | string | If unspecified, will use the default one | - |
timeValue? | LayerTimeDimensionValue | value of the built-in TIME dimension to request; can be a single date, a list of dates, a temporal interval, or a list of intervals | - |
type | "wms" | - | - |
url | string | - | - |
useTiles? | boolean | Whether to use tiled WMS requests. Tiled requests include a TILED=true parameter as per https://wiki.osgeo.org/wiki/WMS_Tiling_Client_Recommendation Using tiled requests allow tiles to be cached and thus the server load to potentially be reduced; on the other hand, it can increase the time to show the layer and degrade the quality of the rendering (e.g. with labels). Note: untiled requests are not supported by MapLibre-GL-JS Default value: true (use tiled requests) | - |
version? | number | Optional version indicator; if provided, must be increased by the application for the change detection to trigger, otherwise the SDK will consider that the layer is unchanged. | MapContextBaseLayer.version |
visibility? | boolean | Whether the layer is visible or not on the map. A non-visible layer will still have its data queried and kept in memory, so switching this on/off shows immediately on the map. Default value is true (visible). | MapContextBaseLayer.visibility |