Univer Boards API
Univer Boards 애플리케이션에서 Facade API를 사용하는 방법을 알아봅니다.
Facade API는 Univer 서비스 및 단위 모형에 신청 직면 층입니다. 그것은 널을 창조하고, 활동적인 페이지를 추가하고, 성분을 새롭게 하고, 콘테이너를 새롭게 하고, 수영을 관리하.
주 메뉴
보드 mutations는 동기이며 boolean 또는 무효 핸들 중 하나를 반환합니다. 결과 읽기 전에 반환 값을 확인하십시오.
Facade 진입점 활성화
보드는 Web SDK 플러그인으로 배포됩니다. 응용 프로그램 용도 :
import { FUniver } from '@univerjs/core/facade'import '@univerjs-pro/boards/facade'아래 레이아웃 검사와 스크린샷에는 UniverBoardsUIPlugin 등록과 다음 가져오기도 필요합니다.
import '@univerjs-pro/boards-ui/facade'Univer 인스턴스 이후 API 객체를 생성하고 필요한 플러그인이 등록되었습니다.
const univerAPI = FUniver.newAPI(univer)Board 만들기 및 읽기
createBoard는 정면을 통해서 널 단위를 창조합니다. 더 낮은 수준 설정 부호에서는, univer.createUnit(UniverInstanceType.UNIVER_BOARD, snapshot)를 가진 단위를 창조하십시오.
const board = univerAPI.createBoard({ id: 'board-demo', name: 'Board Demo',})const activeBoard = univerAPI.getActiveBoard()const sameBoard = univerAPI.getBoard(board.getId())핵심 기능 계속 보기
반환된 FBoard 개체는 활성 페이지와 그 내용에 항목 포인트입니다. 다음 가이드는 세부 사항에 개별 작업을 설명합니다.
- 요소에서는 Board 요소 읽기, 삽입, 연결, 변형, 배치 및 삭제를 설명합니다.
- 컨테이너 및 스윔레인에서는 프레임 그룹, 소속 관계 및 스윔레인 구조를 설명합니다.
보드 레이아웃 확인 및 스크린샷
브라우저에 보드가 표시된 후 아래 예제를 실행하세요.
레이아웃 문제 찾기
analyzeRenderedLayout()는 모양 안쪽에 적합하지 않는 교차 연결관 또는 원본과 같은 문제를 보고합니다. 외침은 문제만 보고하고 배치를 바꾸지 않았습니다. 각 문제점은 rule를, 이는 문제의 유형을 주고, focusBounds, 이는 검열할 지역을 줍니다.
const board = univerAPI.getActiveBoard()if (!board) throw new Error('No active board')const analysis = board.analyzeRenderedLayout()if (!analysis) throw new Error('The board is not ready for layout inspection')for (const { rule, focusBounds } of analysis.issues) { console.log(rule, focusBounds)}지정한 요소 캡처하기
보고서에서 하나의 순서로 단계의 이미지를 포함하려면, 그 단계의 요소 ID와 review-step를 대체합니다. resolveCaptureBounds()는 캡처 영역을 계산합니다. 이미지 소스로 사용할 수있는 PNG 데이터 URL을 얻기 위해 getScreenshot()에 해당 영역을 통과하십시오.
const board = univerAPI.getActiveBoard()if (!board) throw new Error('No active board')const target = board.resolveCaptureBounds({ elementIds: ['review-step'], padding: 16 })if (!target || !target.ok) throw new Error('Cannot locate the element to capture')const screenshot = await board.getScreenshot({ bounds: target.bounds })if (!screenshot) throw new Error('Cannot capture the selected area')console.log(screenshot.dataUrl)resolveCaptureBounds() · getScreenshot()
참고 자료
이 가이드는 어떠셨나요?