@mapgis/webclient-cesium-plugin 17.8.0 → 17.10.9

package/{documention → documentation}/FluidSpecular.html

@@ -83,7 +83,7 @@
     <div class="nameContainer">
         <h4 class="name" id="FluidSpecular">
             
-            new FluidSpecular<span class="signature">(options)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Object}</span>
+            new FluidSpecular<span class="signature">(<span class="optional">options</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Object}</span>
         </h4>
     
         
@@ -99,7 +99,7 @@
     
     
     <div class="description">
-        <p>流体高光对象</p>
+        <p>流体高光效果配置对象。</p>
     </div>
     
 
@@ -146,7 +146,14 @@
             
             <td class="description last">
                 
-                <p>实例化流体高光对象所需的参数</p>
+                    
+                        <span class="optional"> 可选</span>
+                    
+                    
+                        
+                    
+                
+                <p>创建流体高光效果配置对象的参数。</p>
                 
 
 <table class="params">
@@ -200,7 +207,7 @@
                         
                     
                 
-                <p>是否开启流体高光</p></td>
+                <p>是否开启流体高光。</p></td>
         </tr>
 	
 	
@@ -236,7 +243,7 @@
                         
                     
                 
-                <p>高光的明亮程度，取值在0到1之间，其中0为完全暗淡，1为完全高亮</p></td>
+                <p>高光亮度；取值范围为 <code>[0, 1]</code>。</p></td>
         </tr>
 	
 	
@@ -272,7 +279,7 @@
                         
                     
                 
-                <p>高光的大小，值越大则高光的范围越大，反之亦然</p></td>
+                <p>高光范围大小。</p></td>
         </tr>
 	
 	
@@ -308,7 +315,7 @@
                         
                     
                 
-                <p>高光的长度，在太阳和视角形成一定角度时，太阳会反射高光到流体之上，该参数控制反射高光的长度，值越大则反射高光越长，反之亦然</p></td>
+                <p>高光长度；用于控制太阳反射到流体表面的高光延展效果。</p></td>
         </tr>
 	
 	
@@ -379,7 +386,7 @@
                         
                     
             </td>
-            <td class="description last">返回根据参数实例化的流体高光对象</td>
+            <td class="description last">返回流体高光效果配置对象实例。</td>
         </tr>
     
     </tbody>
@@ -394,7 +401,19 @@
     
 
     
-    <pre class="prettyprint"><code>// ES5引入方式
  show: true,
  brightness: 0.5,
  size: 30,
  length: 50,
+    <pre class="prettyprint"><code>// ES5引入方式
+const { FluidSpecular } = zondy.cesium
+
+// ES6引入方式
+import { FluidSpecular } from "@mapgis/webclient-cesium-plugin"
+
+// 创建流体高光对象
+const fluidSpecular = new FluidSpecular({
+  show: true,
+  brightness: 0.5,
+  size: 30,
+  length: 50,
+})</code></pre>
     
 
     
@@ -428,7 +447,7 @@
 <dd>
     
     <div class="description">
-        <p>高光的亮度</p>
+        <p>获取或设置高光亮度。</p>
     </div>
     
     
@@ -473,7 +492,7 @@
 <dd>
     
     <div class="description">
-        <p>高光的长度</p>
+        <p>获取或设置高光长度。</p>
     </div>
     
     
@@ -518,7 +537,7 @@
 <dd>
     
     <div class="description">
-        <p>高光的显隐</p>
+        <p>获取或设置高光效果的显隐状态。</p>
     </div>
     
     
@@ -563,7 +582,7 @@
 <dd>
     
     <div class="description">
-        <p>高光的大小</p>
+        <p>获取或设置高光范围大小。</p>
     </div>
     
     
@@ -614,7 +633,7 @@
 
 
         <footer>
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> on Wed Feb 04 2026 18:31:34 GMT+0800 (中国标准时间)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> on Sat Sep 12 2026 11:55:59 GMT+0800 (中国标准时间)
         </footer>
     </div>
 </div>