UNPKG

@mapgis/webclient-common

Version:

mapgis ES6 format for igserver

1,460 lines (499 loc) 23.6 kB
<header id="page-title" class="page-title"> <span class="page-title-main">类名</span> <span class="page-title-sub">SimpleRenderer</span> </header> <section> <article> <div class="container-overview"> <div class='vertical-section'> <div class="members"> <div class="member"> <h4 class="name" id="SimpleRenderer"> <a class="href-link" href="#SimpleRenderer">#</a> <span class="code-name" id="SimpleRenderer" style="font-size:30px"> new SimpleRenderer<span class="signature">(options)</span> </span> </h4> <div class="description"> <p>统一专题图渲染样式,支持的图层如下:<br/> <a class="mapgis-link-name" title="GraphicsLayer" GraphicsLayer.html><code>几何图形图层</code></a><a class="mapgis-link-name" title="IGSFeatureLayer" IGSFeatureLayer.html><code>IGS要素图层</code></a><a class="mapgis-link-name" title="GeoJSONLayer" GeoJSONLayer.html><code>geojson图层</code></a><a class="mapgis-link-name" title="WFSLayer" WFSLayer.html><code>OGC-WFS图层</code></a></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="label"><code>label</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="description"><code>description</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="symbol"><code>symbol</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"><p>统一专题图样式,支持的样式如下:<br/> <a class="mapgis-link-name" title="SimpleMarkerSymbol" SimpleMarkerSymbol.html><code>1、点样式</code></a><br/> <a class="mapgis-link-name" title="SimpleLineSymbol" SimpleLineSymbol.html><code>2、线样式</code></a><br/> <a class="mapgis-link-name" title="SimpleFillSymbol" SimpleFillSymbol.html><code>3、区样式</code></a><br/> 示例如下:<br> <a href='#Simple-point'>[1、单值专题图-点]</a><br/> <a href='#Simple-line'>[2、单值专题图-线]</a><br/> <a href='#Simple-fill'>[3、单值专题图-区]</a></p></td> </tr> </tbody> </table> </div> <dl class="details"> </dl> <h5>示例</h5> <p class="code-caption"><h7 id='Simple-point'>统一专题图-点</h7></p> <pre class="prettyprint"><code>// ES5引入方式 const { SimpleRenderer } = Zondy.Renderer const { SimpleMarkerSymbol, SimpleLineSymbol } = Zondy.Symbol const { Color } = Zondy // ES6引入方式 import { SimpleRenderer, SimpleMarkerSymbol, SimpleLineSymbol, Color } from "@mapgis/webclient-common" // 初始化统一专题图样式对象 const simpleRenderer = new SimpleRenderer({ // 样式对象,更多样式详见:<a class="mapgis-link-name" title="SimpleMarkerSymbol" SimpleMarkerSymbol.html><code>《SimpleMarkerSymbol》</code></a> symbol: new SimpleMarkerSymbol({ // 填充颜色 color: 'rgba(1,1,252,0)', // 点半径 size: 13, // 外边线样式 outline: new SimpleLineSymbol({ //线颜色 color: new Color(255, 1, 0, 1), //线宽 width: 1 }) }) });</code></pre> <p class="code-caption"><h7 id='Simple-line'>统一专题图-线</h7></p> <pre class="prettyprint"><code>// ES5引入方式 const { SimpleRenderer } = Zondy.Renderer const { SimpleLineSymbol } = Zondy.Symbol const { Color } = Zondy // ES6引入方式 import { SimpleRenderer, SimpleLineSymbol, Color } from "@mapgis/webclient-common" // 初始化统一专题图样式对象 const simpleRenderer = new SimpleRenderer({ // 样式对象,更多样式详见:<a class="mapgis-link-name" title="SimpleLineSymbol" SimpleLineSymbol.html><code>《SimpleLineSymbol》</code></a> symbol: new SimpleLineSymbol({ //线符号颜色 color: new Color(255, 1, 0, 11), //线宽 width: 1 }) });</code></pre> <p class="code-caption"><h7 id='Simple-fill'>统一专题图-区</h7></p> <pre class="prettyprint"><code>// ES5引入方式 const { SimpleRenderer } = Zondy.Renderer const { SimpleFillSymbol, SimpleLineSymbol } = Zondy.Symbol const { Color } = Zondy // ES6引入方式 import { SimpleRenderer, SimpleFillSymbol, SimpleLineSymbol, Color } from "@mapgis/webclient-common" // 初始化统一专题图样式对象,更多样式详见:<a class="mapgis-link-name" title="SimpleFillSymbol" SimpleFillSymbol.html><code>《SimpleFillSymbol》</code></a> const simpleRenderer = new SimpleRenderer({ // 样式对象,更多样式详见:<a class="mapgis-link-name" title="SimpleLineSymbol" SimpleLineSymbol.html><code>《SimpleLineSymbol》</code></a> symbol: new SimpleFillSymbol({ // 填充颜色 color: 'rgba(1,1,252,0)', // 外边线样式 outline: new SimpleLineSymbol({ //线颜色 color: new Color(255, 1, 0, 1), //线宽 width: 1 }) }) });</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="#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="#label">label</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="#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>defaultSymbol 统一专题图样式</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>type 'simple',统一专题图</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#visualVariables">visualVariables</a></code></td> <td class="name"> <code> <span class="param-type">Array.&lt;<a link="Array.<VisualVariable>.html" onclick="getTypeHTML(event)" href="VisualVariable.html">VisualVariable</a>></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="description"> <a class="href-link" href="#description">#</a> <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="label"> <a class="href-link" href="#label">#</a> <span class="code-name"> label </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>defaultSymbol 统一专题图样式</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="code-name"> type </span> </h4> <div class="description"> <p>type 'simple',统一专题图</p> </div> <dl class="details"> </dl> </div> <div class="member"> <span class="method-parameter is-pulled-right"> <label>类型:</label> <span class="param-type">Array.&lt;<a link="Array.<VisualVariable>.html" onclick="getTypeHTML(event)" href="VisualVariable.html">VisualVariable</a>></span> </span> <h4 class="name" id="visualVariables"> <a class="href-link" href="#visualVariables">#</a> <span class="code-name"> visualVariables </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="SimpleRenderer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="SimpleRenderer" SimpleRenderer.html>SimpleRenderer</a></span> </code> </td> <td class="name"><code><p>通过json构造SimpleRenderer对象</p></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="SimpleRenderer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="SimpleRenderer" SimpleRenderer.html>SimpleRenderer</a></span> </code> </td> <td class="name"><code><p>克隆renderer对象</p></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><p>导出为json对象</p></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"> <p>通过json构造SimpleRenderer对象</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="json"><code>json</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"></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>新创建的SimpleRenderer对象</p></div> <div class='column is-5 has-text-left'> <label>类型: </label> <span class="param-type"><a link="SimpleRenderer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="SimpleRenderer" SimpleRenderer.html>SimpleRenderer</a></span> </div> </div> </div> </div> <h5>示例</h5> <p class="code-caption"><h7>通过json创造SimpleRenderer对象</h7></p> <pre class="prettyprint"><code>let simpleRenderer = SimpleRenderer.fromJSON({ // 初始化参数 })</code></pre> </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"> <p>克隆renderer对象</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#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>克隆后的renderer对象</p></div> <div class='column is-5 has-text-left'> <label>类型: </label> <span class="param-type"><a link="SimpleRenderer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="SimpleRenderer" SimpleRenderer.html>SimpleRenderer</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" id="json"><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"> <p>导出为json对象</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#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>