@mapgis/webclient-common
Version:
mapgis ES6 format for igserver
3,353 lines (1,209 loc) • 82.1 kB
HTML
<header id="page-title" class="page-title">
<span class="page-title-main">类名</span>
<span class="page-title-sub">MapServer</span>
</header>
<section>
<article>
<div class="container-overview">
<div class='vertical-section'>
<div class="members">
<div class="member">
<h4 class="name" id="MapServer">
<a class="href-link" href="#MapServer">#</a>
<span class="code-name" id="MapServer" style="font-size:30px">
new MapServer<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>
</tbody>
</table>
</div>
<dl class="details">
</dl>
<h5>示例</h5>
<pre class="prettyprint"><code>//初始化MapServer服务对象
// ES5引入方式
const { MapServer } = Zondy.Service
// ES6引入方式
import { MapServer } from "@mapgis/webclient-common"
const mapServer = new MapServer({
//从igs详情里面获取的服务地址
url: 'http://localhost:8089/igs/rest/services/动态裁图/MapServer'
});</code></pre>
</div>
</div>
</div>
</div>
<h3 class="subsection-title">继承关系</h3>
<ul>
<li><a link="BaseServer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="BaseServer" BaseServer.html>BaseServer</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="#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="#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="#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="#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="#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">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">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">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">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"><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="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="url" link="BaseServer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="BaseServer#url" BaseServer.html#url>BaseServer#url</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'
});
//动态修改
BaseServer.url = '新URL';</code></pre>
</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="#addLayer">addLayer</a></code></td>
<td class="name">
<code>
</code>
</td>
<td class="name"><code><p>添加临时文档图层</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#deleteLayer">deleteLayer</a></code></td>
<td class="name">
<code>
</code>
</td>
<td class="name"><code><p>删除临时文档图层</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#exportImage">exportImage</a></code></td>
<td class="name">
<code>
</code>
</td>
<td class="name"><code><p>根据参数出图，详细说明请参考IGS的API文档</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#getImage">getImage</a></code></td>
<td class="name">
<code>
</code>
</td>
<td class="name"><code><p>根据参数获取图片的url</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#getLegend">getLegend</a></code></td>
<td class="name">
<code>
</code>
</td>
<td class="name"><code><p>获取图例</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#queryFeatures">queryFeatures</a></code></td>
<td class="name">
<code>
</code>
</td>
<td class="name"><code><p>指定图层的要素查询</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#queryFeaturesInLayers">queryFeaturesInLayers</a></code></td>
<td class="name">
<code>
</code>
</td>
<td class="name"><code><p>多图层的要素查询</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#queryLayerInfo">queryLayerInfo</a></code></td>
<td class="name">
<code>
</code>
</td>
<td class="name"><code><p>查询指定图层信息</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#queryLayerList">queryLayerList</a></code></td>
<td class="name">
<code>
</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="#setSystemLib">setSystemLib</a></code></td>
<td class="name">
<code>
</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="member">
<h4 class="name" id="addLayer">
<a class="href-link" href="#addLayer">#</a>
<span class="code-name" id="addLayer" style="font-size:30px">
addLayer<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="addInfo"><code>addInfo</code></td>
<td class="type">
<span class="param-type">Array</span>
</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="description last"><p>请求成功时的回调</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="failure"><code>failure</code></td>
<td class="type">
<span class="param-type"><a link="queryFailure.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="queryFailure" global.html#queryFailure>queryFailure</a></span>
</td>
<td class="description last"><p>请求失败时的回调</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="clientId"><code>clientId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>客户端Id</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<h4 class="name" id="deleteLayer">
<a class="href-link" href="#deleteLayer">#</a>
<span class="code-name" id="deleteLayer" style="font-size:30px">
deleteLayer<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="layerId"><code>layerId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>图层id，必传</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="description last"><p>请求成功时的回调</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="description last"><p>请求失败时的回调</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="clientId"><code>clientId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>客户端Id</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<h4 class="name" id="exportImage">
<a class="href-link" href="#exportImage">#</a>
<span class="code-name" id="exportImage" style="font-size:30px">
exportImage<span class="signature">(options)</span>
</span>
</h4>
<div class="description">
<p>根据参数出图，详细说明请参考IGS的API文档</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">
</td>
<td class="default">
</td>
<td class="description last"></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="method"><code>method</code></td>
<td class="type">
<span class="param-type"><a link="FetchMethod.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="FetchMethod" global.html#FetchMethod>FetchMethod</a></span>
</td>
<td class="default">
FetchMethod.post
</td>
<td class="description last"><p>请求方式</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="bbox"><code>bbox</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
</td>
<td class="description last"><p>出图范围，格式：xmin,ymin,xmax,ymax，如果设置了projectionSrs参数，确保bbox是projectionSrs参照系的范围</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="layers"><code>layers</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
</td>
<td class="description last"><p>图层状态，格式：show|hide|include|exclude:layerid1,layerid2</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="size"><code>size</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
</td>
<td class="description last"><p>图片大小，格式：width,height，默认512,512</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="transparent"><code>transparent</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
</td>
<td class="description last"><p>返回的图片是否透明，支持true/false, 默认true</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="format"><code>format</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
</td>
<td class="description last"><p>返回图片格式，支持png/jpg/gif，默认png</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="projectionSrs"><code>projectionSrs</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
</td>
<td class="description last"><p>投影空间参照系，支持MapGIS参照系名称、EPSG格式参考系、WKT格式参考系</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="isAntialiasing"><code>isAntialiasing</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
</td>
<td class="description last"><p>返回的图片是否抗锯齿，支持true/false, 默认false</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="layerStyles"><code>layerStyles</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
</td>
<td class="description last"><p>样式信息，格式参照 Map<String,MapLayerDisplayStyleDto>，key为layerId，支持图层复合索引</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="layerFilters"><code>layerFilters</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
</td>
<td class="description last"><p>过滤信息，格式参照Map<String,MapLayerFilterDto>，key为layerId，支持图层复合索引</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="dynamicLayers"><code>dynamicLayers</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="clipping"><code>clipping</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="f"><code>f</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="clientId"><code>clientId</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>
</tbody>
</table>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<h4 class="name" id="getImage">
<a class="href-link" href="#getImage">#</a>
<span class="code-name" id="getImage" style="font-size:30px">
getImage<span class="signature">(options)</span>
</span>
</h4>
<div class="description">
<p>根据参数获取图片的url</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">
</td>
<td class="default">
</td>
<td class="description last"></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="extent"><code>extent</code></td>
<td class="type">
<span class="param-type"><a link="Extent.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Extent" Extent.html>Extent</a></span>
</td>
<td class="default">
</td>
<td class="description last"><p>图片范围</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="width"><code>width</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
256
</td>
<td class="description last"><p>图片宽度，单位像素</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="height"><code>height</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
256
</td>
<td class="description last"><p>图片高度，单位像素</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
</dl>
<div class='columns method-parameter'>
<div class="column is-2"><label>返回值</label></div>
<div class="column is-10">
<div class="columns">
<div class='param-desc column is-7'><p>String 图片的url</p></div>
</div>
</div>
</div>
</div>
<div class="member">
<h4 class="name" id="getLegend">
<a class="href-link" href="#getLegend">#</a>
<span class="code-name" id="getLegend" style="font-size:30px">
getLegend<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="success"><code>success</code></td>
<td class="type">
<span class="param-type"><a link="getLegendSuccess.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="getLegendSuccess" global.html#getLegendSuccess>getLegendSuccess</a></span>
</td>
<td class="description last"><p>请求成功时的回调</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="failure"><code>failure</code></td>
<td class="type">
<span class="param-type"><a link="queryFailure.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="queryFailure" global.html#queryFailure>queryFailure</a></span>
</td>
<td class="description last"><p>请求失败时的回调</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="layers"><code>layers</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="size"><code>size</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>图例图片的大小，格式：width,height</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="where"><code>where</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>属性条件,类SQL语句</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="bbox"><code>bbox</code></td>
<td class="type">
<span class="param-type"><a link="Extent.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Extent" Extent.html>Extent</a></span>
</td>
<td class="description last"><p>矩形范围过滤条件</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="page"><code>page</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>图例结果分页页数</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="pageSize"><code>pageSize</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>图例结果分页大小</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="maxQueryFeatureCount"><code>maxQueryFeatureCount</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>查询要素的最大条数</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
</dl>
<h5>示例</h5>
<pre class="prettyprint"><code>//回调方式
mapServer.getLegend({
layers: "0",
size: '45,45',
success: function (result) {
console.log('请求成功：', result);
},
failure: function (result) {
console.log('请求失败：', result);
}
});
//promise方式
mapServer.getLegend({
layers: "1"
}).then(function (result) {
console.log('请求成功：', result);
}).catch(function (result) {
console.log('请求失败：', result);
});</code></pre>
</div>
<div class="member">
<h4 class="name" id="queryFeatures">
<a class="href-link" href="#queryFeatures">#</a>
<span class="code-name" id="queryFeatures" style="font-size:30px">
queryFeatures<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"><p>构造参数</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="layerId"><code>layerId</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" id="success"><code>success</code></td>
<td class="type">
<span class="param-type"><a link="queryFeaturesSuccess.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="queryFeaturesSuccess" global.html#queryFeaturesSuccess>queryFeaturesSuccess</a></span>
</td>
<td class="default">
</td>
<td class="description last"><p>请求成功时的回调</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="failure"><code>failure</code></td>
<td class="type">
<span class="param-type"><a link="queryFailure.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="queryFailure" global.html#queryFailure>queryFailure</a></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"><a link="FetchMethod.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="FetchMethod" global.html#FetchMethod>FetchMethod</a></span>
</td>
<td class="default">
FetchMethod.get
</td>
<td class="description last"><p>请求方式，包括FetchMethod.get，FetchMethod.post</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="where"><code>where</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
</td>
<td class="description last"><p>要素查询where条件，类似sql语句</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="default">
</td>
<td class="description last"><p>要素查询几何条件</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="distance"><code>distance</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
0
</td>
<td class="description last"><p>几何缓冲的距离，geometry为point、line时有效（若数据源为大数据PG数据，且geometryType为line或者point时为必填数据）</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="geometryPrecision"><code>geometryPrecision</code></td>
<td class="type">