@mapgis/webclient-common

<header id="page-title" class="page-title"> <span class="page-title-main">类名</span> <span class="page-title-sub">Color</span> </header> <section> <article> <div class="container-overview"> <div class='vertical-section'> <div class="members"> <div class="member"> <h4 class="name" id="Color"> <a class="href-link" href="#Color">#</a> <span class="code-name" id="Color" style="font-size:30px"> new Color<span class="signature">(red<span class="signature-attributes">opt</span>, green<span class="signature-attributes">opt</span>, blue<span class="signature-attributes">opt</span>, alpha<span class="signature-attributes">opt</span>)</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>red</code></td> <td class="type"> <span class="param-type"> Number </span> </td> <td class="default"> 0.0 </td> <td class="description last"><p>红色</p></td> </tr> <tr class="deep-level-0"> <td class="name"><code>green</code></td> <td class="type"> <span class="param-type"> Number </span> </td> <td class="default"> 0.0 </td> <td class="description last"><p>绿色</p></td> </tr> <tr class="deep-level-0"> <td class="name"><code>blue</code></td> <td class="type"> <span class="param-type"> Number </span> </td> <td class="default"> 0.0 </td> <td class="description last"><p>蓝色</p></td> </tr> <tr class="deep-level-0"> <td class="name"><code>alpha</code></td> <td class="type"> <span class="param-type"> Number </span> </td> <td class="default"> 1.0 </td> <td class="description last"><p>透明度</p></td> </tr> </tbody> </table> </div> <dl class="details"> </dl> </div> </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="#fromColor">fromColor</a></code></td> <td class="name"> <code> <span class="param-type"> <a link="Color.html" onclick="getTypeHTML(event)" href="Color.html">Color</a> </span> </code> </td> <td class="name"><code><p>转换为color对象</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#fromCssString">fromCssString</a></code></td> <td class="name"> <code> <span class="param-type"> <a link="Color.html" onclick="getTypeHTML(event)" href="Color.html">Color</a> </span> </code> </td> <td class="name"><code><p>将Css字符串颜色转为Color</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#fromHexString">fromHexString</a></code></td> <td class="name"> <code> <span class="param-type"> <a link="Color.html" onclick="getTypeHTML(event)" href="Color.html">Color</a> </span> </code> </td> <td class="name"><code><p>将hex字符串转成一个Color对象</p></code></td> </tr> <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="Color.html" onclick="getTypeHTML(event)" href="Color.html">Color</a> </span> </code> </td> <td class="name"><code><p>将json转成一个Color对象</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#fromRGBString">fromRGBString</a></code></td> <td class="name"> <code> <span class="param-type"> <a link="Color.html" onclick="getTypeHTML(event)" href="Color.html">Color</a> </span> </code> </td> <td class="name"><code><p>将rgb或rgba字符串转成一个Color对象</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#hexToRgb">hexToRgb</a></code></td> <td class="name"> <code> <span class="param-type"> String </span> </code> </td> <td class="name"><code><p>将hex字符串转成一个rgb字符串</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#isHex">isHex</a></code></td> <td class="name"> <code> <span class="param-type"> Boolean </span> </code> </td> <td class="name"><code><p>判断是否是hex字符串</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#isRGB">isRGB</a></code></td> <td class="name"> <code> <span class="param-type"> Boolean </span> </code> </td> <td class="name"><code><p>判断是否是rgb字符串</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#rgbToHex">rgbToHex</a></code></td> <td class="name"> <code> <span class="param-type"> String </span> </code> </td> <td class="name"><code><p>将rgb字符串转成一个hex字符串</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="Color.html" onclick="getTypeHTML(event)" href="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="#toCesiumRGB">toCesiumRGB</a></code></td> <td class="name"> <code> <span class="param-type"> Object </span> </code> </td> <td class="name"><code><p>转为cesium的rgba值</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#toCssRGBAString">toCssRGBAString</a></code></td> <td class="name"> <code> <span class="param-type"> String </span> </code> </td> <td class="name"><code><p>转为rgba字符串</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#toCssRGBString">toCssRGBString</a></code></td> <td class="name"> <code> <span class="param-type"> String </span> </code> </td> <td class="name"><code><p>转为rgb字符串</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=".fromColor"> <a class="href-link" href="#.fromColor">#</a> <span class='tag'>static</span> <span class="code-name" id="fromColor" style="font-size:30px"> fromColor<span class="signature">(color)</span> </span> </h4> <div class="description"> <p>转换为color对象</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>color</code></td> <td class="type"> <span class="param-type"> <a link="Color.html" onclick="getTypeHTML(event)" href="Color.html">Color</a> </span> | <span class="param-type"> String </span> </td> <td class="description last"><p>hex字符串或rgba字符串或Color对象</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>转换后的颜色对象</p></div> <div class='column is-5 has-text-left'> <label>类型: </label> <span class="param-type"> <a link="Color.html" onclick="getTypeHTML(event)" href="Color.html">Color</a> </span> </div> </div> </div> </div> </div> <div class="member"> <h4 class="name" id=".fromCssString"> <a class="href-link" href="#.fromCssString">#</a> <span class='tag'>static</span> <span class="code-name" id="fromCssString" style="font-size:30px"> fromCssString<span class="signature">(cssString)</span> </span> </h4> <div class="description"> <p>将Css字符串颜色转为Color</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>cssString</code></td> <td class="type"> <span class="param-type"> String </span> </td> <td class="description last"><p>Css字符串颜色</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>转换后的颜色对象</p></div> <div class='column is-5 has-text-left'> <label>类型: </label> <span class="param-type"> <a link="Color.html" onclick="getTypeHTML(event)" href="Color.html">Color</a> </span> </div> </div> </div> </div> </div> <div class="member"> <h4 class="name" id=".fromHexString"> <a class="href-link" href="#.fromHexString">#</a> <span class='tag'>static</span> <span class="code-name" id="fromHexString" style="font-size:30px"> fromHexString<span class="signature">(hex)</span> </span> </h4> <div class="description"> <p>将hex字符串转成一个Color对象</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>hex</code></td> <td class="type"> <span class="param-type"> String </span> </td> <td class="description last"><p>hex字符串</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>Color对象</p></div> <div class='column is-5 has-text-left'> <label>类型: </label> <span class="param-type"> <a link="Color.html" onclick="getTypeHTML(event)" href="Color.html">Color</a> </span> </div> </div> </div> </div> </div> <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转成一个Color对象</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"> String </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>Color对象</p></div> <div class='column is-5 has-text-left'> <label>类型: </label> <span class="param-type"> <a link="Color.html" onclick="getTypeHTML(event)" href="Color.html">Color</a> </span> </div> </div> </div> </div> </div> <div class="member"> <h4 class="name" id=".fromRGBString"> <a class="href-link" href="#.fromRGBString">#</a> <span class='tag'>static</span> <span class="code-name" id="fromRGBString" style="font-size:30px"> fromRGBString<span class="signature">(rgb)</span> </span> </h4> <div class="description"> <p>将rgb或rgba字符串转成一个Color对象</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>rgb</code></td> <td class="type"> <span class="param-type"> String </span> </td> <td class="description last"><p>rgb或rgba字符</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>Color对象</p></div> <div class='column is-5 has-text-left'> <label>类型: </label> <span class="param-type"> <a link="Color.html" onclick="getTypeHTML(event)" href="Color.html">Color</a> </span> </div> </div> </div> </div> </div> <div class="member"> <h4 class="name" id=".hexToRgb"> <a class="href-link" href="#.hexToRgb">#</a> <span class='tag'>static</span> <span class="code-name" id="hexToRgb" style="font-size:30px"> hexToRgb<span class="signature">(hex)</span> </span> </h4> <div class="description"> <p>将hex字符串转成一个rgb字符串</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>hex</code></td> <td class="type"> <span class="param-type"> String </span> </td> <td class="description last"><p>hex字符串</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>rgb字符串</p></div> <div class='column is-5 has-text-left'> <label>类型: </label> <span class="param-type"> String </span> </div> </div> </div> </div> </div> <div class="member"> <h4 class="name" id=".isHex"> <a class="href-link" href="#.isHex">#</a> <span class='tag'>static</span> <span class="code-name" id="isHex" style="font-size:30px"> isHex<span class="signature">(hex)</span> </span> </h4> <div class="description"> <p>判断是否是hex字符串</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>hex</code></td> <td class="type"> <span class="param-type"> String </span> </td> <td class="description last"><p>hex字符串</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>是否是hex字符串</p></div> <div class='column is-5 has-text-left'> <label>类型: </label> <span class="param-type"> Boolean </span> </div> </div> </div> </div> </div> <div class="member"> <h4 class="name" id=".isRGB"> <a class="href-link" href="#.isRGB">#</a> <span class='tag'>static</span> <span class="code-name" id="isRGB" style="font-size:30px"> isRGB<span class="signature">(rgb)</span> </span> </h4> <div class="description"> <p>判断是否是rgb字符串</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>rgb</code></td> <td class="type"> <span class="param-type"> String </span> </td> <td class="description last"><p>rgb字符串</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>是否是rgb字符串</p></div> <div class='column is-5 has-text-left'> <label>类型: </label> <span class="param-type"> Boolean </span> </div> </div> </div> </div> </div> <div class="member"> <h4 class="name" id=".rgbToHex"> <a class="href-link" href="#.rgbToHex">#</a> <span class='tag'>static</span> <span class="code-name" id="rgbToHex" style="font-size:30px"> rgbToHex<span class="signature">(rgb)</span> </span> </h4> <div class="description"> <p>将rgb字符串转成一个hex字符串</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>rgb</code></td> <td class="type"> <span class="param-type"> String </span> </td> <td class="description last"><p>rgb字符串</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>hex字符串</p></div> <div class='column is-5 has-text-left'> <label>类型: </label> <span class="param-type"> String </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>克隆字符串</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>颜色对象</p></div> <div class='column is-5 has-text-left'> <label>类型: </label> <span class="param-type"> <a link="Color.html" onclick="getTypeHTML(event)" href="Color.html">Color</a> </span> </div> </div> </div> </div> </div> <div class="member"> <h4 class="name" id="toCesiumRGB"> <a class="href-link" href="#toCesiumRGB">#</a> <span class="code-name" id="toCesiumRGB" style="font-size:30px"> toCesiumRGB<span class="signature">()</span> </span> </h4> <div class="description"> <p>转为cesium的rgba值</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>cesium的rgba值</p></div> <div class='column is-5 has-text-left'> <label>类型: </label> <span class="param-type"> Object </span> </div> </div> </div> </div> </div> <div class="member"> <h4 class="name" id="toCssRGBAString"> <a class="href-link" href="#toCssRGBAString">#</a> <span class="code-name" id="toCssRGBAString" style="font-size:30px"> toCssRGBAString<span class="signature">()</span> </span> </h4> <div class="description"> <p>转为rgba字符串</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>rgba字符串</p></div> <div class='column is-5 has-text-left'> <label>类型: </label> <span class="param-type"> String </span> </div> </div> </div> </div> </div> <div class="member"> <h4 class="name" id="toCssRGBString"> <a class="href-link" href="#toCssRGBString">#</a> <span class="code-name" id="toCssRGBString" style="font-size:30px"> toCssRGBString<span class="signature">()</span> </span> </h4> <div class="description"> <p>转为rgb字符串</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>rgb字符串</p></div> <div class='column is-5 has-text-left'> <label>类型: </label> <span class="param-type"> String </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对象</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>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>