update jsdoc / bundles to release OpenLayers : ol-3.4.3

current/dist/openlayers/GpPluginOpenLayers-map.css

@@ -9,8 +9,8 @@
  * @copyright copyright (c) IGN 
  * @license CeCILL-B
  * @author IGN
- * @version 3.4.2
- * @date 17/04/2024
+ * @version 3.4.3
+ * @date 14/05/2024
  *
  */
 

current/dist/openlayers/GpPluginOpenLayers-src.css

@@ -9,8 +9,8 @@
  * @copyright copyright (c) IGN 
  * @license CeCILL-B
  * @author IGN
- * @version 3.4.2
- * @date 17/04/2024
+ * @version 3.4.3
+ * @date 14/05/2024
  *
  */
 

current/dist/openlayers/OpenLayers/Controls/Editor.d.ts

@@ -120,137 +120,15 @@ export default Editor;
  *   // possibility to add listeners with globale variable : eventbus
  *   eventbus.addEventListener("editor:style:scale:onchangemin", function (e) {...});
  */
-declare function Editor(options: Object): void;
 declare class Editor {
+    constructor(options: any);
+    options: any;
     /**
-     * @classdesc
-     *
-     * Editor Styles MapBox...
-     *
-     * @constructor
-     * @alias ol.style.Editor
-     * @param {Object} options - options for function call.
-     * @fires editor:layer:onclickvisibility
-     * @fires editor:layer:onclickclone
-     * @fires editor:layer:onclickremove
-     * @fires editor:style:oneditjson
-     * @fires editor:style:scale:onchangemin
-     * @fires editor:style:scale:onchangemax
-     * @fires editor:legend:onclickedition
-     * @fires editor:legend:onchangevalue
-     * @fires editor:filter:oneditjson
-     * @fires editor:themes:onclickimage
-     * @fires editor:themes:onclicktitle
-     * @fires editor:group:oncollapse
-     * @fires editor:onloaded
-     * @example
-     *   var editor = new Editor ({
-     *      target : "",
-     *      style : "data/styles/layer.json",
-     *      themes: {
-     *          themesSummary : "",
-     *          themes : [{
-     *             "thumbnail": "data/images/layer0.png",
-     *             "name": "standard0",
-     *             "url": "data/styles/layer0.json",
-     *             "description": "",
-     *             "selected" : true
-     *          },{
-     *             "thumbnail": "data/images/layer1.png",
-     *             "name": "standard1",
-     *             "url": "data/styles/layer1.json",
-     *             "description": ""
-     *          }]
-     *      },
-     *      scope : this,
-     *      events : {
-     *          "editor:layer:onclickvisibility" : ...,
-     *          "editor:layer:onclickclone" : ...,
-     *          "editor:layer:onclickremove" : ...,
-     *          "editor:style:oneditjson" : ...,
-     *          "editor:style:scale:onchangemin" : ...,
-     *          "editor:style:scale:onchangemax" : ...,
-     *          "editor:filter:oneditjson" : ...,
-     *          "editor:themes:onclickimage" : this._onClickEventImageTheme(),
-     *          "editor:themes:onclicktitle" : function(e) {...}
-     *      },
-     *      tools : {
-     *          // afficher/cacher les themes (par defaut) ou utiliser les options
-     *          themes : true | false | {
-     *              target : "...",
-     *              tools : {
-     *                  "thumbnails": true,
-     *                  "button": { visible : true, type : "checkbox" }
-     *              },
-     *          },
-     *          layers : true | false,     // afficher les couches (layers)
-     *          search : true | false,     // TODO : afficher l'outil de recheche de couches
-     *          style : true | false,      // afficher les styles (sous menu layers)
-     *          filter : true | false,     // afficher les filtres (sous menu layers)
-     *          legend : true | false,     // afficher les legendes (layers)
-     *          group : true | false,      // grouper les couches, l'option 'sort' doit être activée (layers)
-     *          groupAuto : true | false,  // definir la construction automatiques des groupes
-     *          sort : true | false,       // trier les couches (layers)
-     *          sortBy : "id|class|geom",  // definir le type de tri (layers)
-     *          sortOrder : "asc, desc",   // definir l'ordre de tri (layers)
-     *          title : true | false       // afficher les titres des rubriques,
-     *          collapse : true | false | undefined // afficher et/ou plier les couches ou ne pas afficher l'option,
-     *          type : true | false,       // afficher le type de geometrie (layers)
-     *          pin : true | false,        // afficher la puce pour chaque couche (layers)
-     *          visibility : true | false, // afficher l'icone de visibilité (layers),
-     *          icon : {                   // afficher l'icone "oeil" ou "checkbox" (layers),
-     *              "image" : true,
-     *              "anchor" : "start" // afficher l'icone au debut ou à la fin de la ligne
-     *          },
-     *          editable : true | false    // active l'edition de la legende (legendes)
-     *      }
-     *   });
-     *   // options par defaut
-     *   {
-     *      themes : false,
-     *      layers : true,
-     *      search : false,
-     *      style : false,
-     *      filter : false,
-     *      legend : false,
-     *      group : false,
-     *      groupAuto : false,
-     *      sort : true,
-     *      sortBy : "id",
-     *      sortOrder : "asc",
-     *      title : true,
-     *      collapse : undefined,
-     *      type : true,
-     *      pin : true,
-     *      visibility : true,
-     *      icon : {
-     *          image : true,
-     *          anchor : "end"
-     *      },
-     *      editable : true
-     *   }
-     *   // Context
-     *   editor.setContext("map", map);
-     *   editor.setContext("layer", layer);
-     *   // create DOM
-     *   editor.createElement()
-     *     .then(() => {
-     *       console.warn(editor.getID());
-     *       console.log(this.getContext("map"));
-     *       console.log(this.getContext("layer"));
-     *     })
-     *     .catch(error => {});
-     *   // possibility to add listeners with globale variable : eventbus
-     *   eventbus.addEventListener("editor:style:scale:onchangemin", function (e) {...});
-     */
-    constructor(options: Object);
-    options: Object;
-    /**
-     * Constructor (alias)
+     * Initialize component
+     * (called by constructor)
      *
      * @private
      */
-    private constructor;
     private _initialize;
     id: any;
     context: {} | undefined;
@@ -269,8 +147,57 @@ declare class Editor {
     } | undefined;
     mapbox: any;
     sprites: {} | undefined;
+    /**
+    * Initialize events with handlers
+    * (called by constructor)
+    *
+    * List Events :
+    *          "editor:layer:visibility"
+    *          "editor:layer:clone"
+    *          "editor:layer:remove"
+    *          "editor:style:edit"
+    *          "editor:style:minScale"
+    *          "editor:style:maxScale"
+    *          "editor:filter:edit"
+    *          "editor:themes:image",
+    *          "editor:themes:title"
+    * @private
+    */
     private _initEvents;
+    /**
+     * Graphical rendering of the component
+     * (called by constructor)
+     *
+     * @example
+     *  <div class="GPEditorMapBoxContainer" id="GPEditorMapBoxContainer_ID_0">
+     *    <div id="GPEditorMapBoxThemesTitle" class="GPEditorMapBoxThemesTitle">Liste des 'thèmes'</div>
+     *    <div class="GPEditorMapBoxThemesContainer">
+     *      ...
+     *    </div>
+     *    <div id="GPEditorMapBoxLayersTitle" class="GPEditorMapBoxLayersTitle">Liste des 'couches'</div>
+     *    <div class="GPEditorMapBoxLayersContainer">
+     *      <div class="GPEditorMapBoxLayerContainer">
+     *          <div id="GPEditorMapBoxLayerTitleContainer-0_1" class="GPEditorMapBoxLayerTitleContainer">
+     *              <label class="GPEditorMapBoxLayerImageLabel"></label>
+     *              <input id="GPEditorMapBoxLayerTitleInput-0_1" class="GPEditorMapBoxLayerTitleInput" type="checkbox">
+     *              <label class="GPEditorMapBoxLayerTitleLabel" for="GPEditorMapBoxLayerTitleInput-0_1" title="states">population_lt_2m</label>
+     *          </div>
+     *      </div>
+     *      <div class="GPEditorMapBoxLayerContainer">...</div>
+     *      <div class="GPEditorMapBoxLayerContainer">...</div>
+     *    </div>
+     *  </div>
+     * @private
+     */
     private _initContainer;
+    /**
+     * Getting Sprites informations
+     * (called by _initialize)
+     *
+     * @param {String} sprites - url des sprites
+     * @returns {Promise} - promise
+     * @private
+     */
     private _getSprites;
     /**
      * Create Editor

current/dist/openlayers/OpenLayers/Controls/Editor/Filter.d.ts

@@ -23,40 +23,15 @@ export default Filter;
  *  filter.display(true);
  *  filter.getContainer();
  */
-declare function Filter(options: Object): void;
 declare class Filter {
+    constructor(options: any);
+    options: any;
     /**
-     * @classdesc
-     *
-     * MapBox filter management
-     *
-     * @constructor
-     * @alias ol.style.editor.Filter
-     * @param {Object} options - options for function call.
-     * @example
-     *   var filter = new Filter ({
-     *      target : ...,
-     *      position : 1, // identifiant de position (unique !)
-     *      tools : {
-     *          edition : false
-     *      },
-     *      title : "Filtres (JSON)",
-     *      obj : {
-     *          filter : []
-     *      }
-     *   });
-     *  filter.add();
-     *  filter.display(true);
-     *  filter.getContainer();
-     */
-    constructor(options: Object);
-    options: Object;
-    /**
-     * Constructor (alias)
+     * Initialize component
+     * (called by constructor)
      *
      * @private
      */
-    private constructor;
     private _initialize;
     id: any;
     container: HTMLDivElement | null | undefined;
@@ -68,6 +43,20 @@ declare class Filter {
         jsondisplay: string;
         containertoolsedit: string;
     } | undefined;
+    /**
+     * Graphical rendering of the component
+     * (called by constructor)
+     *
+     * @private
+     * @example
+     * <div class="GPEditorMapBoxFilterContainer">
+     *  <div class ="GPEditorMapBoxFilterJsonontainer">
+     *     <label class="GPEditorMapBoxFilterTitleJson">JSON Filtres :</label>
+     *     <pre class="GPEditorMapBoxFilterDisplayJson">...</pre>
+     *  </div>
+     *  <div class ="GPEditorMapBoxStyleToolsEditionContainer"></div>
+     * </div>
+     */
     private _initContainer;
     /**
      * Add element into target DOM
@@ -87,6 +76,16 @@ declare class Filter {
      * @returns {DOMElement} DOM element
      */
     getContainer(): DOMElement;
+    /**
+     * this method is called by event '' on '' tag form...
+     *
+     * 'e' contains the option object into 'e.target.data' !
+     * 'e' contains the id editor into 'e.target.editorID' !
+     *
+     * @param {Object} e - HTMLElement
+     * @private
+     * @fires Filter#editor:style:oneditjson
+     */
     private onEditJsonFilterMapBox;
 }
 //# sourceMappingURL=Filter.d.ts.map

current/dist/openlayers/OpenLayers/Controls/Editor/Group.d.ts

@@ -16,33 +16,15 @@ export default Group;
  *   group.add();
  *   group.add();
  */
-declare function Group(options: Object): void;
 declare class Group {
+    constructor(options: any);
+    options: any;
     /**
-     * @classdesc
-     *
-     * MapBox group management
-     *
-     * @constructor
-     * @alias ol.style.editor.Group
-     * @param {Object} options - options for function call.
-     * @example
-     *   var group = new Group ({
-     *      title : "MyGroup",
-     *      collapse : true, // plier/deplier
-     *      target : ...
-     *   });
-     *   group.add();
-     *   group.add();
-     */
-    constructor(options: Object);
-    options: Object;
-    /**
-     * Constructor (alias)
+     * Initialize component
+     * (called by constructor)
      *
      * @private
      */
-    private constructor;
     private _initialize;
     id: any;
     container: HTMLDivElement | null | undefined;
@@ -52,6 +34,14 @@ declare class Group {
         details: string;
         summary: string;
     } | undefined;
+    /**
+     * Graphical rendering of the component
+     * (called by constructor)
+     *
+     * @private
+     * @example
+     * <div class="GPEditorMapBoxGroupContainer">...</div>
+     */
     private _initContainer;
     /**
      * Add element into target DOM
@@ -69,6 +59,14 @@ declare class Group {
      * @returns {DOMElement} DOM element
      */
     getContainer(): DOMElement;
+    /**
+     * this method is called by event '' on '' tag form
+     *
+     * NOT USED !
+     * @param {Object} e - HTMLElement
+     * @private
+     * @fires Group#editor:group:oncollapse
+     */
     private onCollapseGroupMapBox;
 }
 //# sourceMappingURL=Group.d.ts.map