Excel.Range class

範囲は、セル、行、列、セルのブロックなど、1つまたは複数の隣接するセルのセットを表します。API 全体で範囲を使用する方法の詳細については、「 Excel JAVASCRIPT api を使用して範囲を操作する」および「 excel javascript api を使用して範囲を操作する (詳細) 」を参照してください。Range represents a set of one or more contiguous cells such as a cell, a row, a column, block of cells, etc. To learn more about how ranges are used throughout the API, read Work with ranges using the Excel JavaScript API and Work with ranges using the Excel JavaScript API (advanced).

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

Extends

プロパティ

address

A1 スタイルの範囲参照を表します。Represents the range reference in A1-style. Address 値にはシート参照が含まれます (例: "Sheet1!A1: B4 ")Address value will contain the Sheet reference (e.g. "Sheet1!A1:B4"). 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

addressLocal

ユーザーの言語で指定された範囲の範囲参照を表します。Represents range reference for the specified range in the language of the user. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

cellCount

範囲に含まれるセルの数。Number of cells in the range. セルの数が 2^31-1 (2,147,483,647) を超えると、この API は -1 を返します。This API will return -1 if the cell count exceeds 2^31-1 (2,147,483,647). 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

columnCount

範囲に含まれる列の合計数を表します。Represents the total number of columns in the range. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

columnHidden

現在の範囲のすべての列が非表示になっているかどうかを表します。Represents if all columns of the current range are hidden.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

columnIndex

範囲に含まれる最初のセルの列番号を表します。Represents the column number of the first cell in the range. 0 を起点とする番号になります。Zero-indexed. 読み取り専用。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

conditionalFormats

範囲に交差する ConditionalFormats のコレクションです。Collection of ConditionalFormats that intersect the range. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

dataValidation

dataValidation オブジェクトを返します。Returns a data validation object.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

format

Format オブジェクト (範囲のフォント、塗りつぶし、罫線、配置などのプロパティをカプセル化するオブジェクト) を返します。Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

formulas

A1 スタイル表記の数式を表します。Represents the formula in A1-style notation. 範囲に数式を設定する場合、引数 value には単一の値 (文字列) または2次元配列のいずれかを指定できます。When setting formulas to a range, the value argument can be either a single value (a string) or a two-dimensional array. 引数に1つの値を指定すると、範囲内のすべてのセルに適用されます。If the argument is a single value, it will be applied to all cells in the range.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

formulasLocal

ユーザーの言語と数値書式ロケールで、A1 スタイル表記の数式を表します。Represents the formula in A1-style notation, in the user's language and number-formatting locale. たとえば、英語の数式 "=SUM(A1, 1.5)" は、ドイツ語では "=SUMME(A1; 1,5)" になります。For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. 範囲に数式を設定する場合、引数 value には単一の値 (文字列) または2次元配列のいずれかを指定できます。When setting formulas to a range, the value argument can be either a single value (a string) or a two-dimensional array. 引数に1つの値を指定すると、範囲内のすべてのセルに適用されます。If the argument is a single value, it will be applied to all cells in the range.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

formulasR1C1

R1C1 スタイル表記の数式を表します。Represents the formula in R1C1-style notation. 範囲に数式を設定する場合、引数 value には単一の値 (文字列) または2次元配列のいずれかを指定できます。When setting formulas to a range, the value argument can be either a single value (a string) or a two-dimensional array. 引数に1つの値を指定すると、範囲内のすべてのセルに適用されます。If the argument is a single value, it will be applied to all cells in the range.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

hasSpill

すべてのセルにスピル ボーダーがあるかどうかを表します。Represents if all cells have a spill border. すべてのセルにスピル枠がある場合は true を返し、すべてのセルにスピル境界線がない場合は false を返します。Returns true if all cells have a spill border, or false if all cells do not have a spill border. 範囲内の罫線を左右に左右しないセルがある場合は、null を返します。Returns null if there are cells both with and without spill borders within the range.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

height

100% ズームの場合の、範囲の上端から範囲の下端までの距離を、ポイント単位で返します。 Returns the distance in points, for 100% zoom, from top edge of the range to bottom edge of the range. 読み取り専用です。Read-only.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

hidden

現在の範囲のすべてのセルが非表示になっているかどうかを表します。Represents if all cells of the current range are hidden. 読み取り専用。Read-only.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

hyperlink

現在の範囲のハイパーリンクを表します。Represents the hyperlink for the current range.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

isEntireColumn

現在の範囲が列全体であるかどうかを表します。Represents if the current range is an entire column. 読み取り専用です。Read-only.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

isEntireRow

現在の範囲が行全体であるかどうかを表します。Represents if the current range is an entire row. 読み取り専用です。Read-only.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

left

100% ズームの場合の、ワークシートの左端から範囲の左端までの距離を、ポイント単位で返します。 Returns the distance in points, for 100% zoom, from left edge of the worksheet to left edge of the range. 読み取り専用です。Read-only.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

linkedDataTypeState

各セルのデータ型の状態を表します。Represents the data type state of each cell. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

numberFormat

指定された範囲の Excel の数値書式コードを表します。Represents Excel's number format code for the given range. 数値の表示形式を範囲に設定する場合、引数 value には単一の値 (文字列) または2次元配列を指定できます。When setting number format to a range, the value argument can be either a single value (string) or a two-dimensional array. 引数に1つの値を指定すると、範囲内のすべてのセルに適用されます。If the argument is a single value, it will be applied to all cells in the range.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

numberFormatLocal

ユーザーの言語で文字列として指定された範囲に対応する、Excel の数値形式コードを表します。Represents Excel's number format code for the given range as a string in the language of the user. 数値の表示形式を範囲に設定する場合、引数 value には単一の値 (文字列) または2次元配列のいずれかを指定できます。When setting number format local to a range, the value argument can be either a single value (string) or a two-dimensional array. 引数に1つの値を指定すると、範囲内のすべてのセルに適用されます。If the argument is a single value, it will be applied to all cells in the range.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

rowCount

範囲に含まれる行の合計数を返します。Returns the total number of rows in the range. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

rowHidden

現在の範囲のすべての行が非表示になっているかどうかを表します。Represents if all rows of the current range are hidden.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

rowIndex

範囲に含まれる最初のセルの行番号を返します。Returns the row number of the first cell in the range. 0 を起点とする番号になります。Zero-indexed. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

savedAsArray

すべてのセルが配列数式として保存されるかどうかを表します。Represents if ALL the cells would be saved as an array formula. すべてのセルが配列として保存される場合は true を返し、すべてのセルが配列数式として保存されない場合は false を返します。Returns true if ALL cells would be saved as an array, or false if ALL cells would NOT be saved as an array formula. 配列数式として保存されないセルが混在している場合は、null を返します。Returns null if there is a mixture of cells that would and would not be saved as an array formula.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

sort

現在の範囲について、範囲の並べ替えを表します。Represents the range sort of the current range. 読み取り専用です。Read-only.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

style

現在の範囲のスタイルを表します。Represents the style of the current range. セルのスタイルに不整合がある場合は、null が返されます。If the styles of the cells are inconsistent, null will be returned. ユーザー設定のスタイルの場合は、スタイル名が返されます。For custom styles, the style name will be returned. 組み込みのスタイルの場合、BuiltInStyle 列挙内の値を表す文字列が返されます。For built-in styles, a string representing a value in the BuiltInStyle enum will be returned.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

text

指定した範囲のテキスト値。Text values of the specified range. テキスト値は、セルの幅には依存しません。The Text value will not depend on the cell width. Excel # UI で行われた符号置換は、API によって返されるテキスト値には影響しません。The # sign substitution that happens in Excel UI will not affect the text value returned by the API. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

top

100% ズームの場合の、ワークシートの上端から範囲の上端までの距離を、ポイント単位で返します。 Returns the distance in points, for 100% zoom, from top edge of the worksheet to top edge of the range. 読み取り専用です。Read-only.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

values

指定した範囲の Raw 値を表します。Represents the raw values of the specified range. 返されるデータの型は、文字列、数値、ブール値のいずれかになります。The data returned could be of type string, number, or a boolean. エラーが含まれているセルは、エラー文字列を返します。Cells that contain an error will return the error string. 範囲に値を設定する場合、引数 value には単一の値 (文字列、数値、またはブール値)、または2次元配列を指定できます。When setting values to a range, the value argument can be either a single value (string, number or boolean) or a two-dimensional array. 引数に1つの値を指定すると、範囲内のすべてのセルに適用されます。If the argument is a single value, it will be applied to all cells in the range.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

valueTypes

各セルのデータの種類を表します。Represents the type of data of each cell. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

width

100% ズームの場合の、範囲の左端から範囲の右端までの距離を、ポイント単位で返します。 Returns the distance in points, for 100% zoom, from left edge of the range to right edge of the range. 読み取り専用です。Read-only.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

worksheet

現在の範囲を含んでいるワークシート。The worksheet containing the current range. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

メソッド

autoFill(destinationRange, autoFillType)

現在の範囲から対象の範囲までの範囲に値を設定します。Fills range from the current range to the destination range. 移動先の範囲は、ソースを水平方向または垂直方向に拡張する必要があります。The destination range must extend the source either horizontally or vertically. 連続していない範囲はサポートされていません。Discontiguous ranges are not supported.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

autoFill(destinationRange, autoFillTypeString)

現在の範囲から対象の範囲までの範囲に値を設定します。Fills range from the current range to the destination range. 移動先の範囲は、ソースを水平方向または垂直方向に拡張する必要があります。The destination range must extend the source either horizontally or vertically. 連続していない範囲はサポートされていません。Discontiguous ranges are not supported.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

calculate()

ワークシート上のセルの範囲を計算します。Calculates a range of cells on a worksheet.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

clear(applyTo)

範囲の値、書式、塗りつぶし、罫線などをクリアします。Clear range values, format, fill, border, etc.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

clear(applyToString)

範囲の値、書式、塗りつぶし、罫線などをクリアします。Clear range values, format, fill, border, etc.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

convertDataTypeToText()

データ型を含む範囲セルをテキストに変換します。Converts the range cells with datatypes into text.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

convertToLinkedDataType(serviceID, languageCulture)

ワークシート内で範囲セルをリンク付きデータ型に変換します。Converts the range cells into linked datatype in the worksheet.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

copyFrom(sourceRange, copyType, skipBlanks, transpose)

ソース範囲または RangeAreas から現在の範囲にセル データまたは書式設定をコピーします。Copies cell data or formatting from the source range or RangeAreas to the current range. コピー先の範囲は、元の範囲または RangeAreas のサイズと異なる場合があります。The destination range can be of different size than the source range or RangeAreas. 転送先は、ソースよりも小さい場合は自動的に展開されます。The destination will be expanded automatically if it is smaller than the source.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

copyFrom(sourceRange, copyTypeString, skipBlanks, transpose)

ソース範囲または RangeAreas から現在の範囲にセル データまたは書式設定をコピーします。Copies cell data or formatting from the source range or RangeAreas to the current range. コピー先の範囲は、元の範囲または RangeAreas のサイズと異なる場合があります。The destination range can be of different size than the source range or RangeAreas. 転送先は、ソースよりも小さい場合は自動的に展開されます。The destination will be expanded automatically if it is smaller than the source.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

