Class: M3DServer

M3DServer

new M3DServer(options)

service/igs/M3DServer.js, line 5

M3d服务，服务地址:/igs/rest/services/{folder}/{serviceName}/M3dServer

Name Type Description
options Object

构造参数

Name Type Default Description
url String null 可选

服务基地址
Example
//初始化M3DServer服务对象
// ES5引入方式
const { M3DServer } = zondy.service
// ES6引入方式
import { M3DServer } from "@mapgis/webclient-common"
    const m3dServer = new M3DServer({
      //服务基地址
      url: 'http://192.168.82.89:8089/igs/rest/services/M3Dv2/武汉建筑轮廓白模/M3dServer'
    })

Extends

Members

clientIdBoolean

客户端id

enableGlobeFetchBoolean

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

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

headersString

请求头参数

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

requestInterceptorfunction

请求发送拦截器

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

requestTimeoutString

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

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

responseInterceptorfunction

请求响应拦截器

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

tokenAttachTypeTokenAttachType

指定token附加到何处

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

tokenKeyString

token名

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

tokenValueString

token值

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

urlString

服务基地址

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

Methods

getModelCache(){String}

service/igs/M3DServer.js, line 191

获取地形缓存出图地址

Returns:
Type Description
String 出图地址

getSharedResources(options){Promise.<Object>}

service/igs/M3DServer.js, line 147

获取M3d公共服务资源,后端接口:/igs/rest/services/{serviceName}/M3dServer/sharedResources

Name Type Description
options

查询参数

Name Type Default Description
method String FetchMethod.get 可选

请求类型
success function 无 可选

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

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

queryFeaturesInM3DCache(options){Promise.<Object>}

service/igs/M3DServer.js, line 238

多图层的要素查询(仅M3D2.1以上版本，且DataAttribute.db数据存在，数据内容不为空)

Name Type Description
options

要素查询参数

Name Type Default Description
success queryFeaturesInLayersSuccess 可选

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

查询失败回调函数，若使用Promise方式则不必填写
method String FetchMethod.get 可选

请求类型
layerDefs Array 可选

多图层的属性条件。包括layerId、where、outFields；此处的layerId需要通过m3d缓存目录下的layerinfo文件中获取。当值为空时，查询所有图层，并当为拉框查询时，自动过滤不需要不需要查询的图层，示例："[{ "layerId":"0-0","where": "name='中国'", "outfields": "field1,field2"}]"
resultRecordCount Number 20 可选

分页参数：结果返回条数，默认20
resultOffset Number 可选

分页参数：跳过条数
condition String 可选

过滤条件
f String 'json' 可选

查询返回的数据格式。支持"html" "json"返回格式
Returns:
Type Description
Promise.<Object> //回调方式 // ES5引入方式 const { Extent } = zondy.geometry const { FetchMethod } = zondy.enum // ES6引入方式 import { Extent,FetchMethod } from "@mapgis/webclient-common" const m3dServer = new M3DServer({ url: "http://10.12.201.4:8089/igs/rest/services/干线电缆/M3dServer", }); m3dServer .queryFeaturesInM3DCache({ layerDefs: [{ layerId: "2927027442" }], condition: "TID == 1", }) .then((res) => { console.log("res: ", res); }); });

queryRootInfo(options){Promise.<Object>}

service/igs/M3DServer.js, line 83

获取M3d节点信息,后端接口:/igs/rest/services/{serviceName}/M3dServer/nodes/{nodeId}

Name Type Description
options

查询参数

Name Type Default Description
nodeId String 无 可选

节点Id，必传
method String FetchMethod.get 可选

请求类型
success function 无 可选

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

查询失败回调函数，若使用Promise方式则不必填写
include String 无 可选

返回节点信息包括的类型，默认为空，等于descendants时返回节点信息包括节点的子孙后代
maxDepth Number 1 可选

节点最大深度
maxCount Number 1000 可选

节点最大个数
Returns:
Type Description
Promise.<Object>
Example
//回调方式
m3dServer.queryNodeInfo({
        nodeId: '1',
        maxCount:2,
        success: function (result) {
          console.log('请求成功：', result)
        }
      })
//promise方式
m3dServer.queryNodeInfo({
        nodeId: '1',
        maxCount:2,
}).then(function (result) {
  console.log('请求成功：', result);
}).catch(function (result) {
  console.log('请求失败：', result);
});

queryRootNodeInfo(options){Promise.<Object>}

service/igs/M3DServer.js, line 28

获取M3d根节点信息，仅支持M3DV2版本，后端接口：/igs/rest/services/{serviceName}/M3dServer/nodes/root

Name Type Description
options

查询参数

Name Type Default Description
method String FetchMethod.get 可选

请求类型
success function 无 可选

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

查询失败回调函数，若使用Promise方式则不必填写
include String 无 可选

返回节点信息包括的类型，默认为空，等于descendants时返回节点信息包括节点的子孙后代
maxDepth Number 1 可选

节点最大深度
maxCount Number 1000 可选

节点最大个数
Returns:
Type Description
Promise.<Object>
Example
//回调方式
m3dServer.queryRootNodeInfo({
        maxCount:1100,
        success: function (result) {
          console.log('请求成功：', result)
        }
      })
//promise方式
m3dServer.queryRootNodeInfo({
 maxCount:1100,
}).then(function (result) {
  console.log('请求成功：', result);
}).catch(function (result) {
  console.log('请求失败：', result);
});

inherited queryServerInfo(options)

service/BaseServer.js, line 151

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

Name Type Description
options

查询参数

Name Type Default Description
success function 无 可选

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

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

获取服务信息-回调方式

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