Class Catalog

Hierarchy (View Summary)

Constructors

constructor

Properties

auto categories categoryId clusterize clusterOptions collapsed configData container description disposed draggable element eventsListeners layersList layersListOnMap listable listenerKeys on once options un

Methods

activeLayer activeLayerByID addChangeListener addEventListener addLayerConfig applyProperties changed disableLayer disableLayerByID dispatchEvent dispose disposeInternal get getCollapsed getContainer getKeys getLayerId getLayersByCategory getListeners getMap getProperties getPropertiesInternal getRevision hasListener hasProperties hideWaiting notify onceInternal onInternal onSearchSpecificCatalogButtonResetClick removeChangeListener removeEventListener render set setCollapsed setMap setPosition setProperties setTarget showWaiting unInternal unset updatePosition

Events

ADD_CATALOG_LAYER_EVENT LOADED_CATALOG_EVENT REMOVE_CATALOG_LAYER_EVENT

Constructors

constructor

  • new Catalog(options: CatalogOptions): Catalog

    Parameters

    Returns Catalog

    Fires

    catalog:loaded

    Fires

    catalog:layer:add

    Fires

    catalog:layer:remove

    Example

    var widget = new ol.control.Catalog({
              collapsed : true,
              draggable : false,
              titlePrimary : "",
              titleSecondary : "Gérer vos couches de données",
              layerLabel : "title",
              layerThumbnail : true,
              search : {
                  display : true,
                  label : "Rechercher une donnée",
                  criteria : [
                      "name",
                      "title",
                      "description"
                  ]
              },
              addToMap : true,
              categories : [
                  {
                      title : "Données",
                      id : "data",
                      default : true,
                      search : false,
                      filter : null
                      // sous categories
                      // items : [
                      //     {
                      //         title : "",
                      //         default : true,
                      //         section : true, // avec section (ex. regroupement par themes)
                      //         icon : true, // icone pour les sections (svg ou lien http ou dsfr classe)
                      //         filter : {
                      //             field : "",
                      //             value : ""
                      //         }
                      //     }
                      // ]
                  }
              ],
              configuration : {
                  type : "json",
                  urls : [ // data:{}
                      "https://raw.githubusercontent.com/IGNF/cartes.gouv.fr-entree-carto/main/public/data/layers.json",
                      "https://raw.githubusercontent.com/IGNF/cartes.gouv.fr-entree-carto/main/public/data/edito.json"
                  ]
              }
    });
    widget.on("catalog:loaded", (e) => { console.log(e.data); });
    widget.on("catalog:layer:add", (e) => { console.log(e); });
    widget.on("catalog:layer:remove", (e) => { console.log(e); });
    map.addControl(widget);

    Todo

    validation du schema

Properties

auto

auto: undefined | boolean

specify if control add some stuff auto

categories

categories: undefined | Categories[]

specify all categories

Example

[
    {
       title : "Données",   // title of the category
       id : "data",         // id of the category
       default : true,      // if true, this category is selected by default
       search : false,      // if true, a search bar is displayed for this category
       cluster : false,     // if true, clustering is activated for this category
       filter : null,       // filter to apply on the category
       items : [            // list of subcategories
           {
              title : "Toutes les données", // title of the subcategory
              id : "all",                   // id of the subcategory
              default : true,               // if true, this subcategory is selected by default
              icon : true,                  // icon for the subcategory (svg or http link or dsfr class)
              iconJson : [],                // list of icons (json) for the sections
              cluster : false,              // if true, clustering is activated for this subcategory
              section : false,              // if true, this subcategory has a section
              sections : [],                // list of sections (filled later)
              filter : null,                // filter to apply on the subcategory
           }
       ]
    }
]

categoryId

categoryId: undefined | string

specify the current category selected

clusterize

clusterize: undefined | {}

clusterOptions

clusterOptions: undefined | { blocks_in_cluster: number; rows_in_block: number }

collapsed

collapsed: undefined | boolean

specify if control is collapsed (true) or not (false)

