layercontrol

Layer control

Usage

npm install @eox/layercontrol

// for setups with bundlers e.g. Vite
import "@eox/layercontrol"

// or, for e.g. single HTML files without bundler
import "@eox/layercontrol/dist/eox-layercontrol.js"

<eox-layercontrol for="eox-map"></eox-layercontrol>

Attributes

for: string = "eox-map"

The query selector of the eox-map you wish to attach the layer control to.

<eox-map .layers="[...]"></eox-map>
<eox-layercontrol for="eox-map"></eox-layercontrol>

When used with a vanilla OpenLayer map, you need to reference the JS map object in the DOM, such as:

const olMap = new Map({
    ...
    target: "map-div"
})
document.querySelector("map-div").map = olMap

<eox-layercontrol for="#map-div"></eox-layercontrol>

idProperty: string = "id"

The layer identifier property of the layers. Fallback is set automatically based on ol_uid if not provided.

titleProperty: string = "title"

The layer title property of the layers. "title" by default, fallback is set automatically based on "layer" + ol_uid if not provided.

unstyled: Boolean

Display the unstyled version of the layer control.

Layer properties

In order to be displayed correctly, the OpenLayers map layers need some custom properties (using e.g. layer.set(property, value)).

id?: string

The layer id. Not required but recommended (see automatic fallback).

title?: string

The title of the layer displayed in the layer control. Not required (see automatic fallback), but recommended in order to display human-readable layer titles.

layerControlHide?: Boolean

Completely hide a layer from the layer control.

layerControlOptional?: Boolean

Initially hide a layer from the layer control, but make it available as an optional layer. If the layer is selected and added, it will be set to visible and pushed to the top of the layer list or (if originally configured within a layer group) to the top of the layer group.

layerControlExclusive?: Boolean

Make layers mutually exclusive. If two or more layers (on the same level, i.e. at root or inside a layer group) have this property, then only one of them can be visualized at a time.

layerControlExpand?: Boolean

Pre-expand a layer dropdown so that it is always open when the component initializes.

Contribute

Setup

npm install
npm start
npm run format

npm version <new version>
npm run build
npm publish (requires OTP)

Testing

This element includes components tests and is part of e2e tests. Please refer to the root README for more details.

Changelog

Created automatically here