次の方法で共有


Excel.Interfaces.RangeData interface

range.toJSON() を呼び出すことによって返されるデータを記述するインターフェイス。

プロパティ

address

範囲参照を A1 スタイルで指定します。 アドレス値にはシート参照が含まれます (例: "Sheet1!A1:B4")。

addressLocal

ユーザーの言語で指定した範囲の範囲参照を表します。

cellCount

範囲内のセルの数を指定します。 セルの数が 2^31-1 (2,147,483,647) を超えると、この API は -1 を返します。

columnCount

範囲内の列の合計数を指定します。

columnHidden

現在の範囲内のすべての列が非表示の場合にを表します。 値は、範囲内のすべての列が非表示の場合に true されます。 値は、範囲内の列が非表示でない場合に false されます。 値は、範囲内の一部の列が非表示で、同じ範囲内の他の列が非表示でない場合に null されます。

columnIndex

範囲内の最初のセルの列番号を指定します。 0 を起点とする番号になります。

conditionalFormats

範囲と交差する ConditionalFormats のコレクション。

control

この範囲に適用されたセル コントロールにアクセスします。 範囲に複数のセル コントロールがある場合は、 EmptyCellControlが返されます。

dataValidation

dataValidation オブジェクトを返します。

format

Format オブジェクト (範囲のフォント、塗りつぶし、罫線、配置などのプロパティをカプセル化するオブジェクト) を返します。

formulas

A1 スタイル表記の数式を表します。 セルに数式がない場合は、代わりに値が返されます。

formulasLocal

ユーザーの言語と数値書式ロケールで、A1 スタイル表記の数式を表します。 たとえば、英語の数式 "=SUM(A1, 1.5)" は、ドイツ語では "=SUMME(A1; 1,5)" になります。 セルに数式がない場合は、代わりに値が返されます。

formulasR1C1

R1C1 スタイル表記の数式を表します。 セルに数式がない場合は、代わりに値が返されます。

hasSpill

すべてのセルにスピル ボーダーがあるかどうかを表します。 すべてのセルにスピル罫線がある場合は true を返し、すべてのセルにスピル罫線がない場合は false を返します。 範囲内にスピル境界があるセルとスピル境界のないセルがある場合は、 null を返します。

height

範囲の上端から範囲の下端までの 100% ズームの距離をポイント単位で返します。

hidden

現在の範囲内のすべてのセルが非表示かどうかを表します。 値は、範囲内のすべてのセルが非表示の場合に true されます。 値は、範囲内のセルが非表示でない場合に false されます。 値は、範囲内の一部のセルが非表示で、同じ範囲内の他のセルが非表示でない場合に null されます。

hyperlink

現在の範囲のハイパーリンクを表します。

isEntireColumn

現在の範囲が列全体であるかどうかを表します。

isEntireRow

現在の範囲が行全体であるかどうかを表します。

left

ワークシートの左端から範囲の左端までの 100% ズームの距離をポイント単位で返します。

linkedDataTypeState

各セルのデータ型の状態を表します。

numberFormat

指定した範囲の Excel の数値書式コードを表します。 Excel の数値書式の詳細については、「数値書式 コード」を参照してください。

numberFormatCategories

各セルの数値形式のカテゴリを表します。

numberFormatLocal

ユーザーの言語設定に基づいて、指定した範囲の Excel の数値書式コードを表します。 excel では、 numberFormatLocal プロパティを取得または設定するときに、言語や書式の強制は実行されません。 返されるテキストは、システム設定で指定された言語に基づいて、ローカル形式の文字列を使用します。

rowCount

範囲に含まれる行の合計数を返します。

rowHidden

現在の範囲内のすべての行が非表示になっているかどうかを表します。 値は、範囲内のすべての行が非表示の場合に true されます。 値は、範囲内の行が非表示でない場合に false されます。 値は、範囲内の一部の行が非表示で、同じ範囲内の他の行が非表示でない場合に null されます。

rowIndex

範囲に含まれる最初のセルの行番号を返します。 0 を起点とする番号になります。

savedAsArray

すべてのセルを配列数式として保存するかどうかを表します。 すべてのセルを配列数式として保存する場合は true 、すべてのセルを配列数式として保存しない場合は false を返します。 一部のセルが配列数式として保存され、一部のセルが保存されない場合は、 null を返します。

style

現在の範囲のスタイルを表します。 セルのスタイルに一貫性がない場合は、 null が返されます。 カスタム スタイルの場合、スタイル名が返されます。 組み込みのスタイルの場合、 BuiltInStyle 列挙型の値を表す文字列が返されます。

text

