JavaScript ArcGIS config.BeforeInterceptorCallback用法及代码示例

基本信息

以下是所在类或对象的基本信息。

AMD: require(["esri/config"], (esriConfig) => { /* code goes here */ });

ESM: import esriConfig from "@arcgis/core/config";

对象： esri/config

自从：用于 JavaScript 4.0 的 ArcGIS API

用法说明

config.BeforeInterceptorCallback函数(或属性)的定义如下：

BeforeInterceptorCallback (params) {Object}

在发送请求之前更改请求 URL 或选项。返回值将用作响应数据，这将阻止发送请求。

如果返回null 或undefined，则发送请求时对参数所做的任何更改。如果返回错误，则请求将被拒绝并返回 esriError 。如果返回任何其他类型，则将请求解析为返回值为response data(不会发送请求)。

参数：

规格：

类型

说明

params Object

参数对象，指定可以设置的两个属性。

规格：

url String	请求 URL。
requestOptions request.RequestOptions	用户在数据请求中指定的选项。有关可用属性，请参阅RequestOptions。

类型	说明
Object	返回：`null`、`undefined`、Error、response data，或解析为这些对象类型中的任何一种的 Promise。

例子：

// modifying the query parameters
const featureLayerUrl = "https://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer/0";

esriConfig.request.interceptors.push({
  // set the `urls` property to the URL of the FeatureLayer so that this
  // interceptor only applies to requests made to the FeatureLayer URL
  urls: featureLayerUrl,
  // use the BeforeInterceptorCallback to check if the query of the
  // FeatureLayer has a maxAllowableOffset property set.
  // if so, then set the maxAllowableOffset to 0
  before: function(params) {
    if (params.requestOptions.query.maxAllowableOffset) {
      params.requestOptions.query.maxAllowableOffset = 0;
    }
  }
});

// fetching the data in place of the requests
const wmsLayerUrl = "https://sampleserver6.arcgisonline.com/arcgis/services/911CallsHotspot/MapServer/WMSServer";

esriConfig.request.interceptors.push({
   urls: wmsLayerUrl,
   before: function(params) {
     if (params.url === url && params.requestOptions.responseType === "xml") {
        if ("fetch" in window && "TextDecoder" in window) {
           // decode the response as ISO-8859-1 if it's not UTF-8 as expected
           return fetch(url + "?SERVICE=WMS&REQUEST=GetCapabilities")
             .then(function(response) {
               return response.arrayBuffer();
             })
             .then(function(buffer) {
               let textDecoder = new TextDecoder("ISO-8859-1"); // specified in the Capabilities XML declaration
               let xmlText = textDecoder.decode(buffer);
               let parser = new DOMParser();
               xml = parser.parseFromString(xmlText, "application/xml");
               return xml;
             });
         }
     }
   }
});

相关用法

注：本文由纯净天空筛选整理自arcgis.com大神的英文原创作品 config.BeforeInterceptorCallback。非经特殊声明，原始代码版权归原作者所有，本译文未经允许或授权，请勿转载或复制。

基本信息

用法说明

参数：

返回：

例子：