refactor: properties & events & clean up

Author: airslice

Diff for: .vscode/mdx.code-snippets

@@ -22,6 +22,41 @@
     ],
     "description": "Page meta",
   },
+  "API": {
+    "prefix": "api",
+    "body": [
+      "`${1:description}`",
+      "",
+      "## Properties`",
+      "",
+      "## Methods",
+      "",
+      "## Events",
+      "",
+      "## References",
+    ],
+  },
+  "Property": {
+    "prefix": "property",
+    "body": [
+      "### `${1:name}`",
+      "",
+      "`${2:description}`",
+      "",
+      "#### Syntax",
+      "",
+      "```ts",
+      "${3:code}",
+      "```",
+      "",
+      "#### Return Value",
+      "",
+      "**Type** `${4:type}`",
+      "",
+      "${5:description}",
+    ],
+    "description": "Property",
+  },
   "Method": {
     "prefix": "method",
     "body": [
@@ -39,6 +74,10 @@
       "",
       "#### Return Value",
       "",
+      "**Type** `${4:type}`",
+      "",
+      "${5:description}",
+      "",
       "#### Example",
       "",
     ],
@@ -60,4 +99,24 @@
     "body": ["**Type** `${1:type}`", "", "${2:description}"],
     "description": "Return value",
   },
+  "Event": {
+    "prefix": "event",
+    "body": [
+      "### `${1:name}`",
+      "",
+      "`${2:description}`",
+      "",
+      "#### Syntax",
+      "",
+      "```ts",
+      "${3:code}",
+      "```",
+      "",
+      "#### Parameters",
+      "",
+      "#### Example",
+      "",
+    ],
+    "description": "Event",
+  },
 }

Diff for: README.md

