@mapgis/webclient-common
Version:
mapgis ES6 format for igserver
3,086 lines (1,199 loc) • 87.8 kB
HTML
<header id="page-title" class="page-title">
<span class="page-title-main">类名</span>
<span class="page-title-sub">SceneServer</span>
</header>
<section>
<article>
<div class="container-overview">
<div class='vertical-section'>
<div class="members">
<div class="member">
<h4 class="name" id="SceneServer">
<a class="href-link" href="#SceneServer">#</a>
<span class="code-name" id="SceneServer" style="font-size:30px">
new SceneServer<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>
</tbody>
</table>
</div>
<dl class="details">
</dl>
<h5>示例</h5>
<p class="code-caption"><h5>IGS2.0的SceneServer</h5></p>
<pre class="prettyprint"><code>// ES5引入方式
const { SceneServer } = Zondy.Service
// ES6引入方式
import { SceneServer } from "@mapgis/webclient-common
const sceneServer = new SceneServer({
// 服务基地址,folder为igs服务的文件夹名,没有可不填,serviceName为服务名
url: 'http://{ip}:{port}/igs/rest/services/{folder}/{serviceName}/SceneServer'
});</code></pre>
<p class="code-caption"><h5>G3DServer</h5></p>
<pre class="prettyprint"><code>// ES5引入方式
const { SceneServer } = Zondy.Service
// ES6引入方式
import { SceneServer } from "@mapgis/webclient-common
const sceneServer = new SceneServer({
// 服务基地址,serviceName为服务名,端口号为6163则是.net服务,端口号为8089则是java服务
url: 'http://{ip}:{port}/igs/rest/g3d/{serviceName}'
});</code></pre>
<p class="code-caption"><h5>设置拦截器</h5></p>
<pre class="prettyprint"><code>// ES5引入方式
const { SceneServer } = Zondy.Service
// ES6引入方式
import { SceneServer } from "@mapgis/webclient-common
const sceneServer = new SceneServer({
// 服务基地址,folder为igs服务的文件夹名,没有可不填,serviceName为服务名
url: 'http://localhost:8089/igs/rest/services/{folder}/{serviceName}/SceneServer'
// 请求发送前的拦截器
requestInterceptor: {
before: function (config) {
return config;
},
failure: function (error) {
console.log("请求发送失败(拦截器):", error)
}
},
// 请求完成后的拦截器
responseInterceptor: {
success: function (result) {
console.log("请求成功拦截响应")
return result;
},
failure: function (result) {
console.log("请求失败拦截响应")
return result;
}
}
});</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="#getCoverings">getCoverings</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="#getSharedResources">getSharedResources</a></code></td>
<td class="name">
<code>
</code>
</td>
<td class="name"><code><p>获取指定图层的M3d共享资源,IGS2.0服务</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#queryDocInfo">queryDocInfo</a></code></td>
<td class="name">
<code>
<span class="param-type">Promise.<Object></span>
</code>
</td>
<td class="name"><code><p>查询G3D服务的文档图层信息</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#queryDocListInfo">queryDocListInfo</a></code></td>
<td class="name">
<code>
<span class="param-type">Promise.<Object></span>
</code>
</td>
<td class="name"><code><p>获取所有发布的G3D文档列表</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>指定图层的要素查询,IGS2.0服务</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>多图层的要素查询,IGS2.0服务</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>获取图层信息,IGS2.0服务</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#queryLayerListInfo">queryLayerListInfo</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="#queryM3DInfo">queryM3DInfo</a></code></td>
<td class="name">
<code>
</code>
</td>
<td class="name"><code><p>获取指定图层的M3d数据信息,IGS2.0服务</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#queryNodeInfo">queryNodeInfo</a></code></td>
<td class="name">
<code>
</code>
</td>
<td class="name"><code><p>获取指定M3d图层的节点信息,IGS2.0服务</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#queryRootNodeInfo">queryRootNodeInfo</a></code></td>
<td class="name">
<code>
</code>
</td>
<td class="name"><code><p>获取指定M3d图层的根节点信息,IGS2.0服务</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>
</tbody>
</table>
</div>
<h4 style="margin-top: 20px;margin-bottom: 20px;">方法详情</h4>
<div class="member">
<h4 class="name" id="getCoverings">
<a class="href-link" href="#getCoverings">#</a>
<span class="code-name" id="getCoverings" style="font-size:30px">
getCoverings<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" id="options"><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" 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">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"><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>查询失败回调函数,若使用Promise方式则不必填写</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="default">
</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="default">
'512,512'
</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">Boolean</span>
</td>
<td class="default">
true
</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"><a link="ReturnFormat.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="ReturnFormat" global.html#ReturnFormat>ReturnFormat</a></span>
</td>
<td class="default">
ReturnFormat.png
</td>
<td class="description last"><p>返回图片格式,支持png/jpg/gif,默认png</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="isAntialiasing"><code>isAntialiasing</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
false
</td>
<td class="description last"><p>返回的图片是否抗锯齿,支持true/false, 默认false</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
</dl>
<h5>示例</h5>
<pre class="prettyprint"><code>//回调方式
// ES5引入方式
const { Extent } = Zondy.Geometry
// ES6引入方式
import { Extent } from "@mapgis/webclient-common"
sceneServer.getCoverings({
layerId: '0',
bbox: new Extent({
"xmin":-180,
"ymin":-90,
"xmax":180,
"ymax":90,
}),
size: "512,512",
format: "png",
transparent: true,
isAntialiasing: true,
success: function (result) {
console.log('请求成功:', result);
}
});
//promise方式
sceneServer.getCoverings({
layerId: '0'
}).then(function (result) {
console.log('请求成功:', result);
}).catch(function (result) {
console.log('请求失败:', result);
});</code></pre>
</div>
<div class="member">
<h4 class="name" id="getSharedResources">
<a class="href-link" href="#getSharedResources">#</a>
<span class="code-name" id="getSharedResources" style="font-size:30px">
getSharedResources<span class="signature">(options)</span>
</span>
</h4>
<div class="description">
<p>获取指定图层的M3d共享资源,IGS2.0服务</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">
</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>查询成功回调函数,若使用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"><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>查询失败回调函数,若使用Promise方式则不必填写</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
</dl>
<h5>示例</h5>
<pre class="prettyprint"><code>// 回调方式
sceneServer.getSharedResources({
layerId: '0',
success: function (result) {
console.log('请求成功:', result);
},
failure: function (result) {
console.log('请求失败:', result);
}
});
// promise方式
sceneServer.getSharedResources({
layerId: '0'
}).then(function (result) {
console.log('请求成功:', result);
}).catch(function (result) {
console.log('请求失败:', result);
});</code></pre>
</div>
<div class="member">
<h4 class="name" id="queryDocInfo">
<a class="href-link" href="#queryDocInfo">#</a>
<span class="code-name" id="queryDocInfo" style="font-size:30px">
queryDocInfo<span class="signature">(options)</span>
</span>
</h4>
<div class="description">
<p>查询G3D服务的文档图层信息</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">
</td>
<td class="description last"></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>查询成功回调函数,若使用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"><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>查询失败回调函数,若使用Promise方式则不必填写</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>Promise对象</p></div>
<div class='column is-5 has-text-left'>
<label>类型: </label>
<span class="param-type">Promise.<Object></span>
</div>
</div>
</div>
</div>
<h5>示例</h5>
<p class="code-caption"><h5>查询G3D服务的文档图层信息</h5></p>
<pre class="prettyprint"><code>sceneServer.queryDocInfo()
.then((result) => {
console.log('查询成功:', result)
})
.catch((result) => {
console.log('查询失败:', result)
})</code></pre>
</div>
<div class="member">
<h4 class="name" id="queryDocListInfo">
<a class="href-link" href="#queryDocListInfo">#</a>
<span class="code-name" id="queryDocListInfo" style="font-size:30px">
queryDocListInfo<span class="signature">(options)</span>
</span>
</h4>
<div class="description">
<p>获取所有发布的G3D文档列表</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">
</td>
<td class="description last"></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="ip"><code>ip</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>服务器的ip地址,必填</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="port"><code>port</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="success"><code>success</code></td>
<td class="type">
<span class="param-type">function</span>
</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"><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>查询失败回调函数,若使用Promise方式则不必填写</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>Promise对象</p></div>
<div class='column is-5 has-text-left'>
<label>类型: </label>
<span class="param-type">Promise.<Object></span>
</div>
</div>
</div>
</div>
<h5>示例</h5>
<p class="code-caption"><h5>获取所有发布的G3D文档列表</h5></p>
<pre class="prettyprint"><code>sceneServer.queryDocListInfo({
// 服务器的ip地址
ip: 'localhost',
// 服务器的端口号
port: '6163'
})
.then((result) => {
console.log('查询成功:', result)
})
.catch((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>指定图层的要素查询,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" id="options"><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" 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="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="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>查询成功回调函数,若使用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"><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>查询失败回调函数,若使用Promise方式则不必填写</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="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条件</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="outFields"><code>outFields</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="objectIds"><code>objectIds</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="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">
<span class="param-type">Number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>返回要素几何信息中坐标xy的精度</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="spatialRel"><code>spatialRel</code></td>
<td class="type">
<span class="param-type"><a link="SpatialRelation.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="SpatialRelation" global.html#SpatialRelation>SpatialRelation</a></span>
</td>
<td class="default">
</td>
<td class="description last"><p>几何条件的空间判定规则,Intersects(相交)、EnvelopeIntersects(外包矩形相交)、Contains(包含)、Disjoint(相离)</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="orderByFields"><code>orderByFields</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
</td>
<td class="description last"><p>排序字段,格式: fieldName [ASC|DESC]</p></td>
</tr>
<tr class="deep-leve