UNPKG

@mapgis/webclient-common

Version:

mapgis ES6 format for igserver

2,053 lines (672 loc) 32.7 kB
<header id="page-title" class="page-title"> <span class="page-title-main">类名</span> <span class="page-title-sub">TextSymbol3DLayer</span> </header> <section> <article> <div class="container-overview"> <div class='vertical-section'> <div class="members"> <div class="member"> <h4 class="name" id="TextSymbol3DLayer"> <a class="href-link" href="#TextSymbol3DLayer">#</a> <span class="code-name" id="TextSymbol3DLayer" style="font-size:30px"> new TextSymbol3DLayer<span class="signature">(options)</span> </span> </h4> <div class="description"> <p>三维注记符号图层,定义如何在三维场景中显示文字,不支持二维视图<br/> 示例如下:<br/> <a href='#TextSymbol3DLayer'>[1、创建一个三维注记符号图层对象]</a><br/></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="text"><code>text</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="default"> null </td> <td class="description last"><p>文字内容</p></td> </tr> <tr class="deep-level-1"> <td class="name" id="font"><code>font</code></td> <td class="type"> <span class="param-type"><a link="Font.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Font" Font.html>Font</a></span> </td> <td class="default"> new Font() </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">Number</span> </td> <td class="default"> 9 </td> <td class="description last"><p>文字大小,在字体中设置文字大小无效</p></td> </tr> <tr class="deep-level-1"> <td class="name" id="material"><code>material</code></td> <td class="type"> <span class="param-type"><a link="ColorMaterial.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="ColorMaterial" ColorMaterial.html>ColorMaterial</a></span> </td> <td class="default"> new ColorMaterial() </td> <td class="description last"><p>文字材质目前支持的材质有:<br/> ColorMaterial: 纯色材质,通过设置纯色材质来设置文字颜色</p></td> </tr> <tr class="deep-level-1"> <td class="name" id="background"><code>background</code></td> <td class="type"> <span class="param-type"><a link="Color.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Color" Color.html>Color</a></span> </td> <td class="default"> new Color() </td> <td class="description last"><p>文字背景颜色</p></td> </tr> <tr class="deep-level-1"> <td class="name" id="halo"><code>halo</code></td> <td class="type"> <span class="param-type"><a link="TextHalo.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="TextHalo" TextHalo.html>TextHalo</a></span> </td> <td class="default"> new TextHalo() </td> <td class="description last"><p>文字光晕样式</p></td> </tr> <tr class="deep-level-1"> <td class="name" id="horizontalAlignment"><code>horizontalAlignment</code></td> <td class="type"> <span class="param-type"><a link="HorizontalAlignment.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="HorizontalAlignment" global.html#HorizontalAlignment>HorizontalAlignment</a></span> </td> <td class="default"> HorizontalAlignment.center </td> <td class="description last"><p>文字水平对齐方式</p></td> </tr> <tr class="deep-level-1"> <td class="name" id="verticalAlignment"><code>verticalAlignment</code></td> <td class="type"> <span class="param-type"><a link="VerticalAlignment.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="VerticalAlignment" global.html#VerticalAlignment>VerticalAlignment</a></span> </td> <td class="default"> VerticalAlignment.baseline </td> <td class="description last"><p>文字垂直对齐方式</p></td> </tr> <tr class="deep-level-1"> <td class="name" id="lineHeight"><code>lineHeight</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="default"> 1 </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数据构造一个TextSymbol3DLayer对象]</a><br/> <a href='#toJSON'>[2、导出为JSON对象]</a><br/> <a href='#clone'>[3、克隆并返回一个新的TextSymbol3DLayer对象]</a><br/></p> <h5>示例</h5> <p class="code-caption"><h7 id='TextSymbol3DLayer'>创建一个三维注记符号图层对象</h7></p> <pre class="prettyprint"><code>// ES5引入方式 const { Color } = Zondy const { TextSymbol3DLayer, ColorMaterial } = Zondy.Symbol // ES6引入方式 import { TextSymbol3DLayer, ColorMaterial, Color } from "@mapgis/webclient-common" // 创建一个三维注记符号图层对象 const symbol = new TextSymbol3DLayer({ // 文字内容 text: '你的文字内容', // 文字大小 size: 40, // 文字颜色 material: new ColorMaterial({ color: new Color(255, 1, 1, 1) }) })</code></pre> </div> </div> </div> </div> <h3 class="subsection-title">继承关系</h3> <ul> <li><a link="Symbol3DLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Symbol3DLayer" Symbol3DLayer.html>Symbol3DLayer</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="#background">background</a></code></td> <td class="name"> <code> <span class="param-type"><a link="Color.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Color" Color.html>Color</a></span> </code> </td> <td class="name"><code><p>背景颜色</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#background">background</a></code></td> <td class="name"> <code> <span class="param-type"><a link="Font.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Font" Font.html>Font</a></span> </code> </td> <td class="name"><code><p>字体</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#color">color</a></code></td> <td class="name"> <code> <span class="param-type"><a link="Color.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Color" Color.html>Color</a></span> </code> </td> <td class="name"><code><p>颜色</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#extendOptions">extendOptions</a></code></td> <td class="name"> <code> <span class="param-type">Object</span> </code> </td> <td class="name"><code><p>符号的额外构造参数,该构造参数是地图引擎的额外构造参数,在此设置了之后,会覆盖该符号转换好地图引擎的构造参数</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#halo">halo</a></code></td> <td class="name"> <code> <span class="param-type"><a link="TextHalo.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="TextHalo" TextHalo.html>TextHalo</a></span> </code> </td> <td class="name"><code><p>文字光晕样式</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#horizontalAlignment">horizontalAlignment</a></code></td> <td class="name"> <code> <span class="param-type"><a link="HorizontalAlignment.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="HorizontalAlignment" global.html#HorizontalAlignment>HorizontalAlignment</a></span> </code> </td> <td class="name"><code><p>文字水平对齐方式</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#lineHeight">lineHeight</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="#material">material</a></code></td> <td class="name"> <code> <span class="param-type"><a link="ColorMaterial.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="ColorMaterial" ColorMaterial.html>ColorMaterial</a></span> </code> </td> <td class="name"><code><p>材质</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#size">size</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="#text">text</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="#type">type</a></code></td> <td class="name"> <code> <span class="param-type"><a link="Symbol3DLayerType.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Symbol3DLayerType" global.html#Symbol3DLayerType>Symbol3DLayerType</a></span> </code> </td> <td class="name"><code><p>三维符号图层类型</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#verticalAlignment">verticalAlignment</a></code></td> <td class="name"> <code> <span class="param-type"><a link="VerticalAlignment.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="VerticalAlignment" global.html#VerticalAlignment>VerticalAlignment</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"><a link="Color.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Color" Color.html>Color</a></span> </span> <h4 class="name" id="background"> <a class="href-link" href="#background">#</a> <span class="code-name"> background </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="Font.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Font" Font.html>Font</a></span> </span> <h4 class="name" id="background"> <a class="href-link" href="#background">#</a> <span class="code-name"> background </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="Color.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Color" Color.html>Color</a></span> </span> <h4 class="name" id="color"> <a class="href-link" href="#color">#</a> <span class="code-name"> color </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="color" link="Symbol.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Symbol#color" Symbol.html#color>Symbol#color</a> </li></ul></dd> </dl> </div> <div class="member"> <span class="method-parameter is-pulled-right"> <label>类型:</label> <span class="param-type">Object</span> </span> <h4 class="name" id="extendOptions"> <a class="href-link" href="#extendOptions">#</a> <span class="code-name"> extendOptions </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="extendOptions" link="Symbol.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Symbol#extendOptions" Symbol.html#extendOptions>Symbol#extendOptions</a> </li></ul></dd> </dl> </div> <div class="member"> <span class="method-parameter is-pulled-right"> <label>类型:</label> <span class="param-type"><a link="TextHalo.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="TextHalo" TextHalo.html>TextHalo</a></span> </span> <h4 class="name" id="halo"> <a class="href-link" href="#halo">#</a> <span class="code-name"> halo </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="HorizontalAlignment.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="HorizontalAlignment" global.html#HorizontalAlignment>HorizontalAlignment</a></span> </span> <h4 class="name" id="horizontalAlignment"> <a class="href-link" href="#horizontalAlignment">#</a> <span class="code-name"> horizontalAlignment </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="lineHeight"> <a class="href-link" href="#lineHeight">#</a> <span class="code-name"> lineHeight </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="ColorMaterial.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="ColorMaterial" ColorMaterial.html>ColorMaterial</a></span> </span> <h4 class="name" id="material"> <a class="href-link" href="#material">#</a> <span class="code-name"> material </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="size"> <a class="href-link" href="#size">#</a> <span class="code-name"> size </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="text"> <a class="href-link" href="#text">#</a> <span class="code-name"> text </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="Symbol3DLayerType.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Symbol3DLayerType" global.html#Symbol3DLayerType>Symbol3DLayerType</a></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>三维符号图层类型</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="Symbol3DLayer#type" Symbol3DLayer.html#type>Symbol3DLayer#type</a> </li></ul></dd> </dl> </div> <div class="member"> <span class="method-parameter is-pulled-right"> <label>类型:</label> <span class="param-type"><a link="VerticalAlignment.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="VerticalAlignment" global.html#VerticalAlignment>VerticalAlignment</a></span> </span> <h4 class="name" id="verticalAlignment"> <a class="href-link" href="#verticalAlignment">#</a> <span class="code-name"> verticalAlignment </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="TextSymbol3DLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="TextSymbol3DLayer" TextSymbol3DLayer.html>TextSymbol3DLayer</a></span> </code> </td> <td class="name"><code><a id='fromJSON'/> 通过json数据构造一个TextSymbol3DLayer对象</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="TextSymbol3DLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="TextSymbol3DLayer" TextSymbol3DLayer.html>TextSymbol3DLayer</a></span> </code> </td> <td class="name"><code><a id='clone'/> 克隆并返回一个新的TextSymbol3DLayer对象</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><a id='toJSON'></a> 导出为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"> <a id='fromJSON'/> 通过json数据构造一个TextSymbol3DLayer对象 </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"> </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>新的TextSymbol3DLayer对象</p></div> <div class='column is-5 has-text-left'> <label>类型: </label> <span class="param-type"><a link="TextSymbol3DLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="TextSymbol3DLayer" TextSymbol3DLayer.html>TextSymbol3DLayer</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'/> 克隆并返回一个新的TextSymbol3DLayer对象 </div> <dl class="details"> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a class="mapgis-link-name" title="Symbol3DLayer#clone" Symbol3DLayer.html#clone>Symbol3DLayer#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>新的TextSymbol3DLayer对象</p></div> <div class='column is-5 has-text-left'> <label>类型: </label> <span class="param-type"><a link="TextSymbol3DLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="TextSymbol3DLayer" TextSymbol3DLayer.html>TextSymbol3DLayer</a></span> </div> </div> </div> </div> </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><a id='toJSON'></a> 导出为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="Symbol3DLayer#toJSON" Symbol3DLayer.html#toJSON>Symbol3DLayer#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>