Installation

Prerequisite Setup

It is recommended to install using a package management tool. Here is an example using pnpm:

npm

$ npm i cesium-use

pnpm

$ pnpm i cesium-use

Recommend reading useViewer chapter first to learn how to initialize Viewer.

Automatic Import

This is an optional step, but using automatic import significantly enhances the development experience. Therefore, it is strongly recommended to use automatic import. To install unplugin-auto-import, use the following command:

$ pnpm i -D unplugin-auto-import

For more information about unplugin-auto-import, please visit its GitHub repository.

Using unplugin-auto-import, here is an example with Vite:

import CesiumUseImports from 'cesium-use/imports'

import AutoImport from 'unplugin-auto-import/vite'
import { defineConfig } from 'vite'

export default defineConfig({
  plugins: [
    AutoImport({
      imports: [
        CesiumUseImports()
      ]
    })
  ]
})

The CesiumUseImports function accepts an optional object as a parameter, representing the name -> alias mapping. For example:

CesiumUseImports({
  defineColor: 'color'
})

// Before mapping

// Code after unplugin-auto-import processing
import { defineColor } from 'cesium-use'

// After mapping

// Code after unplugin-auto-import processing
import { defineColor as color } from 'cesium-use'

You can also use unplugin-vue-components to auto-import components:

import CesiumUseResolvers from 'cesium-use/resolvers'

import Components from 'unplugin-vue-components/vite'
import { defineConfig } from 'vite'

export default defineConfig({
  plugins: [
    Components({
      resolvers: [
        CesiumUseResolvers()
      ]
    })
  ]
})