@mapgis/webclient-common
Version:
mapgis ES6 format for igserver
2,154 lines • 30.3 kB
HTML
<header id="page-title" class="page-title">
<span class="page-title-main">类名</span>
<span class="page-title-sub">RankRenderer</span>
</header>
<section>
<article>
<div class="container-overview">
<div class='vertical-section'>
<div class="members">
<div class="member">
<h4 class="name" id="RankRenderer">
<a class="href-link" href="#RankRenderer">#</a>
<span class="code-name" id="RankRenderer" style="font-size:30px">
new RankRenderer<span class="signature">(options)</span>
</span>
</h4>
<div class="description">
<p>等级符号专题图，符号尺寸随指定字段的值的变化而变化</p>
</div>
<h4>参数</h4>
<div class="table-container">
<table class="params table">
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th style="min-width: 100px;">默认值</th>
<th class="last">描述</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">
Object
</span>
</td>
<td class="default">
</td>
<td class="description last"><p>构造参数</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>field</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="default">
</td>
<td class="description last"><p>要素字段名</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>minSize</code></td>
<td class="type">
<span class="param-type">
Number
</span>
</td>
<td class="default">
12
</td>
<td class="description last"><p>等级符号最小尺寸，单位像素</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>maxSize</code></td>
<td class="type">
<span class="param-type">
Number
</span>
</td>
<td class="default">
50
</td>
<td class="description last"><p>等级符号最大尺寸，单位像素</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>minDataValue</code></td>
<td class="type">
<span class="param-type">
Number
</span>
</td>
<td class="default">
</td>
<td class="description last"><p>最小数据范围，如果小于此数据范围按minSize进行符号渲染</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>maxDataValue</code></td>
<td class="type">
<span class="param-type">
Number
</span>
</td>
<td class="default">
</td>
<td class="description last"><p>最大数据范围，如果超出此数据范围按maxSize进行符号渲染</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>symbol</code></td>
<td class="type">
<span class="param-type">
<a link="Symbol.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Symbol" Symbol.html>Symbol</a>
</span>
</td>
<td class="default">
</td>
<td class="description last"><p>等级符号样式，目前仅支持SimpleMarkerSymbol|PictureMarkerSymbol|TextSymbol，不支持线图层</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>valueExpression</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="default">
</td>
<td class="description last"><p>数据字段表达式，设置了会覆盖field的值</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>valueExpressionTitle</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>
<p class="summary"><h5>支持如下方法：</h5>
<a href='#fromJSON'>[1、通过json构造RankRenderer对象]</a><br/>
<a href='#toJSON'>[2、导出json对象]</a><br/>
<a href='#clone'>[3、克隆RankRenderer对象]</a></p>
<h5>示例</h5>
<p class="code-caption"><h7 id='new-PictureMarkerSymbol'>创建随机渲染器对象</h7></p>
<pre class="prettyprint"><code>// ES5引入方式
const { RankRenderer } = zondy.renderer
const { SimpleMarkerSymbol, SimpleLineSymbol } = zondy.symbol
// ES6引入方式
import { RankRenderer, SimpleMarkerSymbol, SimpleLineSymbol } from "@mapgis/webclient-common"
// 初始化等级符号渲染器对象
const rankRenderer = new RankRenderer({
// 等级符号最小尺寸，单位像素
minSize: 12,
// 等级符号最大尺寸，单位像素
maxSize: 50,
// 字段名
field: '字段名',
// 符号样式
symbol:new SimpleMarkerSymbol({
// 填充颜色
color:'#00ff00',
// 符号形状样式
style:'diamond',
// 符号外边线样式
outline:new SimpleLineSymbol({
// 符号外边线颜色
color: '#ff0000',
// 符号外边线宽度
width: 2
})
})
})</code></pre>
</div>
</div>
</div>
</div>
<h3 class="subsection-title">继承关系</h3>
<ul>
<li><a link="BaseRenderer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="BaseRenderer" BaseRenderer.html>BaseRenderer</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="#field">field</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="#id">id</a></code></td>
<td class="name">
<code>
<span class="param-type">
String
</span>
</code>
</td>
<td class="name"><code><p>渲染器id</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#maxDataValue">maxDataValue</a></code></td>
<td class="name">
<code>
<span class="param-type">
Number
</span>
</code>
</td>
<td class="name"><code><p>最大数据范围，如果超出此数据范围按maxSize进行符号渲染</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#maxSize">maxSize</a></code></td>
<td class="name">
<code>
<span class="param-type">
Number
</span>
</code>
</td>
<td class="name"><code><p>等级符号最大尺寸，单位像素</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#minDataValue">minDataValue</a></code></td>
<td class="name">
<code>
<span class="param-type">
Number
</span>
</code>
</td>
<td class="name"><code><p>最小数据范围，如果小于此数据范围按minSize进行符号渲染</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#minSize">minSize</a></code></td>
<td class="name">
<code>
<span class="param-type">
Number
</span>
</code>
</td>
<td class="name"><code><p>等级符号最小尺寸，单位像素</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#symbol">symbol</a></code></td>
<td class="name">
<code>
<span class="param-type">
<a link="Symbol.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Symbol" Symbol.html>Symbol</a>
</span>
</code>
</td>
<td class="name"><code><p>等级符号样式，目前仅支持SimpleMarkerSymbol|PictureMarkerSymbol|TextSymbol</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#type">type</a></code></td>
<td class="name">
<code>
<span class="param-type">
String
</span>
</code>
</td>
<td class="name"><code><p>符号类型，默认为‘rank’</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#valueExpression">valueExpression</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="#valueExpressionTitle">valueExpressionTitle</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="field">
<a class="href-link" href="#field">#</a>
<span class="code-name">
field
</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="id">
<a class="href-link" href="#id">#</a>
<span class='tag'>readonly</span>
<span class="code-name">
id
</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="id" link="BaseRenderer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="BaseRenderer#id" BaseRenderer.html#id>BaseRenderer#id</a>
</li></ul></dd>
</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="maxDataValue">
<a class="href-link" href="#maxDataValue">#</a>
<span class="code-name">
maxDataValue
</span>
</h4>
<div class="description">
<p>最大数据范围，如果超出此数据范围按maxSize进行符号渲染</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="maxSize">
<a class="href-link" href="#maxSize">#</a>
<span class="code-name">
maxSize
</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">
Number
</span>
</span>
<h4 class="name" id="minDataValue">
<a class="href-link" href="#minDataValue">#</a>
<span class="code-name">
minDataValue
</span>
</h4>
<div class="description">
<p>最小数据范围，如果小于此数据范围按minSize进行符号渲染</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="minSize">
<a class="href-link" href="#minSize">#</a>
<span class="code-name">
minSize
</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">
<a link="Symbol.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Symbol" Symbol.html>Symbol</a>
</span>
</span>
<h4 class="name" id="symbol">
<a class="href-link" href="#symbol">#</a>
<span class="code-name">
symbol
</span>
</h4>
<div class="description">
<p>等级符号样式，目前仅支持SimpleMarkerSymbol|PictureMarkerSymbol|TextSymbol</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="type">
<a class="href-link" href="#type">#</a>
<span class='tag'>readonly</span>
<span class="code-name">
type
</span>
</h4>
<div class="description">
<p>符号类型，默认为‘rank’</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="BaseRenderer#type" BaseRenderer.html#type>BaseRenderer#type</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="valueExpression">
<a class="href-link" href="#valueExpression">#</a>
<span class="code-name">
valueExpression
</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="valueExpressionTitle">
<a class="href-link" href="#valueExpressionTitle">#</a>
<span class="code-name">
valueExpressionTitle
</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="#fromJSON">fromJSON</a></code></td>
<td class="name">
<code>
<span class="param-type">
<a link="RankRenderer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="RankRenderer" RankRenderer.html>RankRenderer</a>
</span>
</code>
</td>
<td class="name"><code></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#clone">clone</a></code></td>
<td class="name">
<code>
<span class="param-type">
<a link="RankRenderer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="RankRenderer" RankRenderer.html>RankRenderer</a>
</span>
</code>
</td>
<td class="name"><code></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#fromJSON">fromJSON</a></code></td>
<td class="name">
<code>
</code>
</td>
<td class="name"><code><p>将JSON格式的渲染规则转换为JS对象</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#toJSON">toJSON</a></code></td>
<td class="name">
<code>
<span class="param-type">
Object
</span>
</code>
</td>
<td class="name"><code></code></td>
</tr>
</tbody>
</table>
</div>
<h4 style="margin-top: 20px;margin-bottom: 20px;">方法详情</h4>
<div class="member">
<h4 class="name" id=".fromJSON">
<a class="href-link" href="#.fromJSON">#</a>
<span class='tag'>static</span>
<span class="code-name" id="fromJSON" style="font-size:30px">
fromJSON<span class="signature">(json)</span>
</span>
</h4>
<div class="description">
<a id='fromJSON'/>
通过json构造RankRenderer对象
</div>
<h4>参数</h4>
<div class="table-container">
<table class="params table">
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th class="last">描述</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code>json</code></td>
<td class="type">
<span class="param-type">
Object
</span>
</td>
<td class="description last"><p>json对象</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>RankRenderer实例</p></div>
<div class='column is-5 has-text-left'>
<label>类型: </label>
<span class="param-type">
<a link="RankRenderer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="RankRenderer" RankRenderer.html>RankRenderer</a>
</span>
</div>
</div>
</div>
</div>
</div>
<div class="member">
<h4 class="name" id="clone">
<a class="href-link" href="#clone">#</a>
<span class="code-name" id="clone" style="font-size:30px">
clone<span class="signature">()</span>
</span>
</h4>
<div class="description">
<a id='clone'/>
克隆RankRenderer对象
</div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a class="mapgis-link-name" title="BaseRenderer#clone" BaseRenderer.html#clone>BaseRenderer#clone</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='param-desc column is-7'><p>克隆后的RankRenderer实例</p></div>
<div class='column is-5 has-text-left'>
<label>类型: </label>
<span class="param-type">
<a link="RankRenderer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="RankRenderer" RankRenderer.html>RankRenderer</a>
</span>
</div>
</div>
</div>
</div>
</div>
<div class="member">
<h4 class="name" id="fromJSON">
<a class="href-link" href="#fromJSON">#</a>
<span class="code-name" id="fromJSON" style="font-size:30px">
fromJSON<span class="signature">(json)</span>
</span>
</h4>
<div class="description">
<p>将JSON格式的渲染规则转换为JS对象</p>
</div>
<h4>参数</h4>
<div class="table-container">
<table class="params table">
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th class="last">描述</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code>json</code></td>
<td class="type">
<span class="param-type">
Object
</span>
</td>
<td class="description last"><p>渲染规则的实例化JSON</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="fromJSON" link="BaseRenderer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="BaseRenderer#fromJSON" BaseRenderer.html#fromJSON>BaseRenderer#fromJSON</a>
</li></ul></dd>
</dl>
</div>
<div class="member">
<h4 class="name" id="toJSON">
<a class="href-link" href="#toJSON">#</a>
<span class="code-name" id="toJSON" style="font-size:30px">
toJSON<span class="signature">()</span>
</span>
</h4>
<div class="description">
<a id='toJSON'/>
导出json对象
</div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a class="mapgis-link-name" title="BaseRenderer#toJSON" BaseRenderer.html#toJSON>BaseRenderer#toJSON</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='param-desc column is-7'><p>json对象</p></div>
<div class='column is-5 has-text-left'>
<label>类型: </label>
<span class="param-type">
Object
</span>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</article>
</section>