delete(shift)

範囲に関連付けられているセルを削除します。Deletes the cells associated with the range.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

delete(shiftString)

範囲に関連付けられているセルを削除します。Deletes the cells associated with the range.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

find(text, criteria)

指定された条件に基づいて指定された文字列を見つけます。Finds the given string based on the criteria specified. 現在の範囲が1つのセルより大きい場合は、検索はその範囲に制限されます。それ以外の場合は、シート全体がそのセルの後に表示されます。If the current range is larger than a single cell, then the search will be limited to that range, else the search will cover the entire sheet starting after that cell.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

findOrNullObject(text, criteria)

指定された条件に基づいて指定された文字列を見つけます。Finds the given string based on the criteria specified. 現在の範囲が1つのセルより大きい場合は、検索はその範囲に制限されます。それ以外の場合は、シート全体がそのセルの後に表示されます。If the current range is larger than a single cell, then the search will be limited to that range, else the search will cover the entire sheet starting after that cell. 一致しない場合、この関数は null オブジェクトを返します。If there are no matches, this function will return a null object.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

flashFill()

現在の範囲に対してフラッシュ フィルを実行します。フラッシュ フィルでは、パターンを感知して自動的にデータが設定されるので、範囲は単一列範囲で、かつパターンを検出できるように周囲にデータが存在する必要があります。Does FlashFill to current range.Flash Fill will automatically fills data when it senses a pattern, so the range must be single column range and have data around in order to find pattern.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getAbsoluteResizedRange(numRows, numColumns)

現在の Range オブジェクトと左上のセルが同じで、指定した数の行と列を含む Range オブジェクトを取得します。Gets a Range object with the same top-left cell as the current Range object, but with the specified numbers of rows and columns.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

getBoundingRect(anotherRange)

指定した範囲を包含する、最小の Range オブジェクトを取得します。Gets the smallest range object that encompasses the given ranges. たとえば、"B2:C5" と "D10:E15" の GetBoundingRect は、"B2:E15" になります。For example, the GetBoundingRect of "B2:C5" and "D10:E15" is "B2:E15".

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

getCell(row, column)

行と列の番号に基づいて、1 つのセルを含んだ範囲オブジェクトを取得します。Gets the range object containing the single cell based on row and column numbers. ワークシートのグリッド内に収まるセルは、親の範囲の境界の外側にある場合があります。The cell can be outside the bounds of its parent range, so long as it stays within the worksheet grid. 返されるセルは、範囲の左上のセルを基準に配置されます。The returned cell is located relative to the top left cell of the range.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

getCellProperties(cellPropertiesLoadOptions)

2D 配列を返します。各セルのフォント、塗りつぶし、罫線、配置などのプロパティ データをカプセル化します。Returns a 2D array, encapsulating the data for each cell's font, fill, borders, alignment, and other properties.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getColumn(column)

範囲に含まれる列を 1 つ取得します。Gets a column contained in the range.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

getColumnProperties(columnPropertiesLoadOptions)

一次元配列を返します。各列のフォント、塗りつぶし、罫線、配置などのプロパティ データをカプセル化します。Returns a single-dimensional array, encapsulating the data for each column's font, fill, borders, alignment, and other properties. 指定された列内の列間で一貫性のないプロパティについては、null が返されます。For properties that are not consistent across each cell within a given column, null will be returned.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getColumnsAfter(count)

現在の Range オブジェクトの右にある特定の列数を取得します。Gets a certain number of columns to the right of the current Range object.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

getColumnsBefore(count)

現在の Range オブジェクトの左にある特定の列数を取得します。Gets a certain number of columns to the left of the current Range object.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

getEntireColumn()

範囲の列全体を表すオブジェクトを取得します (たとえば、現在の範囲がセル "B4: E11" を表しているgetEntireColumn場合は、"B: E" という列を表す範囲)。Gets an object that represents the entire column of the range (for example, if the current range represents cells "B4:E11", its getEntireColumn is a range that represents columns "B:E").

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

getEntireRow()

範囲の行全体を表すオブジェクトを取得します (たとえば、現在の範囲がセル "B4: E11" を表しているGetEntireRow場合は、行 "4:11" を表す範囲になります)。Gets an object that represents the entire row of the range (for example, if the current range represents cells "B4:E11", its GetEntireRow is a range that represents rows "4:11").

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

getImage()

範囲を base64 でエンコードされた png 画像としてレンダリングします。Renders the range as a base64-encoded png image.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

getIntersection(anotherRange)

指定した範囲の長方形の交差を表す範囲オブジェクトを取得します。Gets the range object that represents the rectangular intersection of the given ranges.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

getIntersectionOrNullObject(anotherRange)

指定した範囲の長方形の交差を表す範囲オブジェクトを取得します。Gets the range object that represents the rectangular intersection of the given ranges. 交差部分が見つからない場合は、null オブジェクトを返します。If no intersection is found, will return a null object.

[API セット: excelapi 1.4][ API set: ExcelApi 1.4 ]

getLastCell()

範囲内の最後のセルを取得します。Gets the last cell within the range. たとえば、"B2:D5" の最後のセルは "D5" になります。For example, the last cell of "B2:D5" is "D5".

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

getLastColumn()

範囲内の最後の列を取得します。Gets the last column within the range. たとえば、"B2:D5" の最後の列は "D2:D5" になります。For example, the last column of "B2:D5" is "D2:D5".

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

getLastRow()

範囲内の最後の行を取得します。Gets the last row within the range. たとえば、"B2:D5" の最後の行は "B5:D5" になります。For example, the last row of "B2:D5" is "B5:D5".

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

getOffsetRange(rowOffset, columnOffset)

指定した範囲からのオフセットで範囲を表すオブジェクトを取得します。返される範囲のディメンションは、この範囲と一致します。結果の範囲がワークシートのグリッドの境界線の外にはみ出る場合は、エラーがスローされます。Gets an object which represents a range that's offset from the specified range. The dimension of the returned range will match this range. If the resulting range is forced outside the bounds of the worksheet grid, an error will be thrown.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

getResizedRange(deltaRows, deltaColumns)

現在の Range オブジェクトに似た (ただし、右下隅がいくつかの行と列で拡張 (または縮小) されている) Range オブジェクトを取得します。Gets a Range object similar to the current Range object, but with its bottom-right corner expanded (or contracted) by some number of rows and columns.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

getRow(row)

範囲に含まれている行を 1 つ取得します。Gets a row contained in the range.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

getRowProperties(rowPropertiesLoadOptions)

一次元配列を返します。各行のフォント、塗りつぶし、罫線、配置などのプロパティ データをカプセル化します。Returns a single-dimensional array, encapsulating the data for each row's font, fill, borders, alignment, and other properties. 指定された行内の列間で一貫性のないプロパティについては、null が返されます。For properties that are not consistent across each cell within a given row, null will be returned.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getRowsAbove(count)

現在の Range オブジェクトの上にある特定の行数を取得します。Gets a certain number of rows above the current Range object.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

getRowsBelow(count)

現在の Range オブジェクトの下にある特定の行数を取得します。Gets a certain number of rows below the current Range object.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

getSpecialCells(cellType, cellValueType)

指定された型と値に一致するすべてのセルを表し、1 つまたは複数の長方形範囲で構成される RangeAreas オブジェクトを取得します。Gets the RangeAreas object, comprising one or more rectangular ranges, that represents all the cells that match the specified type and value. 特別なセルが見つからない場合は、ItemNotFound エラーがスローされます。If no special cells are found, an ItemNotFound error will be thrown.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getSpecialCells(cellTypeString, cellValueType)

指定された型と値に一致するすべてのセルを表し、1 つまたは複数の長方形範囲で構成される RangeAreas オブジェクトを取得します。Gets the RangeAreas object, comprising one or more rectangular ranges, that represents all the cells that match the specified type and value. 特別なセルが見つからない場合は、ItemNotFound エラーがスローされます。If no special cells are found, an ItemNotFound error will be thrown.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getSpecialCellsOrNullObject(cellType, cellValueType)

指定された型と値に一致するすべてのセルを表し、1 つまたは複数の範囲を構成する RangeAreas オブジェクトを取得します。Gets the RangeAreas object, comprising one or more ranges, that represents all the cells that match the specified type and value. 特別なセルが見つからない場合は、null オブジェクトが返されます。If no special cells are found, a null object will be returned.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getSpecialCellsOrNullObject(cellTypeString, cellValueType)

指定された型と値に一致するすべてのセルを表し、1 つまたは複数の範囲を構成する RangeAreas オブジェクトを取得します。Gets the RangeAreas object, comprising one or more ranges, that represents all the cells that match the specified type and value. 特別なセルが見つからない場合は、null オブジェクトが返されます。If no special cells are found, a null object will be returned.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getSpillingToRange()

アンカー セルで呼び出されたとき、スピル範囲を含む範囲オブジェクトを取得します。Gets the range object containing the spill range when called on an anchor cell. 複数のセルを含む範囲に適用される場合は失敗します。Fails if applied to a range with more than one cell. 読み取り専用です。Read-only.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

getSpillingToRangeOrNullObject()

アンカー セルで呼び出されたとき、スピル範囲を含む範囲オブジェクトを取得します。Gets the range object containing the spill range when called on an anchor cell. 読み取り専用です。Read-only. 指定範囲がアンカーセルでない場合、またはスピル範囲が見つからない場合は、null オブジェクトが返されます。If the range is not an anchor cell or spill range can't be found, a null object will be returned.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

getSpillParent()

スピルするセルのアンカー セルを含む範囲オブジェクトを取得します。Gets the range object containing the anchor cell for a cell getting spilled into. 複数のセルを含む範囲に適用される場合は失敗します。Fails if applied to a range with more than one cell. 読み取り専用です。Read-only.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

getSpillParentOrNullObject()

スピルするセルのアンカー セルを含む範囲オブジェクトを取得します。Gets the range object containing the anchor cell for a cell getting spilled into. 読み取り専用です。Read-only. スピルセルが指定されていない場合、または複数のセルが指定されている場合は、null オブジェクトが返されます。If it is not a spill cell or more than once cells are give, a null object will be returned.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

getSurroundingRegion()

指定された範囲の左上のセルを囲む領域を表す Range オブジェクトを返します。Returns a Range object that represents the surrounding region for the top-left cell in this range. 周囲の領域は、この範囲に相対の空白の行と空白の列の任意の組み合わせで囲まれた範囲です。A surrounding region is a range bounded by any combination of blank rows and blank columns relative to this range.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

getTables(fullyContained)

範囲と重なるテーブルの集まりを範囲限定で取得します。Gets a scoped collection of tables that overlap with the range.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getUsedRange(valuesOnly)

指定した範囲オブジェクトのうち使用されている範囲を返します。範囲内に使用済みのセルがない場合、この関数は ItemNotFound エラーをスローします。Returns the used range of the given range object. If there are no used cells within the range, this function will throw an ItemNotFound error.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

getUsedRangeOrNullObject(valuesOnly)

指定した範囲オブジェクトのうち使用されている範囲を返します。範囲内に使用済みのセルがない場合、この関数は null オブジェクトを返します。Returns the used range of the given range object. If there are no used cells within the range, this function will return a null object.

