@mapgis/webclient-common
Version:
mapgis ES6 format for igserver
732 lines (244 loc) • 10.6 kB
HTML
<header id="page-title" class="page-title">
<span class="page-title-main">类名</span>
<span class="page-title-sub">OutStatistic</span>
</header>
<section>
<article>
<div class="container-overview">
<div class='vertical-section'>
<div class="members">
<div class="member">
<h4 class="name" id="OutStatistic">
<a class="href-link" href="#OutStatistic">#</a>
<span class="code-name" id="OutStatistic" style="font-size:30px">
new OutStatistic<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="statisticType"><code>statisticType</code></td>
<td class="type">
<span class="param-type"><a link="StatisticType.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="StatisticType" global.html#StatisticType>StatisticType</a></span>
</td>
<td class="default">
无
</td>
<td class="description last"><p>统计方法类型，必传</p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="onStatisticField"><code>onStatisticField</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="outStatisticFieldName"><code>outStatisticFieldName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
无
</td>
<td class="description last"><p>输出统计结果时，要统计的字段的别名</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
</dl>
<h5>示例</h5>
<pre class="prettyprint"><code>//创建统计信息结构对象
let OutStatistic = new Zondy.OutStatistic({
//统计最大值
statisticType: StatisticType.functionMax,
//要统计的字段
onStatisticField: 'GDP2011',
//要统计的字段的别名
outStatisticFieldName: 'anotherName'
});</code></pre>
</div>
</div>
</div>
</div>
<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="#onStatisticField">onStatisticField</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="#outStatisticFieldName">outStatisticFieldName</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="#statisticType">statisticType</a></code></td>
<td class="name">
<code>
<span class="param-type">String</span>
</code>
</td>
<td class="name"><code><p>统计方法类型</p></code></td>
</tr>
</tbody>
</table>
</div>
<h4 style="margin-top: 20px;margin-bottom: 20px;">成员变量详情</h4>
<div class="members">
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">String</span>
</span>
<h4 class="name" id="onStatisticField">
<a class="href-link" href="#onStatisticField">#</a>
<span class="code-name">
onStatisticField
</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="outStatisticFieldName">
<a class="href-link" href="#outStatisticFieldName">#</a>
<span class="code-name">
outStatisticFieldName
</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="statisticType">
<a class="href-link" href="#statisticType">#</a>
<span class="code-name">
statisticType
</span>
</h4>
<div class="description">
<p>统计方法类型</p>
</div>
<dl class="details">
</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="#toString">toString</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="toString">
<a class="href-link" href="#toString">#</a>
<span class="code-name" id="toString" style="font-size:30px">
toString<span class="signature">()</span>
</span>
</h4>
<div class="description">
<p>将对象转为字符串</p>
</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>Sting 转化后的字符串</p></div>
</div>
</div>
</div>
<h5>示例</h5>
<pre class="prettyprint"><code>OutStatistic.toString();
//statisticType和onStatisticField存在
//字符串为：'{"statisticType": "FUNCTION_SUM","onStatisticField": "GDP2011"'
//statisticType、onStatisticField和outStatisticFieldName存在
//字符串为：'{"statisticType": "FUNCTION_SUM","onStatisticField": "GDP2011", "outStatisticFieldName":"test"}'</code></pre>
</div>
</div>
</div>
</article>
</section>