@mapgis/webclient-common
Version:
mapgis ES6 format for igserver
3,436 lines (1,262 loc) • 62 kB
HTML
<header id="page-title" class="page-title">
<span class="page-title-main">类名</span>
<span class="page-title-sub">WorkFlowServer600370</span>
</header>
<section>
<article>
<div class="container-overview">
<div class='vertical-section'>
<div class="members">
<div class="member">
<h4 class="name" id="WorkFlowServer600370">
<a class="href-link" href="#WorkFlowServer600370">#</a>
<span class="code-name" id="WorkFlowServer600370" style="font-size:30px">
new WorkFlowServer600370<span class="signature">(options)</span>
</span>
</h4>
<div class="description">
<p>栅格代数运算</p>
</div>
<h4>参数</h4>
<div class="table-container">
<table class="params table">
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th class="last">描述</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">
Object
</span>
</td>
<td class="description last"><p>构造参数</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last"><p>工作流基地址,必传</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>srcInfos</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last"><p>参与代数运算的源栅格数据路径集合,多个用英文逗号分隔,必须保证集合中栅格数据的波段数相同,必传,例如:gdbp://MapGisLocal/sample/ras/影像数据,C://Users//lyd//Desktop//影像数据.tif</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>desInfo</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last"><p>输出结果路径,必传,例如:gdbp://MapGisLocal/sample/ras/影像数据_result或C://Users//lyd//Desktop//影像数据_result.tif</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>expression</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last"><p>运算表达式,支持基础运算和函数表达式,其中源栅格数据路径集合中的数据分别对应变量I1、I2、I3、.....、In,必传,例如:I1+200</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>pixelType</code></td>
<td class="type">
<span class="param-type">
Number
</span>
</td>
<td class="description last"><p>输出结果的像素类型,-1:默认取集合中的第一个数据,1:8位无符号整数,2:16位无符号整数,4:32位无符号整数,5:32位有符号整数,6:32位浮点数据,7:64位浮点数据,必传,例如:{"-1":"默认取集合中的第一个数据","1":"8位无符号整数","2":"16位无符号整数","4":"32位无符号整数","5":"32位有符号整数","6":"32位浮点数据","7":"64位浮点数据"}</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>cellSizeX</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last"><p>输出结果的x分辨率,为空取集合中第一个数据的x分辨率</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>cellSizeY</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last"><p>输出结果的y分辨率,为空取集合中第一个数据的y分辨率</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
</dl>
<h5>示例</h5>
<pre class="prettyprint"><code>const workFlowServer600370 = WorkFlowServer.createWorkFlow({
url: "http://localhost:8089/igs/rest/services/workflow/600370/WorkflowServer",
srcInfos: "gdbp://MapGISLocalPlus/香港/ras/dtm_test",
desInfo: "gdbp://MapGISLocalPlus/香港/ras/dtm_test_result",
expression: "I1+200",
});
workFlowServer600370.execute({
method: zondy.enum.FetchMethod.get,
success: function (res) {
console.log("execute: ", res);
},
});</code></pre>
</div>
</div>
</div>
</div>
<h3 class="subsection-title">继承关系</h3>
<ul>
<li><a link="WorkFlowServer.html" onclick="getTypeHTML(event)" href="WorkFlowServer.html">WorkFlowServer</a></li>
</ul>
<div class='vertical-section'>
<h3 id='member'>成员变量</h3>
<h4 style="margin-top: 20px;margin-bottom: 20px;">成员变量概述</h4>
<div class="table-container">
<table class="params table">
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code><a href="#cellSizeX">cellSizeX</a></code></td>
<td class="name">
<code>
<span class="param-type">
String
</span>
</code>
</td>
<td class="name"><code><p>输出结果的x分辨率,为空取集合中第一个数据的x分辨率</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#cellSizeY">cellSizeY</a></code></td>
<td class="name">
<code>
<span class="param-type">
String
</span>
</code>
</td>
<td class="name"><code><p>输出结果的y分辨率,为空取集合中第一个数据的y分辨率</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#clientId">clientId</a></code></td>
<td class="name">
<code>
<span class="param-type">
Boolean
</span>
</code>
</td>
<td class="name"><code><p>客户端id</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#description">description</a></code></td>
<td class="name">
<code>
<span class="param-type">
String
</span>
</code>
</td>
<td class="name"><code><p>栅格代数运算</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#desInfo">desInfo</a></code></td>
<td class="name">
<code>
<span class="param-type">
String
</span>
</code>
</td>
<td class="name"><code><p>输出结果路径,必传,例如:gdbp://MapGisLocal/sample/ras/影像数据_result或C://Users//lyd//Desktop//影像数据_result.tif</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#enableGlobeFetch">enableGlobeFetch</a></code></td>
<td class="name">
<code>
<span class="param-type">
Boolean
</span>
</code>
</td>
<td class="name"><code><p>是否使用确据唯一的fetch对象,默认为true,当设为false时,会使用自己私有的fetch对象,所有的请求设置不会影响全局</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#expression">expression</a></code></td>
<td class="name">
<code>
<span class="param-type">
String
</span>
</code>
</td>
<td class="name"><code><p>运算表达式,支持基础运算和函数表达式,其中源栅格数据路径集合中的数据分别对应变量I1、I2、I3、.....、In,必传,例如:I1+200</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#flowId">flowId</a></code></td>
<td class="name">
<code>
<span class="param-type">
Number
</span>
</code>
</td>
<td class="name"><code><p>600370</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#groupName">groupName</a></code></td>
<td class="name">
<code>
<span class="param-type">
String
</span>
</code>
</td>
<td class="name"><code><p>其它</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#headers">headers</a></code></td>
<td class="name">
<code>
<span class="param-type">
String
</span>
</code>
</td>
<td class="name"><code><p>请求头参数</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#pixelType">pixelType</a></code></td>
<td class="name">
<code>
<span class="param-type">
Number
</span>
</code>
</td>
<td class="name"><code><p>输出结果的像素类型,-1:默认取集合中的第一个数据,1:8位无符号整数,2:16位无符号整数,4:32位无符号整数,5:32位有符号整数,6:32位浮点数据,7:64位浮点数据,必传,例如:{"-1":"默认取集合中的第一个数据","1":"8位无符号整数","2":"16位无符号整数","4":"32位无符号整数","5":"32位有符号整数","6":"32位浮点数据","7":"64位浮点数据"}</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#requestInterceptor">requestInterceptor</a></code></td>
<td class="name">
<code>
<span class="param-type">
function
</span>
</code>
</td>
<td class="name"><code><p>请求发送拦截器</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#requestTimeout">requestTimeout</a></code></td>
<td class="name">
<code>
<span class="param-type">
String
</span>
</code>
</td>
<td class="name"><code><p>请求超时时间,默认45000ms,即45s</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#responseInterceptor">responseInterceptor</a></code></td>
<td class="name">
<code>
<span class="param-type">
function
</span>
</code>
</td>
<td class="name"><code><p>请求响应拦截器</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#srcInfos">srcInfos</a></code></td>
<td class="name">
<code>
<span class="param-type">
String
</span>
</code>
</td>
<td class="name"><code><p>参与代数运算的源栅格数据路径集合,多个用英文逗号分隔,必须保证集合中栅格数据的波段数相同,必传,例如:gdbp://MapGisLocal/sample/ras/影像数据,C://Users//lyd//Desktop//影像数据.tif</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#tokenAttachType">tokenAttachType</a></code></td>
<td class="name">
<code>
<span class="param-type">
<a link="TokenAttachType.html" onclick="getTypeHTML(event)" href="global.html#TokenAttachType">TokenAttachType</a>
</span>
</code>
</td>
<td class="name"><code><p>指定token附加到何处</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#tokenKey">tokenKey</a></code></td>
<td class="name">
<code>
<span class="param-type">
String
</span>
</code>
</td>
<td class="name"><code><p>token名</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#tokenValue">tokenValue</a></code></td>
<td class="name">
<code>
<span class="param-type">
String
</span>
</code>
</td>
<td class="name"><code><p>token值</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#url">url</a></code></td>
<td class="name">
<code>
<span class="param-type">
String
</span>
</code>
</td>
<td class="name"><code><p>工作流基地址,必传</p></code></td>
</tr>
</tbody>
</table>
</div>
<h4 style="margin-top: 20px;margin-bottom: 20px;">成员变量详情</h4>
<div class="members">
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
String
</span>
</span>
<h4 class="name" id="cellSizeX">
<a class="href-link" href="#cellSizeX">#</a>
<span class="code-name">
cellSizeX
</span>
</h4>
<div class="description">
<p>输出结果的x分辨率,为空取集合中第一个数据的x分辨率</p>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
String
</span>
</span>
<h4 class="name" id="cellSizeY">
<a class="href-link" href="#cellSizeY">#</a>
<span class="code-name">
cellSizeY
</span>
</h4>
<div class="description">
<p>输出结果的y分辨率,为空取集合中第一个数据的y分辨率</p>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
Boolean
</span>
</span>
<h4 class="name" id="clientId">
<a class="href-link" href="#clientId">#</a>
<span class="code-name">
clientId
</span>
</h4>
<div class="description">
<p>客户端id</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="clientId" link="BaseServer.html" onclick="getTypeHTML(event)" href="BaseServer.html#clientId">BaseServer#clientId</a>
</li></ul></dd>
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
String
</span>
</span>
<h4 class="name" id="description">
<a class="href-link" href="#description">#</a>
<span class='tag'>readonly</span>
<span class="code-name">
description
</span>
</h4>
<div class="description">
<p>栅格代数运算</p>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
String
</span>
</span>
<h4 class="name" id="desInfo">
<a class="href-link" href="#desInfo">#</a>
<span class="code-name">
desInfo
</span>
</h4>
<div class="description">
<p>输出结果路径,必传,例如:gdbp://MapGisLocal/sample/ras/影像数据_result或C://Users//lyd//Desktop//影像数据_result.tif</p>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
Boolean
</span>
</span>
<h4 class="name" id="enableGlobeFetch">
<a class="href-link" href="#enableGlobeFetch">#</a>
<span class="code-name">
enableGlobeFetch
</span>
</h4>
<div class="description">
<p>是否使用确据唯一的fetch对象,默认为true,当设为false时,会使用自己私有的fetch对象,所有的请求设置不会影响全局</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="enableGlobeFetch" link="BaseServer.html" onclick="getTypeHTML(event)" href="BaseServer.html#enableGlobeFetch">BaseServer#enableGlobeFetch</a>
</li></ul></dd>
</dl>
<h5>示例</h5>
<pre class="prettyprint"><code>//设置请求基地址
// 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;</code></pre>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
String
</span>
</span>
<h4 class="name" id="expression">
<a class="href-link" href="#expression">#</a>
<span class="code-name">
expression
</span>
</h4>
<div class="description">
<p>运算表达式,支持基础运算和函数表达式,其中源栅格数据路径集合中的数据分别对应变量I1、I2、I3、.....、In,必传,例如:I1+200</p>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
Number
</span>
</span>
<h4 class="name" id="flowId">
<a class="href-link" href="#flowId">#</a>
<span class='tag'>readonly</span>
<span class="code-name">
flowId
</span>
</h4>
<div class="description">
<p>600370</p>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
String
</span>
</span>
<h4 class="name" id="groupName">
<a class="href-link" href="#groupName">#</a>
<span class='tag'>readonly</span>
<span class="code-name">
groupName
</span>
</h4>
<div class="description">
<p>其它</p>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
String
</span>
</span>
<h4 class="name" id="headers">
<a class="href-link" href="#headers">#</a>
<span class="code-name">
headers
</span>
</h4>
<div class="description">
<p>请求头参数</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="headers" link="BaseServer.html" onclick="getTypeHTML(event)" href="BaseServer.html#headers">BaseServer#headers</a>
</li></ul></dd>
</dl>
<h5>示例</h5>
<pre class="prettyprint"><code>//设置请求头参数
// 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';</code></pre>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
Number
</span>
</span>
<h4 class="name" id="pixelType">
<a class="href-link" href="#pixelType">#</a>
<span class="code-name">
pixelType
</span>
</h4>
<div class="description">
<p>输出结果的像素类型,-1:默认取集合中的第一个数据,1:8位无符号整数,2:16位无符号整数,4:32位无符号整数,5:32位有符号整数,6:32位浮点数据,7:64位浮点数据,必传,例如:{"-1":"默认取集合中的第一个数据","1":"8位无符号整数","2":"16位无符号整数","4":"32位无符号整数","5":"32位有符号整数","6":"32位浮点数据","7":"64位浮点数据"}</p>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
function
</span>
</span>
<h4 class="name" id="requestInterceptor">
<a class="href-link" href="#requestInterceptor">#</a>
<span class="code-name">
requestInterceptor
</span>
</h4>
<div class="description">
<p>请求发送拦截器</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="requestInterceptor" link="BaseServer.html" onclick="getTypeHTML(event)" href="BaseServer.html#requestInterceptor">BaseServer#requestInterceptor</a>
</li></ul></dd>
</dl>
<h5>示例</h5>
<pre class="prettyprint"><code>//设置拦截器,任何一个继承自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() {};</code></pre>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
String
</span>
</span>
<h4 class="name" id="requestTimeout">
<a class="href-link" href="#requestTimeout">#</a>
<span class="code-name">
requestTimeout
</span>
</h4>
<div class="description">
<p>请求超时时间,默认45000ms,即45s</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="requestTimeout" link="BaseServer.html" onclick="getTypeHTML(event)" href="BaseServer.html#requestTimeout">BaseServer#requestTimeout</a>
</li></ul></dd>
</dl>
<h5>示例</h5>
<pre class="prettyprint"><code>//设置超时时间
//初始化AddressServer服务对象
// ES5引入方式
const { BaseServer } = zondy.service
// ES6引入方式
import { BaseServer } from "@mapgis/webclient-common"
let BaseServer = new BaseServer({
//超时时间
requestTimeout: 2000
});
//动态修改
BaseServer.requestTimeout = 3000;</code></pre>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
function
</span>
</span>
<h4 class="name" id="responseInterceptor">
<a class="href-link" href="#responseInterceptor">#</a>
<span class="code-name">
responseInterceptor
</span>
</h4>
<div class="description">
<p>请求响应拦截器</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="responseInterceptor" link="BaseServer.html" onclick="getTypeHTML(event)" href="BaseServer.html#responseInterceptor">BaseServer#responseInterceptor</a>
</li></ul></dd>
</dl>
<h5>示例</h5>
<pre class="prettyprint"><code>//设置拦截器,任何一个继承自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() {};</code></pre>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
String
</span>
</span>
<h4 class="name" id="srcInfos">
<a class="href-link" href="#srcInfos">#</a>
<span class="code-name">
srcInfos
</span>
</h4>
<div class="description">
<p>参与代数运算的源栅格数据路径集合,多个用英文逗号分隔,必须保证集合中栅格数据的波段数相同,必传,例如:gdbp://MapGisLocal/sample/ras/影像数据,C://Users//lyd//Desktop//影像数据.tif</p>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
<a link="TokenAttachType.html" onclick="getTypeHTML(event)" href="global.html#TokenAttachType">TokenAttachType</a>
</span>
</span>
<h4 class="name" id="tokenAttachType">
<a class="href-link" href="#tokenAttachType">#</a>
<span class="code-name">
tokenAttachType
</span>
</h4>
<div class="description">
<p>指定token附加到何处</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="tokenAttachType" link="BaseServer.html" onclick="getTypeHTML(event)" href="BaseServer.html#tokenAttachType">BaseServer#tokenAttachType</a>
</li></ul></dd>
</dl>
<h5>示例</h5>
<pre class="prettyprint"><code>//设置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;</code></pre>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
String
</span>
</span>
<h4 class="name" id="tokenKey">
<a class="href-link" href="#tokenKey">#</a>
<span class="code-name">
tokenKey
</span>
</h4>
<div class="description">
<p>token名</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="tokenKey" link="BaseServer.html" onclick="getTypeHTML(event)" href="BaseServer.html#tokenKey">BaseServer#tokenKey</a>
</li></ul></dd>
</dl>
<h5>示例</h5>
<pre class="prettyprint"><code>//设置token名
// ES5引入方式
const { BaseServer } = zondy.service
// ES6引入方式
import { BaseServer } from "@mapgis/webclient-common"
let BaseServer = new BaseServer({
//token名
tokenKey: '你的tokenKey'
});
//动态修改
BaseServer.tokenKey = '新tokenKey';</code></pre>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
String
</span>
</span>
<h4 class="name" id="tokenValue">
<a class="href-link" href="#tokenValue">#</a>
<span class="code-name">
tokenValue
</span>
</h4>
<div class="description">
<p>token值</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="tokenValue" link="BaseServer.html" onclick="getTypeHTML(event)" href="BaseServer.html#tokenValue">BaseServer#tokenValue</a>
</li></ul></dd>
</dl>
<h5>示例</h5>
<pre class="prettyprint"><code>//设置token值
// ES5引入方式
const { BaseServer } = zondy.service
// ES6引入方式
import { BaseServer } from "@mapgis/webclient-common"
let BaseServer = new BaseServer({
//token值
tokenValue: '你的token值'
});
//动态修改
BaseServer.tokenValue = '新token值';</code></pre>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
String
</span>
</span>
<h4 class="name" id="url">
<a class="href-link" href="#url">#</a>
<span class="code-name">
url
</span>
</h4>
<div class="description">
<p>工作流基地址,必传</p>
</div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="WorkFlowServer.html#url">WorkFlowServer#url</a>
</li></ul></dd>
</dl>
</div>
</div>
</div>
<div class='vertical-section'>
<h3 id='function'>方法</h3>
<h4 style="margin-top: 20px;margin-bottom: 20px;">方法概述</h4>
<div class="members">
<div class="table-container">
<table class="params table">
<thead>
<tr>
<th>名称</th>
<th>返回值类型</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code><a href="#execute">execute</a></code></td>
<td class="name">
<code>
<span class="param-type">
Promise.<Object>
</span>
</code>
</td>
<td class="name"><code><p>同步执行工作流,返回执行结果</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#queryServerInfo">queryServerInfo</a></code></td>
<td class="name">
<code>
</code>
</td>
<td class="name"><code><p>获取服务信息,IGS2.0新增服务</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#queryTaskResult">queryTaskResult</a></code></td>
<td class="name">
<code>
<span class="param-type">
Promise.<String>
</span>
</code>
</td>
<td class="name"><code><p>查询工作流执行结果</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#queryTaskStatus">queryTaskStatus</a></code></td>
<td class="name">
<code>
<span class="param-type">
Promise.<String>
</span>
</code>
</td>
<td class="name"><code><p>查询工作流执行状态</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#submit">submit</a></code></td>
<td class="name">
<code>
<span class="param-type">
Promise.<String>
</span>
</code>
</td>
<td class="name"><code><p>异步执行工作流,返回执行任务id</p></code></td>
</tr>
</tbody>
</table>
</div>
<h4 style="margin-top: 20px;margin-bottom: 20px;">方法详情</h4>
<div class="member">
<h4 class="name" id="execute">
<a class="href-link" href="#execute">#</a>
<span class="code-name" id="execute" style="font-size:30px">
execute<span class="signature">(options)</span>
</span>
</h4>
<div class="description">
<p>同步执行工作流,返回执行结果</p>
</div>
<h4>参数</h4>
<div class="table-container">
<table class="params table">
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th style="min-width: 100px;">默认值</th>
<th class="last">描述</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">
Object
</span>
</td>
<td class="default">
</td>
<td class="description last"></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>headers</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="default">
</td>
<td class="description last"><p>请求头参数</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>method</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="default">
FetchMethod.get
</td>
<td class="description last"><p>请求类型</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>success</code></td>
<td class="type">
<span class="param-type">
function
</span>
</td>
<td class="default">
</td>
<td class="description last"><p>查询成功回调函数,若使用Promise方式则不必填写</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>failure</code></td>
<td class="type">
<span class="param-type">
function
</span>
</td>
<td class="default">
</td>
<td class="description last"><p>查询失败回调函数,若使用Promise方式则不必填写</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="execute" link="WorkFlowServer.html" onclick="getTypeHTML(event)" href="WorkFlowServer.html#execute">WorkFlowServer#execute</a>
</li></ul></dd>
</dl>
<div class='columns method-parameter'>
<div class="column is-2"><label>返回值</label></div>
<div class="column is-10">
<div class="columns">
<div class='column is-5 has-text-left'>
<label>类型: </label>
<span class="param-type">
Promise.<Object>
</span>
</div>
</div>
</div>
</div>
<h5>示例</h5>
<pre class="prettyprint"><code>workflow.execute({
method: zondy.enum.FetchMethod.get,
success: function (res) {
console.log("execute: ", res);
},
});</code></pre>
</div>
<div class="member">
<h4 class="name" id="queryServerInfo">
<a class="href-link" href="#queryServerInfo">#</a>
<span class="code-name" id="queryServerInfo" style="font-size:30px">
queryServerInfo<span class="signature">(options)</span>
</span>
</h4>
<div class="description">
<p>获取服务信息,IGS2.0新增服务</p>
</div>
<h4>参数</h4>
<div class="table-container">
<table class="params table">
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th style="min-width: 100px;">默认值</th>
<th class="last">描述</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code>options</code></td>
<td class="type">
</td>
<td class="default">
</td>
<td class="description last"><p>查询参数</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>success</code></td>
<td class="type">
<span class="param-type">
function
</span>
</td>
<td class="default">
无
</td>
<td class="description last"><p>查询成功回调函数,若使用Promise方式则不必填写</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>failure</code></td>
<td class="type">
<span class="param-type">
function
</span>
</td>
<td class="default">
无
</td>
<td class="description last"><p>查询失败回调函数,若使用Promise方式则不必填写</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="queryServerInfo" link="BaseServer.html" onclick="getTypeHTML(event)" href="BaseServer.html#queryServerInfo">BaseServer#queryServerInfo</a>
</li></ul></dd>
</dl>
<h5>示例</h5>
<p class="code-caption"><h5>获取服务信息-回调方式</h5></p>
<pre class="prettyprint"><code>server.queryServerInfo({
success: function (result) {
console.log('请求成功:', result);
},
failure: function (result) {
console.log('请求失败:', result);
}
});</code></pre>
<p class="code-caption"><h5>获取服务信息-promise方式</h5></p>
<pre class="prettyprint"><code>server.queryServerInfo({
})
.then(function (result) {
console.log('请求成功:', result);
}).catch(function (result) {
console.log('请求失败:', result);
});</code></pre>
</div>
<div class="member">
<h4 class="name" id="queryTaskResult">
<a class="href-link" href="#queryTaskResult">#</a>
<span class="code-name" id="queryTaskResult" style="font-size:30px">
queryTaskResult<span class="signature">(options)</span>
</span>
</h4>
<div class="description">
<p>查询工作流执行结果</p>
</div>
<h4>参数</h4>
<div class="table-container">
<table class="params table">
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th style="min-width: 100px;">默认值</th>
<th class="last">描述</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">
Object
</span>
</td>
<td class="default">
</td>
<td class="description last"></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>taskId</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="default">
</td>
<td class="description last"><p>工作流任务id,必传</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>headers</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="default">
</td>
<td class="description last"><p>请求头参数</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>method</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="default">
FetchMethod.get
</td>
<td class="description last"><p>请求类型</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>success</code></td>
<td class="type">
<span class="param-type">
function
</span>
</td>
<td class="default">
</td>
<td class="description last"><p>查询成功回调函数,若使用Promise方式则不必填写</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>failure</code></td>
<td class="type">
<span class="param-type">
function
</span>
</td>
<td class="default">
</td>
<td class="description last"><p>查询失败回调函数,若使用Promise方式则不必填写</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="queryTaskResult" link="WorkFlowServer.html" onclick="getTypeHTML(event)" href="WorkFlowServer.html#queryTaskResult">WorkFlowServer#queryTaskResult</a>
</li></ul></dd>
</dl>
<div class='columns method-parameter'>
<div class="column is-2"><label>返回值</label></div>
<div class="column is-10">
<div class="columns">
<div class='column is-5 has-text-left'>
<label>类型: </label>
<span class="param-type">
Pr