configData

configData: any

specify configuration data (configuration service)

container

container: HTMLElement

description

description: any

Protecteddisposed

disposed: boolean

The object has already been disposed.

draggable

draggable: undefined | boolean

specify if control is draggable (true) or not (false)

element

element: HTMLElement

eventsListeners

eventsListeners: undefined | any[]

specify some events listeners

layersList

layersList: undefined | any[]

specify all list of layers (configuration service)

layersListOnMap

layersListOnMap: any

list of layers added on map by key pair : name/service

Example

{
         *    "GEOGRAPHICALGRIDSYSTEMS.PLANIGNV2:WMTS" : ol/layer/Tile,
         *    "PLAN.IGN$GEOPORTAIL:TMS" : ol/layer/VectorTile
         * }

listable

listable: boolean

ProtectedlistenerKeys

listenerKeys: EventsKey[]

on

on: ObjectOnSignature<EventsKey>

once

once: ObjectOnSignature<EventsKey>

options

options:
    | undefined
    | {
        addToMap: boolean;
        auto: boolean;
        categories: {
            catalogCatalogOptionsTypeCategoriesType: boolean;
            cluster: boolean;
            clusterOptions: { blocks_in_cluster: number; rows_in_block: number };
            filter: null;
            id: string;
            title: string;
        }[];
        collapsed: boolean;
        configuration: { type: string; urls: string[] };
        draggable: boolean;
        layerLabel: string;
        layerThumbnail: boolean;
        search: { criteria: string[]; display: boolean; label: string };
        size: string;
        titlePrimary: string;
        titleSecondary: string;
    }

un

un: ObjectOnSignature<void>

Methods

activeLayer

  • activeLayer(name: string, service: string): void

    Activate a layer This method activates a layer by its name and service. It checks if the layer exists in the layersList and if it does, it adds the layer to the map if addToMap is true. It then dispatches an event indicating that the layer has been added to the catalog.

    Parameters

    • name: string

      Layer name.

    • service: string

      Layer service.

    Returns void

    Example

    activeLayer("GEOGRAPHICALGRIDSYSTEMS.PLANIGNV2", "WMTS");
    activeLayer("PLAN.IGN", "GEOPORTAIL:TMS");

activeLayerByID

  • activeLayerByID(id: any): void

    Activate a layer by its ID This method activates a layer based on its ID, which is expected to be in the format "name$service". It splits the ID to extract the layer name and service, then calls the activeLayer method.

    Parameters

    • id: any

      Layer ID in the format "name$service".

    Returns void

    Example

    activeLayerByID("GEOGRAPHICALGRIDSYSTEMS.PLANIGNV2$WMTS");
    activeLayerByID("PLAN.IGN$GEOPORTAIL:TMS");

addChangeListener

  • addChangeListener(key: string, listener: Listener): void

    Parameters

    • key: string

      Key name.

    • listener: Listener

      Listener.

    Returns void

addEventListener

  • addEventListener(type: string, listener: Listener): void

    Parameters

    • type: string

      Type.

    • listener: Listener

      Listener.

    Returns void

addLayerConfig

ProtectedapplyProperties

  • applyProperties(source: BaseObject): void
    Protected

    Apply any properties from another object without triggering events.

    Parameters

    • source: BaseObject

      The source object.

    Returns void

changed

  • changed(): void

    Increases the revision counter and dispatches a 'change' event.

    Returns void

    Api

disableLayer

  • disableLayer(name: string, service: string): void

    Disable a layer This method disables a layer by its name and service. It checks if the layer exists in the layersList and if it does, it removes the layer from the map if addToMap is true. It then dispatches an event indicating that the layer has been removed from the catalog.

    Parameters

    • name: string

      Layer name.

    • service: string

      Layer service.

    Returns void

    Example

    disableLayer("GEOGRAPHICALGRIDSYSTEMS.PLANIGNV2", "WMTS");
    disableLayer("PLAN.IGN", "GEOPORTAIL:TMS");