[API セット: excelapi 1.4][ API set: ExcelApi 1.4 ]

getVisibleView()

現在の範囲の表示されている行を表します。Represents the visible rows of the current range.

[API セット: excelapi 1.3][ API set: ExcelApi 1.3 ]

insert(shift)

この範囲を占めるセルまたはセルの範囲をワークシートに挿入し、領域を空けるために他のセルをシフトします。この時点で空き領域に位置する、新しい Range オブジェクトが返されます。Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. Returns a new Range object at the now blank space.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

insert(shiftString)

この範囲を占めるセルまたはセルの範囲をワークシートに挿入し、領域を空けるために他のセルをシフトします。この時点で空き領域に位置する、新しい Range オブジェクトが返されます。Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. Returns a new Range object at the now blank space.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

merge(across)

範囲内のセルをワークシートの 1 つの領域に結合します。Merge the range cells into one region in the worksheet.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

removeDuplicates(columns, includesHeader)

列によって指定される範囲から重複する値を削除します。Removes duplicate values from the range specified by the columns.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

replaceAll(text, replacement, criteria)

現在の範囲内で、指定された条件に基づき、指定された文字列を検索し、置換します。Finds and replaces the given string based on the criteria specified within the current range.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

select()

Excel UI で指定した範囲を選択します。Selects the specified range in the Excel UI.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

setCellProperties(cellPropertiesData)

セル プロパティの 2D 配列に基づいて範囲を更新します。フォント、塗りつぶし、罫線、配置などをカプセル化します。Updates the range based on a 2D array of cell properties , encapsulating things like font, fill, borders, alignment, and so forth.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

setColumnProperties(columnPropertiesData)

列プロパティの一次元配列に基づいて範囲を更新します。フォント、塗りつぶし、罫線、配置などをカプセル化します。Updates the range based on a single-dimensional array of column properties, encapsulating things like font, fill, borders, alignment, and so forth.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

setDirty()

次の再計算が発生したときに再計算する範囲を設定します。Set a range to be recalculated when the next recalculation occurs.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

setRowProperties(rowPropertiesData)

行プロパティの一次元配列に基づいて範囲を更新します。フォント、塗りつぶし、罫線、配置などをカプセル化します。Updates the range based on a single-dimensional array of row properties, encapsulating things like font, fill, borders, alignment, and so forth.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

showCard()

アクティブ セルに多数の値が含まれる場合、そのセルのカードを表示します。Displays the card for an active cell if it has rich value content.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の Excel Range オブジェクトは API オブジェクトであるのに対しtoJSON 、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.RangeData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.Range object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.RangeData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

track()

ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。Track the object for automatic adjustment based on surrounding changes in the document. これは context.trackedObjects.add(thisObject) 呼び出しの省略形です。This call is a shorthand for context.trackedObjects.add(thisObject). ".sync" 呼び出し間で、かつ ".run" バッチの連続実行の外でこのオブジェクトを使用しているとき、オブジェクトであるプロパティを設定したか、あるメソッドを呼び出したときに "InvalidObjectPath" エラーが表示される場合、オブジェクトを最初に作成したときに、追跡対象オブジェクトの集まりにそのオブジェクトを追加しておく必要がありました。If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.

unmerge()

範囲内のセルを結合解除して別々のセルにします。Unmerge the range cells into separate cells.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

untrack()

前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。Release the memory associated with this object, if it has previously been tracked. これは context.trackedObjects.remove(thisObject) 呼び出しの省略形です。This call is shorthand for context.trackedObjects.remove(thisObject). 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. メモリ リリースを有効にするには、"context.sync()" を先に呼び出す必要があります。You will need to call "context.sync()" before the memory release takes effect.

プロパティの詳細

address

A1 スタイルの範囲参照を表します。Represents the range reference in A1-style. Address 値にはシート参照が含まれます (例: "Sheet1!A1: B4 ")Address value will contain the Sheet reference (e.g. "Sheet1!A1:B4"). 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

readonly address: string;

プロパティ値

string

addressLocal

ユーザーの言語で指定された範囲の範囲参照を表します。Represents range reference for the specified range in the language of the user. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

readonly addressLocal: string;

プロパティ値

string

cellCount

範囲に含まれるセルの数。Number of cells in the range. セルの数が 2^31-1 (2,147,483,647) を超えると、この API は -1 を返します。This API will return -1 if the cell count exceeds 2^31-1 (2,147,483,647). 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

readonly cellCount: number;

プロパティ値

number

columnCount

範囲に含まれる列の合計数を表します。Represents the total number of columns in the range. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

readonly columnCount: number;

プロパティ値

number

columnHidden

現在の範囲のすべての列が非表示になっているかどうかを表します。Represents if all columns of the current range are hidden.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

columnHidden: boolean;

プロパティ値

boolean

columnIndex

範囲に含まれる最初のセルの列番号を表します。Represents the column number of the first cell in the range. 0 を起点とする番号になります。Zero-indexed. 読み取り専用。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

readonly columnIndex: number;

プロパティ値

number

conditionalFormats

範囲に交差する ConditionalFormats のコレクションです。Collection of ConditionalFormats that intersect the range. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

readonly conditionalFormats: Excel.ConditionalFormatCollection;

プロパティ値

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

context: RequestContext;

プロパティ値

RequestContext

dataValidation

dataValidation オブジェクトを返します。Returns a data validation object.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

readonly dataValidation: Excel.DataValidation;

プロパティ値

format

Format オブジェクト (範囲のフォント、塗りつぶし、罫線、配置などのプロパティをカプセル化するオブジェクト) を返します。Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

readonly format: Excel.RangeFormat;

プロパティ値

formulas

A1 スタイル表記の数式を表します。Represents the formula in A1-style notation. 範囲に数式を設定する場合、引数 value には単一の値 (文字列) または2次元配列のいずれかを指定できます。When setting formulas to a range, the value argument can be either a single value (a string) or a two-dimensional array. 引数に1つの値を指定すると、範囲内のすべてのセルに適用されます。If the argument is a single value, it will be applied to all cells in the range.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

formulas: any[][];

プロパティ値

any[][]

formulasLocal

ユーザーの言語と数値書式ロケールで、A1 スタイル表記の数式を表します。Represents the formula in A1-style notation, in the user's language and number-formatting locale. たとえば、英語の数式 "=SUM(A1, 1.5)" は、ドイツ語では "=SUMME(A1; 1,5)" になります。For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. 範囲に数式を設定する場合、引数 value には単一の値 (文字列) または2次元配列のいずれかを指定できます。When setting formulas to a range, the value argument can be either a single value (a string) or a two-dimensional array. 引数に1つの値を指定すると、範囲内のすべてのセルに適用されます。If the argument is a single value, it will be applied to all cells in the range.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

formulasLocal: any[][];

プロパティ値

any[][]

formulasR1C1

R1C1 スタイル表記の数式を表します。Represents the formula in R1C1-style notation. 範囲に数式を設定する場合、引数 value には単一の値 (文字列) または2次元配列のいずれかを指定できます。When setting formulas to a range, the value argument can be either a single value (a string) or a two-dimensional array. 引数に1つの値を指定すると、範囲内のすべてのセルに適用されます。If the argument is a single value, it will be applied to all cells in the range.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

formulasR1C1: any[][];

プロパティ値

any[][]

hasSpill

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

すべてのセルにスピル ボーダーがあるかどうかを表します。Represents if all cells have a spill border. すべてのセルにスピル枠がある場合は true を返し、すべてのセルにスピル境界線がない場合は false を返します。Returns true if all cells have a spill border, or false if all cells do not have a spill border. 範囲内の罫線を左右に左右しないセルがある場合は、null を返します。Returns null if there are cells both with and without spill borders within the range.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

readonly hasSpill: boolean;

プロパティ値

boolean

height

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

100% ズームの場合の、範囲の上端から範囲の下端までの距離を、ポイント単位で返します。 Returns the distance in points, for 100% zoom, from top edge of the range to bottom edge of the range. 読み取り専用です。Read-only.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

readonly height: number;

プロパティ値

number

hidden

現在の範囲のすべてのセルが非表示になっているかどうかを表します。Represents if all cells of the current range are hidden. 読み取り専用。Read-only.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

readonly hidden: boolean;

プロパティ値

boolean

現在の範囲のハイパーリンクを表します。Represents the hyperlink for the current range.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

hyperlink: Excel.RangeHyperlink;

プロパティ値

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Orders");

    let productsRange = sheet.getRange("A3:A5");
    productsRange.load("values");

    await context.sync();

    // Create a hyperlink to a URL 
    // for each product name in the first table.
    for (let i = 0; i < productsRange.values.length; i++) {
        let cellRange = productsRange.getCell(i, 0);
        let cellText = productsRange.values[i][0];

        let hyperlink = {
            textToDisplay: cellText,
            screenTip: "Search Bing for '" + cellText + "'",
            address: "https://www.bing.com?q=" + cellText
        }
        cellRange.hyperlink = hyperlink;
    }

    await context.sync();
});

isEntireColumn

現在の範囲が列全体であるかどうかを表します。Represents if the current range is an entire column. 読み取り専用です。Read-only.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

readonly isEntireColumn: boolean;

プロパティ値

boolean

isEntireRow

現在の範囲が行全体であるかどうかを表します。Represents if the current range is an entire row. 読み取り専用です。Read-only.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

readonly isEntireRow: boolean;

プロパティ値

boolean

left

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

100% ズームの場合の、ワークシートの左端から範囲の左端までの距離を、ポイント単位で返します。 Returns the distance in points, for 100% zoom, from left edge of the worksheet to left edge of the range. 読み取り専用です。Read-only.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

readonly left: number;

プロパティ値

number

linkedDataTypeState

各セルのデータ型の状態を表します。Represents the data type state of each cell. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly linkedDataTypeState: Excel.LinkedDataTypeState[][];

プロパティ値

Excel.LinkedDataTypeState[][]

numberFormat

指定された範囲の Excel の数値書式コードを表します。Represents Excel's number format code for the given range. 数値の表示形式を範囲に設定する場合、引数 value には単一の値 (文字列) または2次元配列を指定できます。When setting number format to a range, the value argument can be either a single value (string) or a two-dimensional array. 引数に1つの値を指定すると、範囲内のすべてのセルに適用されます。If the argument is a single value, it will be applied to all cells in the range.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

numberFormat: any[][];

プロパティ値

any[][]

numberFormatLocal

ユーザーの言語で文字列として指定された範囲に対応する、Excel の数値形式コードを表します。Represents Excel's number format code for the given range as a string in the language of the user. 数値の表示形式を範囲に設定する場合、引数 value には単一の値 (文字列) または2次元配列のいずれかを指定できます。When setting number format local to a range, the value argument can be either a single value (string) or a two-dimensional array. 引数に1つの値を指定すると、範囲内のすべてのセルに適用されます。If the argument is a single value, it will be applied to all cells in the range.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

numberFormatLocal: any[][];

プロパティ値

any[][]

rowCount

範囲に含まれる行の合計数を返します。Returns the total number of rows in the range. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

readonly rowCount: number;

プロパティ値

number

rowHidden

現在の範囲のすべての行が非表示になっているかどうかを表します。Represents if all rows of the current range are hidden.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

