Create a Layer class to access the ArcGIS 9.3 Map Export service. Patch by
Jeff Adams, from Avencia. r=me. Tested with the default service, and several other example map services from ESRI (like http://sampleserver1.arcgisonline.com/ArcGIS/rest/services/Specialty/ESRI_StatesCitiesRivers_USA/MapServer/export). Note that I don't believe this takes advantage of map caches; if we create a seperate layer for that, we should probably create a Layer.ArcGIS. namespace. (Closes #1749) git-svn-id: http://svn.openlayers.org/trunk/openlayers@8917 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
This commit is contained in:
crschmidt
252
lib/OpenLayers/Layer/ArcGIS93Rest.js
Normal file
252
lib/OpenLayers/Layer/ArcGIS93Rest.js
Normal file
@@ -0,0 +1,252 @@
|
||||
/* Copyright (c) 2008 Avencia, Inc., published under the Clear BSD
|
||||
* license. See http://svn.openlayers.org/trunk/openlayers/license.txt for the
|
||||
* full text of the license. */
|
||||
|
||||
|
||||
/**
|
||||
* @requires OpenLayers/Layer/Grid.js
|
||||
* @requires OpenLayers/Tile/Image.js
|
||||
*/
|
||||
|
||||
/**
|
||||
* Class: OpenLayers.Layer.ArcGIS93Rest
|
||||
* Instances of OpenLayers.Layer.ArcGIS93Rest are used to display data from
|
||||
* ESRI ArcGIS Server 9.3 (and up?) Mapping Services using the REST API.
|
||||
* Create a new ArcGIS93Rest layer with the <OpenLayers.Layer.ArcGIS93Rest>
|
||||
* constructor. More detail on the REST API is available at
|
||||
* http://sampleserver1.arcgisonline.com/ArcGIS/SDK/REST/index.html ;
|
||||
* specifically, the URL provided to this layer should be an export service
|
||||
* URL: http://sampleserver1.arcgisonline.com/ArcGIS/SDK/REST/export.html
|
||||
*
|
||||
* Inherits from:
|
||||
* - <OpenLayers.Layer.Grid>
|
||||
*/
|
||||
OpenLayers.Layer.ArcGIS93Rest = OpenLayers.Class(OpenLayers.Layer.Grid, {
|
||||
|
||||
/**
|
||||
* Constant: DEFAULT_PARAMS
|
||||
* {Object} Hashtable of default parameter key/value pairs
|
||||
*/
|
||||
DEFAULT_PARAMS: {
|
||||
format: "png"
|
||||
},
|
||||
|
||||
/**
|
||||
* APIProperty: isBaseLayer
|
||||
* {Boolean} Default is true for ArcGIS93Rest layer
|
||||
*/
|
||||
isBaseLayer: true,
|
||||
|
||||
|
||||
/**
|
||||
* Constructor: OpenLayers.Layer.ArcGIS93Rest
|
||||
* Create a new ArcGIS93Rest layer object.
|
||||
*
|
||||
* Example:
|
||||
* (code)
|
||||
* var arcims = new OpenLayers.Layer.ArcGIS93Rest("MyName",
|
||||
* "http://sampleserver1.arcgisonline.com/ArcGIS/rest/services/Specialty/ESRI_StateCityHighway_USA/MapServer",
|
||||
* {
|
||||
* layers: "0,1,2"
|
||||
* });
|
||||
* (end)
|
||||
*
|
||||
* Parameters:
|
||||
* name - {String} A name for the layer
|
||||
* url - {String} Base url for the ArcGIS server REST service
|
||||
* options - {Object} An object with key/value pairs representing the
|
||||
* options and option values.
|
||||
* Valid Options:
|
||||
* format: {String} MIME type of desired image type.
|
||||
* layers: {String} Comma-separated list of layers to display.
|
||||
* srs: {String} Projection ID.
|
||||
*/
|
||||
initialize: function(name, url, params, options) {
|
||||
var newArguments = [];
|
||||
//uppercase params
|
||||
params = OpenLayers.Util.upperCaseObject(params);
|
||||
newArguments.push(name, url, params, options);
|
||||
OpenLayers.Layer.Grid.prototype.initialize.apply(this, newArguments);
|
||||
OpenLayers.Util.applyDefaults(
|
||||
this.params,
|
||||
OpenLayers.Util.upperCaseObject(this.DEFAULT_PARAMS)
|
||||
);
|
||||
|
||||
//layer is transparent
|
||||
if (this.params.TRANSPARENT &&
|
||||
this.params.TRANSPARENT.toString().toLowerCase() == "true") {
|
||||
|
||||
// unless explicitly set in options, make layer an overlay
|
||||
if ( (options == null) || (!options.isBaseLayer) ) {
|
||||
this.isBaseLayer = false;
|
||||
}
|
||||
|
||||
// jpegs can never be transparent, so intelligently switch the
|
||||
// format, depending on the browser's capabilities
|
||||
if (this.params.FORMAT == "jpg") {
|
||||
this.params.FORMAT = OpenLayers.Util.alphaHack() ? "gif"
|
||||
: "png";
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
|
||||
/**
|
||||
* Method: destroy
|
||||
* Destroy this layer
|
||||
*/
|
||||
destroy: function() {
|
||||
// for now, nothing special to do here.
|
||||
OpenLayers.Layer.Grid.prototype.destroy.apply(this, arguments);
|
||||
},
|
||||
|
||||
/**
|
||||
* Method: clone
|
||||
* Create a clone of this layer
|
||||
*
|
||||
* Returns:
|
||||
* {<OpenLayers.Layer.ArcGIS93Rest>} An exact clone of this layer
|
||||
*/
|
||||
clone: function (obj) {
|
||||
|
||||
if (obj == null) {
|
||||
obj = new OpenLayers.Layer.ArcGIS93Rest(this.name,
|
||||
this.url,
|
||||
this.params,
|
||||
this.options);
|
||||
}
|
||||
|
||||
//get all additions from superclasses
|
||||
obj = OpenLayers.Layer.Grid.prototype.clone.apply(this, [obj]);
|
||||
|
||||
// copy/set any non-init, non-simple values here
|
||||
|
||||
return obj;
|
||||
},
|
||||
|
||||
|
||||
/**
|
||||
* Method: getURL
|
||||
* Return an image url this layer.
|
||||
*
|
||||
* Parameters:
|
||||
* bounds - {<OpenLayers.Bounds>} A bounds representing the bbox for the
|
||||
* request.
|
||||
*
|
||||
* Returns:
|
||||
* {String} A string with the map image's url.
|
||||
*/
|
||||
getURL: function (bounds) {
|
||||
bounds = this.adjustBounds(bounds);
|
||||
|
||||
// ArcGIS Server only wants the numeric portion of the projection ID.
|
||||
var projWords = this.projection.getCode().split(":");
|
||||
var srid = projWords[projWords.length - 1];
|
||||
|
||||
var imageSize = this.getImageSize();
|
||||
var newParams = {
|
||||
'BBOX': bounds.toBBOX(),
|
||||
'SIZE': imageSize.w + "," + imageSize.h,
|
||||
// We always want image, the other options were json, image with a whole lotta html around it, etc.
|
||||
'F': "image",
|
||||
'BBOXSR': srid,
|
||||
'IMAGESR': srid
|
||||
};
|
||||
|
||||
// Now add the filter parameters.
|
||||
if (this.layerDefs) {
|
||||
var layerDefStrList = [];
|
||||
var layerID;
|
||||
for(layerID in this.layerDefs) {
|
||||
if (this.layerDefs.hasOwnProperty(layerID)) {
|
||||
if (this.layerDefs[layerID]) {
|
||||
layerDefStrList.push(layerID);
|
||||
layerDefStrList.push(":");
|
||||
layerDefStrList.push(this.layerDefs[layerID]);
|
||||
layerDefStrList.push(";");
|
||||
}
|
||||
}
|
||||
}
|
||||
if (layerDefStrList.length > 0) {
|
||||
newParams['LAYERDEFS'] = layerDefStrList.join("");
|
||||
}
|
||||
}
|
||||
var requestString = this.getFullRequestString(newParams);
|
||||
return requestString;
|
||||
},
|
||||
|
||||
/**
|
||||
* Method: setLayerFilter
|
||||
* addTile creates a tile, initializes it, and adds it to the layer div.
|
||||
*
|
||||
* Parameters:
|
||||
* id - {String} The id of the layer to which the filter applies.
|
||||
* queryDef - {String} A sql-ish query filter, for more detail see the ESRI
|
||||
* documentation at http://sampleserver1.arcgisonline.com/ArcGIS/SDK/REST/export.html
|
||||
*/
|
||||
setLayerFilter: function ( id, queryDef ) {
|
||||
if (!this.layerDefs) {
|
||||
this.layerDefs = {};
|
||||
}
|
||||
if (queryDef) {
|
||||
this.layerDefs[id] = queryDef;
|
||||
} else {
|
||||
delete this.layerDefs[id];
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* Method: clearLayerFilter
|
||||
* Clears layer filters, either from a specific layer,
|
||||
* or all of them.
|
||||
*
|
||||
* Parameters:
|
||||
* id - {String} The id of the layer from which to remove any
|
||||
* filter. If unspecified/blank, all filters
|
||||
* will be removed.
|
||||
*/
|
||||
clearLayerFilter: function ( id ) {
|
||||
if (id) {
|
||||
delete this.layerDefs[id];
|
||||
} else {
|
||||
delete this.layerDefs;
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* APIMethod: mergeNewParams
|
||||
* Catch changeParams and uppercase the new params to be merged in
|
||||
* before calling changeParams on the super class.
|
||||
*
|
||||
* Once params have been changed, the tiles will be reloaded with
|
||||
* the new parameters.
|
||||
*
|
||||
* Parameters:
|
||||
* newParams - {Object} Hashtable of new params to use
|
||||
*/
|
||||
mergeNewParams:function(newParams) {
|
||||
var upperParams = OpenLayers.Util.upperCaseObject(newParams);
|
||||
var newArguments = [upperParams];
|
||||
return OpenLayers.Layer.Grid.prototype.mergeNewParams.apply(this,
|
||||
newArguments);
|
||||
},
|
||||
|
||||
/**
|
||||
* Method: addTile
|
||||
* addTile creates a tile, initializes it, and adds it to the layer div.
|
||||
*
|
||||
* Parameters:
|
||||
* bounds - {<OpenLayers.Bounds>}
|
||||
* position - {<OpenLayers.Pixel>}
|
||||
*
|
||||
* Returns:
|
||||
* {<OpenLayers.Tile.Image>} The added OpenLayers.Tile.Image
|
||||
*/
|
||||
addTile:function(bounds,position) {
|
||||
return new OpenLayers.Tile.Image(this, position, bounds,
|
||||
null, this.tileSize);
|
||||
},
|
||||
|
||||
|
||||
CLASS_NAME: "OpenLayers.Layer.ArcGIS93Rest"
|
||||
});
|
||||
Reference in New Issue
Block a user