类名 ArcGISMapServer

# new ArcGISMapServer(options)

ArcGIS的MapServer服务

参数:

名称 类型 默认值 描述
options Object

构造参数

url String

服务基地址

继承关系

成员变量

Boolean

# clientId

客户端id

Inherited From:
Boolean

# enableGlobeFetch

是否使用确据唯一的fetch对象,默认为true,当设为false时,会使用自己私有的fetch对象,所有的请求设置不会影响全局

Inherited From:
示例
//设置请求基地址
// ES5引入方式
const { BaseServer } = zondy.service
// ES6引入方式
import { BaseServer } from "@mapgis/webclient-common"
let BaseServer = new BaseServer({
  //请求基地址
  url: '你的URL',
  //使用私有的fetch对象
  enableGlobeFetch: false,
  //此时设置token等属性,不会影响全局的fetch对象
  tokenValue: '你的token'
});
//继续使用全局fetch
BaseServer.enableGlobeFetch = true;
String

# headers

请求头参数

Inherited From:
示例
//设置请求头参数
// ES5引入方式
const { BaseServer } = zondy.service
// ES6引入方式
import { BaseServer } from "@mapgis/webclient-common"
let BaseServer = new BaseServer({
  //请求头
  headers: {
     //设置Content-Type为multipart/form-data
    'Content-Type': 'multipart/form-data',
     //设置token
    'token': '你的token'
  }
});
//动态修改
BaseServer.headers.token = '新token';
function

# requestInterceptor

请求发送拦截器

Inherited From:
示例
//设置拦截器,任何一个继承自BaseServer的对象都可以设置,全局唯一
// ES5引入方式
const { BaseServer,RequestInterceptor } = zondy.service
// ES6引入方式
import { BaseServer,RequestInterceptor } from "@mapgis/webclient-common"
let BaseServer = new BaseServer({
  //设置请求发送拦截器
  requestInterceptor: new RequestInterceptor({
    //请求发送前进行统一处理
    before: function(config) {
      //执行你的业务逻辑
      //注意必须显示返回config对象,如果返回为空,则不发送请求
      return config;
    },
    //请求发送失败时进行统一处理
    failure: function(error) {
      //执行你的业务逻辑
    }
  })
});
//动态修改
BaseServer.requestInterceptor.before = function() {};
String

# requestTimeout

请求超时时间,默认45000ms,即45s

Inherited From:
示例
//设置超时时间
//初始化AddressServer服务对象
// ES5引入方式
const { BaseServer } = zondy.service
// ES6引入方式
import { BaseServer } from "@mapgis/webclient-common"
let BaseServer = new BaseServer({
  //超时时间
  requestTimeout: 2000
});
//动态修改
BaseServer.requestTimeout = 3000;
function

# responseInterceptor

请求响应拦截器

Inherited From:
示例
//设置拦截器,任何一个继承自BaseServer的对象都可以设置,全局唯一
// ES5引入方式
const { BaseServer,ResponseInterceptor } = zondy.service
// ES6引入方式
import { BaseServer,ResponseInterceptor } from "@mapgis/webclient-common"
let BaseServer = new BaseServer({
  //设置请求响应拦截器
  responseInterceptor: new ResponseInterceptor({
    //执行请求响应,接口调用成功时会执行的回调
    success: function(result) {
      //执行你的业务逻辑
      //注意必须显示返回result对象,如果返回为空,则不执行请求响应成功回调
      return result;
    },
    //请求响应成功,接口调用失败时会执行的函数
    failure: function(result) {
      //执行你的业务逻辑
      //注意必须显示返回result对象,如果返回为空,则不执行回调韩式
      return result;
    }
  })
});
//动态修改
BaseServer.responseInterceptor.success = function() {};
TokenAttachType

# tokenAttachType

指定token附加到何处

Inherited From:
示例
//设置token值
// ES5引入方式
const { BaseServer } = zondy.service
const { TokenAttachType } = zondy.enum
// ES6引入方式
import { BaseServer,TokenAttachType } from "@mapgis/webclient-common"
let BaseServer = new BaseServer({
  //token名
  tokenValue: '你的token值',
  //token值
  tokenValue: '你的token值',
  //指定token附加到url后面
  tokenAttachType: TokenAttachType.url
});
//动态修改
BaseServer.tokenAttachType = TokenAttachType.header;
String

# tokenKey

token名

Inherited From:
示例
//设置token名
// ES5引入方式
const { BaseServer } = zondy.service
// ES6引入方式
import { BaseServer } from "@mapgis/webclient-common"
let BaseServer = new BaseServer({
  //token名
  tokenKey: '你的tokenKey'
});
//动态修改
BaseServer.tokenKey = '新tokenKey';
String

# tokenValue

token值

Inherited From:
示例
//设置token值
// ES5引入方式
const { BaseServer } = zondy.service
// ES6引入方式
import { BaseServer } from "@mapgis/webclient-common"
let BaseServer = new BaseServer({
  //token值
  tokenValue: '你的token值'
});
//动态修改
BaseServer.tokenValue = '新token值';
String