rowHidden: boolean;

プロパティ値

boolean

rowIndex

範囲に含まれる最初のセルの行番号を返します。Returns the row number of the first cell in the range. 0 を起点とする番号になります。Zero-indexed. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

readonly rowIndex: number;

プロパティ値

number

savedAsArray

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

すべてのセルが配列数式として保存されるかどうかを表します。Represents if ALL the cells would be saved as an array formula. すべてのセルが配列として保存される場合は true を返し、すべてのセルが配列数式として保存されない場合は false を返します。Returns true if ALL cells would be saved as an array, or false if ALL cells would NOT be saved as an array formula. 配列数式として保存されないセルが混在している場合は、null を返します。Returns null if there is a mixture of cells that would and would not be saved as an array formula.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

readonly savedAsArray: boolean;

プロパティ値

boolean

sort

現在の範囲について、範囲の並べ替えを表します。Represents the range sort of the current range. 読み取り専用です。Read-only.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

readonly sort: Excel.RangeSort;

プロパティ値

style

現在の範囲のスタイルを表します。Represents the style of the current range. セルのスタイルに不整合がある場合は、null が返されます。If the styles of the cells are inconsistent, null will be returned. ユーザー設定のスタイルの場合は、スタイル名が返されます。For custom styles, the style name will be returned. 組み込みのスタイルの場合、BuiltInStyle 列挙内の値を表す文字列が返されます。For built-in styles, a string representing a value in the BuiltInStyle enum will be returned.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

style: string;

プロパティ値

string

Examples

await Excel.run(async (context) => {
    let worksheet = context.workbook.worksheets.getItem("Sample");
    let range = worksheet.getRange("A1:E1");

    // Apply built-in style. 
    // Styles are in the Home tab ribbon.
    range.style = Excel.BuiltInStyle.neutral;
    range.format.horizontalAlignment = "Right";

    await context.sync();
});

text

指定した範囲のテキスト値。Text values of the specified range. テキスト値は、セルの幅には依存しません。The Text value will not depend on the cell width. Excel # UI で行われた符号置換は、API によって返されるテキスト値には影響しません。The # sign substitution that happens in Excel UI will not affect the text value returned by the API. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

readonly text: string[][];

プロパティ値

string[][]

top

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

100% ズームの場合の、ワークシートの上端から範囲の上端までの距離を、ポイント単位で返します。 Returns the distance in points, for 100% zoom, from top edge of the worksheet to top edge of the range. 読み取り専用です。Read-only.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

readonly top: number;

プロパティ値

number

values

指定した範囲の Raw 値を表します。Represents the raw values of the specified range. 返されるデータの型は、文字列、数値、ブール値のいずれかになります。The data returned could be of type string, number, or a boolean. エラーが含まれているセルは、エラー文字列を返します。Cells that contain an error will return the error string. 範囲に値を設定する場合、引数 value には単一の値 (文字列、数値、またはブール値)、または2次元配列を指定できます。When setting values to a range, the value argument can be either a single value (string, number or boolean) or a two-dimensional array. 引数に1つの値を指定すると、範囲内のすべてのセルに適用されます。If the argument is a single value, it will be applied to all cells in the range.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

values: any[][];

プロパティ値

any[][]

valueTypes

各セルのデータの種類を表します。Represents the type of data of each cell. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

readonly valueTypes: Excel.RangeValueType[][];

プロパティ値

Excel.RangeValueType[][]

width

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

100% ズームの場合の、範囲の左端から範囲の右端までの距離を、ポイント単位で返します。 Returns the distance in points, for 100% zoom, from left edge of the range to right edge of the range. 読み取り専用です。Read-only.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

readonly width: number;

プロパティ値

number

worksheet

現在の範囲を含んでいるワークシート。The worksheet containing the current range. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

readonly worksheet: Excel.Worksheet;

プロパティ値

メソッドの詳細

autoFill(destinationRange, autoFillType)

現在の範囲から対象の範囲までの範囲に値を設定します。Fills range from the current range to the destination range. 移動先の範囲は、ソースを水平方向または垂直方向に拡張する必要があります。The destination range must extend the source either horizontally or vertically. 連続していない範囲はサポートされていません。Discontiguous ranges are not supported.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

autoFill(destinationRange: Range | string, autoFillType?: Excel.AutoFillType): void;

パラメーター

destinationRange
Range | string

オートフィルの対象となるセル範囲を指定します。The destination range to autofill.

autoFillType
Excel.AutoFillType

オートフィルの種類を示します。The type of autofill. 現在の範囲の内容に基づいて、移動先の範囲をどのように塗りつぶすかを指定します。Specifies how the destination range is to be filled, based on the contents of the current range. 既定値は "FillDefault" です。Default is "FillDefault".

戻り値

void

autoFill(destinationRange, autoFillTypeString)

現在の範囲から対象の範囲までの範囲に値を設定します。Fills range from the current range to the destination range. 移動先の範囲は、ソースを水平方向または垂直方向に拡張する必要があります。The destination range must extend the source either horizontally or vertically. 連続していない範囲はサポートされていません。Discontiguous ranges are not supported.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

autoFill(destinationRange: Range | string, autoFillTypeString?: "FillDefault" | "FillCopy" | "FillSeries" | "FillFormats" | "FillValues" | "FillDays" | "FillWeekdays" | "FillMonths" | "FillYears" | "LinearTrend" | "GrowthTrend" | "FlashFill"): void;

パラメーター

destinationRange
Range | string

オートフィルの対象となるセル範囲を指定します。The destination range to autofill.

autoFillTypeString
"FillDefault" | "FillCopy" | "FillSeries" | "FillFormats" | "FillValues" | "FillDays" | "FillWeekdays" | "FillMonths" | "FillYears" | "LinearTrend" | "GrowthTrend" | "FlashFill"

オートフィルの種類を示します。The type of autofill. 現在の範囲の内容に基づいて、移動先の範囲をどのように塗りつぶすかを指定します。Specifies how the destination range is to be filled, based on the contents of the current range. 既定値は "FillDefault" です。Default is "FillDefault".

戻り値

void

calculate()

ワークシート上のセルの範囲を計算します。Calculates a range of cells on a worksheet.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

calculate(): void;

戻り値

void

clear(applyTo)

範囲の値、書式、塗りつぶし、罫線などをクリアします。Clear range values, format, fill, border, etc.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

clear(applyTo?: Excel.ClearApplyTo): void;

パラメーター

applyTo
Excel.ClearApplyTo

省略可能。Optional. クリア操作の種類を決定します。Determines the type of clear action. 詳細については、「Excel. ClearApplyTo」を参照してください。See Excel.ClearApplyTo for details.

戻り値

void

Examples

// Below example clears format and contents of the range. 
Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "D:F";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.clear();
    return ctx.sync(); 
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

clear(applyToString)

範囲の値、書式、塗りつぶし、罫線などをクリアします。Clear range values, format, fill, border, etc.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

clear(applyToString?: "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks"): void;

パラメーター

applyToString
"All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks"

省略可能。Optional. クリア操作の種類を決定します。Determines the type of clear action. 詳細については、「Excel. ClearApplyTo」を参照してください。See Excel.ClearApplyTo for details.

戻り値

void

convertDataTypeToText()

データ型を含む範囲セルをテキストに変換します。Converts the range cells with datatypes into text.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

convertDataTypeToText(): void;

戻り値

void

convertToLinkedDataType(serviceID, languageCulture)

ワークシート内で範囲セルをリンク付きデータ型に変換します。Converts the range cells into linked datatype in the worksheet.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

convertToLinkedDataType(serviceID: number, languageCulture: string): void;

パラメーター

serviceID
number

データのクエリに使用されるサービス ID。The Service ID which will be used to query the data.

languageCulture
string

サービスを照会する言語カルチャ。Language Culture to query the service for.

戻り値

void

copyFrom(sourceRange, copyType, skipBlanks, transpose)

ソース範囲または RangeAreas から現在の範囲にセル データまたは書式設定をコピーします。Copies cell data or formatting from the source range or RangeAreas to the current range. コピー先の範囲は、元の範囲または RangeAreas のサイズと異なる場合があります。The destination range can be of different size than the source range or RangeAreas. 転送先は、ソースよりも小さい場合は自動的に展開されます。The destination will be expanded automatically if it is smaller than the source.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

copyFrom(sourceRange: Range | RangeAreas | string, copyType?: Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean): void;

パラメーター

sourceRange
Range | RangeAreas | string

コピー元の範囲または RangeAreas を指定します。The source range or RangeAreas to copy from. ソース範囲に複数の範囲が含まれている場合は、列の範囲から完全な行または列を削除することによって作成できるアウトライン形式である必要があります。When the source RangeAreas has multiple ranges, it must in the outline form which can be created by removing full rows or columns from a rectangular range.

copyType
Excel.RangeCopyType

コピーするセルのデータまたは書式の種類を指定します。The type of cell data or formatting to copy over. 既定値は "すべて" です。Default is "All".

skipBlanks
boolean

True の場合は、ソース範囲の空白セルをスキップします。True if to skip blank cells in the source range. 既定値は false です。Default is false.

transpose
boolean

True を指定すると、貼り付け先の範囲内のセルが転置されます。True if to transpose the cells in the destination range. 既定値は false です。Default is false.

戻り値

void

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    sheet.getRange("F2").values = [["Copied Formula"]];
    sheet.getRange("F2").format.autofitColumns();

    // copy a range preserving the formulas
    // note: non-formula values are copied over as is
    sheet.getRange("G2").copyFrom("A1:E1", Excel.RangeCopyType.formulas);
    await context.sync();
});

copyFrom(sourceRange, copyTypeString, skipBlanks, transpose)

ソース範囲または RangeAreas から現在の範囲にセル データまたは書式設定をコピーします。Copies cell data or formatting from the source range or RangeAreas to the current range. コピー先の範囲は、元の範囲または RangeAreas のサイズと異なる場合があります。The destination range can be of different size than the source range or RangeAreas. 転送先は、ソースよりも小さい場合は自動的に展開されます。The destination will be expanded automatically if it is smaller than the source.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

copyFrom(sourceRange: Range | RangeAreas | string, copyTypeString?: "All" | "Formulas" | "Values" | "Formats", skipBlanks?: boolean, transpose?: boolean): void;

パラメーター

sourceRange
Range | RangeAreas | string

コピー元の範囲または RangeAreas を指定します。The source range or RangeAreas to copy from. ソース範囲に複数の範囲が含まれている場合は、列の範囲から完全な行または列を削除することによって作成できるアウトライン形式である必要があります。When the source RangeAreas has multiple ranges, it must in the outline form which can be created by removing full rows or columns from a rectangular range.

copyTypeString
"All" | "Formulas" | "Values" | "Formats"

コピーするセルのデータまたは書式の種類を指定します。The type of cell data or formatting to copy over. 既定値は "すべて" です。Default is "All".

skipBlanks
boolean

True の場合は、ソース範囲の空白セルをスキップします。True if to skip blank cells in the source range. 既定値は false です。Default is false.

transpose
boolean

True を指定すると、貼り付け先の範囲内のセルが転置されます。True if to transpose the cells in the destination range. 既定値は false です。Default is false.

戻り値

void

