Facade API

복잡한 요구 사항을 충족하기 위해 Univer의 아키텍처 역시 상당히 복잡하게 구성되어 있어 사용에 어려움이 있을 수 있습니다. 이를 해결하기 위해 더 단순하고 사용하기 쉬운 Facade API를 제공합니다.

이 장에서는 애플리케이션에 Facade API를 추가하는 방법을 자세히 설명합니다. 이어지는 “기능” 장에서는 각 기능의 주요 Facade API를 소개합니다. 모든 Facade API를 확인하려면 각 플러그인의 API 레퍼런스를 참고하세요.

플러그인 모드에서 Facade API 통합하기

설치

플러그인 모드로 설치한 Univer에 Facade API를 통합할 때 Facade API 구현은 여러 플러그인에 나뉘어 배포되며 전역 Facade API 루트 객체에 마운트됩니다. 따라서 Facade API를 제공하는 플러그인의 해당 구현을 필요에 따라 가져올 수 있습니다.

import { FUniver } from '@univerjs/core/facade'import '@univerjs/ui/facade'import '@univerjs/docs/facade'import '@univerjs/docs-ui/facade'

사용법

import { FUniver } from '@univerjs/core/facade'const univerAPI = FUniver.newAPI(univer)

주의 사항

모든 Facade API를 즉시 호출할 수 있는 것은 아닙니다. 일부 API는 특정 생명 주기 단계에서 사용해야 합니다. 즉시 실행할 때 문제가 발생하면 다음 방법을 참고하여 적절한 생명 주기 단계에서 실행하세요.

const disposable = univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, ({ stage }) => {  if (stage === univerAPI.Enum.LifecycleStages.Rendered) {    // Code to be executed when the lifecycle stage is Rendered  }  if (stage === univerAPI.Enum.LifecycleStages.Steady) {    // Code to be executed when the lifecycle stage is Steady  }})

프리셋 모드에서 Facade API 통합하기

프리셋 모드로 Univer를 통합하면 포함된 기능의 Facade API를 자동으로 가져오며, Univer 인스턴스를 생성할 때 해당 Facade API 인스턴스인 univerAPI를 반환합니다. 이를 바로 사용할 수 있습니다.