MapGIS Client for JavaScript API

# clientId

Inherited From:

• BaseServer#clientId

# enableGlobeFetch

Inherited From:

• BaseServer#enableGlobeFetch

示例

//设置请求基地址
// 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;

# headers

Inherited From:

• BaseServer#headers

示例

//设置请求头参数
// 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';

# requestInterceptor

Inherited From:

• BaseServer#requestInterceptor

示例

//设置拦截器，任何一个继承自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() {};

# requestTimeout

Inherited From:

• BaseServer#requestTimeout

示例

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

# responseInterceptor

Inherited From:

• BaseServer#responseInterceptor

示例

//设置拦截器，任何一个继承自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

Inherited From:

• BaseServer#tokenAttachType

示例

//设置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;

# tokenKey

Inherited From:

• BaseServer#tokenKey

示例

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

# tokenValue

Inherited From:

• BaseServer#tokenValue

示例

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

# url

Inherited From:

• BaseServer#url

示例

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

# addLayer(options)

参数:

# deleteLayer(options)

参数:

# exportImage(options)

参数:

# getImage(options)

参数:

# getLegend(options)

参数:

示例

//回调方式
mapServer.getLegend({
  layers: "0",
  size: '45,45',
  success: function (result) {
    console.log('请求成功：', result);
  },
  failure: function (result) {
    console.log('请求失败：', result);
  }
});
//promise方式
mapServer.getLegend({
  layers: "1"
}).then(function (result) {
  console.log('请求成功：', result);
}).catch(function (result) {
  console.log('请求失败：', result);
});

# queryFeatures(options)

参数:

示例

//通过where语句进行查询
//回调方式
// ES5引入方式
const { Point } = zondy.geometry
 // ES6引入方式
import { Point } from "@mapgis/webclient-common"
mapServer.queryFeatures({
  //图层id
  layerId: '1',
  //where查询条件，类似sql语句，这里查询2011年GDP大于20的城市
	 where: "GDP2011>20",
	 //以GDP2011字段进行升序排序
  orderByFields: "GDP2011 ASC",
	 //指定输出的属性字段为NAME,GDP2011
	 outFields: "NAME,GDP2011",
	 //指定返回要素中几何坐标的小数点位数为2
	 geometryPrecision: 2,
	 //成功返回结果
	 success: function(result) {
		 console.log('请求成功：',result);
	 },
	 failure: function(result) {
		 console.log('请求失败：',result);
	 }
});
//promise方式
//通过geometry语句进行查询
let point = new Point({
	coordinates: [113.8178, 30.172834]
});
mapServer.queryFeatures({
  //图层id
  layerId: 1,
  //几何条件
  geometry: point,
  //设置缓冲距离，仅当几何类型为point、line时有效
  distance: 100
}).then(function (result) {
  console.log('请求成功：', result);
}).catch(function (result) {
  console.log(' n请求失败：', result);
});

# queryFeaturesInLayers(options)

参数:

示例

//回调方式
// ES5引入方式
const { Extent } = zondy.geometry
const { FetchMethod } = zondy.enum
// ES6引入方式
import { Extent,FetchMethod } from "@mapgis/webclient-common"
mapServer.queryFeaturesInLayers({
  geometry: new Extent({
    xmin: 110.66,
    ymin: 29.61,
    xmax: 114.05,
    ymax: 32.43
  }),
  method: FetchMethod.post,
  success: function (result) {
    console.log('请求成功：', result);
  },
  failure: function (result) {
    console.log('请求击败：', result);
  }
});
//promise方式
mapServer.queryFeaturesInLayers({
  layerDefs: [{
    layerId: "0",
    outfields: "mpLayer,mpPerimeter"
  },{
    layerId: "1",
    where: "mpLayer=1",
    outfields: "mpLayer"
  }]
}).then(function (result) {
  console.log('请求成功：', result);
}).catch(function (result) {
  console.log(' n请求失败：', result);
});

# queryLayerInfo(options)

参数:

示例

//查询指定图层信息
//回调方式
mapServer.queryLayerInfo({
 //图层id
	layerId: 0,
	//成功回调
	success: function(result) {
		console.log('请求成功：',result);
	},
 failure: function (result) {
   console.log('请求失败：', result);
 }
});
//promise方式
mapServer.queryLayerInfo({
  //图层id
  layerId: '0'
}).then(function (result) {
  console.log('请求成功：', result);
}).catch(function (result) {
  console.log(' n请求失败：', result);
});

# queryLayerList(options)

参数:

示例

//获取图层列表信息
//回调方式
mapServer.queryLayerList({
	success: function(result) {
		console.log('请求成功：',result);
	},
	failure: function(result) {
	  console.log('请求失败：',result);
	}
});
//promise方式
mapServer.queryLayerList({
}).then(function (result) {
  console.log('请求成功：', result);
}).catch(function (result) {
  console.log(' n请求失败：', result);
});

# queryServerInfo(options)

参数:

Inherited From:

• BaseServer#queryServerInfo

示例

获取服务信息-回调方式

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);
});

# setSystemLib(options)

参数: