0.41.0 docs (#672)

Author: deyihu

docs/api/threelayer.md

@@ -23,18 +23,23 @@ threeLayer.addTo(map);
 
 ```ts
 export type BaseLayerOptionType = {
-    renderer?: string;
-    doubleBuffer?: boolean;
+    minZoom?: number;
+	maxZoom?: number;
+	visible?: boolean;
+	opacity?: number;
+	zIndex?: number;
+    renderer?: 'gl',
+    doubleBuffer?: boolean,
     glOptions?: {
-        preserveDrawingBuffer: boolean;
-    };
-    geometryEvents?: boolean;
-    identifyCountOnEvent?: number;
-    forceRenderOnMoving?: boolean;
-    forceRenderOnRotating?: boolean;
-    forceRenderOnZooming?: boolean;
-    centerForDistance?: maptalks.Coordinate;
-    loopRenderCount?: number;
+        preserveDrawingBuffer: boolean
+    },
+    geometryEvents?: boolean,
+    identifyCountOnEvent?: number,
+    forceRenderOnMoving?: boolean,
+    forceRenderOnRotating?: boolean,
+    forceRenderOnZooming?: boolean,
+    centerForDistance?: maptalks.Coordinate,
+    loopRenderCount?: number
 };
 ```
 
@@ -97,12 +102,13 @@ const vector2 = threeLayer.altitudeToVector3(100, 100);
 
 ```ts
 export type ExtrudePolygonOptionType = BaseObjectOptionType & {
-    height?: number;
-    bottomHeight?: number;
-    topColor?: string;
-    bottomColor?: string;
-    key?: string;
-};
+    height?: number,
+    bottomHeight?: number,
+    topColor?: string,
+    bottomColor?: string,
+    key?: string,
+    top?: boolean
+}
 
 const extrudePolygon = threeLayer.toExtrudePolygon(
     new maptalks.Polygon(coordinates),
@@ -158,14 +164,14 @@ const line = threeLayer.toLine(
 
 ```ts
 export type ExtrudeLineOptionType = BaseObjectOptionType & {
-    bottomHeight?: number;
-    width?: number;
-    height?: number;
-    topColor?: string;
-    bottomColor?: string;
-    key?: string;
-};
-
+    bottomHeight?: number,
+    width?: number,
+    height?: number,
+    topColor?: string,
+    bottomColor?: string,
+    key?: string,
+    pathUV?: boolean
+}
 const line = threeLayer.toExtrudeLine(
     new maptalks.LineString(coordinates),
     {
@@ -207,12 +213,13 @@ const line = threeLayer.toExtrudeLine(
 
 ```ts
 export type ExtrudeLineTrailOptionType = BaseObjectOptionType & {
-    trail?: number;
-    chunkLength?: number;
-    width?: number;
-    height?: number;
-    speed?: number;
-};
+    trail?: number,
+    chunkLength?: number,
+    width?: number,
+    height?: number,
+    speed?: number,
+    pathUV?: boolean
+}
 
 const line = threeLayer.toExtrudeLineTrail(
     new maptalks.LineString(coordinates),
@@ -238,13 +245,13 @@ Considering performance issues, it is not recommended to use it
 
 ```ts
 export type ExtrudePolygonOptionType = BaseObjectOptionType & {
-    height?: number;
-    bottomHeight?: number;
-    topColor?: string;
-    bottomColor?: string;
-    key?: string;
-};
-
+    height?: number,
+    bottomHeight?: number,
+    topColor?: string,
+    bottomColor?: string,
+    key?: string,
+    top?: boolean
+}
 const polygon1=new maptalks.Polygon(coordinates);
 const polygon2=new maptalks.Polygon(coordinates);
 
@@ -337,7 +344,8 @@ export type ExtrudeLineOptionType = BaseObjectOptionType & {
     height?: number,
     topColor?: string,
     bottomColor?: string,
-    key?: string
+    key?: string,
+    pathUV?: boolean
 }
 
 const lineStrings=[

docs/api/types.md

@@ -60,7 +60,8 @@ export type ExtrudePolygonOptionType = BaseObjectOptionType & {
     bottomHeight?: number,
     topColor?: string,
     bottomColor?: string,
-    key?: string
+    key?: string,
+    top?: boolean
 }
 
 ```
@@ -75,7 +76,8 @@ export type ExtrudeLineOptionType = BaseObjectOptionType & {
     height?: number,
     topColor?: string,
     bottomColor?: string,
-    key?: string
+    key?: string,
+    pathUV?: boolean
 }
 ```
 
@@ -101,7 +103,8 @@ export type ExtrudeLineTrailOptionType = BaseObjectOptionType & {
     chunkLength?: number,
     width?: number,
     height?: number,
-    speed?: number
+    speed?: number,
+    pathUV?: boolean
 }
 ```
 

docs/dist/404.html

@@ -9,14 +9,14 @@
     <link rel="preload stylesheet" href="/maptalks.three/docs/dist/assets/style.Dj9aAfoc.css" as="style">
     <link rel="preload stylesheet" href="/maptalks.three/docs/dist/vp-icons.css" as="style">
 
-    <script type="module" src="/maptalks.three/docs/dist/assets/app.CSmQ_GHp.js"></script>
+    <script type="module" src="/maptalks.three/docs/dist/assets/app.BS7L0fYZ.js"></script>
     <link rel="preload" href="/maptalks.three/docs/dist/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
     <script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
     <script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
   </head>
   <body>
     <div id="app"></div>
-    <script>window.__VP_HASH_MAP__=JSON.parse("{\"api_baseobject.md\":\"ClRSHmS4\",\"api_index.md\":\"BYyICOA8\",\"api_threelayer.md\":\"DJ_MhOJR\",\"api_types.md\":\"B1Qhn4VE\",\"index.md\":\"Cvp-nnnj\",\"questions_index.md\":\"D42nop73\",\"start_custom.md\":\"DXusqSQm\",\"start_helloworld.md\":\"C4t00qqH\",\"start_install.md\":\"CvYUAdCv\",\"start_links.md\":\"BYlvTVrf\",\"start_target.md\":\"DmTeVfOC\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"🌐maptalks.three\",\"description\":\"A maptalks layer to render with three.js.\",\"base\":\"/maptalks.three/docs/dist/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"nav\":[{\"text\":\"Start\",\"link\":\"/start/install.md\",\"activeMatch\":\"/start/\"},{\"text\":\"API\",\"link\":\"/api/index.md\",\"activeMatch\":\"/api/\"},{\"text\":\"Questions\",\"link\":\"/questions/index.md\",\"activeMatch\":\"/questions/\"},{\"text\":\"Examples\",\"link\":\"https://maptalks.org/maptalks.three/demo/index.html\"}],\"sidebar\":{\"/start/\":[{\"text\":\"Install\",\"link\":\"/start/install.md\"},{\"text\":\"Hello World\",\"link\":\"/start/helloworld.md\"},{\"text\":\"Design Target\",\"link\":\"/start/target.md\"},{\"text\":\"Custom BaseObject\",\"link\":\"/start/custom.md\"},{\"text\":\"Some Links\",\"link\":\"/start/links.md\"}],\"/api/\":[{\"text\":\"Some Types\",\"link\":\"/api/types.md\"},{\"text\":\"BaseObject\",\"link\":\"/api/baseobject.md\"},{\"text\":\"ThreeLayer\",\"link\":\"/api/threelayer.md\"}]},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/maptalks/maptalks.three\"}],\"lastUpdated\":true,\"search\":{\"provider\":\"local\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
+    <script>window.__VP_HASH_MAP__=JSON.parse("{\"api_baseobject.md\":\"ClRSHmS4\",\"api_index.md\":\"BYyICOA8\",\"api_threelayer.md\":\"CLLoHpAM\",\"api_types.md\":\"BpJ3OtuL\",\"index.md\":\"Cvp-nnnj\",\"questions_index.md\":\"D42nop73\",\"start_custom.md\":\"DXusqSQm\",\"start_helloworld.md\":\"C4t00qqH\",\"start_install.md\":\"DJwzgDoQ\",\"start_links.md\":\"BYlvTVrf\",\"start_target.md\":\"DmTeVfOC\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"🌐maptalks.three\",\"description\":\"A maptalks layer to render with three.js.\",\"base\":\"/maptalks.three/docs/dist/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"nav\":[{\"text\":\"Start\",\"link\":\"/start/install.md\",\"activeMatch\":\"/start/\"},{\"text\":\"API\",\"link\":\"/api/index.md\",\"activeMatch\":\"/api/\"},{\"text\":\"Questions\",\"link\":\"/questions/index.md\",\"activeMatch\":\"/questions/\"},{\"text\":\"Examples\",\"link\":\"https://maptalks.org/maptalks.three/demo/index.html\"}],\"sidebar\":{\"/start/\":[{\"text\":\"Install\",\"link\":\"/start/install.md\"},{\"text\":\"Hello World\",\"link\":\"/start/helloworld.md\"},{\"text\":\"Design Target\",\"link\":\"/start/target.md\"},{\"text\":\"Custom BaseObject\",\"link\":\"/start/custom.md\"},{\"text\":\"Some Links\",\"link\":\"/start/links.md\"}],\"/api/\":[{\"text\":\"Some Types\",\"link\":\"/api/types.md\"},{\"text\":\"BaseObject\",\"link\":\"/api/baseobject.md\"},{\"text\":\"ThreeLayer\",\"link\":\"/api/threelayer.md\"}]},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/maptalks/maptalks.three\"}],\"lastUpdated\":true,\"search\":{\"provider\":\"local\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
 
   </body>
 </html>

docs/dist/api/baseobject.html

@@ -9,9 +9,9 @@
     <link rel="preload stylesheet" href="/maptalks.three/docs/dist/assets/style.Dj9aAfoc.css" as="style">
     <link rel="preload stylesheet" href="/maptalks.three/docs/dist/vp-icons.css" as="style">
 
-    <script type="module" src="/maptalks.three/docs/dist/assets/app.CSmQ_GHp.js"></script>
+    <script type="module" src="/maptalks.three/docs/dist/assets/app.BS7L0fYZ.js"></script>
     <link rel="preload" href="/maptalks.three/docs/dist/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
-    <link rel="modulepreload" href="/maptalks.three/docs/dist/assets/chunks/theme.BLaGH9F0.js">
+    <link rel="modulepreload" href="/maptalks.three/docs/dist/assets/chunks/theme.DSn-zCsg.js">
     <link rel="modulepreload" href="/maptalks.three/docs/dist/assets/chunks/framework.C7KVE_tj.js">
     <link rel="modulepreload" href="/maptalks.three/docs/dist/assets/api_baseobject.md.ClRSHmS4.lean.js">
     <script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
@@ -58,7 +58,7 @@
 <span class="line"></span>
 <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span>
 <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">bar.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">on</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;click mousemove&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, clickHandler);</span></span></code></pre></div><h3 id="add" tabindex="-1">add <a class="header-anchor" href="#add" aria-label="Permalink to &quot;add&quot;">​</a></h3><h3 id="remove-1" tabindex="-1">remove <a class="header-anchor" href="#remove-1" aria-label="Permalink to &quot;remove&quot;">​</a></h3><h3 id="click" tabindex="-1">click <a class="header-anchor" href="#click" aria-label="Permalink to &quot;click&quot;">​</a></h3><h3 id="mousemove" tabindex="-1">mousemove <a class="header-anchor" href="#mousemove" aria-label="Permalink to &quot;mousemove&quot;">​</a></h3><h3 id="mouseover" tabindex="-1">mouseover <a class="header-anchor" href="#mouseover" aria-label="Permalink to &quot;mouseover&quot;">​</a></h3><h3 id="mouseout" tabindex="-1">mouseout <a class="header-anchor" href="#mouseout" aria-label="Permalink to &quot;mouseout&quot;">​</a></h3><h3 id="dblclick" tabindex="-1">dblclick <a class="header-anchor" href="#dblclick" aria-label="Permalink to &quot;dblclick&quot;">​</a></h3><h3 id="empty" tabindex="-1">empty <a class="header-anchor" href="#empty" aria-label="Permalink to &quot;empty&quot;">​</a></h3><h3 id="idchange" tabindex="-1">idchange <a class="header-anchor" href="#idchange" aria-label="Permalink to &quot;idchange&quot;">​</a></h3><h3 id="propertieschange" tabindex="-1">propertieschange <a class="header-anchor" href="#propertieschange" aria-label="Permalink to &quot;propertieschange&quot;">​</a></h3><h3 id="show-1" tabindex="-1">show <a class="header-anchor" href="#show-1" aria-label="Permalink to &quot;show&quot;">​</a></h3><h3 id="hide-1" tabindex="-1">hide <a class="header-anchor" href="#hide-1" aria-label="Permalink to &quot;hide&quot;">​</a></h3><h3 id="symbolchange" tabindex="-1">symbolchange <a class="header-anchor" href="#symbolchange" aria-label="Permalink to &quot;symbolchange&quot;">​</a></h3><h3 id="workerload" tabindex="-1">workerload <a class="header-anchor" href="#workerload" aria-label="Permalink to &quot;workerload&quot;">​</a></h3><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>This event will only be triggered by constructing graphic data through workers</p></div></div></div></main><footer class="VPDocFooter" data-v-ca6a45ed data-v-cebe99ab><!--[--><!--]--><div class="edit-info" data-v-cebe99ab><!----><div class="last-updated" data-v-cebe99ab><p class="VPLastUpdated" data-v-cebe99ab data-v-1670a9c3>Last updated: <time datetime="2025-01-15T03:12:18.000Z" data-v-1670a9c3></time></p></div></div><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-cebe99ab><span class="visually-hidden" id="doc-footer-aria-label" data-v-cebe99ab>Pager</span><div class="pager" data-v-cebe99ab><a class="VPLink link pager-link prev" href="/maptalks.three/docs/dist/api/types.html" data-v-cebe99ab><!--[--><span class="desc" data-v-cebe99ab>Previous page</span><span class="title" data-v-cebe99ab>Some Types</span><!--]--></a></div><div class="pager" data-v-cebe99ab><a class="VPLink link pager-link next" href="/maptalks.three/docs/dist/api/threelayer.html" data-v-cebe99ab><!--[--><span class="desc" data-v-cebe99ab>Next page</span><span class="title" data-v-cebe99ab>ThreeLayer</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><!----><!--[--><!--]--></div></div>
-    <script>window.__VP_HASH_MAP__=JSON.parse("{\"api_baseobject.md\":\"ClRSHmS4\",\"api_index.md\":\"BYyICOA8\",\"api_threelayer.md\":\"DJ_MhOJR\",\"api_types.md\":\"B1Qhn4VE\",\"index.md\":\"Cvp-nnnj\",\"questions_index.md\":\"D42nop73\",\"start_custom.md\":\"DXusqSQm\",\"start_helloworld.md\":\"C4t00qqH\",\"start_install.md\":\"CvYUAdCv\",\"start_links.md\":\"BYlvTVrf\",\"start_target.md\":\"DmTeVfOC\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"🌐maptalks.three\",\"description\":\"A maptalks layer to render with three.js.\",\"base\":\"/maptalks.three/docs/dist/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"nav\":[{\"text\":\"Start\",\"link\":\"/start/install.md\",\"activeMatch\":\"/start/\"},{\"text\":\"API\",\"link\":\"/api/index.md\",\"activeMatch\":\"/api/\"},{\"text\":\"Questions\",\"link\":\"/questions/index.md\",\"activeMatch\":\"/questions/\"},{\"text\":\"Examples\",\"link\":\"https://maptalks.org/maptalks.three/demo/index.html\"}],\"sidebar\":{\"/start/\":[{\"text\":\"Install\",\"link\":\"/start/install.md\"},{\"text\":\"Hello World\",\"link\":\"/start/helloworld.md\"},{\"text\":\"Design Target\",\"link\":\"/start/target.md\"},{\"text\":\"Custom BaseObject\",\"link\":\"/start/custom.md\"},{\"text\":\"Some Links\",\"link\":\"/start/links.md\"}],\"/api/\":[{\"text\":\"Some Types\",\"link\":\"/api/types.md\"},{\"text\":\"BaseObject\",\"link\":\"/api/baseobject.md\"},{\"text\":\"ThreeLayer\",\"link\":\"/api/threelayer.md\"}]},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/maptalks/maptalks.three\"}],\"lastUpdated\":true,\"search\":{\"provider\":\"local\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
+    <script>window.__VP_HASH_MAP__=JSON.parse("{\"api_baseobject.md\":\"ClRSHmS4\",\"api_index.md\":\"BYyICOA8\",\"api_threelayer.md\":\"CLLoHpAM\",\"api_types.md\":\"BpJ3OtuL\",\"index.md\":\"Cvp-nnnj\",\"questions_index.md\":\"D42nop73\",\"start_custom.md\":\"DXusqSQm\",\"start_helloworld.md\":\"C4t00qqH\",\"start_install.md\":\"DJwzgDoQ\",\"start_links.md\":\"BYlvTVrf\",\"start_target.md\":\"DmTeVfOC\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"🌐maptalks.three\",\"description\":\"A maptalks layer to render with three.js.\",\"base\":\"/maptalks.three/docs/dist/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"nav\":[{\"text\":\"Start\",\"link\":\"/start/install.md\",\"activeMatch\":\"/start/\"},{\"text\":\"API\",\"link\":\"/api/index.md\",\"activeMatch\":\"/api/\"},{\"text\":\"Questions\",\"link\":\"/questions/index.md\",\"activeMatch\":\"/questions/\"},{\"text\":\"Examples\",\"link\":\"https://maptalks.org/maptalks.three/demo/index.html\"}],\"sidebar\":{\"/start/\":[{\"text\":\"Install\",\"link\":\"/start/install.md\"},{\"text\":\"Hello World\",\"link\":\"/start/helloworld.md\"},{\"text\":\"Design Target\",\"link\":\"/start/target.md\"},{\"text\":\"Custom BaseObject\",\"link\":\"/start/custom.md\"},{\"text\":\"Some Links\",\"link\":\"/start/links.md\"}],\"/api/\":[{\"text\":\"Some Types\",\"link\":\"/api/types.md\"},{\"text\":\"BaseObject\",\"link\":\"/api/baseobject.md\"},{\"text\":\"ThreeLayer\",\"link\":\"/api/threelayer.md\"}]},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/maptalks/maptalks.three\"}],\"lastUpdated\":true,\"search\":{\"provider\":\"local\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
 
   </body>
 </html>