指定した範囲のテキスト値。 テキスト値は、セルの幅には依存しません。 Excel UI で発生する数値記号 (#) の置換は、API によって返されるテキスト値には影響しません。

top

ワークシートの上端から範囲の上端までの 100% ズームの距離をポイント単位で返します。

values

指定した範囲の Raw 値を表します。 返されるデータは、文字列、数値、またはブール値のいずれかです。 エラーが含まれているセルは、エラー文字列を返します。 返される値が正符号 ("+")、マイナス ("-")、または等号 ("=") で始まる場合、Excel はこの値を数式として解釈します。

valuesAsJson

この範囲内のセル内の値の JSON 表現。 Range.values とは異なり、Range.valuesAsJsonではセルに含めることができるすべてのデータ型がサポートされます。 たとえば、標準のブール値、数値、および文字列値に加えて、書式設定された数値と Web イメージが含まれます。 この API から返されるデータは、常に en-US ロケールと一致します。 ユーザーの表示ロケールでデータを取得するには、 Range.valuesAsJsonLocalを使用します。

valuesAsJsonLocal

この範囲内のセル内の値の JSON 表現。 Range.values とは異なり、Range.valuesAsJsonLocalではセルに含めることができるすべてのデータ型がサポートされます。 たとえば、標準のブール値、数値、および文字列値に加えて、書式設定された数値と Web イメージが含まれます。 この API から返されるデータは、常にユーザーの表示ロケールと一致します。 ロケールに依存しないデータを取得するには、 Range.valuesAsJsonを使用します。

valueTypes

各セル内のデータの種類を指定します。

width

範囲の左端から範囲の右端までの 100% ズームの距離をポイント単位で返します。

プロパティの詳細

address

範囲参照を A1 スタイルで指定します。 アドレス値にはシート参照が含まれます (例: "Sheet1!A1:B4")。

address?: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.1 ]

addressLocal

ユーザーの言語で指定した範囲の範囲参照を表します。

addressLocal?: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.1 ]

cellCount

範囲内のセルの数を指定します。 セルの数が 2^31-1 (2,147,483,647) を超えると、この API は -1 を返します。

cellCount?: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.1 ]

columnCount

範囲内の列の合計数を指定します。

columnCount?: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.1 ]

columnHidden

現在の範囲内のすべての列が非表示の場合にを表します。 値は、範囲内のすべての列が非表示の場合に true されます。 値は、範囲内の列が非表示でない場合に false されます。 値は、範囲内の一部の列が非表示で、同じ範囲内の他の列が非表示でない場合に null されます。

columnHidden?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.2 ]

columnIndex

範囲内の最初のセルの列番号を指定します。 0 を起点とする番号になります。

columnIndex?: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.1 ]

conditionalFormats

範囲と交差する ConditionalFormats のコレクション。

conditionalFormats?: Excel.Interfaces.ConditionalFormatData[];

プロパティ値

注釈

[ API セット: ExcelApi 1.6 ]

control

注意

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

この範囲に適用されたセル コントロールにアクセスします。 範囲に複数のセル コントロールがある場合は、 EmptyCellControlが返されます。

control?: CellControl;

プロパティ値

注釈

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

dataValidation

dataValidation オブジェクトを返します。

dataValidation?: Excel.Interfaces.DataValidationData;

プロパティ値

注釈

[ API セット: ExcelApi 1.8 ]

format

Format オブジェクト (範囲のフォント、塗りつぶし、罫線、配置などのプロパティをカプセル化するオブジェクト) を返します。

format?: Excel.Interfaces.RangeFormatData;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

formulas

A1 スタイル表記の数式を表します。 セルに数式がない場合は、代わりに値が返されます。

formulas?: any[][];

プロパティ値

any[][]

注釈

[ API セット: ExcelApi 1.1 ]

formulasLocal

ユーザーの言語と数値書式ロケールで、A1 スタイル表記の数式を表します。 たとえば、英語の数式 "=SUM(A1, 1.5)" は、ドイツ語では "=SUMME(A1; 1,5)" になります。 セルに数式がない場合は、代わりに値が返されます。

formulasLocal?: any[][];

プロパティ値

any[][]

注釈

[ API セット: ExcelApi 1.1 ]

formulasR1C1

R1C1 スタイル表記の数式を表します。 セルに数式がない場合は、代わりに値が返されます。

formulasR1C1?: any[][];

プロパティ値

any[][]

注釈

[ API セット: ExcelApi 1.2 ]

hasSpill

すべてのセルにスピル ボーダーがあるかどうかを表します。 すべてのセルにスピル罫線がある場合は true を返し、すべてのセルにスピル罫線がない場合は false を返します。 範囲内にスピル境界があるセルとスピル境界のないセルがある場合は、 null を返します。

hasSpill?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.12 ]

height

範囲の上端から範囲の下端までの 100% ズームの距離をポイント単位で返します。

height?: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.10 ]

hidden

現在の範囲内のすべてのセルが非表示かどうかを表します。 値は、範囲内のすべてのセルが非表示の場合に true されます。 値は、範囲内のセルが非表示でない場合に false されます。 値は、範囲内の一部のセルが非表示で、同じ範囲内の他のセルが非表示でない場合に null されます。

hidden?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.2 ]

