ワークシートデータ構造

IWorksheetData

IWorksheetData は Univer Sheet におけるワークシートのスナップショットを表します。

プロパティ

プロパティタイプ説明
idstringワークシートの一意識別子。
namestringワークシートの名前。
tabColorstringワークシートタブの色。
hiddenBooleanNumberシートが非表示かどうか。デフォルト: BooleanNumber.FALSE。
freezeIFreezeフリーズペインの設定。
rowCountnumber行の総数。
columnCountnumber列の総数。
defaultColumnWidthnumber列のデフォルト幅、単位 px。
defaultRowHeightnumber行のデフォルト高さ、単位 px。
mergeDataIRange[]結合セル範囲の配列。
cellDataIObjectMatrixPrimitiveType<ICellData>セル内容のマトリックス。詳細情報。
rowDataIObjectArrayPrimitiveType<Partial<IRowData>>行データオブジェクトの配列。
columnDataIObjectArrayPrimitiveType<Partial<IColumnData>>列データオブジェクトの配列。
rowHeader{ width: number; hidden?: BooleanNumber; }行ヘッダーの設定。
columnHeader{ height: number; hidden?: BooleanNumber; }列ヘッダーの設定。
backgroundImage?IWorksheetBackgroundImage任意のタイル画像ソース:{ source: string; imageSourceType: ImageSourceType }。背景画像を参照。
showGridlinesBooleanNumberグリッド線が表示されるかどうか。
rightToLeftBooleanNumberワークシートが右から左モードかどうか。
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: 'JaJP',  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: '',    },  ],}

このガイドはいかがですか?

© 2026 DreamNum Co., Ltd.