### Basic Usage
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-imagery-provider-ion.md
Use the `vc-layer-imagery` tag to add an imagery layer with IonImageryProvider to the viewer. This example demonstrates the fundamental setup for loading an Ion imagery asset.
```html
```
--------------------------------
### Install Project Dependencies
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/README.md
Run this command to install all necessary dependencies for the project.
```bash
pnpm i
```
--------------------------------
### Launch Local Development Server
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/guide/dev-guide.md
Execute this command to start the local development server for website preview.
```shell
pnpm docs:dev
```
--------------------------------
### Install ECharts
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-overlay-echarts.md
Install the ECharts library using npm. This is a prerequisite for using the VcOverlayEcharts component.
```bash
npm install echarts
```
--------------------------------
### Install heatmap.js
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-overlay-heatmap.md
Install the heatmap.js library using npm. This library is a dependency for the VcOverlayHeatmap component.
```bash
npm install heatmap.js
```
--------------------------------
### Basic Viewer Usage
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-viewer.md
This example demonstrates the basic usage of the vc-viewer component using the Vue Composition API. It sets up a 3D scene and shows how to integrate navigation and entity components.
```html
```
--------------------------------
### Install netcdfjs
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-overlay-windmap.md
Install the netcdfjs library, which is required for parsing NetCDF meteorological data files.
```bash
npm install netcdfjs
```
--------------------------------
### Basic Usage of VcGraphicsPolygon
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-graphics-polygon.md
This is a basic example demonstrating how to use the `vc-graphics-polygon` component. Ensure it is mounted as a subcomponent of `vc-entity` for proper loading.
```html
```
--------------------------------
### VcPrimitiveGroundPolyline Usage Example
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-primitive-ground-polyline.md
This is a basic example demonstrating how to use the `vc-primitive-ground-polyline` component. It requires `vc-geometry-ground-polyline` as its child content.
```vue
```
--------------------------------
### VcOverlayTyphoon Usage Example
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-overlay-typhoon.md
Demonstrates the basic usage of the VcOverlayTyphoon component. This snippet shows how to integrate the component into a Vue application for displaying typhoon data.
```html
```
--------------------------------
### Basic Usage of VcCollectionPrimitive
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-collection-primitive.md
Demonstrates the basic usage of the `vc-collection-primitive` component to add billboard and model primitives to the viewer. This is a fundamental example for integrating collections of primitives.
```vue
```
--------------------------------
### Generate and Preview Documentation
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/README.md
Execute these commands to generate the version information and launch the development server for previewing components.
```bash
pnpm gen:version
pnpm website-dev
```
--------------------------------
### Basic Usage of VcGraphicsPolylineVolume
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-graphics-polyline-volume.md
Demonstrates the basic usage of the VcGraphicsPolylineVolume component. Ensure it is mounted as a subcomponent of `vc-entity` for proper loading.
```html
```
--------------------------------
### Basic Usage of VcGraphicsWall
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-graphics-wall.md
Demonstrates the fundamental implementation of the VcGraphicsWall component. Ensure it is mounted as a subcomponent of `vc-entity` for proper loading.
```html
```
--------------------------------
### Install Vue Cesium with Package Managers
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/guide/installation.md
Install Vue Cesium using your preferred package manager. This is the recommended method for use with bundlers like Vite or webpack.
```shell
# NPM
$ npm install vue-cesium --save
```
```shell
# Yarn
$ yarn add vue-cesium
```
```shell
# pnpm
$ pnpm install vue-cesium
```
--------------------------------
### VcGeometryBox Usage
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-geometry-box.md
This is a basic usage example of the VcGeometryBox component. It must be used as a child component of vc-geometry-instance.
```html
```
--------------------------------
### Basic Usage of VcGeometryEllipsoid
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-geometry-ellipsoid.md
Demonstrates the fundamental implementation of the VcGeometryEllipsoid component. Ensure it is nested within a `vc-geometry-instance` component for proper loading.
```html
```
--------------------------------
### VcGeometryPolyline Basic Usage
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-geometry-polyline.md
This is a basic example demonstrating how to use the VcGeometryPolyline component. It requires being used as a child of vc-geometry-instance.
```html
```
--------------------------------
### Basic Usage of VcGraphicsPath
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-graphics-path.md
Demonstrates the basic integration of the VcGraphicsPath component. Ensure it is mounted as a subcomponent of `vc-entity` for proper loading.
```html
```
--------------------------------
### VcGeometryPlane Basic Usage
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-geometry-plane.md
This is a basic usage example of the VcGeometryPlane component. It demonstrates how to load a plane geometry within a vc-geometry-instance.
```html
```
--------------------------------
### Basic Usage of VcNavigation
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-navigation.md
Demonstrates the basic integration of the VcNavigation component. Ensure the vue-cesium CSS is imported for proper styling.
```html
```
--------------------------------
### VcGraphicsPoint Basic Usage
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-graphics-point.md
Demonstrates the basic usage of the VcGraphicsPoint component. Ensure it is mounted as a subcomponent of `vc-entity` for proper loading.
```html
```
--------------------------------
### Incorrect VcViewer Usage Example
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-viewer.md
Demonstrates incorrect placement of child components outside the VcViewer. All VueCesium components must be children of VcViewer.
```html
```
--------------------------------
### Basic Usage of VcGraphicsCylinder
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-graphics-cylinder.md
Demonstrates the basic implementation of the VcGraphicsCylinder component. Ensure it is mounted as a subcomponent of `vc-entity` for proper loading.
```html
```
--------------------------------
### VcPostProcessStageScan Basic Usage
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-post-process-stage-scan.md
Use the `vc-post-process-stage-scan` tag to add a post-processing scanning effect to the viewer. This example demonstrates the basic integration of the component.
```html
```
--------------------------------
### Basic Usage of VcEntity
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-entity.md
Demonstrates adding points, billboards, labels, and rectangle instances to the viewer using the vc-entity tag. It also shows how to respond to mouse events.
```html
```
--------------------------------
### Basic Usage of VcGraphicsBillboard
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-graphics-billboard.md
Demonstrates the basic integration of the VcGraphicsBillboard component within a `vc-entity`. Ensure it's mounted as a subcomponent of `vc-entity` for proper loading.
```html
```
--------------------------------
### Full Import for Vue Application
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/guide/quickstart.md
Use this for a convenient setup when bundle size is not a primary concern. It imports all necessary Vue Cesium modules and CSS.
```typescript
// main.ts
import { createApp } from 'vue'
import VueCesium from 'vue-cesium'
import App from './App.vue'
import 'vue-cesium/dist/index.css'
const app = createApp(App)
app.use(VueCesium)
app.mount('#app')
```
--------------------------------
### Basic Usage of VcLayerImagery
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-layer-imagery.md
Demonstrates how to add an OpenStreetMap tile layer to the viewer using the `vc-layer-imagery` component. Ensure this component is a child of `vc-viewer`.
```html
```
--------------------------------
### VcOverlayDynamic Basic Usage
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-overlay-dynamic.md
Demonstrates the basic integration of the VcOverlayDynamic component. This snippet is intended for initial setup and understanding of how to include the component in your Vue application.
```html
```
--------------------------------
### Basic Usage of VcGraphicsEllipsoid
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-graphics-ellipsoid.md
Demonstrates the basic implementation of the VcGraphicsEllipsoid component. Ensure it is nested within a vc-entity for proper loading.
```html
```
--------------------------------
### Commit Message Template Example
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/guide/commit-examples.md
A template illustrating the structure of a commit message, including subject, body, and bullet points. Emphasizes line length and capitalization.
```markdown
feat(components): [button] I did something with button
Blank between subject and body is expected.(period is expected)
Describes your change in one line or multi-line.
Capitalize your first letter when starting a new line
Please do not exceeds 72 characters per line, because that would be harder to comprehend.
- You can also add bullet list symbol for better layout
```
--------------------------------
### Basic Usage of VcGraphicsEllipse
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-graphics-ellipse.md
This snippet demonstrates the basic usage of the VcGraphicsEllipse component. Ensure it is mounted as a subcomponent of vc-entity for proper loading.
```html
```
--------------------------------
### On-demand Import with Viewer Component
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/guide/quickstart.md
Import Vue Cesium components on demand for better bundle size optimization. This example shows how to set up the VcViewer with a custom Cesium path.
```vue
```
--------------------------------
### Basic Usage of VcCollectionPoint
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-collection-point.md
Demonstrates the basic usage of the `vc-collection-point` and `vc-point` components to add a point primitive collection to the viewer.
```html
```
--------------------------------
### Basic VcAnalyses Usage
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-analyses.md
This example demonstrates the basic integration of the VcAnalyses component in a Vue Cesium application. Ensure the component is registered and used within a Cesium viewer context.
```html
```
--------------------------------
### Basic Usage of VcImageryProviderTianditu
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-imagery-provider-tianditu.md
Use the `vc-layer-imagery` tag to add the imagery layer with Tianditu WMTS imagery provider to the viewer.
```html
```
--------------------------------
### CDN Usage for Internationalization
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/guide/i18n.md
When using Vue Cesium via CDN, import the language script and then use `app.use` to apply the locale. This example uses unpkg and the Chinese language pack.
```html
```
--------------------------------
### Basic Usage of VcPostProcessStage
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-post-process-stage.md
Use the `vc-post-process-stage` tag to add a raining effect on the viewer. This demonstrates the fundamental application of the component.
```html
```
--------------------------------
### Configure VueCesium with dc-sdk
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-demo-dc-sdk.md
Import VueCesium and configure the `cesiumPath` option to point to the dc-sdk CDN. This setup is required for using dc-sdk functionalities within your Vue application. Ensure the `dcConfig` is also correctly set for dc-sdk resources.
```javascript
import { createApp } from 'vue'
import VueCesium from 'vue-cesium'
import App from './App.vue'
import 'vue-cesium/dist/index.css'
const app = createApp(App)
app.use(VueCesium, {
cesiumPath: 'https://cdn.jsdelivr.net/npm/@dvgis/dc-sdk/dist/dc.min.js',
dcConfig: {
baseUrl: 'https://cdn.jsdelivr.net/npm/@dvgis/dc-sdk/dist/resources/',
Cesium: 'https://unpkg.com/cesium@latest/Build/Cesium/Cesium.js'
}
})
app.mount('#app')
```
--------------------------------
### Basic Usage of VcCollectionCloud
Source: https://github.com/zouyaoji/vue-cesium/blob/dev/docs/en-US/component/vc-collection-cloud.md
Demonstrates the basic usage of the `vc-collection-cloud` and `vc-cumulus-cloud` tags to add a CloudCollection object to the viewer. This is the recommended way to add multiple cloud primitives.
```html
```