Docdash

Name	Type	Description
activePane	SidePanelPane	The currently active pane - or null if no pane is active.

Constructor

new SidePanel()

Source:

SidePanel.js, line 34

Example

import { SidePanel } from 'ol-side-panel';

const sidePanel = new SidePanel();

map.addControl(sidePanel);

const layersPane = sidePanel.definePane({
  paneId: 'layers',
  name: "Layers",
  icon: '<i class="bi bi-layers-half"></i>'
});

const layersGreeting = document.createElement('p');
layersGreeting.innerHTML = "Hi there layers!";

layersPane.addWidgetElement(layersGreeting);

Extends

external:Control

Methods

addWidgetElement(paneId, widgetElement) → {SidePanelWidget}

Source:

SidePanel.js, line 156

Add an HTML element to the named pane as a new SidePanelWidget.

Parameters:

Name	Type	Description
`paneId`	String	The identifier of the pane to add the widget to.
`widgetElement`	external:Element

Returns:

A reference to the newly added widget.

Type: SidePanelWidget

definePane(args) → {SidePanelPane}

Source:

SidePanel.js, line 109

Defines a new pane.

Parameters:

Name Type Description

args

Object

pane args

Properties

Name	Type	Description
`paneId`	String	Locally unique identifier for the pane - used to refer to the pane within an instance of the ol-side-panel control.
`name`	String \| external:Element	Name of the pane - User-facing name of this pane.
`icon`	String \| external:Element	Icon of the pane - User-facing icon for this pane.
`weight`	Number	Weight of the pane - controls the order of the pane tabs with lower numbers appearing closer to the top and higher numbers appearing farther down. Panes with a weight >= 100 will have their icons appear at the bottom of the tab bar.