일반 API
PDF 애플리케이션에서 공통 명령, 이벤트, 기록, 클립보드, UI, WebSocket, 열거형 및 유틸리티를 사용합니다.
루트 Facade API는 PDF 응용 프로그램에 의해 등록 된 플러그인과 공유 Univer 런타임을 결합합니다. 이 페이지는 Univer 제품 전체에 동일한 방식으로 동작하는 메커니즘을 커버하고 다른 Univer 문서 유형과 함께 경험을 가정하지 않습니다. PDF 단위 및 페이지 항목 포인트를 들어, Univer PDF의 API를 계속하십시오.
API 객체 만들기
Univer 인스턴스와 필요한 플러그인을 등록한 후 단일 FUniver 래퍼를 만듭니다.
import { FUniver } from '@univerjs/core/facade'const univerAPI = FUniver.newAPI(univer)Facade 항목이 호출하기 전에 수입 된 동일한 객체에 메소드를 추가합니다.
명령
executeCommand()는 비동기적으로 등록 된 명령을 실행합니다. 명령이 비동기 실행을 명시적으로 지원할 때 syncExecuteCommand() 만 사용하십시오. 일반적인 PDF 작업의 경우 Facade 방법은 선호하는 입력 지점을 유지합니다.
이벤트
const commandLog = univerAPI.addEvent( univerAPI.Event.CommandExecuted, ({ id }) => console.log('Executed:', id))// 더 이상 필요하지 않으면 리스너를 제거합니다.commandLog.dispose()BeforeCommandExecute를 사용하여 응용 프로그램을 검사하거나 명령을 취소해야합니다. LifeCycleChanged는 Rendered 및 Steady와 같은 일반적인 편집기 단계를보고합니다.
실행 취소와 다시 실행
Undo와 redo는 현재 초점이 있는 Univer Unit에 적용하고, 둘 다 반환 약속을 약속합니다:
await univerAPI.undo()await univerAPI.redo()PDF Facade는 역동적 인 운영으로 변화합니다. PDF Unit의 역사를 입력합니다.
시스템 클립보드
UniverPdfsUIPlugin가 등록되고 PDF 편집이 활성화되면 copy()와 UI Facade의 paste() 메소드는 PDF 단위를 집중적으로 전달합니다.
import '@univerjs/ui/facade'await univerAPI.copy()await univerAPI.paste()편집 가능한 PDF 객체의 경우 PDF UI 플러그인은 현재 브라우저 세션에서 복사 된 페이로드를 유지하지만 운영 체제 클립 보드에 쓰기보다. 브라우저의 기본 텍스트 편집은 여전히 브라우저의 클립 보드 동작을 따릅니다.
UI
UI Facade는 메시지를 표시하고, 대화 상자와 사이드바를 열고, 구성 요소를 등록하고, 내장 UI 부품을 제어합니다.
univerAPI.setUIVisible(univerAPI.Enum.BuiltInUIPart.TOOLBAR, true)이 방법은 UniverUIPlugin를 요구하고, PDF 편집 제어는 또한 UniverPdfsUIPlugin가 필요합니다.
WebSocket
WebSocket은 선택 기능입니다. API 객체를 만들기 전에 Network 플러그인을 등록하고 Facade 진입점을 가져오세요.
import { UniverNetworkPlugin } from '@univerjs/network'import '@univerjs/network/facade'univer.registerPlugin(UniverNetworkPlugin)const socket = univerAPI.createSocket('wss://example.com/pdfs')socket.open$.subscribe(() => socket.send('ready'))메시지 프로토콜, 인증, 재연결 및 협업 충돌 처리는 호스트 애플리케이션의 책임에 남아 있습니다.
열거형
univerAPI.Enum는 실행 시간 enums 및 PDF Facade에 의해 추가된 enums를 노출합니다:
const lifecycle = univerAPI.Enum.LifecycleStages.Steadyconst annotationType = univerAPI.Enum.PdfAnnotationType.HIGHLIGHT유틸리티
univerAPI.Util은 숫자 서식, 사각형 연산 및 공통 도구 같은 공유 헬퍼를 제공합니다.
const payload = univerAPI.Util.tools.deepClone({ pageId: 'page-1', selectedElementIds: ['element-1'],})완전한 일반적인 API는 Facade 참고에서 문서화됩니다.
이 가이드는 어떠셨나요?