Mviewer 4.1 vers 4.2¶
Custom controls et custom layers : portée des variables JavaScript¶
Le chargement des custom controls et des custom layers dans configuration.js utilise désormais fetch puis un élément <script> classique, à la place du chargement jQuery. Leur portée d’exécution diffère : les custom controls s’exécutent directement dans la portée globale, tandis que le chargeur enveloppe automatiquement chaque custom layer dans une fonction pour isoler ses déclarations.
Pour les custom controls, le callback de fetch ne crée pas de portée locale pour le code chargé. Retirer l’élément <script> après exécution ne supprime pas les déclarations globales. Si plusieurs contrôles déclarent const layerid ou const cc au niveau global, le chargement peut échouer avec une erreur de redéclaration, par exemple SyntaxError: Identifier 'layerid' has already been declared. Le risque concerne aussi les déclarations avec let.
Remplacer const par var ne crée pas de portée locale : les variables restent globales et peuvent être écrasées par un autre script. Pour isoler les custom controls, enveloppez chaque fichier dans une IIFE (Immediately Invoked Function Expression, ou fonction immédiatement invoquée). Les custom layers bénéficient de cette isolation automatiquement, sans enveloppe à ajouter dans leurs fichiers.
Adaptation des contrôles existants¶
Enveloppez tout le contenu de chaque fichier JavaScript de custom control dans une fonction immédiatement invoquée (IIFE), y compris la déclaration de layerid et l’enregistrement du contrôle :
(function() {
const layerid = "heatmap";
const cc = {
init: function () {
// Initialiser le contrôle et ajouter ses écouteurs.
},
destroy: function () {
// Retirer les écouteurs et libérer les références conservées.
}
};
new CustomControl(layerid, cc.init, cc.destroy);
}());
Cette isolation s’applique également à l’ancienne méthode d’enregistrement via mviewer.customControls[layerid]. Conservez les variables internes dans l’IIFE, avec const pour les références non réaffectées et let pour l’état modifiable.
Pour exposer des méthodes publiques supplémentaires, ajoutez-les au contrôle enregistré dans mviewer.customControls[layerid]. Avec CustomControl, conservez l’instance créée dans une variable locale et ajoutez-y ces méthodes. Adaptez les appels qui utilisaient une variable globale telle que cc pour passer par mviewer.customControls["heatmap"].
Custom layers : isolation automatique par le chargeur¶
Les fichiers JavaScript des custom layers conservent leur syntaxe directe, sans IIFE à ajouter. Le chargeur crée une portée locale pour chaque fichier, y compris pour ses déclarations const, let, var et ses classes.
Plusieurs couches peuvent donc déclarer une variable layer sans collision.
const layerid = "heatmap";
const layer = new ol.layer.Heatmap({
source: new ol.source.Vector({
url: "demo/heatmap/data/2012_Earthquakes_Mag5.kml",
format: new ol.format.KML({
extractStyles: false
})
}),
blur: 10,
radius: 10
});
new CustomLayer(layerid, layer);
L’enregistrement avec new CustomLayer(...) ou l’ancienne méthode mviewer.customLayers[layerid] reste nécessaire pour rendre la couche accessible à mviewer.
Pour accéder à la couche depuis un autre script, utilisez mviewer.customLayers["heatmap"].layer.
Adaptez les éventuels appels qui dépendaient de variables ou de fonctions globales déclarées dans les fichiers custom layers : ces déclarations sont désormais locales.
Ajoutez les méthodes publiques nécessaires à l’instance enregistrée dans mviewer.customLayers.
A noter qu’une IIFE déjà présente dans un fichier peut être conservée.
Les exemples sont disponibles dans Développer un customLayer et Approfondir - Custom Layer.
Custom controls : nettoyage lors de la fermeture du panneau¶
Les exemples de la documentation retirent désormais dans destroy() les écouteurs ajoutés par init(), avec les mêmes fonctions de rappel, puis remettent à null les références aux éléments DOM et à la couche.
Le drapeau _initialized est aussi réinitialisé pour permettre la réouverture du contrôle.
Reportez ce nettoyage dans vos contrôles personnalisés.
Les deux exemples complets sont disponibles dans Développer un customControl. Après adaptation, vérifiez le chargement simultané de plusieurs contrôles ainsi que la fermeture et la réouverture de leur panneau, sans erreur de redéclaration ni écouteur restant actif après destruction.
Vérifiez également une configuration chargeant plusieurs custom layers et leurs custom controls : toutes les couches doivent être enregistrées et affichées, sans erreur de redéclaration dans la console du navigateur.