disableLayerByID

  • disableLayerByID(id: any): void

    Disable a layer by its ID This method disables a layer based on its ID, which is expected to be in the format "name$service". It splits the ID to extract the layer name and service, then calls the disableLayer method.

    Parameters

    • id: any

      Layer ID in the format "name$service".

    Returns void

    Example

    disableLayerByID("GEOGRAPHICALGRIDSYSTEMS.PLANIGNV2$WMTS");
    disableLayerByID("PLAN.IGN$GEOPORTAIL:TMS");

    Todo

    • ajouter un test pour vérifier si l'ID est valide
    • ajouter un test pour vérifier si la couche est déjà active
    • ajouter un test pour vérifier si la couche est déjà désactivée

dispatchEvent

  • dispatchEvent(event: string | BaseEvent): undefined | boolean

    Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

    Parameters

    • event: string | BaseEvent

      Event object.

    Returns undefined | boolean

    false if anyone called preventDefault on the event object or if any of the listeners returned false.

    Api

dispose

  • dispose(): void

    Clean up.

    Returns void

ProtecteddisposeInternal

  • disposeInternal(): void
    Protected

    Extension point for disposable objects.

    Returns void

get

  • get(key: string): any

    Gets a value.

    Parameters

    • key: string

      Key name.

    Returns any

    Value.

    Api

getCollapsed

getContainer

getKeys

  • getKeys(): string[]

    Get a list of object property names.

    Returns string[]

    List of property names.

    Api

getLayerId

  • getLayerId(name: any, service: any): null | string

    Get long layer ID

    Parameters

    • name: any

      nom de la couche

    • service: any

      service de la couche

    Returns null | string

    • long layer ID or null if not found

    Description

    This method retrieves the long layer ID based on the provided name and service. It searches through the layersList object for a key that matches the pattern of "name.*service". If a match is found, it returns the key; otherwise, it returns null.

    Example

    getLayerId("GEOGRAPHICALGRIDSYSTEMS.PLANIGNV2", "WMTS");
    getLayerId("PLAN.IGN", "GEOPORTAIL:TMS");

getLayersByCategory

  • getLayersByCategory(category: any, layers: any): any

    Get layers by category This method filters the layers based on the provided category. It checks if the category has a filter defined and applies it to the layers. If the filter matches, the layer is added to the layersCategorised object. It also updates the categories property of each layer to include the category ID.

    Parameters

    • category: any

      Category object containing the filter.

    • layers: any

      Object containing all layers.

    Returns any

    • Filtered layers categorized by the provided category.

getListeners

  • getListeners(type: string): undefined | Listener[]

    Get the listeners for a specified event type. Listeners are returned in the order that they will be called in.

    Parameters

    • type: string

      Type.

    Returns undefined | Listener[]

    Listeners.

getMap

  • getMap(): null | Map

    Get the map associated with this control.

    Returns null | Map

    Map.

    Api

getProperties

  • getProperties(): { [x: string]: any }

    Get an object of all property names and values.

    Returns { [x: string]: any }

    Object.

    Api

getPropertiesInternal

  • getPropertiesInternal(): null | { [x: string]: any }

    Get an object of all property names and values.

    Returns null | { [x: string]: any }

    Object.

getRevision

  • getRevision(): number

    Get the version number for this object. Each time the object is modified, its version number will be incremented.

    Returns number

    Revision.

    Api

hasListener

  • hasListener(type?: string): boolean

    Parameters

    • Optionaltype: string

      Type. If not provided, true will be returned if this event target has any listeners.

    Returns boolean

    Has listeners.

hasProperties

  • hasProperties(): boolean

    Returns boolean

    The object has properties.

hideWaiting

notify

  • notify(key: string, oldValue: any): void

    Parameters

    • key: string

      Key name.

    • oldValue: any

      Old value.

    Returns void

ProtectedonceInternal

  • onceInternal(
        type: string | string[],
        listener: (arg0: Event | BaseEvent) => unknown,
    ): EventsKey | EventsKey[]
    Protected

    Parameters

    • type: string | string[]

      Type.

    • listener: (arg0: Event | BaseEvent) => unknown

      Listener.

    Returns EventsKey | EventsKey[]

    Event key.

