行と列

Facade API

完全な Facade API の型定義は Facade API を参照してください。

行（Row）

指定位置の直後に行を挿入

insertRowAfter(afterPosition)：指定した行位置の直後に 1 行挿入します。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 先頭行（位置 0）の直後に 1 行挿入sheet.insertRowAfter(0)

指定位置の直前に行を挿入

insertRowBefore(beforePosition)：指定した行位置の直前に 1 行挿入します。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 先頭行（位置 0）の直前に 1 行挿入sheet.insertRowBefore(0)

指定位置から複数行を挿入

insertRows(rowIndex, numRows)：指定開始位置から連続する空白行を 1 行以上挿入します。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 先頭から 3 行分下方にシフトsheet.insertRows(0, 3)

指定行の直後に複数行を挿入

insertRowsAfter(afterPosition, howMany)：指定した行位置の直後に複数行を挿入します。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 先頭行の直後に 5 行挿入sheet.insertRowsAfter(0, 5)

指定行の直前に複数行を挿入

insertRowsBefore(beforePosition, howMany)：指定した行位置の直前に複数行を挿入します。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 先頭行の直前に 5 行挿入sheet.insertRowsBefore(0, 5)

指定位置の行を削除

deleteRow(rowPosition)：指定した位置の 1 行を削除します。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 行は 0 から始まる - 先頭行を削除sheet.deleteRow(0)

指定位置から複数行を削除

deleteRows(rowPosition, howMany)：指定した開始位置から複数行を削除します。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 先頭 2 行を削除sheet.deleteRows(0, 2)

複数行（不連続）を削除

deleteRowsByPoints(rowPoints): 指定された行位置の配列に基づいて、複数の行（不連続）を削除します。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 行は 0 から始まる - これにより、3 行目と 5～7 行目が削除されますfWorksheet.deleteRowsByPoints([2, [4, 6]])

行を新しい位置へ移動

moveRows(rowSpec, destinationIndex)：指定範囲に含まれるすべての行を destinationIndex の位置へ移動します。rowSpec は行全体を完全に指定している必要はなく、その範囲が跨る行すべてが対象となります。

TypeScript

// 下記コードは行 1-2 (表示上 2-3 行目) を宛先インデックス 5 に移動// 結果としてそれらは行 3-4 となるconst sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 移動対象として行 1 および行 2 を選択const rowSpec = sheet.getRange('1:2')sheet.moveRows(rowSpec, 5)

範囲内の行を非表示

hideRow(row)：指定範囲内の行を非表示にします。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 先頭行を非表示const range = sheet.getRange('1:1')sheet.hideRow(range)

連続する複数行を非表示

hideRows(rowIndex, numRows)：指定インデックスから 0 起算で連続する複数行を非表示にします。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 先頭 3 行を非表示sheet.hideRows(0, 3)

範囲内の行を再表示

unhideRow(row)：指定範囲の行を再表示します。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 非表示だった先頭行を再表示const range = sheet.getRange('1:1')sheet.unhideRow(range)

連続する複数行を再表示

showRows(rowIndex, numRows)：指定インデックスから 0 起算で連続する複数行を再表示します。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 先頭 3 行を再表示sheet.showRows(0, 3)

行の高さを設定

setRowHeight(rowPosition, height)：指定行の高さ（ピクセル）を設定します。既定ではセル内容に応じて自動伸長します。固定したい場合は setRowHeightsForced(startRow, numRows, height) を使用してください。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 先頭行の高さを 200px に設定sheet.setRowHeight(0, 200)

複数行の高さを設定

setRowHeights(startRow, numRows, height)：指定範囲の複数行の高さを設定します。自動伸長は維持されます。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 先頭 3 行を 200px に設定sheet.setRowHeights(0, 3, 200)

複数行の高さを強制固定

setRowHeightsForced(startRow, numRows, height): セル内容より小さくても指定高さに強制固定します。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 先頭 3 行を 5px に強制固定sheet.setRowHeightsForced(0, 3, 5)

行の自動高さ調整

autoResizeRows(startRow, numRows): テキスト内容に合わせて自動で高さを調整します。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 先頭 3 行を内容に合わせて自動調整sheet.autoResizeRows(0, 3)

行のカスタムプロパティ設定

