ggc-library
    Preparing search index...

    Class GgcLegendComponent

    Het ggc-legend component toont de legenda van kaartlagen. Het component ondersteunt verschillende legenda-types zoals iconenlijsten, URL's naar legenda plaatjes en (mapbox) vector tile stijlen. Voor de verschillende types, zie LegendType. Door <ggc-legend></ggc-legend> op te nemen in de HTML kan de legenda worden gebruikt.

    <ggc-legend
      [legends]="legends"
      [showLegendsName]="false"
      [showEmptyLegendMessage]="true"
      [emptyLegendMessage]="'Legenda niet beschikbaar'"
      [collapsable]="true"
    >
    </ggc-legend>

    De verplichte variabele legends is een array van te tonen legenda's.

    Standaard (autoConnect = true) verbindt het component zich automatisch met de kaart (ggc-map/ggc-map-3d) met dezelfde mapIndex, en wordt legends intern gevuld en bijgehouden op basis van de actieve kaartlagen. Handmatig een waarde toekennen aan legends is dan niet nodig.

    Wil je de legenda's zelf samenstellen (bijvoorbeeld los van een kaart), zet dan autoConnect = false en geef zelf een Legend[] mee, bijvoorbeeld:

    const legends: Legend[] = [
      {
        name: "Terugmeldingen",
        expanded: true,
        layerLegends: [
          {
            layerId: "terugmeldingen",
            legend: {
              legendUrl:
                "https://service.pdok.nl/brt/terugmeldingen/wms/v1_0/legend/brtterugmeldingen/brtterugmeldingen:terugmeldingen.png"
            }
          }
        ]
      },
      {
        name: "Status",
        layerLegends: [
          {
            layerId: "status",
            legend: [
              { imageUrl: "assets/icons/nieuw.svg", iconDescription: "Nieuw", text: "nieuw" },
              { imageUrl: "assets/icons/afgerond.svg", iconDescription: "Afgerond", text: "afgerond" }
            ]
          }
        ]
      }
    ];

    Implements

    • OnInit
    Index

    Properties

    alwaysEnableLegends autoConnect collapsable defaultExpanded emptyLegendMessage iconCollapsed iconExpanded layerLegendEnabledCallback legendsChange showEmptyLegendMessage showLegendsName

    Accessors

    legends mapIndex viewerType

    Methods

    addLegend ngOnInit removeLegend toggleLegend

    Properties

    alwaysEnableLegends: boolean = false

    Legenda's worden per default alleen weergegeven als de laag ook zichtbaar is in het huidige zoomniveau. Mocht je legenda's altijd willen tonen,ongeacht het zoomniveau, dan kan deze input op true gezet worden.

    autoConnect: boolean = true

    Bepaalt of events automatisch intern worden afgehandeld binnen de component.

    Standaardwaarde: true.

    Wanneer ingesteld op true, verwerkt de component de events zelf. Bij false worden de events niet intern afgehandeld en wordt verwacht dat de parent-component deze afhandeling verzorgt.

    collapsable: boolean = false

    Geeft aan of de legenda inklapbaar is.

    defaultExpanded: boolean = true

    Geeft aan of legendas als default uitgeklapt zijn of niet. Heeft alleen effect als collapsable op true staat.

    emptyLegendMessage: string = "Geen legenda beschikbaar"

    Tekst die wordt getoond wanneer er geen legenda beschikbaar is en showEmptyLegendMessage = true

    iconCollapsed: string = "fas fa-angle-right"

    CSS-class voor het icoon wanneer de legenda is ingeklapt.

    iconExpanded: string = "fas fa-angle-down"

    CSS-class voor het icoon wanneer de legenda is uitgeklapt.

    layerLegendEnabledCallback: LayerLegendEnabledCallback

    Callback waarmee je de door de dataset-tree berekende enabled status van een layer optioneel kunt overschrijven.

    legendsChange: EventEmitter<Legend[]> = ...

    Event dat wordt afgegeven wanneer de lijst van legenda's verandert.

    showEmptyLegendMessage: boolean = false

    Geeft aan of een melding moet worden getoond wanneer er geen legenda beschikbaar is.

    showLegendsName: boolean = true

    Geeft aan of de namen van de legenda-items getoond moeten worden.

    Accessors

    • get legends(): Legend[]

      Haalt de huidige lijst van legenda's op.

      Returns Legend[]

    • set legends(value: Legend[]): void

      Stelt de lijst van legenda's in.

      Parameters

      • value: Legend[]

        Nieuwe lijst van legenda's.

      Returns void

    • get mapIndex(): string

      De mapIndex die hoort bij deze legend. Deze legenda reageert automatisch op events van de maps met dezelfde mapIndex.

      Returns string

      Zorg dat de mapIndex overeenkomt met de mapIndex van de bijbehorende ggc-map, anders vindt dit component niet de juiste kaart. Heb je maar één kaart in je applicatie, dan hoef je geen mapIndex in te stellen: de default (DEFAULT_MAPINDEX) wordt dan altijd gebruikt. ggc-map-3d maakt geen gebruik van een mapIndex.

      Let op: als meerdere <ggc-legend>-componenten dezelfde mapIndex hebben, worden ze bij het aanroepen van GgcLegendService.collapseAllLegends/expandAllLegends allemaal tegelijk in- of uitgeklapt.

    • get viewerType(): ViewerType

      Type kaartviewer waarmee de dataset-tree interacteert, TWEE_D (ol) of DRIE_D (cesium). Default is TWEE_D

      Returns ViewerType

    Methods

    • Voegt de meegegeven layer-legenda toe aan dit legenda component. Nieuwe legenda's worden standaard bovenaan toegevoegd. Als naam wordt de serviceTitle en anders de layerTitle gebruikt. Mocht er al een legenda zijn met dezelfde naam, dan worden deze samen gegroepeerd. Indien er geen legenda is meegegeven, maar wel een titel. Dan wordt de titel ook niet getoond indien showEmptyLegendMessage = false.

      Parameters

      Returns Promise<void>

    • Initialisatie van het component. Abonneert op events om alle legenda's in of uit te klappen.

      Returns void

    • Verwijder alle legenda's van het opgegeven layerId.

      Parameters

      • layerId: string

        Van dit layerId worden alle legenda's verwijderd.

      Returns void

    • Wisselt de status (ingeklapt/uitgeklapt) van een specifieke legenda.

      Parameters

      • legend: Legend

        De legenda die moet worden gewisseld.

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods