@mapgis/webclient-common
Version:
mapgis ES6 format for igserver
3,079 lines (1,108 loc) • 67.4 kB
HTML
<header id="page-title" class="page-title">
<span class="page-title-main">类名</span>
<span class="page-title-sub">WorkFlowServer600237</span>
</header>
<section>
<article>
<div class="container-overview">
<div class='vertical-section'>
<div class="members">
<div class="member">
<h4 class="name" id="WorkFlowServer600237">
<a class="href-link" href="#WorkFlowServer600237">#</a>
<span class="code-name" id="WorkFlowServer600237" style="font-size:30px">
new WorkFlowServer600237<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" id="options"><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" id="url"><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" id="srcInfo1"><code>srcInfo1</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>被叠加简单要素类的URL,必传,例如:GDBP://mapgislocal/Sample/sfcls/overLay</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="geometry"><code>geometry</code></td>
<td class="type">
<span class="param-type"><a link="Geometry.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Geometry" Geometry.html>Geometry</a></span>
</td>
<td class="description last"><p>多边形几何,必传,必须为Polygon</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="desInfo"><code>desInfo</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>结果简单要素类的URL,必传,例如:GDBP://mapgislocal/Sample/sfcls/overLayDes</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="attOptType"><code>attOptType</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>是否进行属性操作,1:是 0:否,必传,例如:{"activeValue":"1","inactiveValue":"0"}</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="infoOptType"><code>infoOptType</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>共有部分的图形参数操作,0:随机,1:使用第一个类的图形参数,2:使用第二个类的图形参数,必传,例如:{"0":"随机","1":"使用第一个类的图形参数","2":"使用第二个类的图形参数"}</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="overType"><code>overType</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>图层叠加类型,0:求并,1:求交(默认),2:求差,3:内裁,4:外裁,5:叠加,6:对称差,7:判别,必传,例如:{"0":"求并","1":"求交","2":"求差","3":"内裁","4":"外裁","5":"叠加","6":"对称差","7":"判别"}</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="radius"><code>radius</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>容差半径,必传,例如:0.001</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="inFormat"><code>inFormat</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>字符串格式,必传,例如:{"JSON":"JSON","XML":"XML"}</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
</dl>
<h5>示例</h5>
<pre class="prettyprint"><code>const workFlowServer600237 = WorkFlowServer.createWorkFlow({
url: "http://localhost:8089/igs/rest/services/workflow/600237/WorkflowServer",
srcInfo1: "gdbp://MapGISLocalPlus/test/sfcls/林地-gs",
geometry: new Zondy.Geometry.Polygon({
coordinates: [
[
[11.2203627335275, 532.624659163762],
[2732.66363429598, 532.624659163762],
[2933.75550165281, -1310.71745827386],
[-266.956720443423, -1927.39918483481],
[-1259.00993273713, -747.660229674732],
[11.2203627335275, 532.624659163762],
],
],
}),
desInfo: "gdbp://MapGISLocalPlus/test/sfcls/林地-gs-clip" + Math.random(),
attOptType: 1,
infoOptType: 1,
overType: 1,
radius: 0.001,
inFormat: "JSON",
});
workFlowServer600237.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)" class="mapgis-link-name" title="WorkFlowServer" 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="#attOptType">attOptType</a></code></td>
<td class="name">
<code>
<span class="param-type">Number</span>
</code>
</td>
<td class="name"><code><p>是否进行属性操作,1:是 0:否,必传,例如:{"activeValue":"1","inactiveValue":"0"}</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>结果简单要素类的URL,必传,例如:GDBP://mapgislocal/Sample/sfcls/overLayDes</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="#flowId">flowId</a></code></td>
<td class="name">
<code>
<span class="param-type">Number</span>
</code>
</td>
<td class="name"><code><p>600237</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#geometry">geometry</a></code></td>
<td class="name">
<code>
<span class="param-type"><a link="Geometry.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Geometry" Geometry.html>Geometry</a></span>
</code>
</td>
<td class="name"><code><p>多边形几何,必传,必须为Polygon</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#geometrys">geometrys</a></code></td>
<td class="name">
<code>
<span class="param-type">Array.<<a link="Array.<Geometry>.html" onclick="getTypeHTML(event)" href="Geometry.html">Geometry</a>></span>
</code>
</td>
<td class="name"><code><p>多边形几何,必传,必须为Array<Polygon></p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#geometrys">geometrys</a></code></td>
<td class="name">
<code>
<span class="param-type">Array.<<a link="Array.<Geometry>.html" onclick="getTypeHTML(event)" href="Geometry.html">Geometry</a>></span>
</code>
</td>
<td class="name"><code><p>多边形几何,必传,必须为Array<Polygon></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="#infoOptType">infoOptType</a></code></td>
<td class="name">
<code>
<span class="param-type">Number</span>
</code>
</td>
<td class="name"><code><p>共有部分的图形参数操作,0:随机,1:使用第一个类的图形参数,2:使用第二个类的图形参数,必传,例如:{"0":"随机","1":"使用第一个类的图形参数","2":"使用第二个类的图形参数"}</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#inFormat">inFormat</a></code></td>
<td class="name">
<code>
<span class="param-type">String</span>
</code>
</td>
<td class="name"><code><p>字符串格式,必传,例如:{"JSON":"JSON","XML":"XML"}</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#overType">overType</a></code></td>
<td class="name">
<code>
<span class="param-type">Number</span>
</code>
</td>
<td class="name"><code><p>图层叠加类型,0:求并,1:求交(默认),2:求差,3:内裁,4:外裁,5:叠加,6:对称差,7:判别,必传,例如:{"0":"求并","1":"求交","2":"求差","3":"内裁","4":"外裁","5":"叠加","6":"对称差","7":"判别"}</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#radius">radius</a></code></td>
<td class="name">
<code>
<span class="param-type">Number</span>
</code>
</td>
<td class="name"><code><p>容差半径,必传,例如:0.001</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="#srcInfo1">srcInfo1</a></code></td>
<td class="name">
<code>
<span class="param-type">String</span>
</code>
</td>
<td class="name"><code><p>被叠加简单要素类的URL,必传,例如:GDBP://mapgislocal/Sample/sfcls/overLay</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)" class="mapgis-link-name" title="TokenAttachType" 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">Number</span>
</span>
<h4 class="name" id="attOptType">
<a class="href-link" href="#attOptType">#</a>
<span class="code-name">
attOptType
</span>
</h4>
<div class="description">
<p>是否进行属性操作,1:是 0:否,必传,例如:{"activeValue":"1","inactiveValue":"0"}</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)" class="mapgis-link-name" title="BaseServer#clientId" 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>结果简单要素类的URL,必传,例如:GDBP://mapgislocal/Sample/sfcls/overLayDes</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)" class="mapgis-link-name" title="BaseServer#enableGlobeFetch" 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">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>600237</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="Geometry.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Geometry" Geometry.html>Geometry</a></span>
</span>
<h4 class="name" id="geometry">
<a class="href-link" href="#geometry">#</a>
<span class="code-name">
geometry
</span>
</h4>
<div class="description">
<p>多边形几何,必传,必须为Polygon</p>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">Array.<<a link="Array.<Geometry>.html" onclick="getTypeHTML(event)" href="Geometry.html">Geometry</a>></span>
</span>
<h4 class="name" id="geometrys">
<a class="href-link" href="#geometrys">#</a>
<span class="code-name">
geometrys
</span>
</h4>
<div class="description">
<p>多边形几何,必传,必须为Array<Polygon></p>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">Array.<<a link="Array.<Geometry>.html" onclick="getTypeHTML(event)" href="Geometry.html">Geometry</a>></span>
</span>
<h4 class="name" id="geometrys">
<a class="href-link" href="#geometrys">#</a>
<span class="code-name">
geometrys
</span>
</h4>
<div class="description">
<p>多边形几何,必传,必须为Array<Polygon></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)" class="mapgis-link-name" title="BaseServer#headers" 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="infoOptType">
<a class="href-link" href="#infoOptType">#</a>
<span class="code-name">
infoOptType
</span>
</h4>
<div class="description">
<p>共有部分的图形参数操作,0:随机,1:使用第一个类的图形参数,2:使用第二个类的图形参数,必传,例如:{"0":"随机","1":"使用第一个类的图形参数","2":"使用第二个类的图形参数"}</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="inFormat">
<a class="href-link" href="#inFormat">#</a>
<span class="code-name">
inFormat
</span>
</h4>
<div class="description">
<p>字符串格式,必传,例如:{"JSON":"JSON","XML":"XML"}</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="overType">
<a class="href-link" href="#overType">#</a>
<span class="code-name">
overType
</span>
</h4>
<div class="description">
<p>图层叠加类型,0:求并,1:求交(默认),2:求差,3:内裁,4:外裁,5:叠加,6:对称差,7:判别,必传,例如:{"0":"求并","1":"求交","2":"求差","3":"内裁","4":"外裁","5":"叠加","6":"对称差","7":"判别"}</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="radius">
<a class="href-link" href="#radius">#</a>
<span class="code-name">
radius
</span>
</h4>
<div class="description">
<p>容差半径,必传,例如:0.001</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)" class="mapgis-link-name" title="BaseServer#requestInterceptor" 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)" class="mapgis-link-name" title="BaseServer#requestTimeout" 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)" class="mapgis-link-name" title="BaseServer#responseInterceptor" 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="srcInfo1">
<a class="href-link" href="#srcInfo1">#</a>
<span class="code-name">
srcInfo1
</span>
</h4>
<div class="description">
<p>被叠加简单要素类的URL,必传,例如:GDBP://mapgislocal/Sample/sfcls/overLay</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)" class="mapgis-link-name" title="TokenAttachType" 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)" class="mapgis-link-name" title="BaseServer#tokenAttachType" 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)" class="mapgis-link-name" title="BaseServer#tokenKey" 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)" class="mapgis-link-name" title="BaseServer#tokenValue" 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 class="mapgis-link-name" title="WorkFlowServer#url" 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" id="options"><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" id="headers"><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" id="method"><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" id="success"><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" id="failure"><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)" class="mapgis-link-name" title="WorkFlowServer#execute" 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>
<di