<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: layers/LayerBaseVectorEsri.js</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Source: layers/LayerBaseVectorEsri.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>/**
* Created by gavorhes on 11/2/2015.
*/
import $ from '../jquery/jquery';
import LayerBaseVector from './LayerBaseVector';
import * as esriToOl from '../olHelpers/esriToOlStyle';
import provide from '../util/provide';
import ol from '../ol/ol';
let nm = provide('layers');
/**
* Base layer for esri vector layers
* @augments LayerBaseVector
*/
class LayerBaseVectorEsri extends LayerBaseVector {
/**
* The base vector layer
* @param {string} url - url for source
* @param {object} options - config
* @param {string} [options.id] - layer id
* @param {string} [options.name=Unnamed Layer] - layer name
* @param {number} [options.opacity=1] - opacity
* @param {boolean} [options.visible=true] - default visible
* @param {number} [options.minZoom=undefined] - min zoom level, 0 - 28
* @param {number} [options.maxZoom=undefined] - max zoom level, 0 - 28
* @param {object} [options.params={}] the get parameters to include to retrieve the layer
* @param {number} [options.zIndex=0] the z index for the layer
* @param {function} [options.loadCallback] function to call on load, context this is the layer object
* @param {boolean} [options.legendCollapse=false] if the legend item should be initially collapsed
* @param {boolean} [options.legendCheckbox=true] if the legend item should have a checkbox for visibility
* @param {boolean} [options.legendContent] additional content to add to the legend
*
* @param {boolean} [options.autoLoad=false] if the layer should auto load if not visible
* @param {object} [options.style=undefined] the layer style, use openlayers default style if not defined
* @param {boolean} [options.onDemand=false] if the layer should be loaded by extent on map move
* @param {number} [options.onDemandDelay=300] delay before the map move callback should be called
* @param {MapMoveCls} [options.mapMoveObj=mapMove] alternate map move object for use with multi map pages
*
* @param {string} [options.where=1=1] the layer filter clause
* @param {string} [options.outFields=*] comma separated list of output fields, defaults to all
* @param {string} [options.format=pjson] the format the retrieve the data
* @param {number} [options.outSR=3857] the output spatial reference, defaults to web mercator
* @param {boolean} [options.useEsriStyle=false] if the map service style should be used
* @param {boolean} [options.collapseLegend=false] if the legend should be initially collapsed
* @param {number} [options.mapMoveMakeGetParams=function(extent, zoomLevel){}] function to create additional map move params
*/
constructor(url, options) {
if (typeof options.params != 'object') {
options.params = {};
}
options.params['where'] = options.where || '1=1';
options.params['outFields'] = options.outFields || '*';
options.params['f'] = options.format || 'pjson';
options.params['outSR'] = options.outSR || 3857;
super(url, options);
this._outSR = this.params['outSR'];
this._esriFormat = new ol.format.EsriJSON();
if (this._url[this._url.length - 1] !== '/') {
this._url += '/';
}
this._urlCopy = this.url;
this._url += 'query?callback=?';
if (this.autoLoad || this.visible) {
this._load();
}
this._useEsriStyle = typeof options.useEsriStyle == 'boolean' ? options.useEsriStyle : false;
if (this._useEsriStyle) {
this.addLegendContent();
}
}
/**
* add additional content to the legend
* @param {string} [additionalContent=''] additional content to add to legend
*/
addLegendContent(additionalContent) {
if (!this._useEsriStyle) {
super.addLegendContent(additionalContent);
} else {
$.get(this._urlCopy + '?f=pjson&callback=?', {}, (d) => {
if (d['subLayers'].length > 0) {
alert('should only use single feature layers, not groups');
return;
}
let newStyleAndLegend = esriToOl.makeFeatureServiceLegendAndSymbol(d);
this.style = newStyleAndLegend.style;
super.addLegendContent(newStyleAndLegend.legend);
}, 'json');
}
}
/**
* add feature collection
* @param {object} featureCollection - features as esrijson
*/
addFeatures(featureCollection) {
let feats = this._esriFormat.readFeatures(featureCollection);
this.source.addFeatures(feats);
}
/**
* trigger load features
* @protected
* @returns {boolean} if already loaded
*/
_load() {
if (super._load()) {
return true;
}
$.get(this._url, this.params, (d) => {
this.addFeatures(d);
this.loadCallback(this);
}, 'json').fail(() => {
this._loaded = false;
});
return false;
}
/**
* callback to generate the parameters passed in the get request
* @param {object} extent - extent object
* @param {number} extent.minX - minX
* @param {number} extent.minY - minY
* @param {number} extent.maxX - maxX
* @param {number} extent.maxY - maxY
* @param {number} zoomLevel - zoom level
*/
mapMoveMakeGetParams(extent, zoomLevel) {
super.mapMoveMakeGetParams(extent, zoomLevel);
this.mapMoveParams['geometry'] = `${extent.minX},${extent.minY},${extent.maxX},${extent.maxY}`;
this.mapMoveParams['geometryType'] = 'esriGeometryEnvelope';
this.mapMoveParams['spatialRel'] = 'esriSpatialRelIntersects';
this.mapMoveParams['spatialRel'] = 'esriSpatialRelIntersects';
this.mapMoveParams['inSR'] = 3857;
if (this._outSR == 3857) {
this.mapMoveParams['geometryPrecision'] = 1;
}
}
/**
* Before call to map move callback, can prevent call by returning false
* @param {number} zoom - zoom level
* @param {string} [evtType=undefined] undefined for initial load, otherwise one of 'change:center', 'change:resolution'
* @returns {boolean} if the call should proceed
*/
mapMoveBefore(zoom, evtType) {
return super.mapMoveBefore(zoom, evtType);
//if (super.mapMoveBefore(zoom, evtType)){
// //place holder for additional processing
// return true;
//} else {
// return false;
//}
}
/**
* callback function on map move
* @param {object} d - the json response
*/
mapMoveCallback(d) {
super.mapMoveCallback(d);
this.source.addFeatures(this._esriFormat.readFeatures(d));
}
}
nm.LayerBaseVectorEsri = LayerBaseVectorEsri;
export default LayerBaseVectorEsri;
</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="-_FeatureLayerProperties.html">_FeatureLayerProperties</a></li><li><a href="-_Slider.html">_Slider</a></li><li><a href="CommonSymbol.html">CommonSymbol</a></li><li><a href="DayRange.html">DayRange</a></li><li><a href="ItsLayerCollection.html">ItsLayerCollection</a></li><li><a href="LayerBase.html">LayerBase</a></li><li><a href="LayerBaseVector.html">LayerBaseVector</a></li><li><a href="LayerBaseVectorEsri.html">LayerBaseVectorEsri</a></li><li><a href="LayerBaseVectorGeoJson.html">LayerBaseVectorGeoJson</a></li><li><a href="LayerBaseXyzTile.html">LayerBaseXyzTile</a></li><li><a href="LayerEsriMapServer.html">LayerEsriMapServer</a></li><li><a href="LayerEsriTile.html">LayerEsriTile</a></li><li><a href="LayerGroup.html">LayerGroup</a></li><li><a href="LayerItsInventory.html">LayerItsInventory</a></li><li><a href="LayerLegend.html">LayerLegend</a></li><li><a href="LayerRealEarthTile.html">LayerRealEarthTile</a></li><li><a href="LayerSwipe.html">LayerSwipe</a></li><li><a href="LayerVectorRealEarth.html">LayerVectorRealEarth</a></li><li><a href="MapInteractionBase.html">MapInteractionBase</a></li><li><a href="MapMoveCls.html">MapMoveCls</a></li><li><a href="MapPopupCls.html">MapPopupCls</a></li><li><a href="RealEarthAnimate.html">RealEarthAnimate</a></li><li><a href="RealEarthAnimateTile.html">RealEarthAnimateTile</a></li><li><a href="RealEarthAnimateVector.html">RealEarthAnimateVector</a></li><li><a href="SingleSymbol.html">SingleSymbol</a></li><li><a href="Sliders.html">Sliders</a></li><li><a href="SortedFeatures.html">SortedFeatures</a></li><li><a href="UniqueValueSymbol.html">UniqueValueSymbol</a></li></ul><h3>Global</h3><ul><li><a href="global.html#$">$</a></li><li><a href="global.html#bundleEs2015Multiple">bundleEs2015Multiple</a></li><li><a href="global.html#calculateExtent">calculateExtent</a></li><li><a href="global.html#dateToYyyyMmDdHh000">dateToYyyyMmDdHh000</a></li><li><a href="global.html#dateToYyyyMmDdHhMmSs">dateToYyyyMmDdHhMmSs</a></li><li><a href="global.html#definedAndNotNull">definedAndNotNull</a></li><li><a href="global.html#defineLegend">defineLegend</a></li><li><a href="global.html#defineStyle">defineStyle</a></li><li><a href="global.html#fitToMap">fitToMap</a></li><li><a href="global.html#getUrlParams">getUrlParams</a></li><li><a href="global.html#gulp">gulp</a></li><li><a href="global.html#hexAlphaToRgbOrRgba">hexAlphaToRgbOrRgba</a></li><li><a href="global.html#htmlEscape">htmlEscape</a></li><li><a href="global.html#keyValPairs">keyValPairs</a></li><li><a href="global.html#makeBlueGreenRedGradient">makeBlueGreenRedGradient</a></li><li><a href="global.html#makeBlueGreenRedGradientZScore">makeBlueGreenRedGradientZScore</a></li><li><a href="global.html#makeFeatureServiceLegendAndSymbol">makeFeatureServiceLegendAndSymbol</a></li><li><a href="global.html#makeGuid">makeGuid</a></li><li><a href="global.html#makeMapServiceLegend">makeMapServiceLegend</a></li><li><a href="global.html#mapServiceLegendItem">mapServiceLegendItem</a></li><li><a href="global.html#offsetMinutes">offsetMinutes</a></li><li><a href="global.html#overflowScroll">overflowScroll</a></li><li><a href="global.html#processLessFile">processLessFile</a></li><li><a href="global.html#propertiesZoomStyle">propertiesZoomStyle</a></li><li><a href="global.html#provide">provide</a></li><li><a href="global.html#quickMap">quickMap</a></li><li><a href="global.html#quickMapBase">quickMapBase</a></li><li><a href="global.html#quickMapMulti">quickMapMulti</a></li><li><a href="global.html#resolutionToZoom">resolutionToZoom</a></li><li><a href="global.html#responsiveScroll">responsiveScroll</a></li><li><a href="global.html#rgb2hex">rgb2hex</a></li><li><a href="global.html#rgbToRgba">rgbToRgba</a></li><li><a href="global.html#triggerCallback">triggerCallback</a></li><li><a href="global.html#undefinedOrNull">undefinedOrNull</a></li><li><a href="global.html#windowScroll">windowScroll</a></li><li><a href="global.html#zoomToResolution">zoomToResolution</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Jul 18 2016 20:02:34 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>