ProtectedonInternal

  • onInternal(
        type: string | string[],
        listener: (arg0: Event | BaseEvent) => unknown,
    ): EventsKey | EventsKey[]
    Protected

    Parameters

    • type: string | string[]

      Type.

    • listener: (arg0: Event | BaseEvent) => unknown

      Listener.

    Returns EventsKey | EventsKey[]

    Event key.

onSearchSpecificCatalogButtonResetClick

removeChangeListener

  • removeChangeListener(key: string, listener: Listener): void

    Parameters

    • key: string

      Key name.

    • listener: Listener

      Listener.

    Returns void

removeEventListener

  • removeEventListener(type: string, listener: Listener): void

    Parameters

    • type: string

      Type.

    • listener: Listener

      Listener.

    Returns void

render

  • render(mapEvent: MapEvent): void

    Renders the control.

    Parameters

    • mapEvent: MapEvent

      Map event.

    Returns void

    Api

set

  • set(key: string, value: any, silent?: boolean): void

    Sets a value.

    Parameters

    • key: string

      Key name.

    • value: any

      Value.

    • Optionalsilent: boolean

      Update without triggering an event.

    Returns void

    Api

setCollapsed

  • setCollapsed(collapsed: boolean): void

    Collapse or display widget main container

    Parameters

    • collapsed: boolean

      True to collapse widget, False to display it

    Returns void

setMap

  • setMap(map: Map): void

    Overwrite OpenLayers setMap method This method sets the map for the Catalog control. It initializes event listeners for the map and sets up the control's draggable and collapsed states. It also checks for existing layers on the map and updates the control accordingly.

    Parameters

    • map: Map

      Map instance to set for the control.

    Returns void

setPosition

setProperties

  • setProperties(values: { [x: string]: any }, silent?: boolean): void

    Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

    Parameters

    • values: { [x: string]: any }

      Values.

    • Optionalsilent: boolean

      Update without triggering an event.

    Returns void

    Api

setTarget

  • setTarget(target: string | HTMLElement): void

    This function is used to set a target element for the control. It has no effect if it is called after the control has been added to the map (i.e. after setMap is called on the control). If no target is set in the options passed to the control constructor and if setTarget is not called then the control is added to the map's overlay container.

    Parameters

    • target: string | HTMLElement

      Target.

    Returns void

    Api

showWaiting

ProtectedunInternal

  • unInternal(
        type: string | string[],
        listener: (arg0: Event | BaseEvent) => unknown,
    ): void
    Protected

    Unlisten for a certain type of event.

    Parameters

    • type: string | string[]

      Type.

    • listener: (arg0: Event | BaseEvent) => unknown

      Listener.

    Returns void

unset

  • unset(key: string, silent?: boolean): void

    Unsets a property.

    Parameters

    • key: string

      Key name.

    • Optionalsilent: boolean

      Unset without triggering an event.

    Returns void

    Api

updatePosition

Events

ADD_CATALOG_LAYER_EVENT

ADD_CATALOG_LAYER_EVENT: undefined | string

event triggered when layer is added

catalog:layer:add

Default Value

"catalog:layer:add"

Example

Catalog.on("catalog:layer:add", function (e) {
  console.log(e.layer);
})

LOADED_CATALOG_EVENT

LOADED_CATALOG_EVENT: undefined | string

event triggered when data is loaded

catalog:loaded

Default Value

"catalog:loaded"

Example

Catalog.on("catalog:loaded", function (e) {
  console.log(e.data);
})

REMOVE_CATALOG_LAYER_EVENT

REMOVE_CATALOG_LAYER_EVENT: undefined | string

event triggered when layer is removed

catalog:layer:remove

Default Value

"catalog:layer:remove"

Example

Catalog.on("catalog:layer:remove", function (e) {
  console.log(e.layer);
})

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
Events