edu.ucdavis.cstars.client

Class ESRI

java.lang.Object

edu.ucdavis.cstars.client.ESRI

public class ESRI
extends java.lang.Object

Set esri.config.default variables and options

Author:

jrmerz

Constructor Summary

Constructors

Constructor and Description
ESRI()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addCorsEnabledServers(java.lang.String server) Specify an array of servers with cross-origin resource sharing enabled.
static void	alwaysUseProxy(boolean useProxy) Whether or not to always use the proxy for communication to a REST endpoint.
static void	disableSliderLabel() The slider will not show tick marks.
static void	getItem(java.lang.String itemId) Get details about the input ArcGIS.com item.
static void	setCorsDetectionEnabled(boolean enabled) Whether or not to detect support for cross-origin resource sharing (CORS).
static void	setGeometryService(GeometryService service) Specify the default geometry service used by widgets and operations.
static void	setPanDuration(int duration) The length of time in milliseconds that the map will take to pan from one extent to another.
static void	setPanRate(int rate) The length of time in milliseconds that the map will refresh as it pans to the next extent.
static void	setProxyUrl(java.lang.String url) The location of the proxy url that should be used when posting large payloads to an endpoint.
static void	setSlider(java.lang.String left, java.lang.String top, java.lang.String width, java.lang.String height) The parameters that define the location, size, and orientation of the slider.
static void	setSliderLabel(int tick, java.lang.String[] labels, java.lang.String style) The parameters that define the slider tick and accompanying tick label.
static void	setTimeout(int timeout) Each request through esri.request is allowed up to 60 seconds to respond.
static void	setZoomDuration(int duration) The length of time in milliseconds that the map will take to zoom from one extent to another.
static void	setZoomRate(int rate) The length of time in milliseconds that the map will refresh as it zooms to the next extent.
static void	setZoomSymbol(SimpleFillSymbol zoomSymbol) The SimpleFillSymbol to use to represent the color, fill, and outline properties of the RubberBand zoom.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ESRI

public ESRI()

Method Detail

alwaysUseProxy

public static void alwaysUseProxy(boolean useProxy)

Whether or not to always use the proxy for communication to a REST endpoint. (esriConfig.defaults.io.alwaysUseProxy)

Parameters:

useProxy -

setCorsDetectionEnabled

public static void setCorsDetectionEnabled(boolean enabled)

Whether or not to detect support for cross-origin resource sharing (CORS). Setting this to false will stop the API from sending requests that result in "XMLHttpRequest cannot load http://some.url.com/ArcGIS/rest/info?f=json. Origin http://yourapp.com is not allowed by Access-Control-Allow-Origin." messages in browser developer tools but it will also prevent the API from discovering that a resource supports CORS if it is not explicitly added to esriConfig.defaults.io.corsEnabledServers.

addCorsEnabledServers

public static void addCorsEnabledServers(java.lang.String server)

Specify an array of servers with cross-origin resource sharing enabled. Cross-Origin Resource Sharing (CORS) allows web applications to bypass the browser's same origin policy file and access resources or services on different servers/domains. When both the web server and browser support CORS, esri.request will not use a proxy to perform cross-domain requests. (esri.config.defaults.io.corsEnabledServers)

Parameters:

server - - CORS enabled server

setGeometryService

public static void setGeometryService(GeometryService service)

Specify the default geometry service used by widgets and operations. (esri.config.defaults.geometryService)

Parameters:

service - - default geometry service

setProxyUrl

public static void setProxyUrl(java.lang.String url)

The location of the proxy url that should be used when posting large payloads to an endpoint. This must reside on the same domain as the HTML application. (esriConfig.defaults.io.proxyUrl)

Parameters:

url - - proxy url

setTimeout

public static void setTimeout(int timeout)

Each request through esri.request is allowed up to 60 seconds to respond. If no response is returned or a server-side error is returned, the esri.Error and error back handlers are called, in that order. Default: 60 seconds. (esri.config.defaults.io.timeout)

Parameters:

timeout - - request timeout (in milliseconds)

setPanDuration

public static void setPanDuration(int duration)

The length of time in milliseconds that the map will take to pan from one extent to another. Default: 350. (esri.config.defaults.map.panDuration)

Parameters:

duration - - pan duration

setPanRate

public static void setPanRate(int rate)

The length of time in milliseconds that the map will refresh as it pans to the next extent. Default: 50. (esri.config.defaults.map.panRate)

Parameters:

rate - - refresh rate

setSlider

public static void setSlider(java.lang.String left,
             java.lang.String top,
             java.lang.String width,
             java.lang.String height)

The parameters that define the location, size, and orientation of the slider. Default: {left:"30px", top:"30px", width:null, height:"200px"}. (esri.config.defaults.map.slider)

Parameters:

left - - left position of slider

top - - top position of slider

width - - slider width

height - - slider height

setSliderLabel

public static void setSliderLabel(int tick,
                  java.lang.String[] labels,
                  java.lang.String style)

The parameters that define the slider tick and accompanying tick label. Default: {tick:5,labels:null,style:"width:2em; font-family:Verdana; font-size:75%;"} (esri.config.defaults.map.sliderLabel)

Parameters:

tick - - number of ticks

labels - - tick labels

style - - style attribute for slider

disableSliderLabel

public static void disableSliderLabel()

The slider will not show tick marks. (esri.config.defaults.map.sliderLabel)

setZoomDuration

public static void setZoomDuration(int duration)

The length of time in milliseconds that the map will take to zoom from one extent to another. Default: 500 (esri.config.defaults.map.zoomDuration)

Parameters:

rate - - zoom rate

setZoomRate

public static void setZoomRate(int rate)

The length of time in milliseconds that the map will refresh as it zooms to the next extent. Default: 50 (esri.config.defaults.map.zoomRate)

Parameters:

rate - - refresh rate

setZoomSymbol

public static void setZoomSymbol(SimpleFillSymbol zoomSymbol)

The SimpleFillSymbol to use to represent the color, fill, and outline properties of the RubberBand zoom. Default: {color:[0,0,0,64],outline:{color:[255,0,0,255],width:1.5,style:"esriSLSSolid"},style:"esriSFSSolid"} (esri.config.defaults.map.zoomSymbol)

Parameters:

zoomSymbol -

getItem

public static void getItem(java.lang.String itemId)

Get details about the input ArcGIS.com item. An object with the following specification is passed to the callback: The information included in the response object returned to the callback depends on the version. View the Working with web maps help topic for details on the response object. Return value: dojo.Deferred

Parameters:

itemId -