Структура данных документа
IDocumentData
IDocumentData — формат снимка, используемый в Univer Docs.
Он описывает целый документ, включая текст, стили уровня документа, колонтитулы, графические объекты, списки, таблицы и ресурсы плагинов.
Свойства
| Свойство | Тип | Описание |
|---|---|---|
| id | string | Уникальный идентификатор документа. |
| rev? | number | Ревизия документа, используемая при совместном редактировании. |
| locale? | LocaleType | Локаль документа. |
| title? | string | Заголовок документа. |
| body? | IDocumentBody | Основная часть с форматированным текстом. Подробнее |
| documentStyle | IDocumentStyle | Настройки страницы, макета, колонтитулов и стиля текста по умолчанию на уровне документа. |
| settings? | IDocumentSettings | Параметры среды выполнения, например zoomRatio. |
| resources? | IResources | Ресурсы плагинов. |
| disabled? | boolean | Отключён ли документ. |
| headers? | IHeaders | Содержимое верхних колонтитулов с их идентификаторами в качестве ключей. |
| footers? | IFooters | Содержимое нижних колонтитулов с их идентификаторами в качестве ключей. |
| lists? | ILists | Определения списков, используемые для маркеров абзацев. |
| drawings? | IDrawings | Графические объекты, например изображения. |
| drawingsOrder? | string[] | Порядок отрисовки графических объектов. |
| tableSource? | ITables | Определения таблиц, на которые ссылается основная часть документа. |
Пример
TypeScript
const documentData: IDocumentData = { id: 'doc-1', title: 'Demo Document', locale: LocaleType.EN_US, body: { dataStream: 'Hello Univer\r\n', textRuns: [ { st: 0, ed: 12, ts: { fs: 14 }, }, ], paragraphs: [ { startIndex: 12, paragraphId: 'paragraph-1', }, ], }, documentStyle: { pageSize: { width: 595, height: 842 }, marginTop: 72, marginBottom: 72, marginLeft: 72, marginRight: 72, },}Использование
IDocumentData главным образом используется для следующих задач:
- Создание документа Univer Docs
- Сохранение снимка Univer Docs
- Импорт и экспорт файлов
.docx - Хранение форматированного текста в ячейках Sheets через
ICellData.p
Снимок — это сохраняемая структура данных. Не изменяйте её напрямую после запуска документа. Для изменения содержимого документа используйте Facade API или команды.
Насколько полезно это руководство?