現在の範囲のハイパーリンクを表します。

hyperlink?: Excel.RangeHyperlink;

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

isEntireColumn

現在の範囲が列全体であるかどうかを表します。

isEntireColumn?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

isEntireRow

現在の範囲が行全体であるかどうかを表します。

isEntireRow?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

left

ワークシートの左端から範囲の左端までの 100% ズームの距離をポイント単位で返します。

left?: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.10 ]

linkedDataTypeState

各セルのデータ型の状態を表します。

linkedDataTypeState?: Excel.LinkedDataTypeState[][];

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

numberFormat

指定した範囲の Excel の数値書式コードを表します。 Excel の数値書式の詳細については、「数値書式 コード」を参照してください。

numberFormat?: any[][];

プロパティ値

any[][]

注釈

[ API セット: ExcelApi 1.1 ]

numberFormatCategories

各セルの数値形式のカテゴリを表します。

numberFormatCategories?: Excel.NumberFormatCategory[][];

プロパティ値

注釈

[ API セット: ExcelApi 1.12 ]

numberFormatLocal

ユーザーの言語設定に基づいて、指定した範囲の Excel の数値書式コードを表します。 excel では、 numberFormatLocal プロパティを取得または設定するときに、言語や書式の強制は実行されません。 返されるテキストは、システム設定で指定された言語に基づいて、ローカル形式の文字列を使用します。

numberFormatLocal?: any[][];

プロパティ値

any[][]

注釈

[ API セット: ExcelApi 1.7 ]

rowCount

範囲に含まれる行の合計数を返します。

rowCount?: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.1 ]

rowHidden

現在の範囲内のすべての行が非表示になっているかどうかを表します。 値は、範囲内のすべての行が非表示の場合に true されます。 値は、範囲内の行が非表示でない場合に false されます。 値は、範囲内の一部の行が非表示で、同じ範囲内の他の行が非表示でない場合に null されます。

rowHidden?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.2 ]

rowIndex

範囲に含まれる最初のセルの行番号を返します。 0 を起点とする番号になります。

rowIndex?: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.1 ]

savedAsArray

すべてのセルを配列数式として保存するかどうかを表します。 すべてのセルを配列数式として保存する場合は true 、すべてのセルを配列数式として保存しない場合は false を返します。 一部のセルが配列数式として保存され、一部のセルが保存されない場合は、 null を返します。

savedAsArray?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.12 ]

style

現在の範囲のスタイルを表します。 セルのスタイルに一貫性がない場合は、 null が返されます。 カスタム スタイルの場合、スタイル名が返されます。 組み込みのスタイルの場合、 BuiltInStyle 列挙型の値を表す文字列が返されます。

style?: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.7 ]

text

指定した範囲のテキスト値。 テキスト値は、セルの幅には依存しません。 Excel UI で発生する数値記号 (#) の置換は、API によって返されるテキスト値には影響しません。

text?: string[][];

プロパティ値

string[][]

注釈

[ API セット: ExcelApi 1.1 ]

top

ワークシートの上端から範囲の上端までの 100% ズームの距離をポイント単位で返します。

top?: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.10 ]

values

指定した範囲の Raw 値を表します。 返されるデータは、文字列、数値、またはブール値のいずれかです。 エラーが含まれているセルは、エラー文字列を返します。 返される値が正符号 ("+")、マイナス ("-")、または等号 ("=") で始まる場合、Excel はこの値を数式として解釈します。

values?: any[][];

プロパティ値

any[][]

注釈

[ API セット: ExcelApi 1.1 ]

valuesAsJson

この範囲内のセル内の値の JSON 表現。 Range.values とは異なり、Range.valuesAsJsonではセルに含めることができるすべてのデータ型がサポートされます。 たとえば、標準のブール値、数値、および文字列値に加えて、書式設定された数値と Web イメージが含まれます。 この API から返されるデータは、常に en-US ロケールと一致します。 ユーザーの表示ロケールでデータを取得するには、 Range.valuesAsJsonLocalを使用します。

valuesAsJson?: CellValue[][];

プロパティ値

注釈

[ API セット: ExcelApi 1.16 ]

valuesAsJsonLocal

この範囲内のセル内の値の JSON 表現。 Range.values とは異なり、Range.valuesAsJsonLocalではセルに含めることができるすべてのデータ型がサポートされます。 たとえば、標準のブール値、数値、および文字列値に加えて、書式設定された数値と Web イメージが含まれます。 この API から返されるデータは、常にユーザーの表示ロケールと一致します。 ロケールに依存しないデータを取得するには、 Range.valuesAsJsonを使用します。

valuesAsJsonLocal?: CellValue[][];

プロパティ値

注釈

[ API セット: ExcelApi 1.16 ]

valueTypes

各セル内のデータの種類を指定します。

valueTypes?: Excel.RangeValueType[][];

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

width

範囲の左端から範囲の右端までの 100% ズームの距離をポイント単位で返します。

width?: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.10 ]