Legende

Dieses Element zeigt eine Legende der Layer an, die in der Karte dargestellt werden. Dabei wird jeder einzelne Layer mit seinen Punkten, Flächen und Linien aufgelistet.

../../../_images/legend.png

Konfiguration

../../../_images/legend_configuration.png
  • Automatisches Öffnen: true, wenn die Legende beim Start der Anwendung geöffnet werden soll, der Standardwert ist false.
  • Title: Titel des Elements. Dieser wird in der Layouts Liste angezeigt. Der Titel wird außerdem neben dem Button angezeigt, wenn “Beschriftung anzeigen” aktiviert ist.
  • Tooltip: Text, der angezeigt wird, wenn der Mauszeiger eine längere Zeit über dem Element verweilt.
  • Element type: Anzeige als Dialog- oder Blockelement, Standard ist Dialog.
  • Display type: akkordeonartige Anzeige oder Liste. Standard ist Liste.
  • Target: ID des Kartenelements, auf das sich das Element bezieht.
  • Titel der Datenquelle anzeigen: zeigt den WMS Titel, der Standardwert ist true.
  • Titel der Ebene anzeigen: zeigt den Layertitel, der Standardwert ist true.
  • Titel der gruppierten Ebenen anzeigen: zeigt den Gruppenlayertitel für gruppierte Layer, der Standardwert ist true.

Für das Element wird ein Button oder die Sidepane verwendet. Zu der Konfiguration des Buttons besuchen sie die Dokumentationsseite unter Button.

Konfigurationsbeispiele

Legende in der Sidepane

Die Legende in der Sidepane wird über das + -Zeichen in der Anwendung unter Layouts, Sidepane eingebunden.

../../../_images/add_sidepane.png

Im Dialogfeld wird das Element “Legende” ausgewählt. Anschließend öffnet sich der Konfigurationsdialog “Element hinzufügen – Legende”.

../../../_images/legend_example_sidepane_dialog.png

Das hier konfigurierte Element hat den Titel “Legende”. Es entspricht dem Element type “blockelement”, da es in der Sidepane fest eingebunden ist. Der Display type ist “list” und das Target die “Hauptkarte”. Die Legende öffnet sich automatisch (Häkchen bei Automatisches Öffnen). Der Titel der Ebenen wird angezeigt sowie der Titel der gruppierten Ebenen (Häkchen bei Titel der Ebene anzeigen und Titel der gruppierten Ebene anzeigen).

Diese Konfiguration ergibt folgendes Ergebnis in der Anwendung:

../../../_images/legend_example_sidepane.png

Es wird empfohlen, dass die Legende immer als “blockelement” eingebunden wird, wenn diese in der Sidepane angezeigt werden soll. Wird sie als Element type “dialog” eingebunden, öffnet sich ein Dialogfeld und die Legende wird nicht in der Sidepane angezeigt. Lediglich die Überschrift “Legende” ist zu sehen. Sofern dieser Dialog geschlossen wurde, ist dieser nicht mehr aufrufbar. Falls die Legende in der Toolbar eingebunden werden soll, empfiehlt es sich diese über einen Button zu konfigurieren und nicht über das Element Legende.

Legende in der Toolbar

Die Legende kann auch als Button in der Toolbar eingebunden werden. Hierfür muss zuerst das Element Legende in der Anwendung unter dem Reiter Layouts im Content integriert werden.

../../../_images/add_content.png

Für das Konfigurationsbeispiel wurden folgende Einstellungen gewählt:

../../../_images/legend_example_toolbar_dialog.png

Wichtig ist hier, den Element type auf “dialog” einzustellen. Für das Konfigurationsbeispiel wurde das Häkchen bei Automatisches Öffnen entfernt, sodass sich die Legende nur bei aktivem Klicken auf den Button öffnet. Sobald dieses Element im Content eingebunden wurde, muss ein Button in der Toolbar eingefügt werden. Die Konfiguration von Buttons wird in der Mapbender-Dokumentation unter Button beschrieben.

Die Konfiguration eines Buttons für die Legende kann wie folgt aussehen:

../../../_images/legend_example_button.png

Mit diesen Einstellungen sieht das Ergebnis in der Anwendung wie folgt aus:

../../../_images/legend_example_toolbar.png

In der Toolbar ist der Button für das Legenden-Element zu sehen. Sobald auf den Button geklickt wird, öffnet sich das Dialogfeld und zeigt die Legende an.

Inwiefern sich die Aktivierung bzw. Deaktivierung einzelner Haken auf die Legende auswirkt, ist hier zu sehen:

../../../_images/legend_example_toolbar_checkboxes.png

YAML-Definition:

tooltip: 'Legend'                    # Text des Tooltips
elementType: dialog                  # Anzeige als Dialog- oder Blockelement, Standard ist Dialog.
autoOpen: true                       # true, wenn die Legende beim Start der Anwendung geöffnet werden soll, der Standardwert ist false.
displayType: list                    # akkordeonartige Anzeige oder Liste. Standard ist Liste.
target: ~                            # ID des Kartenelements
hideEmptyLayer: true                 # true/false Layer wird versteckt, wenn keine Legende verfügbar ist, der Standardwert ist true
showWmsTitle: true                   # true/false zeigt den WMS Titel, der Standardwert ist true
showLayerTitle: true                 # true/false zeigt den Layertitel, der Standardwert ist true
showGroupedLayerTitle: true          # true/false zeigt den Gruppentitel für gruppierte Layer, der Standardwert ist true

Class, Widget & Style

  • Class: Mapbender\CoreBundle\Element\Legend
  • Widget: mapbender.element.legend.js
  • Style: mapbender.element.legend.css