setRowCustom(custom)：指定行に JSON 互換の任意データを格納する custom プロパティを設定します。更新時は既存の custom を上書きするため、保持したい場合は取得後マージしてください。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 1 行目と 3 行目にカスタム属性を設定sheet.setRowCustom({  0: { color: 'red' },  2: { size: 16 },})

列（Column）

指定位置の直後に列を挿入

insertColumnAfter(afterPosition)：指定した列位置の直後に 1 列挿入します。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 先頭列（位置 0）の直後に 1 列挿入sheet.insertColumnAfter(0)

指定位置の直前に列を挿入

insertColumnBefore(beforePosition)：指定した列位置の直前に 1 列挿入します。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 先頭列（位置 0）の直前に 1 列挿入sheet.insertColumnBefore(0)

指定位置から複数列を挿入

insertColumns(columnIndex, numColumns)：指定開始位置から連続する空白列を挿入します。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 先頭から 3 列分右へシフトsheet.insertColumns(0, 3)

指定列の直後に複数列を挿入

insertColumnsAfter(afterPosition, howMany)：指定した列位置の直後に複数列を挿入します。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 先頭列の直後に 2 列挿入sheet.insertColumnsAfter(0, 2)

指定列の直前に複数列を挿入

insertColumnsBefore(beforePosition, howMany)：指定した列位置の直前に複数列を挿入します。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 先頭列の直前に 5 列挿入sheet.insertColumnsBefore(0, 5)

指定位置の列を削除

deleteColumn(columnPosition)：指定位置の列を削除します。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 列は 0 起算 - 先頭列を削除sheet.deleteColumn(0)

指定位置から複数列を削除

deleteColumns(columnPosition, howMany)：指定開始位置から複数列を削除します。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 先頭 2 列を削除sheet.deleteColumns(0, 2)

複数列（不連続）を削除

deleteColumnsByPoints(columnPoints): 指定された列位置の配列に基づいて、複数の列（不連続）を削除します。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 列は 0 起算 - これにより、列 C と列 E〜G が削除されますfWorksheet.deleteColumnsByPoints([2, [4, 6]])

列を新しい位置へ移動

moveColumns(columnSpec, destinationIndex)：指定範囲が跨るすべての列を destinationIndex へ移動します。columnSpec が列全体を完全指定している必要はありません。

TypeScript

// 下記コードは列 A-B を宛先インデックス 5 へ移動// 結果としてそれらは列 C-D となるconst sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 移動対象として列 A と列 B を選択const columnSpec = sheet.getRange('A:B')sheet.moveColumns(columnSpec, 5)

範囲内の列を非表示

hideColumn(column)：指定範囲の列を非表示にします。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 先頭列を非表示const range = sheet.getRange('A:A')sheet.hideColumn(range)

連続する複数列を非表示

hideColumns(columnIndex, numColumns)：指定インデックスから 0 起算で連続する複数列を非表示にします。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 先頭 3 列を非表示sheet.hideColumns(0, 3)

範囲内の列を再表示

unhideColumn(column)：指定範囲の列を再表示します。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 非表示だった先頭列を再表示const range = sheet.getRange('A:A')sheet.unhideColumn(range)

連続する複数列を再表示

showColumns(columnIndex, numColumns)：指定インデックスから 0 起算で連続する複数列を再表示します。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 先頭 3 列を再表示sheet.showColumns(0, 3)

列幅を設定

setColumnWidth(columnPosition, width)：指定列の幅（ピクセル）を設定します。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 先頭列の幅を 200px に設定sheet.setColumnWidth(0, 200)

複数列の幅を設定

setColumnWidths(startColumn, numColumns, width)：指定範囲の複数列の幅（ピクセル）を設定します。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 先頭 3 列の幅を 200px に設定sheet.setColumnWidths(0, 3, 200)

列幅を自動調整

autoResizeColumns(startColumn, numColumns)：指定範囲列の内容に最適な幅へ自動調整します。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 列 A〜C を内容に合わせて自動調整sheet.autoResizeColumns(0, 3)

列のカスタムプロパティ設定

setColumnCustom(custom)：指定列に JSON 互換データを格納する custom プロパティを設定します。更新は既存 custom を上書きするため、保持が必要な場合は取得後マージしてください。

TypeScript

const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// 1 列目と 3 列目にカスタム属性を設定sheet.setColumnCustom({  0: { color: 'red' },  2: { size: 16 },})

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