Common Cesium-Plugin MapboxGL-Plugin Leaflet-Plugin OpenLayers-Plugin Video-Plugin
API文档
类名 ImageServer

# new ImageServer(options)

影像服务，服务地址：/igs/rest/services/{folder}/{serviceName}/ImageServer

参数:

名称 类型 默认值 描述
options Object

构造参数
url String 无

服务基地址
示例
//初始化ImageServer服务对象
// ES5引入方式
const { ImageServer } = zondy.service
// ES6引入方式
import { ImageServer } from "@mapgis/webclient-common"
const imageServer = new ImageServer({
      //服务基地址
      url: 'http://localhost:8089/igs/rest/services/whole_hk_dtm_wgs84_5m/ImageServer'
   })

继承关系

成员变量

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';

方法

# getColorMap(options)

获取色表,后端接口:/igs/rest/services/{serviceName}/ImageServer/colorMap

参数:

名称 类型 默认值 描述
options

查询参数
method String FetchMethod.get

请求类型
success function 无

查询成功回调函数，若使用Promise方式则不必填写
failure function 无

查询失败回调函数，若使用Promise方式则不必填写
Promise.<Object>
示例
//回调方式
imageServer.getColorMap({
         success: function (result) {
           console.log('请求成功：', result)
         }
       })
//promise方式
imageServer.getColorMap({
}).then(function (result) {
  console.log('请求成功：', result);
}).catch(function (result) {
  console.log('请求失败：', result);
});

# getHistograms(options)

获取直方图,后端接口:/igs/rest/services/{serviceName}/ImageServer/histograms

参数:

名称 类型 默认值 描述
options

查询参数
method String FetchMethod.get

请求类型
success function 无

查询成功回调函数，若使用Promise方式则不必填写
failure function 无

查询失败回调函数，若使用Promise方式则不必填写
Promise.<Object>
示例
//回调方式
imageServer.getHistograms({
         success: function (result) {
           console.log('请求成功：', result)
         }
       })
//promise方式
imageServer.getHistograms({
}).then(function (result) {
  console.log('请求成功：', result);
}).catch(function (result) {
  console.log('请求失败：', result);
});

# getLegend(options)

获取图例,后端接口：/igs/rest/services/{serviceName}/ImageServer/legend

参数:

名称 类型 默认值 描述
options

查询参数
method String FetchMethod.get

请求类型
size String 15,15

图例大小，格式：width,height
bandIds String 无

波段id列表
success function 无

查询成功回调函数，若使用Promise方式则不必填写
failure function 无

查询失败回调函数，若使用Promise方式则不必填写
Promise.<Object>
示例
//回调方式
imageServer.getLegend({
         bandIds:'2',
         success: function (result) {
           console.log('请求成功：', result)
         }
       })
//promise方式
imageServer.getHistograms({
   bandIds:'2',
}).then(function (result) {
  console.log('请求成功：', result);
}).catch(function (result) {
  console.log('请求失败：', result);
});

# getRasterValue(options)

获取栅格值,后端接口：/igs/rest/services/{serviceName}/ImageServer/rasterValue

参数:

名称 类型 默认值 描述
options

查询参数
method String FetchMethod.get

请求类型
success function 无

查询成功回调函数，若使用Promise方式则不必填写
failure function 无

查询失败回调函数，若使用Promise方式则不必填写
x Number 0

将查询的地理位置的x坐标值,必填
y Number 0

将查询的地理位置的y坐标值,必填
Promise.<Object>
示例
//回调方式
imageServer.getRasterValue({
         x:113.82174801481621,
         y:22.573404544364156,
         success: function (result) {
           console.log('请求成功：', result)
         }
       })
//promise方式
imageServer.getRasterValue({
         x:113.82174801481621,
         y:22.573404544364156,
}).then(function (result) {
  console.log('请求成功：', result);
}).catch(function (result) {
  console.log('请求失败：', result);
});

# getStatistics(options)

获取统计信息，后端接口：/igs/rest/services/{serviceName}/ImageServer/statistics

参数:

名称 类型 默认值 描述
options

查询参数
method String FetchMethod.get

请求类型
success function 无

查询成功回调函数，若使用Promise方式则不必填写
failure function 无

查询失败回调函数，若使用Promise方式则不必填写
Promise.<Object>
示例
//回调方式
imageServer.getStatistics({
         success: function (result) {
           console.log('请求成功：', result)
         }
       })
//promise方式
imageServer.getStatistics({
}).then(function (result) {
  console.log('请求成功：', result);
}).catch(function (result) {
  console.log('请求失败：', result);
});

# queryImageInfo(options)

获取栅格数据信息 后端接口：/igs/rest/services/{serviceName}/ImageServer/info

参数:

名称 类型 默认值 描述
options

查询参数
method String FetchMethod.get

请求类型
success function 无

查询成功回调函数，若使用Promise方式则不必填写
failure function 无

查询失败回调函数，若使用Promise方式则不必填写
Promise.<Object>
示例
//回调方式
imageServer.queryImageInfo({
         success: function (result) {
           console.log('请求成功：', result)
         }
       })
//promise方式
imageServer.queryImageInfo({
}).then(function (result) {
  console.log('请求成功：', result);
}).catch(function (result) {
  console.log('请求失败：', result);
});

# 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);
});
构造函数
成员变量
方法
事件