@mapgis/webclient-common

<header id="page-title" class="page-title"> <span class="page-title-main">类名</span> <span class="page-title-sub">HeatmapRenderer</span> </header> <section> <article> <div class="container-overview"> <div class='vertical-section'> <div class="members"> <div class="member"> <h4 class="name" id="HeatmapRenderer"> <a class="href-link" href="#HeatmapRenderer">#</a> <span class="code-name" id="HeatmapRenderer" style="font-size:30px"> new HeatmapRenderer<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 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="type"><code>type</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last"></td> </tr> <tr class="deep-level-1"> <td class="name" id="colorStops"><code>colorStops</code></td> <td class="type"> <span class="param-type">Array.<<a link="Array.<HeatmapColorStop>.html" onclick="getTypeHTML(event)" href="HeatmapColorStop.html">HeatmapColorStop</a>></span> </td> <td class="description last"><p>描述渲染器色带的对象数组。像素的密度值与渲染器的 maxDensity 的比率映射到相应的颜色。例如 { color: [133, 193, 200, 0], ratio: 0 }</p></td> </tr> <tr class="deep-level-1"> <td class="name" id="radius"><code>radius</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>热力图数据点半径，单位像素。</p></td> </tr> <tr class="deep-level-1"> <td class="name" id="field"><code>field</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last"><p>要素字段名称，用于指定数据的热力值，优先级高于valueExpression.</p></td> </tr> <tr class="deep-level-1"> <td class="name" id="valueExpression"><code>valueExpression</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last"><p>字段表达式，用于指定数据的热力值，会覆盖field</p></td> </tr> <tr class="deep-level-1"> <td class="name" id="valueExpressionTitle"><code>valueExpressionTitle</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="maxDataValue"><code>maxDataValue</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>热力图最大数据范围，热力图内点的权重值大于此数，不进行渲染。</p></td> </tr> <tr class="deep-level-1"> <td class="name" id="minDataValue"><code>minDataValue</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>热力图最小数据范围，热力图内点的权重值小于此数，不进行渲染。</p></td> </tr> </tbody> </table> </div> <dl class="details"> </dl> </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="#colorStops">colorStops</a></code></td> <td class="name"> <code> <span class="param-type">Array.<<a link="Array.<HeatmapColorStop>.html" onclick="getTypeHTML(event)" href="HeatmapColorStop.html">HeatmapColorStop</a>></span> </code> </td> <td class="name"><code><p>描述渲染器色带的对象数组。像素的密度值与渲染器的 maxDensity 的比率映射到相应的颜色。例如 { color: [133, 193, 200, 0], ratio: 0 }</p></code></td> </tr> <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>要素字段名称，用于指定数据的热力值，优先级高于valueExpression.</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>热力图最大数据范围，热力图内点的权重值大于此数，不进行渲染。</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>热力图最小数据范围，热力图内点的权重值小于此数，不进行渲染。</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#radius">radius</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="#type">type</a></code></td> <td class="name"> <code> <span class="param-type">String</span> </code> </td> <td class="name"><code><p>渲染器类型，默认为'heatmap'</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">Array.<<a link="Array.<HeatmapColorStop>.html" onclick="getTypeHTML(event)" href="HeatmapColorStop.html">HeatmapColorStop</a>></span> </span> <h4 class="name" id="colorStops"> <a class="href-link" href="#colorStops">#</a> <span class="code-name"> colorStops </span> </h4> <div class="description"> <p>描述渲染器色带的对象数组。像素的密度值与渲染器的 maxDensity 的比率映射到相应的颜色。例如 { color: [133, 193, 200, 0], ratio: 0 }</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="field"> <a class="href-link" href="#field">#</a> <span class="code-name"> field </span> </h4> <div class="description"> <p>要素字段名称，用于指定数据的热力值，优先级高于valueExpression.</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="maxDataValue"> <a class="href-link" href="#maxDataValue">#</a> <span class="code-name"> maxDataValue </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>热力图最小数据范围，热力图内点的权重值小于此数，不进行渲染。</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="radius"> <a class="href-link" href="#radius">#</a> <span class="code-name"> radius </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="type"> <a class="href-link" href="#type">#</a> <span class="code-name"> type </span> </h4> <div class="description"> <p>渲染器类型，默认为'heatmap'</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="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="HeatmapRenderer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="HeatmapRenderer" HeatmapRenderer.html>HeatmapRenderer</a></span> </code> </td> <td class="name"><code><p>通过json构造HeatmapRenderer对象</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="HeatmapRenderer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="HeatmapRenderer" HeatmapRenderer.html>HeatmapRenderer</a></span> </code> </td> <td class="name"><code><p>克隆HeatmapRenderer对象</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构造HeatmapRenderer对象</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"> </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>HeatmapRenderer实例</p></div> <div class='column is-5 has-text-left'> <label>类型: </label> <span class="param-type"><a link="HeatmapRenderer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="HeatmapRenderer" HeatmapRenderer.html>HeatmapRenderer</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>克隆HeatmapRenderer对象</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>克隆后的HeatmapRenderer实例</p></div> <div class='column is-5 has-text-left'> <label>类型: </label> <span class="param-type"><a link="HeatmapRenderer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="HeatmapRenderer" HeatmapRenderer.html>HeatmapRenderer</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>