layer/layerRec/wmsRecord.js

  1. 'use strict';
  3. const wmsFC = require('./wmsFC.js')();
  4. const placeholderFC = require('./placeholderFC.js')();
  5. const layerRecord = require('./layerRecord.js')();
  6. const shared = require('./shared.js')();
  8. /**
  9.  * @class WmsRecord
  10.  */
  11. class WmsRecord extends layerRecord.LayerRecord {
  13.     /**
  14.      * Create a layer record with the appropriate geoApi layer type.  Layer config
  15.      * should be fully merged with all layer options defined (i.e. this constructor
  16.      * will not apply any defaults).
  17.      * @param {Object} layerClass    the ESRI api object for wms layers
  18.      * @param {Object} apiRef        object pointing to the geoApi. allows us to call other geoApi functions.
  19.      * @param {Object} config        layer config values
  20.      * @param {Object} esriLayer     an optional pre-constructed layer
  21.      * @param {Function} epsgLookup  an optional lookup function for EPSG codes (see geoService for signature)
  22.      */
  23.     constructor (layerClass, apiRef, config, esriLayer, epsgLookup) {
  24.         super(layerClass, apiRef, config, esriLayer, epsgLookup);
  26.         // handles placeholder symbol, possibly other things
  27.         this._defaultFC = '0';
  28.         this._featClasses['0'] = new placeholderFC.PlaceholderFC(this, this.name);
  30.     }
  32.     get layerType () { return shared.clientLayerType.OGC_WMS; }
  34.     makeLayerConfig () {
  35.         const cfg = super.makeLayerConfig();
  36.         cfg.visibleLayers = this.config.layerEntries.map(le => le.id);
  37.         return cfg;
  38.     }
  40.     /**
  41.     * Triggers when the layer loads.
  42.     *
  43.     * @function onLoad
  44.     */
  45.     onLoad () {
  46.         const loadPromises = super.onLoad();
  48.         const fc = new wmsFC.WmsFC(this, '0', this.config);
  49.         this._featClasses['0'] = fc;
  51.         loadPromises.push(fc.loadSymbology());
  53.         Promise.all(loadPromises).then(() => {
  54.             this._stateChange(shared.states.LOADED);
  55.         });
  56.     }
  58.     /**
  59.      * Run a getFeatureInfo on a WMS layer, return the result as a promise.  Fills the panelData array on resolution.
  60.      *
  61.      * @param {Object} opts additional argumets like map object, clickEvent, etc.
  62.      * @returns {Object} an object with identify results array and identify promise resolving when identify is complete; if an empty object is returned, it will be skipped
  63.      */
  64.     identify (opts) {
  65.         // TODO add full documentation for options parameter
  67.         // TODO consider having a constants area in geoApi / better place for this definition
  68.         const infoMap = {
  69.             'text/html;fgpv=summary': 'HTML',
  70.             'text/html': 'HTML',
  71.             'text/plain': 'Text',
  72.             'application/json': 'EsriFeature'
  73.         };
  75.         // ignore layers with no mime type
  76.         if (!infoMap.hasOwnProperty(this.config.featureInfoMimeType)) {
  77.             return {};
  78.         }
  80.         // TODO fix these params
  81.         // TODO legendEntry.name, legendEntry.symbology appear to be fast links to populate the left side of the results
  82.         //      view.  perhaps it should not be in this object anymore?
  83.         // TODO see how the client is consuming the internal pointer to layerRecord.  this may also now be
  84.         //      directly available via the legend object.
  85.         const identifyResult =
  86.             new shared.IdentifyResult('legendEntry.name', 'legendEntry.symbology',
  87.                 infoMap[this.config.featureInfoMimeType], this);
  89.         const identifyPromise = this._apiRef.layer.ogc
  90.             .getFeatureInfo(
  91.                 this._layer,
  92.                 opts.clickEvent,
  93.                 this.config.layerEntries.map(le => le.id),
  94.                 this.config.featureInfoMimeType)
  95.             .then(data => {
  96.                 identifyResult.isLoading = false;
  98.                 // TODO: check for French service
  99.                 // check if a result is returned by the service. If not, do not add to the array of data
  100.                 if (data.indexOf('Search returned no results') === -1 && data !== '') {
  101.                     identifyResult.data.push(data);
  102.                 }
  104.                 // console.info(data);
  105.             });
  107.         return { identifyResults: [identifyResult], identifyPromise };
  108.     }
  109. }
  111. module.exports = () => ({
  112.     WmsRecord
  113. });