# url

服务基地址

Inherited From:
示例
//设置请求基地址
// ES5引入方式
const { BaseServer } = zondy.service
// ES6引入方式
import { BaseServer } from "@mapgis/webclient-common"
let BaseServer = new BaseServer({
  //请求基地址
  url: '你的URL'
});
//动态修改
BaseServer.url = '新URL';

方法

# exportImage(options)

根据参数出图,详细说明请参考IGS的API文档

参数:

名称 类型 默认值 描述
options
method FetchMethod FetchMethod.post

请求方式

bbox String

出图范围,格式:xmin,ymin,xmax,ymax,如果设置了projectionSrs参数,确保bbox是projectionSrs参照系的范围

layers String

图层状态,格式:show|hide|include|exclude:layerid1,layerid2

size String

图片大小,格式:width,height,默认512,512

transparent String

返回的图片是否透明,支持true/false, 默认true

format String

返回图片格式,支持png/jpg/gif,默认png

imageSR String

投影空间参照系,支持EPSG格式参考系

f String

返回格式

# find(options)

针对地图或地图中一个或多个图层进行属性查询

参数:

名称 类型 默认值 描述
options

查询参数

searchText String

搜索包含该字符串的要素,在该服务下的所有文档中搜索,必填

layers String

要搜索的图层id,多个图层id以逗号分割,必填

success function

查询成功回调函数,若使用Promise方式则不必填写

failure function

查询失败回调函数,若使用Promise方式则不必填写

contains Boolean true

匹配字符串时,是否是包含匹配,默认为true,即包含匹配,false时进行全词匹配

searchFields String

要搜索的字段名,多个字段名以逗号分割,不指定则全字段搜索

returnGeometry Boolean true

是否返回几何数据

geometryPrecision Number 3

返回几何数据的小数点位数

# getLayers(options)

获取所有图层资源

参数:

名称 类型 描述
options

查询参数

success function

查询成功回调函数,若使用Promise方式则不必填写

failure function

查询失败回调函数,若使用Promise方式则不必填写

callback String

# getLegend(options)

获取图例

参数:

名称 类型 默认值 描述
options

查询参数

success function

查询成功回调函数,若使用Promise方式则不必填写

failure function

查询失败回调函数,若使用Promise方式则不必填写

dpi Number 96

图例图像的分辨率

size String '15,15'

图例图像的大小

# identify(options)

识别地图中与传入几何要素相交的要素

参数:

名称 类型 描述
options

查询参数

success function

查询成功回调函数,若使用Promise方式则不必填写

failure function

查询失败回调函数,若使用Promise方式则不必填写

# queryFeatureInLayers(options)

指定图层的空间和属性查询

参数:

名称 类型 默认值 描述
options

查询参数

layerId String

图层ID,必填

geometry String

几何查询

geometryType String

几何查询

inSR String

查询几何的参考系

outSR String

返回数据的几何参考系

spatialRel String

几何查询空间关系

units String

设置几何数据的单位

where String

where查询语句,类似sql语句

objectIds String

根据要素ID查询并返回数据,多个id以逗号分割

outFields String

指定返回数据的显示字段,多个字段名以逗号分割

orderByFields String

指定排序字段,多个字段名以逗号分割,例如orderByFields=field1 , field2 , field3 ,orderByFields=STATE_NAME ASC, RACE DESC, GENDER

outStatistics Array.<OutStatistic>

字段统计参数数组

groupByFieldsForStatistics String
geometryPrecision String

指定返回几何数据的小数点位数

resultOffset Number 0

查询偏移位数,例如resultOffset=10,则从第11位开始查询

returnIdsOnly Boolean false

仅返回查询到的要素id

returnCountOnly Boolean false

仅返回查询到的要素的数目

returnGeometry Boolean true

是否返几何数据

returnZ Boolean false

是否返几何Z轴坐标

success function

查询成功回调函数,若使用Promise方式则不必填写

failure function

查询失败回调函数,若使用Promise方式则不必填写

# queryLayerInfo(options)

查询指定图层信息

参数:

名称 类型 描述
options

查询参数

success function

查询成功回调函数,若使用Promise方式则不必填写

failure function

查询失败回调函数,若使用Promise方式则不必填写

# queryServerInfo(options)

获取服务信息,IGS2.0新增服务

参数:

名称 类型 默认值 描述
options

查询参数

success function

查询成功回调函数,若使用Promise方式则不必填写

failure function

查询失败回调函数,若使用Promise方式则不必填写

Inherited From:
示例

获取服务信息-回调方式

server.queryServerInfo({
  success: function (result) {
    console.log('请求成功:', result);
  },
  failure: function (result) {
    console.log('请求失败:', result);
  }
});

获取服务信息-promise方式

server.queryServerInfo({
})
.then(function (result) {
  console.log('请求成功:', result);
}).catch(function (result) {
  console.log('请求失败:', result);
});
构造函数
成员变量
方法
事件