useViewer

获取当前组件或其祖先组件通过 createViewer 注入的 Viewer 实例。

Usage

WARNING

若 useViewer 与 createViewer 同时在同一组件内使用：

• useViewer 需在 createViewer 之后调用。
• useViewer 会优先使用当前组件 createViewer 创建的实例。

同一组件注入并获取

createViewer(/** options */);

// 必须在 `createViewer` 之后
const viewer = useViewer();

注入后，子孙组件获取

// parent.vue
<script setup>
const elRef = ref<HTMLElement>();
const viewer = createViewer(elRef);
</script>

<template>
  <div ref="elRef" />
  <Child />
</template>

// child.vue
<script setup>
const viewer = useViewer();
</script>

Type Definitions

import type { Viewer } from 'cesium';
import type { ShallowRef } from 'vue';
/**
 * Obtain the `Viewer` instance injected through `createViewer` in the current component or its ancestor components.
 *
 * note:
 * - If `createViewer` and `useViewer` are called in the same component, the `Viewer` instance injected by `createViewer` will be used preferentially.
 * - When calling `createViewer` and `useViewer` in the same component, `createViewer` should be called before `useViewer`.
 */
export declare function useViewer(): Readonly<ShallowRef<Viewer | undefined>>;