# new PlotServer(options)
æ ‡ç»˜æœåŠ¡
傿•°
åç§° | 类型 | 默认值 | æè¿° |
---|---|---|---|
options |
Object | æž„é€ å‚æ•° |
|
url |
String | æ— | æœåŠ¡åŸºåœ°å€ |
继承关系
æˆå‘˜å˜é‡
æˆå‘˜å˜é‡æ¦‚è¿°
åç§° | 类型 | æè¿° |
---|---|---|
clientId |
Boolean
|
|
enableGlobeFetch |
Boolean
|
|
headers |
String
|
|
requestInterceptor |
function
|
|
requestTimeout |
String
|
|
responseInterceptor |
function
|
|
tokenAttachType |
TokenAttachType
|
|
tokenKey |
String
|
|
tokenValue |
String
|
|
url |
String
|
|
æˆå‘˜å˜é‡è¯¦æƒ…
# 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;
# 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';
# 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() {};
# 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;
# 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
指定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;
# 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';
# 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值';
# url
æœåŠ¡åŸºåœ°å€
- Inherited From:
示例
//设置请求基地å€
// ES5引入方å¼
const { BaseServer } = Zondy.Service
// ES6引入方å¼
import { BaseServer } from "@mapgis/webclient-common"
let BaseServer = new BaseServer({
//请求基地å€
url: 'ä½ çš„URL'
});
//动æ€ä¿®æ”¹
BaseServer.url = 'æ–°URL';
方法
方法概述
åç§° | 返回值类型 | æè¿° |
---|---|---|
deleteAnimationScript |
|
|
deleteLayer |
|
|
deleteSymbol |
|
|
getAnimationScript |
|
|
getLayer |
|
|
getSymbol |
|
|
getSymbolLib |
|
|
getSymbolLibList |
|
|
queryAnimationScriptList |
|
|
queryLayerList |
|
|
queryServerInfo |
|
|
updateAnimationScript |
|
|
updateLayer |
|
|
方法详情
# deleteAnimationScript(options)
åˆ é™¤æ€åŠ¿æŽ¨æ¼”è„šæœ¬
傿•°
åç§° | 类型 | æè¿° |
---|---|---|
options |
æŸ¥è¯¢å‚æ•° |
|
scriptId |
String | 脚本id,必填 |
success |
function | 查询æˆåŠŸå›žè°ƒå‡½æ•°ï¼Œè‹¥ä½¿ç”¨Promiseæ–¹å¼åˆ™ä¸å¿…填写 |
failure |
function | 查询失败回调函数,若使用Promiseæ–¹å¼åˆ™ä¸å¿…填写 |
# deleteLayer(options)
åˆ é™¤æ ‡ç»˜å›¾å±‚
傿•°
åç§° | 类型 | æè¿° |
---|---|---|
options |
æŸ¥è¯¢å‚æ•° |
|
layerId |
String | 图层id,必填 |
success |
function | 查询æˆåŠŸå›žè°ƒå‡½æ•°ï¼Œè‹¥ä½¿ç”¨Promiseæ–¹å¼åˆ™ä¸å¿…填写 |
failure |
function | 查询失败回调函数,若使用Promiseæ–¹å¼åˆ™ä¸å¿…填写 |
# deleteSymbol(options)
åˆ é™¤æ ‡å·
傿•°
åç§° | 类型 | æè¿° |
---|---|---|
options |
æŸ¥è¯¢å‚æ•° |
|
libId |
String | æ ‡å·åº“id,必填 |
symbolId |
String | æ ‡å·id,必填 |
success |
function | 查询æˆåŠŸå›žè°ƒå‡½æ•°ï¼Œè‹¥ä½¿ç”¨Promiseæ–¹å¼åˆ™ä¸å¿…填写 |
failure |
function | 查询失败回调函数,若使用Promiseæ–¹å¼åˆ™ä¸å¿…填写 |
# getAnimationScript(options)
èŽ·å–æ€åŠ¿æŽ¨æ¼”è„šæœ¬
傿•°
åç§° | 类型 | æè¿° |
---|---|---|
options |
æŸ¥è¯¢å‚æ•° |
|
scriptId |
String | 脚本id,必填 |
success |
function | 查询æˆåŠŸå›žè°ƒå‡½æ•°ï¼Œè‹¥ä½¿ç”¨Promiseæ–¹å¼åˆ™ä¸å¿…填写 |
failure |
function | 查询失败回调函数,若使用Promiseæ–¹å¼åˆ™ä¸å¿…填写 |
# getLayer(options)
èŽ·å–æ ‡ç»˜å›¾å±‚
傿•°
åç§° | 类型 | æè¿° |
---|---|---|
options |
æŸ¥è¯¢å‚æ•° |
|
layerId |
String | 图层id,必填 |
success |
function | 查询æˆåŠŸå›žè°ƒå‡½æ•°ï¼Œè‹¥ä½¿ç”¨Promiseæ–¹å¼åˆ™ä¸å¿…填写 |
failure |
function | 查询失败回调函数,若使用Promiseæ–¹å¼åˆ™ä¸å¿…填写 |
# getSymbol(options)
èŽ·å–æ ‡å·
傿•°
åç§° | 类型 | æè¿° |
---|---|---|
options |
æŸ¥è¯¢å‚æ•° |
|
libId |
String | æ ‡å·åº“id,必填 |
symbolId |
String | æ ‡å·id,必填 |
success |
function | 查询æˆåŠŸå›žè°ƒå‡½æ•°ï¼Œè‹¥ä½¿ç”¨Promiseæ–¹å¼åˆ™ä¸å¿…填写 |
failure |
function | 查询失败回调函数,若使用Promiseæ–¹å¼åˆ™ä¸å¿…填写 |
# getSymbolLib(options)
èŽ·å–æ ‡å·åº“列表
傿•°
åç§° | 类型 | æè¿° |
---|---|---|
options |
æŸ¥è¯¢å‚æ•° |
|
libId |
String | æ ‡å·åº“id,必填 |
success |
function | 查询æˆåŠŸå›žè°ƒå‡½æ•°ï¼Œè‹¥ä½¿ç”¨Promiseæ–¹å¼åˆ™ä¸å¿…填写 |
failure |
function | 查询失败回调函数,若使用Promiseæ–¹å¼åˆ™ä¸å¿…填写 |
# getSymbolLibList(options)
èŽ·å–æ ‡å·åº“列表
傿•°
åç§° | 类型 | æè¿° |
---|---|---|
options |
æŸ¥è¯¢å‚æ•° |
|
success |
function | 查询æˆåŠŸå›žè°ƒå‡½æ•°ï¼Œè‹¥ä½¿ç”¨Promiseæ–¹å¼åˆ™ä¸å¿…填写 |
failure |
function | 查询失败回调函数,若使用Promiseæ–¹å¼åˆ™ä¸å¿…填写 |
# queryAnimationScriptList(options)
查询æ€åŠ¿æŽ¨æ¼”è„šæœ¬åˆ—è¡¨
傿•°
åç§° | 类型 | æè¿° |
---|---|---|
options |
æŸ¥è¯¢å‚æ•° |
|
success |
function | 查询æˆåŠŸå›žè°ƒå‡½æ•°ï¼Œè‹¥ä½¿ç”¨Promiseæ–¹å¼åˆ™ä¸å¿…填写 |
failure |
function | 查询失败回调函数,若使用Promiseæ–¹å¼åˆ™ä¸å¿…填写 |
# queryLayerList(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);
});
# updateAnimationScript(options)
æ›´æ–°æ€åŠ¿æŽ¨æ¼”è„šæœ¬
傿•°
åç§° | 类型 | æè¿° |
---|---|---|
options |
æŸ¥è¯¢å‚æ•° |
|
scriptName |
String | 脚本å称,必填 |
content |
String | 脚本内容,必填 |
success |
function | 查询æˆåŠŸå›žè°ƒå‡½æ•°ï¼Œè‹¥ä½¿ç”¨Promiseæ–¹å¼åˆ™ä¸å¿…填写 |
failure |
function | 查询失败回调函数,若使用Promiseæ–¹å¼åˆ™ä¸å¿…填写 |
scriptId |
String | 脚本id |
# updateLayer(options)
æ›´æ–°æ ‡ç»˜å›¾å±‚
傿•°
åç§° | 类型 | æè¿° |
---|---|---|
options |
æŸ¥è¯¢å‚æ•° |
|
layerName |
String | 图层å称,必填 |
content |
FeatureSet | 图层内容,必填 |
success |
function | 查询æˆåŠŸå›žè°ƒå‡½æ•°ï¼Œè‹¥ä½¿ç”¨Promiseæ–¹å¼åˆ™ä¸å¿…填写 |
failure |
function | 查询失败回调函数,若使用Promiseæ–¹å¼åˆ™ä¸å¿…填写 |
layerId |
String | 图层id |