Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Object: esri/urlUtils
[ AMD Module Require | Legacy Module Require ]
require(["esri/urlUtils"], function(urlUtils) { /* code goes here */ });
Description
(Added at v3.8)
Utility methods for working with URLs.When coding legacy (non-AMD) style, there is no need to require the module. All methods and properties are available in the namespace. For example,
esri.addProxyRule().Samples
Search for samples that use this class.Methods
| Name | Return type | Summary |
|---|---|---|
| addProxyRule(rule) | Number | Adds the given proxy rule to the proxy rules list: esri.config.defaults.io.proxyRules. |
| getProxyRule(url) | Object | Returns the proxy rule that matches the given url. . |
| urlToObject(url) | Object | Converts the URL arguments to an object representation. |
Method Details
Adds the given proxy rule to the proxy rules list: esri.config.defaults.io.proxyRules
Return type:
NumberParameters:
< |
Required | The rule argument should have the following properties.
|
Returns the proxy rule that matches the given url.
Return type:
ObjectParameters:
< |
Required | The URL of the resources accessed via proxy. |
Converts the URL arguments to an object representation. The object format is
{path: <String>, query:{key:<Object>}}Return type:
ObjectParameters:
< |
Required | The input URL. |
Sample:
require([
"esri/urlUtils", ...
], function(urlUtils, ... ) {
var myObject = urlUtils.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 = urlUtils.urlToObject("http://www.myworld.com");
if(myObject.query){
var query = myObject.query;
}