@@ -1,30 +1,51 @@
-# Starlight Starter Kit: Basics
+# Re:Earth Visualizer Developer Documentation
 
 [![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
 
+## Markdown Snippets
+
+We have provided a set of code snippets for Visual Studio Code to help you write markdown files faster. Please check this file for supported snippets.
+
+```planetext
+.vscode/mdx.code-snippets
 ```
-npm create astro@latest -- --template starlight
+
+## Manage Codes
+
+To avoid markdown files from becoming too long, we have provided a way to manage codes in separate files. Please put your code file to `src/content/code/` and manage with the same folder structure as the document.
+You can import the code text and use it like this:
+
+```mdx
+import Add3dModelCode from "@code/plugin-api/layers/add-3d-model?raw";
+import { clearNoCheck } from "@code/utils";
+
+<Code code={clearNoCheck(Add3dModelCode)} lang="ts" />
 ```
 
-[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
-[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
-[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/basics)
-[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs)
+## Mangae Assets
+
+Please manage the assets in subfolders of `src/assets` following the same structure as the document.
+Use `@assets` instead of relative paths to refer to the assets in markdown files.
 
-> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
+```markdown
+![Re:Earth Logo](@assets/ReearthLogoColorful.svg)
+```
 
-## 🚀 Project Structure
+## Project Structure
 
 Inside of your Astro + Starlight project, you'll see the following folders and files:
 
-```
+```planetext
 .
 ├── public/
 ├── src/
 │   ├── assets/
 │   ├── content/
+│   │   ├── code/
 │   │   ├── docs/
+│   │   ├── i18n/
 │   │   └── config.ts
+│   ├── styles/
 │   └── env.d.ts
 ├── astro.config.mjs
 ├── package.json
@@ -37,7 +58,7 @@ Images can be added to `src/assets/` and embedded in Markdown with a relative li
 
 Static assets, like favicons, can be placed in the `public/` directory.
 
-## 🧞 Commands
+## Commands
 
 All commands are run from the root of the project, from a terminal:
 
@@ -50,6 +71,6 @@ All commands are run from the root of the project, from a terminal:
 | `npm run astro ...`       | Run CLI commands like `astro add`, `astro check` |
 | `npm run astro -- --help` | Get help using the Astro CLI                     |
 
-## 👀 Want to learn more?
+## Want to learn more?
 
 Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).

Diff for: src/assets/README.md

@@ -0,0 +1 @@
+# Please manage the assets in subfolders following the same structure as the document.

Diff for: src/assets/houston.webp

@@ -0,0 +1,11 @@
+// @ts-nocheck
+
+type LazyLayer = Readonly<Layer> & {
+  computed?: Readonly<ComputedLayer>;
+  isTempLayer?: boolean;
+  pluginId?: string;
+  extensionId?: string;
+  property?: any;
+  propertyId?: string;
+  isVisible?: boolean;
+};

Diff for: src/content/code/plugin-api/layers/type-lazylayer.ts

@@ -9,6 +9,29 @@ import { Code } from "@astrojs/starlight/components";
 import { Tabs, TabItem } from "@astrojs/starlight/components";
 import { clearNoCheck } from "@code/utils";
 
+## Properties
+
+### layers
+
+This property provides a list of all layers currently exists in the **`reearth`** scene, allowing plugin developers to access and manipulate the layers as needed. The property returns an array of **`LazyLayer`** objects, each representing a distinct layer within the scene.
+
+#### Syntax
+
+```ts
+reearth.layers.layers: LazyLayer[];
+```
+
+#### Return Value
+
+**Type** `LazyLayer[]`
+
+An array of **`LazyLayer`** objects, each representing a distinct layer within the scene.
+
+:::note
+Please note that the **`LazyLayer`** object is a lightweight representation of a layer, you need to expcitly visit its property based on your needs.
+For more information on LazyLayer Types, please refer to [LazyLayer Type](#lazylayer-type) section.
+:::
+
 ## Methods
 
 ### add
@@ -97,20 +120,50 @@ import FindLayerCode from "@code/plugin-api/layers/find-layer?raw";
 
 ### select
 
-**TODO** Description of the event.
+Select event is triggered when a layer is selected within the **`reearth`** scene. The event provides information about the selected layer, including its unique identifier `id`, allowing plugin developers to respond to user interactions or changes in the scene.
+
+#### Syntax
+
+```ts
+reearth.layers.on("select", (layerId: string | undefined, featureId: string | undefined) => void): void;
+```
+
+#### Parameters
+
+##### `layerId`
+
+**Type**: `string | undefined`
+
+The unique identifier of the selected layer. If no layer is selected, the value is `undefined`.
+
+##### `featureId`
+
+**Type**: `string | undefined`
+
+The unique identifier of the selected feature within the layer. If no feature is selected, the value is `undefined`. Usually there will always be a feature selected when a layer is selected.
 
 ## References
 
 ### Layer Type
 
-**TODO** Description of the layer type.
+**TODO** Description of the Layer type.
 
 import TypeLayer from "@code/plugin-api/layers/type-layer?raw";
 
 <Code code={clearNoCheck(TypeLayer)} lang="ts" />
 
+### LazyLayer Type
+
+**TODO** Description of the LazyLayer type.
+
+import TypeLazyLayer from "@code/plugin-api/layers/type-lazylayer?raw";
+
+<Code code={clearNoCheck(TypeLazyLayer)} lang="ts" />
+
 ### Layer Appearance Types
 
+**TODO** Description of the Layer Appearance types.
+
 import TypeAppearanceMarker from "@code/plugin-api/layers/type-appearance-marker?raw";
 import TypeAppearancePolyline from "@code/plugin-api/layers/type-appearance-polyline?raw";
 import TypeAppearancePolygon from "@code/plugin-api/layers/type-appearance-polygon?raw";

Diff for: src/content/docs/plugin-api/layers.mdx

@@ -4,7 +4,8 @@
     "skipLibCheck": true,
     "baseUrl": "./",
     "paths": {
-      "@code/*": ["src/content/code/*"]
+      "@code/*": ["src/content/code/*"],
+      "@assets/*": ["src/assets/*"]
     }
   },
   "include": ["src"],