Inicio rápido

Antes de instalar Univer Boards, conozca los cuatro conceptos que aparecen en toda su API y documentación. Explican cómo se compone, almacena, modifica y controla un Board.

Conceptos básicos

Plugins

Las funciones de Univer se distribuyen como plugins. @univerjs-pro/boards aporta el modelo, los comandos y UniverBoardsPlugin; @univerjs-pro/boards-ui aporta el lienzo, la interfaz de edición y UniverBoardsUIPlugin. Los paquetes de texto enriquecido, dibujo, tinta y edición de formas son dependencias técnicas de renderizado registradas durante la instalación; no es necesario conocer previamente otro producto de Univer. Los elementos de tabla y mapa mental son plugins opcionales de Board.

Registre solo los plugins que necesite su aplicación. La guía de instalación enumera la configuración completa para el navegador y sus dependencias.

Instantánea y modelo de datos

IBoardData es el formato de persistencia de una unidad Board. Guarda las páginas en pages y su orden en pageOrder; cada página guarda los elementos en elements y su orden de renderizado en elementOrder. Los recursos, los temas, la página activa, el zoom y la configuración de Board también forman parte de la instantánea.

Use una instantánea para crear, guardar o restaurar un Board. Una vez iniciada la unidad, no modifique directamente el objeto de instantánea. Consulte Estructura de datos de Board y Elementos de Board para conocer el esquema.

Comandos

Los cambios en tiempo de ejecución pasan por comandos. Insertar un elemento, cambiar su transformación, moverlo a un contenedor o cambiar el estado de una página mediante la capa de comandos o Facade mantiene coherentes el modelo, el lienzo, deshacer/rehacer y la colaboración.

Prefiera la API Facade en el código de la aplicación. Use identificadores de comandos directamente solo para integraciones de bajo nivel que Facade no exponga.

API Facade

La API Facade envuelve las capas de comandos y modelo de Board con FBoard y manejadores de elementos. Importe @univerjs-pro/boards/facade y, después de registrar los plugins, cree la API con FUniver.newAPI(univer). Así podrá crear o buscar un Board, leer su página activa y sus elementos, y administrar contenedores y carriles.

Continúe con Instalación y uso básico y luego use la guía de la API Facade de Boards para crear y editar contenido.