일반 API
Univer에서 사용할 수있는 Facade API는 현재 단위 유형과 등록 된 플러그인에 따라 다릅니다. 이 페이지는 Univer 보드 응용 프로그램에 사용되는 일반적인 API를 포함합니다.
가져오기
import { FUniver } from '@univerjs/core/facade'import '@univerjs-pro/boards/facade'const univerAPI = FUniver.newAPI(univer)명령
Univer의 대부분의 작업은 명령 시스템에 등록되어 있습니다. 이 단일 실행 경로는 undo, redo 및 협업을 지원합니다.
디자인 합리적 인 경우 Univer 명령 시스템를 참조하십시오.
명령 수신
Event.BeforeCommandExecute는 명령이 실행되기 전에 화재와 Event.CommandExecuted 화재가 완료됩니다.
const beforeDisposable = univerAPI.addEvent(univerAPI.Event.BeforeCommandExecute, ({ id, params }) => { console.log('명령 실행 전:', id, params)})const afterDisposable = univerAPI.addEvent(univerAPI.Event.CommandExecuted, ({ id, params }) => { console.log('명령 실행 후:', id, params)})BeforeCommandExecute 청취자는 event.cancel를 true로 설정하여 실행하여 명령을 방지할 수 있습니다.
const disposable = univerAPI.addEvent(univerAPI.Event.BeforeCommandExecute, (event) => { if (event.id === 'board.command.set-name') { event.cancel = true }})각 청취자는 IDisposable를 반환합니다. 청취자가 더 이상 필요하지 않을 때 그것을 처리하십시오.
beforeDisposable.dispose()afterDisposable.dispose()disposable.dispose()명령 실행
명령 ID와 매개 변수가 알려지면 FUniver.executeCommand 명령을 실행합니다. 다음 보드 명령은 활성 보드를 이름을 변경합니다.
const board = univerAPI.getActiveBoard()if (board) { await univerAPI.executeCommand('board.command.set-name', { unitId: board.getId(), name: '프로젝트 노트', })}이벤트 API
univerAPI.Event는 Univer 코어에서 이벤트 이름을 나열하고 현재 응용 프로그램에 등록 된 플러그인에서 나열합니다. 코어는 공유 명령 및 단위 이벤트를 공급하고 플러그인은 자신의 추가 할 수 있습니다. 이벤트를 사용하기 전에 이벤트를 제공하는 플러그인이 등록되어 있는지 확인하십시오.
Facade 이벤트 참조는 현재 릴리스의 이벤트 이름과 매개 변수 유형을 나열합니다.
addEvent로 구독하고, 반환된 객체를 삭제합니다.
const disposable = univerAPI.addEvent(univerAPI.Event.CommandExecuted, ({ id }) => { if (id === 'board.command.set-name') { console.log('Board 이름이 변경되었습니다') }})// 더 이상 필요하지 않은 리스너를 제거합니다disposable.dispose()실행 취소 및 다시 실행
await univerAPI.undo()await univerAPI.redo()UI
메뉴, 도구 모음 및 기타 보드 인터페이스 영역을 확장하려면 보드 UI 구성 요소를 참조하십시오.
WebSocket
WebSocket API를 사용하려면 @univerjs/network를 설치하고 UniverNetworkPlugin을 등록한 다음 Facade 확장을 가져오세요.
import { UniverNetworkPlugin } from '@univerjs/network'import '@univerjs/network/facade'univer.registerPlugin(UniverNetworkPlugin)등록 후, 소켓은 소켓 이벤트에 subscribing을 지원하며 메시지를 보내고 연결을 닫습니다.
const socket = univerAPI.createSocket('wss://example.com/boards')socket.open$.subscribe(() => socket.send('hello'))socket.message$.subscribe((message) => console.log('WebSocket 메시지:', message.data))socket.error$.subscribe((error) => console.error('WebSocket 오류:', error))socket.close()열거형 API
일반적인 enum 유형은 univerAPI.Enum에 드러납니다:
console.log(univerAPI.Enum.UniverInstanceType.UNIVER_BOARD)console.log(univerAPI.Enum.BoardElementType.Shape)유틸리티 메서드 API
공유 유틸리티는 univerAPI.Util에 노출됩니다.
console.log(univerAPI.Util.tools.isString('Univer Boards')) // true이 가이드는 어떠셨나요?