ArcGIS JavaScript API default configurations that can be overridden programatically. For details, see Default API configurations.

Represents the size of the client side window or document at first load. The size contains width and height properties, and these do not change on window resize. (As of v1.3)

Current version of the JavaScript API. (As of v1.2)

Creates a new object with all properties that pass the test implemented by the filter provided in the function. (As of v1.2)

Return value: Object

Input Parameters:

Code snippets:

      function showResults(results) {
        var filterFunction = function(value) {
          if ((value !== ' ') & (Number(value) !== 0)) {
            return true;
          }
        };

        var filteredResults = esri.filter(results.features[0].attributes, filterFunction);
        var s = "";
        for (att in filteredResults) {
          s = s + "" + att + ":  " + filteredResults[att] + "
";
        }
        dojo.byId("info").innerHTML = s;
      }

Utility function that returns the extent of an array of graphics. If the extent height and width are 0, null is returned. (As of v1.3)

Return value: Extent

Input Parameters:

Code snippets:

var myFeatureExtent = esri.graphicsExtent(myFeatureSet.features);

Hides an HTML element such as a DIV or TABLE.

Return value: none

Input Parameters:

Code snippets:

esri.hide(myTable);

See also:
toggle   show  

A wrapper around dojo.io.script.get and dojo.xhrPost. To request data from a server, this method handles sending requests when esriConfig.defaults.io.proxyURL and esriConfig.defaults.io.alwaysUseProxy are set. This method includes a default error handler in cases when the server response is an error. The returned object is dojo.Deferred.

Return value: Object

Input Parameters:

Code snippets:

The following example sends a request and calls back the 'load' function on completion.

esri.request({
  url:"", 
  content:{},
  callbackParamName:"callback",
  load:function(response, io) {...}, 
  error:esriConfig.defaults.io.errorHandler
});

Shows an HTML element such as a DIV or TABLE.

Return value: none

Input Parameters:

Code snippets:

esri.show(myDiv);

See also:
hide   toggle  

A wrapper around dojo.string.substitute that can also handle wildcard substitution. A wildcard uses the format of ${*}. If no template is provided, it is assumed to be a wildcard. This method is useful if you are not using Graphic or an InfoTemplate, but you want to embed result values in HTML, for example.

Return value: String

Input Parameters:

Code snippets:

Example 1: no wildcard is included but is assumed.

esri.substitute({state_name: "Arizona", state_capital: "Phoenix"});

Returns: state_name = Arizona <br/> state_capital = PHoenix

Example 2: no wildcard is included and only the first property is displayed.

esri.substitute({state_name: "Arizona", state_capital: "Phoenix"},null,true);

Returns: state_name = Arizona <br/>

Example 3: a template is included for display.

esri.substitute({state_name: "Arizona", state_capital: "Phoenix"},"The capital of ${state_name} is ${state_capital}.");

Returns: The capital of Arizona is Phoenix.

If an HTML element is currently visible, the element is hidden. If the element is hidden, it becomes visible.

Return value: none

Input Parameters:

See also:
show   hide  

Converts the URL arguments to an object representaion. The object format is

{path: <String>, query:{key:<Object>}}

Return value: Object

Input Parameters:

Code snippets:

var myObject = esri.urlToObject("http://www.myworld.com?state_name=Ohio&city_name=Akron");

Returns: { path: "http://www.myworld.com", query: {state_name: "Ohio", city_name: "Akron"} }

If there are no query parameters the return value for query will be null: {path:"http://www.myworld.com",query:null}

The following snippet shows how to check for null or undefined values.

var myObject =  esri.urlToObject("http://www.myworld.com");
if(myObject.query){
  var query = myObject.query;
}

Iterates through the argument array and searches for the identifier to which the argument value matches. Returns null if no matching identifier is found.

Return value: Object

Input Parameters:

Code snippets:

Example 1:

esri.valueOf([firststring: "Oregon", secondstring: "Washington"], "Washington");

Returns: secondstring

Example 2:

esri.valueOf([firststring: "Oregon", secondstring: "Washington"], "Virginia");

Returns: null