delete(shift)

範囲に関連付けられているセルを削除します。Deletes the cells associated with the range.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

delete(shift: Excel.DeleteShiftDirection): void;

パラメーター

shift
Excel.DeleteShiftDirection

セルをシフトする方向を指定します。Specifies which way to shift the cells. 詳細については、「DeleteShiftDirection」を参照してください。See Excel.DeleteShiftDirection for details.

戻り値

void

delete(shiftString)

範囲に関連付けられているセルを削除します。Deletes the cells associated with the range.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

delete(shiftString: "Up" | "Left"): void;

パラメーター

shiftString
"Up" | "Left"

セルをシフトする方向を指定します。Specifies which way to shift the cells. 詳細については、「DeleteShiftDirection」を参照してください。See Excel.DeleteShiftDirection for details.

戻り値

void

Examples

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "D:F";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.delete("Left");
    return ctx.sync(); 
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

find(text, criteria)

指定された条件に基づいて指定された文字列を見つけます。Finds the given string based on the criteria specified. 現在の範囲が1つのセルより大きい場合は、検索はその範囲に制限されます。それ以外の場合は、シート全体がそのセルの後に表示されます。If the current range is larger than a single cell, then the search will be limited to that range, else the search will cover the entire sheet starting after that cell.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

find(text: string, criteria: Excel.SearchCriteria): Excel.Range;

パラメーター

text
string

検索する文字列を指定します。The string to find.

criteria
Excel.SearchCriteria

検索の方向、検索をセル全体に一致させる必要があるかどうか、または大文字と小文字を区別するかどうかを含む、追加の検索条件。Additional search criteria, including the search direction and whether the search needs to match the entire cell or be case sensitive.

戻り値

検索条件に一致する範囲を指定します。The Range which matched the search criteria.

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const table = sheet.tables.getItem("ExpensesTable");
    const searchRange = table.getRange();

    // NOTE: If no match is found, an ItemNotFound error
    // is thrown when Range.find is evaluated.
    const foundRange = searchRange.find($("#searchText").text(), {
        completeMatch: completeMatch,
        matchCase: matchCase,
        searchDirection: searchDirection
    });
    
    foundRange.load("address");
    await context.sync();


    console.log(foundRange.address);
});

findOrNullObject(text, criteria)

指定された条件に基づいて指定された文字列を見つけます。Finds the given string based on the criteria specified. 現在の範囲が1つのセルより大きい場合は、検索はその範囲に制限されます。それ以外の場合は、シート全体がそのセルの後に表示されます。If the current range is larger than a single cell, then the search will be limited to that range, else the search will cover the entire sheet starting after that cell. 一致しない場合、この関数は null オブジェクトを返します。If there are no matches, this function will return a null object.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

findOrNullObject(text: string, criteria: Excel.SearchCriteria): Excel.Range;

パラメーター

text
string

検索する文字列を指定します。The string to find.

criteria
Excel.SearchCriteria

検索の方向、検索をセル全体に一致させる必要があるかどうか、または大文字と小文字を区別するかどうかを含む、追加の検索条件。Additional search criteria, including the search direction and whether the search needs to match the entire cell or be case sensitive.

戻り値

検索条件に一致する範囲を指定します。The Range which matched the search criteria.

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const table = sheet.tables.getItem("ExpensesTable");
    const searchRange = table.getRange();
    const foundRange = searchRange.findOrNullObject($("#searchText").text(), {
        completeMatch: completeMatch,
        matchCase: matchCase,
        searchDirection: searchDirection
    });
    
    foundRange.load("address");
    await context.sync();

    if (foundRange.isNullObject) {
        console.log("Text not found");
    } else {
        console.log(foundRange.address);
    }
});

flashFill()

現在の範囲に対してフラッシュ フィルを実行します。フラッシュ フィルでは、パターンを感知して自動的にデータが設定されるので、範囲は単一列範囲で、かつパターンを検出できるように周囲にデータが存在する必要があります。Does FlashFill to current range.Flash Fill will automatically fills data when it senses a pattern, so the range must be single column range and have data around in order to find pattern.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

flashFill(): void;

戻り値

void

getAbsoluteResizedRange(numRows, numColumns)

現在の Range オブジェクトと左上のセルが同じで、指定した数の行と列を含む Range オブジェクトを取得します。Gets a Range object with the same top-left cell as the current Range object, but with the specified numbers of rows and columns.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

getAbsoluteResizedRange(numRows: number, numColumns: number): Excel.Range;

パラメーター

numRows
number

新しい範囲サイズの行数を指定します。The number of rows of the new range size.

numColumns
number

新しい範囲のサイズの列数を指定します。The number of columns of the new range size.

戻り値

getBoundingRect(anotherRange)

指定した範囲を包含する、最小の Range オブジェクトを取得します。Gets the smallest range object that encompasses the given ranges. たとえば、"B2:C5" と "D10:E15" の GetBoundingRect は、"B2:E15" になります。For example, the GetBoundingRect of "B2:C5" and "D10:E15" is "B2:E15".

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

getBoundingRect(anotherRange: Range | string): Excel.Range;

パラメーター

anotherRange
Range | string

Range オブジェクト、アドレスまたは範囲名。The range object or address or range name.

戻り値

