# Univer Boards API

> Узнайте, как использовать Facade API в приложении Univer Boards.

- Human documentation: [https://docs.univer.ai/ru-RU/guides/boards/features/core/boards-api](https://docs.univer.ai/ru-RU/guides/boards/features/core/boards-api)

- Agent Markdown: [https://docs.univer.ai/ru-RU/guides/boards/features/core/boards-api.md](https://docs.univer.ai/ru-RU/guides/boards/features/core/boards-api.md)

- Requested language: `ru-RU`

- Content language: `ru-RU`

- Documentation version: `1.2.0`

- Source: [boards/features/core/boards-api.ru-RU.mdx](https://github.com/dream-num/documentation/blob/dev/content/guides/boards/features/core/boards-api.ru-RU.mdx)

---

Facade API предоставляет прикладной уровень поверх сервисов и моделей модулей Univer. Используйте его для типичных операций с досками: создания досок, чтения активных страниц, добавления элементов, обновления контейнеров и управления дорожками.

> [!WARNING: Внимание]
> Изменения Board выполняются синхронно и возвращают `boolean` или nullable-объект. Проверяйте возвращаемое значение.

## Подключение точки входа Facade

Boards распространяется в виде плагинов Web SDK. Импортируйте точку входа Facade для возможностей Boards, которые использует ваше приложение:

```ts
import { FUniver } from '@univerjs/core/facade'
import '@univerjs-pro/boards/facade'
```

Создайте объект API после регистрации экземпляра Univer и необходимых плагинов:

```ts
const univerAPI = FUniver.newAPI(univer)
```

## Создание и чтение доски

Используйте `createBoard`, чтобы создать модуль доски через уровень Facade. В низкоуровневом коде конфигурации создавайте модуль с помощью `univer.createUnit(UniverInstanceType.UNIVER_BOARD, snapshot)`.

```ts
const board = univerAPI.createBoard({
  id: 'board-demo',
  name: 'Board Demo',
})

const activeBoard = univerAPI.getActiveBoard()
const sameBoard = univerAPI.getBoard(board.getId())
```

## Переход к основным возможностям

Возвращённый объект `FBoard` служит точкой входа к активной странице и её содержимому. Подробные операции описаны в отдельных руководствах:

* [Элементы](https://docs.univer.ai/ru-RU/guides/boards/features/core/elements.md) — чтение, вставка, соединение, преобразование, размещение и удаление элементов Board.
* [Контейнеры и дорожки](https://docs.univer.ai/ru-RU/guides/boards/features/core/containers.md) — группы с рамками, принадлежность элементов и структура дорожек.

## Справочные материалы

* [Общий API](https://docs.univer.ai/ru-RU/guides/boards/features/core/general-api.md)
* [Справочник по Facade Boards](https://docs.univer.ai/ru-RU/reference/facade/board.md)
* [Модель данных доски](https://docs.univer.ai/ru-RU/guides/boards/model/board-data.md)
* [Элементы доски](https://docs.univer.ai/ru-RU/guides/boards/model/board-elements.md)