일반 API
응용 프로그램에 사용할 수있는 Facade API는 현재 단위 유형과 등록 된 플러그인에 따라 다릅니다. 이 페이지는 Univer Bases 응용 프로그램 일반적으로 사용중인 API를 다룹니다.
가져오기
import { FUniver } from '@univerjs/core/facade'import '@univerjs-pro/bases/facade'import '@univerjs/ui/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)})실행에서 명령을 방지하려면 event.cancel ~ true 내부 BeforeCommandExecute 청취자.
const disposable = univerAPI.addEvent(univerAPI.Event.BeforeCommandExecute, (event) => { if (event.id === 'base.command.set-base-name') { event.cancel = true }})둘 다 청취자는 IDisposable를 돌려줍니다. 더 이상 필요로 할 때 반환된 목표의 처리.
beforeDisposable.dispose()afterDisposable.dispose()disposable.dispose()명령 실행
명령 ID와 그 매개 변수가 알려지면 FUniver.executeCommand는 명령을 직접 실행합니다. 다음 Bases 명령은 활성 Base를 이름을 변경합니다.
const base = univerAPI.getActiveBase()if (base) { await univerAPI.executeCommand('base.command.set-base-name', { unitId: base.getId(), name: '프로젝트 노트', })}이벤트 API
univerAPI.Event의 이벤트는 Univer 코어와 현재 응용 프로그램에 등록 된 플러그인에서 온다. 코어는 모든 제품 주식이 명령 및 단위 이벤트를 제공합니다; Bases 플러그인은 테이블, 필드, 기록, 조회 및 기타 기본 변경을위한 이벤트를 추가합니다. 이벤트를 사용하기 전에, 그것을 제공하는 플러그인이 등록되어 있는지 확인하십시오.
Facade 이벤트 참조는 현재 릴리스에서 사용할 수있는 이벤트 이름과 매개 변수 유형을 나열합니다.
addEvent와 함께 구독하면 반환된 객체를 삭제합니다.
const disposable = univerAPI.addEvent(univerAPI.Event.CommandExecuted, ({ id }) => { if (id === 'base.command.set-base-name') { console.log('Base 이름이 변경되었습니다') }})// 더 이상 필요하지 않은 리스너를 제거합니다disposable.dispose()실행 취소 및 다시 실행
await univerAPI.undo()await univerAPI.redo()시스템 클립보드
Bases UI 플러그인을 등록하면 copy와 paste는 현재 Base 선택 영역과 캐럿 위치에서 동작합니다.
await univerAPI.copy()await univerAPI.paste()복사 및 붙여넣기 사용 브라우저의 기본 클립 보드 API. 그들은 페이지가 초점이 없을 때 실패 할 수 있습니다, 호출이 사용자 행동에서 시작되지 않는 경우, 또는 클립 보드 권한이 사용할 수 없습니다. MDN 클립보드 문서를 참조하십시오.
UI
메뉴, 도구 모음 및베이스 인터페이스의 다른 영역을 확장하려면 Bases UI 구성 요소를 참조하십시오.
WebSocket
WebSocket API를 사용하려면 @univerjs/network를 설치하고 UniverNetworkPlugin을 등록하고 Facade 확장을 가져옵니다.
import { UniverNetworkPlugin } from '@univerjs/network'import '@univerjs/network/facade'univer.registerPlugin(UniverNetworkPlugin)이 응용 프로그램은 소켓 이벤트에 가입 할 수 있으며 메시지를 보내고 연결을 닫습니다.
const socket = univerAPI.createSocket('wss://example.com/bases')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
Facade는 univerAPI.Enum의 일반적인 enum 유형을 드러냅니다:
console.log(univerAPI.Enum.UniverInstanceType.UNIVER_BASE)console.log(univerAPI.Enum.BaseFieldType.Text)유틸리티 메서드 API
univerAPI.Util에 공유 유틸리티 방법은 다음과 같습니다.
console.log(univerAPI.Util.tools.isString('Univer Bases')) // true이 가이드는 어떠셨나요?