Examples

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "D4:G6";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    var range = range.getBoundingRect("G4:H8");
    range.load('address');
    return ctx.sync().then(function() {
        console.log(range.address); // Prints Sheet1!D4:H8
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getCell(row, column)

行と列の番号に基づいて、1 つのセルを含んだ範囲オブジェクトを取得します。Gets the range object containing the single cell based on row and column numbers. ワークシートのグリッド内に収まるセルは、親の範囲の境界の外側にある場合があります。The cell can be outside the bounds of its parent range, so long as it stays within the worksheet grid. 返されるセルは、範囲の左上のセルを基準に配置されます。The returned cell is located relative to the top left cell of the range.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

getCell(row: number, column: number): Excel.Range;

パラメーター

row
number

取得するセルの行番号。Row number of the cell to be retrieved. 0 を起点とする番号になります。Zero-indexed.

column
number

取得セルの列番号。Column number of the cell to be retrieved. 0 を起点とする番号になります。Zero-indexed.

戻り値

Examples

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "A1:F8";
    var worksheet = ctx.workbook.worksheets.getItem(sheetName);
    var range = worksheet.getRange(rangeAddress);
    var cell = range.cell(0,0);
    cell.load('address');
    return ctx.sync().then(function() {
        console.log(cell.address);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getCellProperties(cellPropertiesLoadOptions)

2D 配列を返します。各セルのフォント、塗りつぶし、罫線、配置などのプロパティ データをカプセル化します。Returns a 2D array, encapsulating the data for each cell's font, fill, borders, alignment, and other properties.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions): OfficeExtension.ClientResult<CellProperties[][]>;

パラメーター

cellPropertiesLoadOptions
CellPropertiesLoadOptions

読み込むセルのプロパティを表すオブジェクト。An object that represents which cell properties to load.

戻り値

OfficeExtension.ClientResult<CellProperties[][]>

各項目が対応するセルの要求されたプロパティを表す2次元配列。A 2D array where each item represents the requested properties of the corresponding cell.

Examples

await Excel.run(async (context) => {
    const cell = context.workbook.getActiveCell();

    // Define the cell properties to get by setting the matching LoadOptions to true.
    const propertiesToGet = cell.getCellProperties({
        address: true,
        format: {
            fill: {
                color: true
            },
            font: {
                color: true
            }
        },
        style: true
    });

    // Sync to get the data from the workbook.
    await context.sync();
    const cellProperties = propertiesToGet.value[0][0];
    console.log(
        `Address: ${cellProperties.address}\nStyle: ${cellProperties.style}\nFill Color: ${cellProperties.format.fill.color}\nFont Color: ${cellProperties.format.font.color}`);
});

getColumn(column)

範囲に含まれる列を 1 つ取得します。Gets a column contained in the range.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

getColumn(column: number): Excel.Range;

パラメーター

column
number

取得する範囲の列番号。Column number of the range to be retrieved. 0 を起点とする番号になります。Zero-indexed.

戻り値

Examples

Excel.run(function (ctx) { 
    var sheetName = "Sheet19";
    var rangeAddress = "A1:F8";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getColumn(1);
    range.load('address');
    return ctx.sync().then(function() {
        console.log(range.address); // prints Sheet1!B1:B8
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getColumnProperties(columnPropertiesLoadOptions)

一次元配列を返します。各列のフォント、塗りつぶし、罫線、配置などのプロパティ データをカプセル化します。Returns a single-dimensional array, encapsulating the data for each column's font, fill, borders, alignment, and other properties. 指定された列内の列間で一貫性のないプロパティについては、null が返されます。For properties that are not consistent across each cell within a given column, null will be returned.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getColumnProperties(columnPropertiesLoadOptions: ColumnPropertiesLoadOptions): OfficeExtension.ClientResult<ColumnProperties[]>;

パラメーター

columnPropertiesLoadOptions
ColumnPropertiesLoadOptions

読み込む列のプロパティを表すオブジェクト。An object that represents which column properties to load.

戻り値

OfficeExtension.ClientResult<ColumnProperties[]>

各項目が対応する列の要求されたプロパティを表す配列。An array where each item represents the requested properties of the corresponding column.

getColumnsAfter(count)

現在の Range オブジェクトの右にある特定の列数を取得します。Gets a certain number of columns to the right of the current Range object.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

getColumnsAfter(count?: number): Excel.Range;

パラメーター

count
number

省略可能。結果の範囲に含める列の数です。通常、正の数値を使用して現在の範囲外に範囲を作成します。負の数値を使用して、現在の範囲内に範囲を作成することもできます。既定値は 1 です。Optional. The number of columns to include in the resulting range. In general, use a positive number to create a range outside the current range. You can also use a negative number to create a range within the current range. The default value is 1.

戻り値

getColumnsBefore(count)

現在の Range オブジェクトの左にある特定の列数を取得します。Gets a certain number of columns to the left of the current Range object.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

getColumnsBefore(count?: number): Excel.Range;

パラメーター

count
number

省略可能。結果の範囲に含める列の数です。通常、正の数値を使用して現在の範囲外に範囲を作成します。負の数値を使用して、現在の範囲内に範囲を作成することもできます。既定値は 1 です。Optional. The number of columns to include in the resulting range. In general, use a positive number to create a range outside the current range. You can also use a negative number to create a range within the current range. The default value is 1.

戻り値

getEntireColumn()

範囲の列全体を表すオブジェクトを取得します (たとえば、現在の範囲がセル "B4: E11" を表しているgetEntireColumn場合は、"B: E" という列を表す範囲)。Gets an object that represents the entire column of the range (for example, if the current range represents cells "B4:E11", its getEntireColumn is a range that represents columns "B:E").

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

getEntireColumn(): Excel.Range;

戻り値

Examples

// Note: the grid properties of the Range (values, numberFormat, formulas) 
// contains null since the Range in question is unbounded.
Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "D:F";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    var rangeEC = range.getEntireColumn();
    rangeEC.load('address');
    return ctx.sync().then(function() {
        console.log(rangeEC.address);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getEntireRow()

範囲の行全体を表すオブジェクトを取得します (たとえば、現在の範囲がセル "B4: E11" を表しているGetEntireRow場合は、行 "4:11" を表す範囲になります)。Gets an object that represents the entire row of the range (for example, if the current range represents cells "B4:E11", its GetEntireRow is a range that represents rows "4:11").

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

getEntireRow(): Excel.Range;

戻り値

Examples

// Gets an object that represents the entire row of the range 
// (for example, if the current range represents cells "B4:E11", 
// its GetEntireRow is a range that represents rows "4:11").
Excel.run(function (ctx) {
    var sheetName = "Sheet1";
    var rangeAddress = "D:F"; 
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    var rangeER = range.getEntireRow();
    rangeER.load('address');
    return ctx.sync().then(function() {
        console.log(rangeER.address);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getImage()

範囲を base64 でエンコードされた png 画像としてレンダリングします。Renders the range as a base64-encoded png image.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

getImage(): OfficeExtension.ClientResult<string>;

戻り値

OfficeExtension.ClientResult<string>

getIntersection(anotherRange)

指定した範囲の長方形の交差を表す範囲オブジェクトを取得します。Gets the range object that represents the rectangular intersection of the given ranges.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

getIntersection(anotherRange: Range | string): Excel.Range;

パラメーター

anotherRange
Range | string

範囲の交差を判断するために使用される、Range オブジェクトまたは Range アドレス。The range object or range address that will be used to determine the intersection of ranges.

戻り値

Examples

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "A1:F8";
    var range = 
        ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getIntersection("D4:G6");
    range.load('address');
    return ctx.sync().then(function() {
        console.log(range.address); // prints Sheet1!D4:F6
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getIntersectionOrNullObject(anotherRange)

指定した範囲の長方形の交差を表す範囲オブジェクトを取得します。Gets the range object that represents the rectangular intersection of the given ranges. 交差部分が見つからない場合は、null オブジェクトを返します。If no intersection is found, will return a null object.

[API セット: excelapi 1.4][ API set: ExcelApi 1.4 ]

getIntersectionOrNullObject(anotherRange: Range | string): Excel.Range;

パラメーター

anotherRange
Range | string

範囲の交差を判断するために使用される、Range オブジェクトまたは Range アドレス。The range object or range address that will be used to determine the intersection of ranges.

戻り値

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const salesTable = sheet.tables.getItem("SalesTable");
    const dataRange = salesTable.getDataBodyRange();

    // We want the most recent quarter that has data, so
    // exclude quarters without data and get the last of
    // the remaining columns.
    const usedDataRange = dataRange.getUsedRange(true /* valuesOnly */);
    const currentQuarterRange = usedDataRange.getLastColumn();

    // Asian and European teams have separate contests.
    const asianSalesRange = sheet.getRange("A2:E4");
    const europeanSalesRange = sheet.getRange("A5:E7");

    // The data for each chart is the intersection of the
    // current quarter column and the rows for the continent.
    const asianContestRange = asianSalesRange.getIntersectionOrNullObject(currentQuarterRange);
    const europeanContestRange = europeanSalesRange.getIntersectionOrNullObject(currentQuarterRange);

    // Must sync before you can test the output of *OrNullObject
    // method/property.
    await context.sync();

    if (asianContestRange.isNullObject) {
        // See the declaration of this method for how to
        // test this code path.
        reportMissingData("Asian");
    } else {
        createContinentChart(
            sheet,
            "Asian",
            asianContestRange,
            "A9",
            "F24"
        );
    }

    if (europeanContestRange.isNullObject) {
        // See the declaration of this method for how to
        // test this code path.
        reportMissingData("European");
    } else {
        createContinentChart(
            sheet,
            "European",
            europeanContestRange,
            "A25",
            "F40"
        );
    }

    await context.sync();
});

getLastCell()

範囲内の最後のセルを取得します。Gets the last cell within the range. たとえば、"B2:D5" の最後のセルは "D5" になります。For example, the last cell of "B2:D5" is "D5".

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

getLastCell(): Excel.Range;

戻り値

Examples

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "A1:F8";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getLastCell();
    range.load('address');
    return ctx.sync().then(function() {
        console.log(range.address); // prints Sheet1!F8
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getLastColumn()

範囲内の最後の列を取得します。Gets the last column within the range. たとえば、"B2:D5" の最後の列は "D2:D5" になります。For example, the last column of "B2:D5" is "D2:D5".

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

getLastColumn(): Excel.Range;

戻り値

Examples

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "A1:F8";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getLastColumn();
    range.load('address');
    return ctx.sync().then(function() {
        console.log(range.address); // prints Sheet1!F1:F8
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getLastRow()

範囲内の最後の行を取得します。Gets the last row within the range. たとえば、"B2:D5" の最後の行は "B5:D5" になります。For example, the last row of "B2:D5" is "B5:D5".

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

getLastRow(): Excel.Range;

戻り値

Examples

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "A1:F8";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getLastRow();
    range.load('address');
    return ctx.sync().then(function() {
        console.log(range.address); // prints Sheet1!A8:F8
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getOffsetRange(rowOffset, columnOffset)

指定した範囲からのオフセットで範囲を表すオブジェクトを取得します。返される範囲のディメンションは、この範囲と一致します。結果の範囲がワークシートのグリッドの境界線の外にはみ出る場合は、エラーがスローされます。Gets an object which represents a range that's offset from the specified range. The dimension of the returned range will match this range. If the resulting range is forced outside the bounds of the worksheet grid, an error will be thrown.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

getOffsetRange(rowOffset: number, columnOffset: number): Excel.Range;

パラメーター

rowOffset
number

範囲をオフセットする行数 (正、負、または 0)。正の値は下方向へのオフセットです。また、負の値は上方向へのオフセットです。The number of rows (positive, negative, or 0) by which the range is to be offset. Positive values are offset downward, and negative values are offset upward.

columnOffset
number

範囲をオフセットする列数 (正、負、または 0)。正の値は右方向へのオフセットです。また、負の値は左方向へのオフセットです。The number of columns (positive, negative, or 0) by which the range is to be offset. Positive values are offset to the right, and negative values are offset to the left.

戻り値

Examples

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "D4:F6";
    var range = 
        ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getOffsetRange(-1,4);
    range.load('address');
    return ctx.sync().then(function() {
        console.log(range.address); // prints Sheet1!H3:K5
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getResizedRange(deltaRows, deltaColumns)

現在の Range オブジェクトに似た (ただし、右下隅がいくつかの行と列で拡張 (または縮小) されている) Range オブジェクトを取得します。Gets a Range object similar to the current Range object, but with its bottom-right corner expanded (or contracted) by some number of rows and columns.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

getResizedRange(deltaRows: number, deltaColumns: number): Excel.Range;

パラメーター

deltaRows
number

現在の範囲を基準にして、右下隅を拡張する行の数です。範囲を拡張するには正の数値、または範囲を縮小するには負の数値を使用します。The number of rows by which to expand the bottom-right corner, relative to the current range. Use a positive number to expand the range, or a negative number to decrease it.

deltaColumns
number

現在の範囲を基準にして、右下隅を展開する列数を指定します。The number of columns by which to expand the bottom-right corner, relative to the current range. 範囲を拡張するには正の数値、または範囲を縮小するには負の数値を使用します。Use a positive number to expand the range, or a negative number to decrease it.

戻り値

getRow(row)

範囲に含まれている行を 1 つ取得します。Gets a row contained in the range.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

getRow(row: number): Excel.Range;

パラメーター

row
number

取得する範囲の行番号。Row number of the range to be retrieved. 0 を起点とする番号になります。Zero-indexed.

戻り値

Examples

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "A1:F8";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getRow(1);
    range.load('address');
    return ctx.sync().then(function() {
        console.log(range.address); // prints Sheet1!A2:F2
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getRowProperties(rowPropertiesLoadOptions)

一次元配列を返します。各行のフォント、塗りつぶし、罫線、配置などのプロパティ データをカプセル化します。Returns a single-dimensional array, encapsulating the data for each row's font, fill, borders, alignment, and other properties. 指定された行内の列間で一貫性のないプロパティについては、null が返されます。For properties that are not consistent across each cell within a given row, null will be returned.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getRowProperties(rowPropertiesLoadOptions: RowPropertiesLoadOptions): OfficeExtension.ClientResult<RowProperties[]>;

パラメーター

rowPropertiesLoadOptions
RowPropertiesLoadOptions

読み込む行プロパティを表すオブジェクト。An object that represents which row properties to load.

戻り値

OfficeExtension.ClientResult<RowProperties[]>

各項目が対応する行の要求されたプロパティを表す配列。An array where each item represents the requested properties of the corresponding row.

getRowsAbove(count)

現在の Range オブジェクトの上にある特定の行数を取得します。Gets a certain number of rows above the current Range object.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

getRowsAbove(count?: number): Excel.Range;

パラメーター

count
number

省略可能。結果の範囲に含める行の数です。通常、正の数値を使用して現在の範囲外に範囲を作成します。負の数値を使用して、現在の範囲内に範囲を作成することもできます。既定値は 1 です。Optional. The number of rows to include in the resulting range. In general, use a positive number to create a range outside the current range. You can also use a negative number to create a range within the current range. The default value is 1.

戻り値

getRowsBelow(count)

現在の Range オブジェクトの下にある特定の行数を取得します。Gets a certain number of rows below the current Range object.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

getRowsBelow(count?: number): Excel.Range;

パラメーター

count
number

省略可能。結果の範囲に含める行の数です。通常、正の数値を使用して現在の範囲外に範囲を作成します。負の数値を使用して、現在の範囲内に範囲を作成することもできます。既定値は 1 です。Optional. The number of rows to include in the resulting range. In general, use a positive number to create a range outside the current range. You can also use a negative number to create a range within the current range. The default value is 1.

戻り値

getSpecialCells(cellType, cellValueType)

指定された型と値に一致するすべてのセルを表し、1 つまたは複数の長方形範囲で構成される RangeAreas オブジェクトを取得します。Gets the RangeAreas object, comprising one or more rectangular ranges, that represents all the cells that match the specified type and value. 特別なセルが見つからない場合は、ItemNotFound エラーがスローされます。If no special cells are found, an ItemNotFound error will be thrown.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getSpecialCells(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;

パラメーター

cellType
Excel.SpecialCellType

含めるセルの種類を指定します。The type of cells to include.

cellValueType
Excel.SpecialCellValueType

CellType が定数または数式の場合は、この引数を使用して、結果に含めるセルの種類を決定します。If cellType is either Constants or Formulas, this argument is used to determine which types of cells to include in the result. これらの値は、組み合わせて複数の型を返すことができます。These values can be combined together to return more than one type. この引数を省略すると、すべての定数および数式が対象になります。The default is to select all constants or formulas, no matter what the type.

戻り値

Examples

await Excel.run(async (context) => {

    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const usedRange = sheet.getUsedRange();

    // Find the ranges with either text or logical (boolean) values.
    const formulaRanges = usedRange.getSpecialCells("Constants", "LogicalText");
    formulaRanges.format.fill.color = "orange";

    return context.sync();
});

getSpecialCells(cellTypeString, cellValueType)

指定された型と値に一致するすべてのセルを表し、1 つまたは複数の長方形範囲で構成される RangeAreas オブジェクトを取得します。Gets the RangeAreas object, comprising one or more rectangular ranges, that represents all the cells that match the specified type and value. 特別なセルが見つからない場合は、ItemNotFound エラーがスローされます。If no special cells are found, an ItemNotFound error will be thrown.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getSpecialCells(cellTypeString: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;

パラメーター

cellTypeString
"ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible"

含めるセルの種類を指定します。The type of cells to include.

cellValueType
"All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"

CellType が定数または数式の場合は、この引数を使用して、結果に含めるセルの種類を決定します。If cellType is either Constants or Formulas, this argument is used to determine which types of cells to include in the result. これらの値は、組み合わせて複数の型を返すことができます。These values can be combined together to return more than one type. この引数を省略すると、すべての定数および数式が対象になります。The default is to select all constants or formulas, no matter what the type.

戻り値

getSpecialCellsOrNullObject(cellType, cellValueType)

指定された型と値に一致するすべてのセルを表し、1 つまたは複数の範囲を構成する RangeAreas オブジェクトを取得します。Gets the RangeAreas object, comprising one or more ranges, that represents all the cells that match the specified type and value. 特別なセルが見つからない場合は、null オブジェクトが返されます。If no special cells are found, a null object will be returned.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;

パラメーター

cellType
Excel.SpecialCellType

含めるセルの種類を指定します。The type of cells to include.

cellValueType
Excel.SpecialCellValueType

CellType が定数または数式の場合は、この引数を使用して、結果に含めるセルの種類を決定します。If cellType is either Constants or Formulas, this argument is used to determine which types of cells to include in the result. これらの値は、組み合わせて複数の型を返すことができます。These values can be combined together to return more than one type. この引数を省略すると、すべての定数および数式が対象になります。The default is to select all constants or formulas, no matter what the type.

戻り値

getSpecialCellsOrNullObject(cellTypeString, cellValueType)

指定された型と値に一致するすべてのセルを表し、1 つまたは複数の範囲を構成する RangeAreas オブジェクトを取得します。Gets the RangeAreas object, comprising one or more ranges, that represents all the cells that match the specified type and value. 特別なセルが見つからない場合は、null オブジェクトが返されます。If no special cells are found, a null object will be returned.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getSpecialCellsOrNullObject(cellTypeString: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;

パラメーター

cellTypeString
"ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible"

含めるセルの種類を指定します。The type of cells to include.

cellValueType
"All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"

CellType が定数または数式の場合は、この引数を使用して、結果に含めるセルの種類を決定します。If cellType is either Constants or Formulas, this argument is used to determine which types of cells to include in the result. これらの値は、組み合わせて複数の型を返すことができます。These values can be combined together to return more than one type. この引数を省略すると、すべての定数および数式が対象になります。The default is to select all constants or formulas, no matter what the type.

戻り値

getSpillingToRange()

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

アンカー セルで呼び出されたとき、スピル範囲を含む範囲オブジェクトを取得します。Gets the range object containing the spill range when called on an anchor cell. 複数のセルを含む範囲に適用される場合は失敗します。Fails if applied to a range with more than one cell. 読み取り専用です。Read-only.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

getSpillingToRange(): Excel.Range;

戻り値

getSpillingToRangeOrNullObject()

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

アンカー セルで呼び出されたとき、スピル範囲を含む範囲オブジェクトを取得します。Gets the range object containing the spill range when called on an anchor cell. 読み取り専用です。Read-only. 指定範囲がアンカーセルでない場合、またはスピル範囲が見つからない場合は、null オブジェクトが返されます。If the range is not an anchor cell or spill range can't be found, a null object will be returned.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

getSpillingToRangeOrNullObject(): Excel.Range;

戻り値

getSpillParent()

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

スピルするセルのアンカー セルを含む範囲オブジェクトを取得します。Gets the range object containing the anchor cell for a cell getting spilled into. 複数のセルを含む範囲に適用される場合は失敗します。Fails if applied to a range with more than one cell. 読み取り専用です。Read-only.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

getSpillParent(): Excel.Range;

戻り値

getSpillParentOrNullObject()

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

スピルするセルのアンカー セルを含む範囲オブジェクトを取得します。Gets the range object containing the anchor cell for a cell getting spilled into. 読み取り専用です。Read-only. スピルセルが指定されていない場合、または複数のセルが指定されている場合は、null オブジェクトが返されます。If it is not a spill cell or more than once cells are give, a null object will be returned.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

getSpillParentOrNullObject(): Excel.Range;

戻り値

getSurroundingRegion()

指定された範囲の左上のセルを囲む領域を表す Range オブジェクトを返します。Returns a Range object that represents the surrounding region for the top-left cell in this range. 周囲の領域は、この範囲に相対の空白の行と空白の列の任意の組み合わせで囲まれた範囲です。A surrounding region is a range bounded by any combination of blank rows and blank columns relative to this range.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

getSurroundingRegion(): Excel.Range;

戻り値

getTables(fullyContained)

範囲と重なるテーブルの集まりを範囲限定で取得します。Gets a scoped collection of tables that overlap with the range.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getTables(fullyContained?: boolean): Excel.TableScopedCollection;

パラメーター

fullyContained
boolean

True の場合は、範囲範囲内に完全に含まれるテーブルのみを返します。If true, returns only tables that are fully contained within the range bounds. 既定値は false です。The default value is false.

戻り値

getUsedRange(valuesOnly)

指定した範囲オブジェクトのうち使用されている範囲を返します。範囲内に使用済みのセルがない場合、この関数は ItemNotFound エラーをスローします。Returns the used range of the given range object. If there are no used cells within the range, this function will throw an ItemNotFound error.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

getUsedRange(valuesOnly?: boolean): Excel.Range;

パラメーター

valuesOnly
boolean

値の入っているセルのみを使用セルと見なします。Considers only cells with values as used cells. [Api セット: ExcelApi 1.2][Api set: ExcelApi 1.2]

戻り値

Examples

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "D:F";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    var rangeUR = range.getUsedRange();
    rangeUR.load('address');
    return ctx.sync().then(function() {
        console.log(rangeUR.address);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});
await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const salesTable = sheet.tables.getItem("SalesTable");
    const dataRange = salesTable.getDataBodyRange();

    // We want the most recent quarter that has data, so
    // exclude quarters without data and get the last of
    // the remaining columns.
    const usedDataRange = dataRange.getUsedRange(true /* valuesOnly */);
    const currentQuarterRange = usedDataRange.getLastColumn();

    // Asian and European teams have separate contests.
    const asianSalesRange = sheet.getRange("A2:E4");
    const europeanSalesRange = sheet.getRange("A5:E7");

    // The data for each chart is the intersection of the
    // current quarter column and the rows for the continent.
    const asianContestRange = asianSalesRange.getIntersectionOrNullObject(currentQuarterRange);
    const europeanContestRange = europeanSalesRange.getIntersectionOrNullObject(currentQuarterRange);

    // Must sync before you can test the output of *OrNullObject
    // method/property.
    await context.sync();

    if (asianContestRange.isNullObject) {
        // See the declaration of this method for how to
        // test this code path.
        reportMissingData("Asian");
    } else {
        createContinentChart(
            sheet,
            "Asian",
            asianContestRange,
            "A9",
            "F24"
        );
    }

    if (europeanContestRange.isNullObject) {
        // See the declaration of this method for how to
        // test this code path.
        reportMissingData("European");
    } else {
        createContinentChart(
            sheet,
            "European",
            europeanContestRange,
            "A25",
            "F40"
        );
    }

    await context.sync();
});

getUsedRangeOrNullObject(valuesOnly)

指定した範囲オブジェクトのうち使用されている範囲を返します。範囲内に使用済みのセルがない場合、この関数は null オブジェクトを返します。Returns the used range of the given range object. If there are no used cells within the range, this function will return a null object.

[API セット: excelapi 1.4][ API set: ExcelApi 1.4 ]

getUsedRangeOrNullObject(valuesOnly?: boolean): Excel.Range;

パラメーター

valuesOnly
boolean

値の入っているセルのみを使用セルと見なします。Considers only cells with values as used cells.

戻り値

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const salesTable = sheet.tables.getItem("SalesTable");
    const dataRange = salesTable.getDataBodyRange();

    // Pass true so only cells with values count as used
    const usedDataRange = dataRange.getUsedRangeOrNullObject(
        true /* valuesOnly */
    );

    //Must sync before reading value returned from *OrNullObject method/property.
    await context.sync();

    if (usedDataRange.isNullObject) {
        console.log("Need Data to Make Chart");
        console.log("To create a meaningful chart, press 'Fill the table' (or add names to the Product column and numbers to some of the other cells). Then press 'Try to create chart' again.");
    } else {
        const chart = sheet.charts.add(
            Excel.ChartType.columnClustered,
            dataRange,
            "Columns"
        );
        chart.setPosition("A15", "F30");
        chart.title.text = "Quarterly sales chart";
        chart.legend.position = "Right";
        chart.legend.format.fill.setSolidColor("white");
        chart.dataLabels.format.font.size = 15;
        chart.dataLabels.format.font.color = "black";
    }

    await context.sync();
});

getVisibleView()

現在の範囲の表示されている行を表します。Represents the visible rows of the current range.

[API セット: excelapi 1.3][ API set: ExcelApi 1.3 ]

getVisibleView(): Excel.RangeView;

戻り値

insert(shift)

この範囲を占めるセルまたはセルの範囲をワークシートに挿入し、領域を空けるために他のセルをシフトします。この時点で空き領域に位置する、新しい Range オブジェクトが返されます。Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. Returns a new Range object at the now blank space.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

insert(shift: Excel.InsertShiftDirection): Excel.Range;

パラメーター

shift
Excel.InsertShiftDirection

セルをシフトする方向を指定します。Specifies which way to shift the cells. 詳細については、「InsertShiftDirection」を参照してください。See Excel.InsertShiftDirection for details.

戻り値

Examples

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "F5:F10";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.insert();
    return ctx.sync(); 
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

insert(shiftString)

この範囲を占めるセルまたはセルの範囲をワークシートに挿入し、領域を空けるために他のセルをシフトします。この時点で空き領域に位置する、新しい Range オブジェクトが返されます。Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. Returns a new Range object at the now blank space.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

insert(shiftString: "Down" | "Right"): Excel.Range;

パラメーター

shiftString
"Down" | "Right"

セルをシフトする方向を指定します。Specifies which way to shift the cells. 詳細については、「InsertShiftDirection」を参照してください。See Excel.InsertShiftDirection for details.

戻り値

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(option?: Excel.Interfaces.RangeLoadOptions): Excel.Range;

パラメーター

戻り値

注釈

このシグネチャに加えて、このメソッドのシグネチャは次のとおりです。In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Excel.Range-Where オプションは、読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列です。load(option?: string | string[]): Excel.Range - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.Range-Where オプションを指定します。 select は、読み込むプロパティを指定するコンマで区切られた文字列で、オプション expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。load(option?: { select?: string; expand?: string; }): Excel.Range - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Range-コレクション型でのみ使用できます。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Range - Only available on collection types. これは、前述の署名に似ています。It is similar to the preceding signature. Top は、結果に含めることができるコレクション項目の最大数を指定します。Option.top specifies the maximum number of collection items that can be included in the result. 省略すると、スキップされ、結果に含まれないアイテムの数を指定します。Option.skip specifies the number of items that are to be skipped and not included in the result. Option を指定すると、指定した数のアイテムをスキップした後に結果セットが開始されます。If option.top is specified, the result set will start after skipping the specified number of items.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Excel.Range;

パラメーター

propertyNames
string | string[]

読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列。A comma-delimited string or an array of strings that specify the properties to load.

戻り値

Examples

// Below example uses range address to get the range object.
Excel.run(function (ctx) {
    var sheetName = "Sheet1";
    var rangeAddress = "A1:F8"; 
    var worksheet = ctx.workbook.worksheets.getItem(sheetName);
    var range = worksheet.getRange(rangeAddress);
    range.load('cellCount');
    return ctx.sync().then(function() {
        console.log(range.cellCount);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});
// Below example uses a named-range to get the range object.
Excel.run(function (ctx) { 
    var rangeName = 'MyRange';
    var range = ctx.workbook.names.getItem(rangeName).range;
    range.load('cellCount');
    return ctx.sync().then(function() {
        console.log(range.cellCount);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});
// The example below sets number-format, values and formulas on a grid that contains 2x3 grid.
Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "F5:G7";
    var numberFormat = [[null, "d-mmm"], [null, "d-mmm"], [null, null]]
    var values = [["Today", 42147], ["Tomorrow", "5/24"], ["Difference in days", null]];
    var formulas = [[null,null], [null,null], [null,"=G6-G5"]];
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.numberFormat = numberFormat;
    range.values = values;
    range.formulas= formulas;
    range.load('text');
    return ctx.sync().then(function() {
        console.log(range.text);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.Range;

パラメーター

propertyNamesAndPaths
{ select?: string; expand?: string; }

ここで、は、読み込むプロパティを指定するコンマで区切られた文字列を指定します。 expand は、読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。Where propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

戻り値

merge(across)

範囲内のセルをワークシートの 1 つの領域に結合します。Merge the range cells into one region in the worksheet.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

merge(across?: boolean): void;

パラメーター

across
boolean

省略可能。Optional. 指定した範囲のセルを行ごとに結合して、行ごとに別のセルを作成する場合は True に設定します。Set true to merge cells in each row of the specified range as separate merged cells. 既定値は False です。The default value is false.

戻り値

void

Examples

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "A1:C3";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.merge(true);
    return ctx.sync(); 
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});
Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "A1:C3";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.unmerge();
    return ctx.sync(); 
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

removeDuplicates(columns, includesHeader)

列によって指定される範囲から重複する値を削除します。Removes duplicate values from the range specified by the columns.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

removeDuplicates(columns: number[], includesHeader: boolean): Excel.RemoveDuplicatesResult;

パラメーター

columns
number[]

重複が含まれる可能性がある範囲内の列。The columns inside the range that may contain duplicates. 少なくとも1つの列を指定する必要があります。At least one column needs to be specified. 0 を起点とする番号になります。Zero-indexed.

includesHeader
boolean

True の場合は、入力データにヘッダーが含まれています。True if the input data contains header. 既定値は false です。Default is false.

戻り値

削除された行の数と残りの一意の行の数を含む、結果のオブジェクト。The resulting object that contains the number of rows removed and the number of remaining unique rows.

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B2:D11");

    const deleteResult = range.removeDuplicates([0],true);    
    deleteResult.load();    
    await context.sync();

    console.log(deleteResult.removed + " entries with duplicate names removed.");
    console.log(deleteResult.uniqueRemaining + " entries with unique names remain in the range.");
});

replaceAll(text, replacement, criteria)

現在の範囲内で、指定された条件に基づき、指定された文字列を検索し、置換します。Finds and replaces the given string based on the criteria specified within the current range.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria): OfficeExtension.ClientResult<number>;

パラメーター

text
string

検索する文字列を指定します。String to find.

replacement
string

元のと置き換える文字列。String to replace the original with.

criteria
Excel.ReplaceCriteria

置換条件を追加します。Additional Replace Criteria.

戻り値

OfficeExtension.ClientResult<number>

実行された置換の数。The number of replacements performed.

select()

Excel UI で指定した範囲を選択します。Selects the specified range in the Excel UI.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

select(): void;

戻り値

void

Examples

Excel.run(function (ctx) {
    var sheetName = "Sheet1";
    var rangeAddress = "F5:F10"; 
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.select();
    return ctx.sync(); 
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.RangeUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

properties
Interfaces.RangeUpdateData

メソッドが呼び出されるオブジェクトのプロパティに構造化 isomorphically されているプロパティを持つ JavaScript オブジェクト。A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

プロパティオブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。Provides an option to suppress errors if the properties object tries to set any read-only properties.

戻り値

void

注釈

このメソッドには、次の追加のシグネチャがあります。This method has the following additional signature:

set(properties: Excel.Range): void

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");

    const range = sheet.getRange("B2:E2");
    range.set({
        format: {
            fill: {
                color: "#4472C4"
            },
            font: {
                name: "Verdana",
                color: "white"
            }
        }
    })
    range.format.autofitColumns();
    await context.sync();
});
await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");

    const sourceRange = sheet.getRange("B2:E2");
    sourceRange.load("format/fill/color, format/font/name, format/font/color");
    await context.sync();

    // Set properties based on the loaded and synced 
    // source range.
    const targetRange = sheet.getRange("B7:E7");
    targetRange.set(sourceRange); 
    targetRange.format.autofitColumns();
    await context.sync();
});

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.Range): void;

パラメーター

properties
Excel.Range

戻り値

void

setCellProperties(cellPropertiesData)

セル プロパティの 2D 配列に基づいて範囲を更新します。フォント、塗りつぶし、罫線、配置などをカプセル化します。Updates the range based on a 2D array of cell properties , encapsulating things like font, fill, borders, alignment, and so forth.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

setCellProperties(cellPropertiesData: SettableCellProperties[][]): void;

パラメーター

cellPropertiesData
SettableCellProperties[][]

各セルに設定するプロパティを表す2D 配列。A 2D array that represents which properties to set in each cell.

戻り値

void

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();

    // Creating the SettableCellProperties objects to use for the range.
    // In your add-in, these should be created once, outside the function.
    const topHeaderProps: Excel.SettableCellProperties = {
        // The style property takes a string matching the name of an Excel style.
        // Note that a style will overwrite any formatting,
        // so do not use the format property with the style property.
        style: "Heading1"
    };

    const headerProps: Excel.SettableCellProperties = {
        // Any subproperties of format that are not set will not be changed when these cell properties are set.
        format: {
            fill: {
                color: "Blue"
            },
            font: {
                color: "White",
                bold: true
            }
        }
    };

    const nonApplicableProps: Excel.SettableCellProperties = {
        format: {
            fill: {
                pattern: Excel.FillPattern.gray25
            },
            font: {
                color: "Gray",
                italic: true
            }
        }
    };

    const matchupScoreProps: Excel.SettableCellProperties = {
        format: {
            borders: {
                bottom: {
                    style: Excel.BorderLineStyle.continuous
                },
                left: {
                    style: Excel.BorderLineStyle.continuous
                },
                right: {
                    style: Excel.BorderLineStyle.continuous
                },
                top: {
                    style: Excel.BorderLineStyle.continuous
                }
            }
        }
    };

    const range = sheet.getRange("A1:E5");

    // You can use empty JSON objects to avoid changing a cell's properties.
    range.setCellProperties([
        [topHeaderProps, {}, {}, {}, {}],
        [{}, {}, headerProps, headerProps, headerProps],
        [{}, headerProps, nonApplicableProps, matchupScoreProps, matchupScoreProps],
        [{}, headerProps, matchupScoreProps, nonApplicableProps, matchupScoreProps],
        [{}, headerProps, matchupScoreProps, matchupScoreProps, nonApplicableProps]
    ]);

    sheet.getUsedRange().format.autofitColumns();
    await context.sync();
});

setColumnProperties(columnPropertiesData)

列プロパティの一次元配列に基づいて範囲を更新します。フォント、塗りつぶし、罫線、配置などをカプセル化します。Updates the range based on a single-dimensional array of column properties, encapsulating things like font, fill, borders, alignment, and so forth.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

setColumnProperties(columnPropertiesData: SettableColumnProperties[]): void;

パラメーター

columnPropertiesData
SettableColumnProperties[]

各列に設定するプロパティを表す配列。An array that represents which properties to set in each column.

戻り値

void

setDirty()

次の再計算が発生したときに再計算する範囲を設定します。Set a range to be recalculated when the next recalculation occurs.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

setDirty(): void;

戻り値

void

setRowProperties(rowPropertiesData)

行プロパティの一次元配列に基づいて範囲を更新します。フォント、塗りつぶし、罫線、配置などをカプセル化します。Updates the range based on a single-dimensional array of row properties, encapsulating things like font, fill, borders, alignment, and so forth.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

setRowProperties(rowPropertiesData: SettableRowProperties[]): void;

パラメーター

rowPropertiesData
SettableRowProperties[]

各行に設定するプロパティを表す配列。An array that represents which properties to set in each row.

戻り値

void

showCard()

アクティブ セルに多数の値が含まれる場合、そのセルのカードを表示します。Displays the card for an active cell if it has rich value content.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

showCard(): void;

戻り値

void

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の Excel Range オブジェクトは API オブジェクトであるのに対しtoJSON 、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.RangeData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.Range object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.RangeData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.RangeData;

戻り値

track()

ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。Track the object for automatic adjustment based on surrounding changes in the document. これは context.trackedObjects.add(thisObject) 呼び出しの省略形です。This call is a shorthand for context.trackedObjects.add(thisObject). ".sync" 呼び出し間で、かつ ".run" バッチの連続実行の外でこのオブジェクトを使用しているとき、オブジェクトであるプロパティを設定したか、あるメソッドを呼び出したときに "InvalidObjectPath" エラーが表示される場合、オブジェクトを最初に作成したときに、追跡対象オブジェクトの集まりにそのオブジェクトを追加しておく必要がありました。If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.

track(): Excel.Range;

戻り値

unmerge()

範囲内のセルを結合解除して別々のセルにします。Unmerge the range cells into separate cells.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

unmerge(): void;

戻り値

void

Examples

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "A1:C3";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.unmerge();
    return ctx.sync(); 
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

untrack()

前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。Release the memory associated with this object, if it has previously been tracked. これは context.trackedObjects.remove(thisObject) 呼び出しの省略形です。This call is shorthand for context.trackedObjects.remove(thisObject). 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. メモリ リリースを有効にするには、"context.sync()" を先に呼び出す必要があります。You will need to call "context.sync()" before the memory release takes effect.

untrack(): Excel.Range;

戻り値

Examples

Excel.run(async (context) => {
    const largeRange = context.workbook.getSelectedRange();
    largeRange.load(["rowCount", "columnCount"]);
    await context.sync();

    for (let i = 0; i < largeRange.rowCount; i++) {
        for (let j = 0; j < largeRange.columnCount; j++) {
            let cell = largeRange.getCell(i, j);
            cell.values = [[i *j]];

            // call untrack() to release the range from memory
            cell.untrack();
        }
    }

    await context.sync();
});