新しい Excel JavaScript API は最初に "プレビュー" で導入され、その後、十分なテストが行われ、ユーザー フィードバックが得られてから、番号付きの特定の要件セットの一部になります。
注:
プレビュー API は変更されることがあります。運用環境での使用は意図されていません。 試用はテスト環境と開発環境に限定することをお勧めします。 運用環境やビジネス上重要なドキュメントでプレビュー API を使用しないでください。
プレビュー API を使用するには:
-
Office.js コンテンツ配信ネットワーク (CDN) から Office JavaScript API ライブラリのプレビュー版を使用する必要があります。 TypeScript コンパイルおよび IntelliSense の 型定義ファイルは CDN で見つかり、DefinitelyTyped にあります。 これらの種類は、
npm install --save-dev @types/office-js-previewを使用してインストールできます (以前にインストールしたことがある場合は、@types/office-jsの種類を削除してください)。 - 最新の Office ビルドにアクセスするには、 Microsoft 365 Insider Program への参加が必要な場合があります。
API リスト
次の表に、現在プレビュー中の Excel JavaScript API を示します。 すべての Excel JavaScript API (プレビュー API と以前にリリースされた API を含む) の完全な一覧については、 すべての Excel JavaScript API を参照してください。
| クラス | フィールド | 説明 |
|---|---|---|
| Base64EncodedImage | data | Base64 でエンコードされた文字列。 |
| type | Base64 でエンコードされたイメージのファイルの種類。 | |
| BusyErrorCellValue | previousValue | 必要に応じて、#BUSY! エラーは、現在の一時的な操作が開始される前にセルに格納されている以前の値を格納する可能性があります。 |
| グラフ | getDataRange() | グラフ全体のデータ ソースを取得します。 |
| getDataRangeOrNullObject() | グラフ全体のデータ ソースを取得します。 | |
| EntityArrayCardLayout | arrayProperty | カードに表示される配列を含むプロパティの名前を表します。 |
| columnsToReport | カード クレームが配列内の列の数を表します。 | |
| displayName | カードに表示される配列を含むプロパティの名前を表します。 | |
| firstRowIsHeader | 配列の最初の行をヘッダーとして扱うかどうかを表します。 | |
| レイアウト | このレイアウトの種類を表します。 | |
| rowsToReport | カード クレームが配列内の行数を表します。 | |
| ExternalCodeServiceObjectCellValue | Python_str | このオブジェクトで使用された場合の str() 関数の出力を表します。 |
| Python_type | このオブジェクトの完全な型名を表します。 | |
| Python_typeName | このオブジェクトの短い型名を表します。 | |
| basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
|
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| language | この外部コード サービスのランタイム言語を表します。 | |
| プレビュー | セルに表示されるプレビュー値を表します。 | |
| プロバイダー | この ExternalCodeServiceObjectCellValueのデータを提供したサービスに関する情報を表します。 |
|
| type | このセル値の型を表します。 | |
| LocalImageCellValue | 代替テキスト | 画像が表す内容を説明するために、アクセシビリティ シナリオで使用される代替テキストを表します。 |
| 属性 | このイメージのソースとライセンスの要件を説明するための属性情報を表します。 | |
| basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
|
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| image | 画像そのもの (キャッシュまたはエンコード) を表します。 | |
| プロバイダー | 画像を提供したエンティティまたは個人を説明する情報を表します。 | |
| type | このセル値の型を表します。 | |
| LocalImageCellValueCacheId | cachedUid | キャッシュに表示されるイメージの UID を表します。 |
| NameErrorCellValue | errorSubType |
NameErrorCellValueの種類を表します。 |
| NamedSheetViewCollection | getItemOrNullObject(key: string) | 名前を使用してシート ビューを取得します。 |
| NotAvailableErrorCellValue | errorSubType |
NotAvailableErrorCellValueの種類を表します。 |
| PythonErrorCellValue | basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| duringInitialization | この #PYTHON! エラーが (ワークシートのセル数式からではなく) ブックの初期化 Python コードから発生したことを示します。 |
|
| errorType |
ErrorCellValueの種類を表します。 |
|
| type | このセル値の型を表します。 | |
| RequestContext | sensitivityLabelsCatalog | [API セット: ExcelApi ベータ版 (プレビューのみ)] |
| setInvocation(invocation: { invocationId: number isInSyncExecution: boolean }) | ||
| SensitivityLabel | getCurrentOrNullObject() | ユーザーのブックに存在する現在のラベル情報を取得します。 |
| tryToUpdate(labelId: string, options?: Excel.SensitivityLabelTryUpdateOptions) | ユーザーのブックで指定された秘密度ラベルに更新しようとします。 | |
| SensitivityLabelAbacAttribute | dataType | 属性のデータ型を取得します。 |
| displayName | 属性の表示名を取得します。 | |
| displayOrder | 属性の表示順を取得します。 | |
| isActive | 属性がアクティブかどうかを示す値を取得します。 | |
| isMultiValued | 属性が複数の値をサポートしているかどうかを示す値を取得します。 | |
| values | 属性の値を取得します。 | |
| SensitivityLabelAbacAttributeValue | displayName | 属性値の表示名を取得します。 |
| displayOrder | 属性値の表示順を取得します。 | |
| id | 属性値の一意の識別子を取得します。 | |
| isActive | 属性値がアクティブかどうかを示す値を取得します。 | |
| SensitivityLabelDetails | abacAttributeValues | このラベルに関連付けられている ABAC (属性ベースのアクセス制御) 属性値を取得します。 |
| 子供 | 秘密度ラベルのサブラベルを取得します。 | |
| color | 秘密度ラベルの色を取得します。 | |
| id | 秘密度ラベルの一意識別子 (GUID) を取得します。 | |
| isAbacAttributesRequired | このラベルに ABAC (属性ベースのアクセス制御) 属性が必要かどうかを示す値を取得します。 | |
| isAbacEnabled | このラベルに対して ABAC (属性ベースのアクセス制御) が有効になっているかどうかを示す値を取得します。 | |
| isEnabled | ラベルが有効かどうかを示す値を取得します。 | |
| name | 秘密度ラベルの名前を取得します。 | |
| order | 秘密度ラベルの優先度を取得し、最も低い優先度は 0 です。 | |
| protectionType | このラベルによって提供される保護の種類を示す値を取得します。 | |
| siteId | 秘密度ラベルが属するテナントの一意識別子 (GUID) を取得します。 | |
| ヒント | 秘密度ラベルの説明を取得します。 | |
| SensitivityLabelDetailsCollection | getFirst() | このコレクション内の最初の SensitivityLabelDetails オブジェクトを取得します。 |
| getFirstOrNullObject() | このコレクション内の最初の SensitivityLabelDetails オブジェクトを取得します。 |
|
| items | このコレクション内に読み込まれた子アイテムを取得します。 | |
| SensitivityLabelTryUpdateOptions | abacAttributes | 指定した場合は、ラベルに適用する ABAC 属性を指定します。 |
| SensitivityLabelsCatalog | getAttributes() | 現在のユーザーが使用できる ABAC (属性ベースのアクセス制御) 属性を取得します。 |
| getLabelingCapabilities | Excel でサポートされているラベル付け機能を取得します。 | |
| getLabelingCapability | 秘密度ラベルのカタログが Excel で有効になっているかどうかを取得します。 | |
| getLabels() | 現在のユーザーが使用できる秘密度ラベルを取得します。 | |
| TimeoutErrorCellValue | basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| errorSubType |
TimeoutErrorCellValueの種類を表します。 |
|
| errorType |
ErrorCellValueの種類を表します。 |
|
| type | このセル値の型を表します。 | |
| Window | rangeSelection | ウィンドウ内の範囲の選択を取得します。 |
| ブック | sensitivityLabel | ブックの秘密度ラベルを返します。 |
関連項目
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
Office Add-ins