Структура данных рабочего листа
IWorksheetData
IWorksheetData представляет снимок рабочего листа в Univer Sheet.
Свойства
| Свойство | Тип | Описание |
|---|---|---|
| id | string | Уникальный идентификатор рабочего листа. |
| name | string | Имя рабочего листа. |
| tabColor | string | Цвет вкладки рабочего листа. |
| hidden | BooleanNumber | Указывает, скрыт ли лист. Значение по умолчанию: BooleanNumber.FALSE. |
| freeze | IFreeze | Настройки закрепления областей. |
| rowCount | number | Общее количество строк. |
| columnCount | number | Общее количество столбцов. |
| defaultColumnWidth | number | Ширина столбцов по умолчанию в px. |
| defaultRowHeight | number | Высота строк по умолчанию в px. |
| mergeData | IRange[] | Массив диапазонов объединённых ячеек. |
| cellData | IObjectMatrixPrimitiveType<ICellData> | Матрица содержимого ячеек. Подробнее. |
| rowData | IObjectArrayPrimitiveType<Partial<IRowData>> | Массив объектов с данными строк. |
| columnData | IObjectArrayPrimitiveType<Partial<IColumnData>> | Массив объектов с данными столбцов. |
| rowHeader | { width: number; hidden?: BooleanNumber; } | Настройки заголовков строк. |
| columnHeader | { height: number; hidden?: BooleanNumber; } | Настройки заголовков столбцов. |
| backgroundImage? | IWorksheetBackgroundImage | Необязательный источник: { source: string; imageSourceType: ImageSourceType }. См. фоновые изображения. |
| showGridlines | BooleanNumber | Указывает, отображаются ли линии сетки. |
| rightToLeft | BooleanNumber | Указывает, используется ли на рабочем листе направление справа налево. |
| defaultStyle? | Nullable<IStyleData> | Стиль рабочего листа по умолчанию |
Пример
TypeScript
const worksheetData: IWorksheetData = { id: 'sheet1', name: 'Sheet 1', tabColor: '#FF0000', hidden: BooleanNumber.FALSE, freeze: { xSplit: 1, ySplit: 1, startRow: 1, startColumn: 1 }, rowCount: 1000, columnCount: 26, defaultColumnWidth: 100, defaultRowHeight: 25, mergeData: [], cellData: { 0: { 0: { v: 123, }, }, }, rowData: [], columnData: [], rowHeader: { width: 40 }, columnHeader: { height: 20 }, showGridlines: BooleanNumber.TRUE, rightToLeft: BooleanNumber.FALSE,}Эта структура полностью описывает данные рабочего листа, включая компоновку, содержимое и настройки отображения.
Полный пример
TypeScript
const workbook: IWorkbookData = { id: 'gyI0JO', sheetOrder: [ 'RSfWjJFv4opmE1JaiRj80', ], name: '', appVersion: '0.10.2', locale: 'enUS', styles: {}, sheets: { RSfWjJFv4opmE1JaiRj80: { id: 'RSfWjJFv4opmE1JaiRj80', name: 'Test', tabColor: '', hidden: 0, rowCount: 30, columnCount: 10, zoomRatio: 1, freeze: { startRow: -1, startColumn: -1, ySplit: 0, xSplit: 0, }, scrollTop: 0, scrollLeft: 0, defaultColumnWidth: 73, defaultRowHeight: 23, mergeData: [], cellData: {}, rowData: {}, columnData: { 0: { w: 125, hd: 0, }, 1: { w: 125, hd: 0, }, 2: { w: 125, hd: 0, }, 3: { w: 125, hd: 0, }, 4: { w: 125, hd: 0, }, 5: { w: 125, hd: 0, }, 6: { w: 125, hd: 0, }, 7: { w: 125, hd: 0, }, 8: { w: 125, hd: 0, }, 9: { w: 125, hd: 0, }, }, showGridlines: 1, rowHeader: { width: 46, hidden: 0, }, columnHeader: { height: 20, hidden: 0, }, rightToLeft: 0, }, }, resources: [ { name: 'SHEET_DEFINED_NAME_PLUGIN', data: '', }, ],}Насколько полезно это руководство?