Excel JavaScript プレビュー API
新しい 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 プログラム に参加する必要がある場合があります。
次の表は API の簡潔な概要を示し、後続の API リスト テーブルでは詳細な一覧を示します。
機能領域 | 説明 | 関連オブジェクト |
---|---|---|
ドキュメント タスク | コメントをユーザーに割り当てられたタスクに変換します。 | DocumentTask、 DocumentTaskChange、 DocumentTaskChangeCollection、 DocumentTaskCollection |
リンクされたデータ型 | 外部ソースから Excel に接続されているデータ型のサポートを追加します。 | LinkedDataType、 LinkedDataTypeAddedEventArgs、 LinkedDataTypeCollection |
テーブルのスタイル | フォント、罫線、塗りつぶしの色、およびテーブル スタイルのその他の側面を制御します。 | テーブル、 ピボットテーブル、 スライサー |
API リスト
次の表に、現在プレビュー中の Excel JavaScript API の一覧を示します。 すべての Excel JavaScript API (プレビュー API と以前にリリースされた API を含む) の完全な一覧については、 すべての Excel JavaScript API を参照してください。
クラス | フィールド | 説明 |
---|---|---|
Application | formatStaleValues | [計算オプション] 内の [古い値の書式設定] オプションを有効または無効にするかどうかを指定します。 |
Base64EncodedImage | data | base64 文字列エンコード。 |
type | エンコードされたイメージのファイルの種類。 | |
グラフ | getDataRange() | グラフ全体のデータ ソースを取得します。 |
getDataRangeOrNullObject() | グラフ全体のデータ ソースを取得します。 | |
CheckboxCellControl | type | セル内の対話可能なコントロールを表します。 |
コメント | assignTask(assignee: Excel.EmailIdentity) | コメントにアタッチされたタスクを、割り当て先として指定されたユーザーに割り当てます。 |
getTask() | このコメントに関連付けられているタスクを取得します。 | |
getTaskOrNullObject() | このコメントに関連付けられているタスクを取得します。 | |
CommentReply | assignTask(assignee: Excel.EmailIdentity) | コメントにアタッチされたタスクを、特定のユーザーに単独の担当者として割り当てます。 |
getTask() | このコメント応答のスレッドに関連付けられているタスクを取得します。 | |
getTaskOrNullObject() | このコメント応答のスレッドに関連付けられているタスクを取得します。 | |
DocumentTask | assign(assignee: Excel.EmailIdentity) | タスクにアタッチされている担当者の一覧に、指定したユーザーを追加します。 |
担当者 | タスクの担当者のコレクションを返します。 | |
変更 | タスクの変更レコードを取得します。 | |
comment | タスクに関連付けられているコメントを取得します。 | |
completedBy | タスクを完了した最新のユーザーを取得します。 | |
CompletedDateTime | タスクが完了した日時を取得します。 | |
createdBy | タスクを作成したユーザーを取得します。 | |
createdDateTime | タスクが作成された日付と時刻を取得します。 | |
id | タスクの ID を取得します。 | |
percentComplete | タスクの完了率を指定します。 | |
優先 順位 | タスクの優先度を指定します。 | |
startAndDueDateTime | タスクを開始する日時と期限を取得または設定します。 | |
title | タスクのタイトルを指定します。 | |
unassign(assignee: Excel.EmailIdentity) | タスクにアタッチされている担当者の一覧から、指定したユーザーを削除します。 | |
unassignAll() | タスクにアタッチされている担当者の一覧からすべてのユーザーを削除します。 | |
DocumentTaskChange | 担当者 | 変更アクションのタスク assign に割り当てられたユーザー、または変更アクションのタスクから割り当てられていないユーザーを unassign 表します。 |
changedBy | タスクを変更したユーザーの ID を表します。 | |
commentId | タスクの変更がアンカーされるコメントまたはコメント応答の ID を表します。 | |
createdDateTime | タスク変更レコードの作成日時を表します。 | |
dueDateTime | タスクの期限日時を表します。 | |
id | タスク変更の一意の GUID。 | |
percentComplete | タスクの完了率を表します。 | |
優先 順位 | タスクの優先度を表します。 | |
startDateTime | タスクの開始日と時刻を表します。 | |
title | タスクのタイトルを表します。 | |
type | タスク変更レコードのアクションの種類を表します。 | |
undoChangeId | 変更アクションで元に DocumentTaskChange.id 戻されたプロパティを undo 表します。 |
|
DocumentTaskChangeCollection | getCount() | タスクのコレクション内の変更レコードの数を取得します。 |
getItemAt(index: number) | コレクション内のインデックスを使用して、タスク変更レコードを取得します。 | |
items | このコレクション内に読み込まれた子アイテムを取得します。 | |
DocumentTaskCollection | getCount() | コレクション内のタスクの数を取得します。 |
getItem(key: string) | ID を使用してタスクを取得します。 | |
getItemAt(index: number) | コレクション内のインデックスによってタスクを取得します。 | |
getItemOrNullObject(key: string) | ID を使用してタスクを取得します。 | |
items | このコレクション内に読み込まれた子アイテムを取得します。 | |
DocumentTaskSchedule | dueDateTime | タスクの期限が設定されている日付と時刻を取得します。 |
startDateTime | タスクを開始する日付と時刻を取得します。 | |
EmailIdentity | displayName | ユーザーの表示名を表します。 |
ユーザーのメールを表します。 | ||
id | ユーザーの一意の ID を表します。 | |
EmptyCellControl | type | |
EntityArrayCardLayout | arrayProperty | カードに表示される配列を含むプロパティの名前を表します。 |
columnsToReport | カード要求が配列内にある列の数を表します。 | |
displayName | カードに表示される配列を含むプロパティの名前を表します。 | |
firstRowIsHeader | 配列の最初の行をヘッダーとして扱うかどうかを表します。 | |
レイアウト | このレイアウトの種類を表します。 | |
rowsToReport | カード要求が配列内にある行数を表します。 | |
EntityCardLayout | レイアウト | このレイアウトの種類を表します。 |
ExternalCodeServiceObjectCellValue | Python_str | このオブジェクトで使用する場合の str() 関数の出力を表します。 |
Python_type | このオブジェクトの完全な型名を表します。 | |
Python_typeName | このオブジェクトの短い型名を表します。 | |
basicType | この値を持つセルの によって Range.valueTypes 返される値を表します。 |
|
basicValue | この値を持つセルの によって Range.values 返される値を表します。 |
|
language | この外部コード サービスのランタイム言語を表します。 | |
プレビュー | セルに表示されるプレビュー値を表します。 | |
type | このセル値の型を表します。 | |
Identity | displayName | ユーザーの表示名を表します。 |
id | ユーザーの一意の ID を表します。 | |
LinkedDataType | dataProvider | リンクされたデータ型のデータ プロバイダーの名前。 |
lastRefreshed | リンクされたデータ型が最後に更新されたときにブックが開かれた後のローカル タイム ゾーンの日付と時刻。 | |
name | リンクされたデータ型の名前。 | |
periodicRefreshInterval | リンクされたデータ型が "Periodic" に設定されている場合 refreshMode に更新される頻度 (秒単位)。 |
|
refreshMode | リンクされたデータ型のデータを取得するメカニズム。 | |
requestRefresh() | リンクされたデータ型を更新するように要求します。 | |
requestSetRefreshMode(refreshMode: Excel.LinkedDataTypeRefreshMode) | このリンクされたデータ型の更新モードを変更するように要求します。 | |
serviceId | リンクされたデータ型の一意の ID。 | |
supportedRefreshModes | リンクされたデータ型でサポートされているすべての更新モードを持つ配列を返します。 | |
LinkedDataTypeAddedEventArgs | serviceId | 新しいリンクされたデータ型の一意の ID。 |
source | イベントのソースを取得します。 | |
type | イベントの種類を取得します。 | |
LinkedDataTypeCollection | getCount() | コレクション内のリンクされたデータ型の数を取得します。 |
getItem(key: number) | サービス ID 別のリンクされたデータ型を取得します。 | |
getItemAt(index: number) | コレクション内のインデックスによってリンクされたデータ型を取得します。 | |
getItemOrNullObject(key: number) | ID でリンクされたデータ型を取得します。 | |
items | このコレクション内に読み込まれた子アイテムを取得します。 | |
requestRefreshAll() | コレクション内のすべてのリンクされたデータ型を更新するように要求します。 | |
LocalImage | getBase64EncodedImageData(cacheUid: string) | キャッシュ一意識別子 (UID) を使用して、共有イメージ キャッシュに格納されている base64 でエンコードされたイメージ データを取得します。 |
LocalImageCellValue | altText | アクセシビリティ シナリオで使用される代替テキストを表し、イメージが何を表すのかを表します。 |
帰属 | このイメージのソースとライセンスの要件を説明する属性情報を表します。 | |
basicType | この値を持つセルの によって Range.valueTypes 返される値を表します。 |
|
basicValue | この値を持つセルの によって Range.values 返される値を表します。 |
|
image | キャッシュまたはエンコードされたイメージ自体を表します。 | |
プロバイダー | イメージを提供したエンティティまたは個人を表す情報を表します。 | |
type | このセル値の型を表します。 | |
LocalImageCellValueCacheId | cacheUid | キャッシュに表示されるイメージの UID を表します。 |
MixedCellControl | type | |
NamedSheetViewCollection | getItemOrNullObject(key: string) | 名前を使用してシート ビューを取得します。 |
PivotLayout | getCell(dataHierarchy: DataPivotHierarchy | string, rowItems: Array<PivotItem | string>, columnItems: Array<PivotItem | string>) | データ階層と、それぞれの階層の行および列の項目に基づいて、ピボットテーブル内の一意のセルを取得します。 |
pivotStyle | ピボットテーブルに適用されるスタイル。 | |
setStyle(style: string |PivotTableStyle |BuiltInPivotTableStyle) | ピボットテーブルに適用されるスタイルを設定します。 | |
PythonErrorCellValue | basicType | この値を持つセルの によって Range.valueTypes 返される値を表します。 |
basicValue | この値を持つセルの によって Range.values 返される値を表します。 |
|
errorType | の型を表します ErrorCellValue 。 |
|
type | このセル値の型を表します。 | |
Query | delete() | クエリと関連付けられている接続を削除します。 |
refresh() | クエリを更新します。 | |
QueryCollection | refreshAll() | すべてのクエリを更新します。 |
Range | コントロール | この範囲に適用されたセル コントロールにアクセスします。 |
resetContent() | 範囲内のすべてのセルを既定の状態に設定します。 | |
RangeAreas | ||
RefreshModeChangedEventArgs | refreshMode | リンクされたデータ型の更新モード。 |
serviceId | 更新モードが変更されたオブジェクトの一意の ID。 | |
source | イベントのソースを取得します。 | |
type | イベントの種類を取得します。 | |
RefreshRequestCompletedEventArgs | 更新 | 更新要求が成功したかどうかを示します。 |
serviceId | 更新要求が完了したオブジェクトの一意の ID。 | |
source | イベントのソースを取得します。 | |
type | イベントの種類を取得します。 | |
警告 | 更新要求から生成された警告を含む配列。 | |
ShapeCollection | addLocalImageReference(address: string) | セル アドレスに格納されているローカル イメージの参照を作成し、セルの上に浮動図形として表示します。 |
addSvg(xml: string) | XML 文字列からスケーラブルなベクター グラフィックス (SVG) を作成し、それをワークシートに追加します。 | |
Slicer | nameInFormula | 数式で使用するスライサーの名前を表します。 |
setStyle(style: string |SlicerStyle |BuiltInSlicerStyle) | スライサーに適用されるスタイルを設定します。 | |
slicerStyle | スライサーに適用されるスタイル。 | |
Table | clearStyle() | 既定のテーブル スタイルを使用するようにテーブルを変更します。 |
onFiltered | 特定のテーブルにフィルターが適用されると発生します。 | |
setStyle(style: string |TableStyle |BuiltInTableStyle) | テーブルに適用されるスタイルを設定します。 | |
tableStyle | テーブルに適用されるスタイル。 | |
TableCollection | onFiltered | ブックまたはワークシート内の任意のテーブルにフィルターを適用すると発生します。 |
TableFilteredEventArgs | tableId | フィルターが適用されるテーブルの ID を取得します。 |
type | イベントの種類を取得します。 | |
worksheetId | テーブルを含むワークシートの ID を取得します。 | |
TimeoutErrorCellValue | basicType | この値を持つセルの によって Range.valueTypes 返される値を表します。 |
basicValue | この値を持つセルの によって Range.values 返される値を表します。 |
|
errorSubType | の型を表します TimeoutErrorCellValue 。 |
|
errorType | の型を表します ErrorCellValue 。 |
|
type | このセル値の型を表します。 | |
UnknownCellControl | type | |
ブック | externalCodeServiceTimeout | 外部コード サービスに依存する数式が完了するまでに割り当てられる最大時間を秒単位で指定します。 |
linkedDataTypes | ブックの一部であるリンクされたデータ型のコレクションを返します。 | |
localImage | ブックに LocalImage 関連付けられているオブジェクトを返します。 |
|
showPivotFieldList | ピボットテーブルのフィールド リスト ペインをブック レベルで表示するかどうかを指定します。 | |
タスク | ブックに存在するタスクのコレクションを返します。 | |
use1904DateSystem | ブックの日付を 1904 年から計算する場合、true となります。 | |
Worksheet | onFiltered | 特定のワークシートにフィルターが適用されると発生します。 |
タスク | ワークシートに存在するタスクのコレクションを返します。 | |
WorksheetCollection | addFromBase64(base64File: string, sheetNamesToInsert?: string[], positionType?: Excel.WorksheetPositionType, relativeTo?: Worksheet | string) | あるブックの指定されたワークシートを現在のブックに挿入します。 |
onFiltered | ブック内でワークシートのフィルターが適用されたときに発生します。 | |
WorksheetFilteredEventArgs | type | イベントの種類を取得します。 |
worksheetId | フィルターが適用されるワークシートの ID を取得します。 |
関連項目
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
Office Add-ins