UNPKG

@mapgis/webclient-common

Version:

mapgis ES6 format for igserver

1,315 lines (431 loc) 19.3 kB
<header id="page-title" class="page-title"> <span class="page-title-main">类名</span> <span class="page-title-sub">Font</span> </header> <section> <article> <div class="container-overview"> <div class='vertical-section'> <div class="members"> <div class="member"> <h4 class="name" id="Font"> <a class="href-link" href="#Font">#</a> <span class="code-name" id="Font" style="font-size:30px"> new Font<span class="signature">(options)</span> </span> </h4> <div class="description"> <p>字体样式,参考示例:<a href='#new-Font'>[字体样式]</a></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="family"><code>family</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="default"> 'Microsoft YaHei' </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="style"><code>style</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="default"> 'normal' </td> <td class="description last"><p>字体样式, 可选&quot;normal&quot;|&quot;italic&quot;|&quot;oblique&quot;</p></td> </tr> <tr class="deep-level-1"> <td class="name" id="weight"><code>weight</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="default"> 'normal' </td> <td class="description last"><p>字体粗细, 可选&quot;normal&quot;|&quot;bold&quot;|&quot;bolder&quot;|&quot;lighter&quot;</p></td> </tr> <tr class="deep-level-1"> <td class="name" id="decoration"><code>decoration</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="default"> 'none' </td> <td class="description last"><p>文字装饰元素,默认为&quot;none&quot;。设置&quot;underline&quot;显示文字下划线,设置&quot;line-through&quot;显示文字删除线</p></td> </tr> </tbody> </table> </div> <dl class="details"> </dl> <p class="summary"><h5>支持如下方法:</h5> <a href='#toJSON'>[1、转换为json对象]</a><br/> <a href='#clone'>[2、克隆并返回一个新的LabelClass对象]</a><br/> <a href='#fromJSON'>[3、将JSON里的数据导入,并返回一个新的LabelClass对象]</a><br/></p> <h5>示例</h5> <p class="code-caption"><h7 id='new-Font'>创建字体样式</h7></p> <pre class="prettyprint"><code>const font = new Zondy.Font({ // 字体 family: "微软雅黑", // 文字大小,单位像素 size: 30, // 文字是否为斜体,正常模式 style: "normal", // 文字粗细 weight: "normal" })</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="#decoration">decoration</a></code></td> <td class="name"> <code> <span class="param-type">String</span> </code> </td> <td class="name"><code><p>文字装饰元素,默认为&quot;none&quot;。设置&quot;underline&quot;显示文字下划线,设置&quot;line-through&quot;显示文字删除线</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#family">family</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="#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="#style">style</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="#weight">weight</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="decoration"> <a class="href-link" href="#decoration">#</a> <span class="code-name"> decoration </span> </h4> <div class="description"> <p>文字装饰元素,默认为&quot;none&quot;。设置&quot;underline&quot;显示文字下划线,设置&quot;line-through&quot;显示文字删除线</p> </div> <dl class="details"> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"> <li>'none'</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="family"> <a class="href-link" href="#family">#</a> <span class="code-name"> family </span> </h4> <div class="description"> <p>字体名</p> </div> <dl class="details"> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"> <li>Microsoft YaHei</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="size"> <a class="href-link" href="#size">#</a> <span class="code-name"> size </span> </h4> <div class="description"> <p>字体大小</p> </div> <dl class="details"> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"> <li>12</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="style"> <a class="href-link" href="#style">#</a> <span class="code-name"> style </span> </h4> <div class="description"> <p>字体样式</p> </div> <dl class="details"> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"> <li>normal</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="weight"> <a class="href-link" href="#weight">#</a> <span class="code-name"> weight </span> </h4> <div class="description"> <p>字体粗细</p> </div> <dl class="details"> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"> <li>normal</li> </ul></dd> </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="Font.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Font" Font.html>Font</a></span> </code> </td> <td class="name"><code><p>将JSON里的数据导入,并返回一个新的Font对象<a id='fromJSON'></a></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="Font.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Font" Font.html>Font</a></span> </code> </td> <td class="name"><code><p>克隆并返回一个新的Font对象<a id='clone'></a></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"><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>转换为json对象<a id='toJSON'></a></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 class="signature-attributes">opt</span>)</span> </span> </h4> <div class="description"> <p>将JSON里的数据导入,并返回一个新的Font对象<a id='fromJSON'></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="json"><code>json</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"><p>新的Font对象</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>新的Font对象</p></div> <div class='column is-5 has-text-left'> <label>类型: </label> <span class="param-type"><a link="Font.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Font" Font.html>Font</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"> <p>克隆并返回一个新的Font对象<a id='clone'></a></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>Font对象</p></div> <div class='column is-5 has-text-left'> <label>类型: </label> <span class="param-type"><a link="Font.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Font" Font.html>Font</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>转换为json对象<a id='toJSON'></a></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>Font对象</p></div> <div class='column is-5 has-text-left'> <label>类型: </label> <span class="param-type"><a link="Font.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Font" Font.html>Font</a></span> </div> </div> </div> </div> </div> </div> </div> </article> </section>