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 Program への参加が必要な場合があります。

API リスト

次の表に、現在プレビュー中の Excel JavaScript API を示します。 すべての Excel JavaScript API (プレビュー API と以前にリリースされた API を含む) の完全な一覧については、 すべての Excel JavaScript API を参照してください。

クラス フィールド 説明
Application formatStaleValues [計算オプション] 内の [古い値を書式設定] オプションを有効か無効かを指定します。
AutorunEventCompletedOptions allowEvent イベントの続行を許可するかどうかを指定します。
autorunEventType 許可されている場合に完了する自動実行イベントの種類を指定します。
message 指定された場合、イベントの続行が許可されていない場合のオプションのエラー メッセージを指定します。
Base64EncodedImage data Base64 でエンコードされた文字列。
type Base64 でエンコードされたイメージのファイルの種類。
グラフ getDataRange() グラフ全体のデータ ソースを取得します。
getDataRangeOrNullObject() グラフ全体のデータ ソースを取得します。
コメント assignTask(assignee: Excel.EmailIdentity) コメントに添付されたタスクを、指定されたユーザーに担当者として割り当てます。
getTask() このコメントに関連付けられているタスクを取得します。
getTaskOrNullObject() このコメントに関連付けられているタスクを取得します。
CommentReply assignTask(assignee: Excel.EmailIdentity) コメントに添付されたタスクを、特定のユーザーに唯一の担当者として割り当てます。
getTask() このコメント返信のスレッドに関連付けられているタスクを取得します。
getTaskOrNullObject() このコメント返信のスレッドに関連付けられているタスクを取得します。
DatetimeFormatInfo shortDateTimePattern 短い日付と時刻の値の書式文字列を取得します。
DocumentTask assign(assignee: Excel.EmailIdentity) 指定されたユーザーを、タスクに関連付けられている担当者のリストに追加します。
担当者 タスクの担当者のコレクションを返します。
変更 タスクの変更レコードを取得します。
comment タスクに関連付けられているコメントを取得します。
completedBy タスクを完了した最新のユーザーを取得します。
CompletedDateTime タスクが完了した日時を取得します。
createdBy タスクを作成したユーザーを取得します。
createdDateTime タスクが作成された日時を取得します。
id タスクの ID を取得します。
percentComplete タスクの完了率を指定します。
priority タスクの優先順位を指定します。
startAndDueDateTime タスクを開始する日時と期限を指定します。
title タスクのタイトルを指定します。
unassign(assignee: Excel.EmailIdentity) タスクにアタッチされている担当者のリストから指定されたユーザーを削除します。
unassignAll() タスクに関連付けられている担当者のリストからすべてのユーザーを削除します。
DocumentTaskChange 担当者 assign変更アクションのタスクに割り当てられているユーザー、またはunassign変更アクションのタスクから割り当てられていないユーザーを表します。
changedBy タスクを変更したユーザーの ID を表します。
commentId タスク変更が固定されているコメントまたはコメント返信の ID を表します。
createdDateTime タスク変更レコードの作成日時を表します。
dueDateTime タスクの期限の日付と時刻を表します。
id タスク変更の一意の GUID。
percentComplete タスクの完了率を表します。
priority タスクの優先順位を表します。
startDateTime タスクの開始日時を表します。
title タスクのタイトルを表します。
type タスク変更レコードのアクションの種類を表します。
undoChangeId undo変更操作で元に戻されたDocumentTaskChange.idプロパティを表します。
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 ユーザーの表示名を表します。
email ユーザーのメールを表します。
id ユーザーの一意の ID を表します。
EntityArrayCardLayout arrayProperty カードに表示される配列を含むプロパティの名前を表します。
columnsToReport カード クレームが配列内の列の数を表します。
displayName カードに表示される配列を含むプロパティの名前を表します。
firstRowIsHeader 配列の最初の行をヘッダーとして扱うかどうかを表します。
レイアウト このレイアウトの種類を表します。
rowsToReport カード クレームが配列内の行数を表します。
ExternalCodeServiceObjectCellValue Python_str このオブジェクトで使用された場合の str() 関数の出力を表します。
Python_type このオブジェクトの完全な型名を表します。
Python_typeName このオブジェクトの短い型名を表します。
basicType この値を持つセルに対して Range.valueTypes によって返される値を表します。
basicValue この値を持つセルに対して Range.values によって返される値を表します。
language この外部コード サービスのランタイム言語を表します。
プレビュー セルに表示されるプレビュー値を表します。
プロバイダー この ExternalCodeServiceObjectCellValueのデータを提供したサービスに関する情報を表します。
type このセル値の型を表します。
Identity displayName ユーザーの表示名を表します。
id ユーザーの一意の ID を表します。
LocalImage getBase64EncodedImageData(cacheUid: string) キャッシュ一意識別子 (UID) を使用して、共有イメージ キャッシュに保存されている Base64 でエンコードされたイメージ データを取得します。
LocalImageCellValue 代替テキスト 画像が表す内容を説明するために、アクセシビリティ シナリオで使用される代替テキストを表します。
属性 このイメージのソースとライセンスの要件を説明するための属性情報を表します。
basicType この値を持つセルに対して Range.valueTypes によって返される値を表します。
basicValue この値を持つセルに対して Range.values によって返される値を表します。
image 画像そのもの (キャッシュまたはエンコード) を表します。
プロバイダー 画像を提供したエンティティまたは個人を説明する情報を表します。
type このセル値の型を表します。
LocalImageCellValueCacheId cachedUid キャッシュに表示されるイメージの UID を表します。
NameErrorCellValue errorSubType NameErrorCellValueの種類を表します。
NamedSheetViewCollection getItemOrNullObject(key: string) 名前を使用してシート ビューを取得します。
NotAvailableErrorCellValue errorSubType NotAvailableErrorCellValueの種類を表します。
PivotLayout getCell(dataHierarchy: DataPivotHierarchy | string, rowItems: Array<PivotItem | string>, columnItems: Array<PivotItem | string>) データ階層と、それぞれの階層の行および列の項目に基づいて、ピボットテーブル内の一意のセルを取得します。
pivotStyle ピボットテーブルに適用されるスタイル。
setStyle(style: string |ピボットテーブルスタイル |BuiltInPivotTableStyle) ピボットテーブルに適用されるスタイルを設定します。
PivotTable autoRefresh ソース データが変更されたときにピボットテーブルを自動更新するかどうかを指定します。
PythonErrorCellValue basicType この値を持つセルに対して Range.valueTypes によって返される値を表します。
basicValue この値を持つセルに対して Range.values によって返される値を表します。
errorType ErrorCellValueの種類を表します。
type このセル値の型を表します。
Query delete() クエリと関連付けられている接続を削除します。
QueryCollection refreshAll() すべてのクエリを更新します。
Range togglePythonMarshalMode(marshalMode?: Excel.PythonMarshalMode) Python in Excel の数式 = PY のマーシャリング モードを設定します。
RequestContext sensitivityLabelsCatalog [API セット: ExcelApi ベータ版 (プレビューのみ)]
setInvocation(invocation: { invocationId: number isInSyncExecution: boolean })
SensitivityLabel getCurrentOrNullObject() ユーザーのブックに存在する現在のラベル情報を取得します。
tryToUpdate(labelId: string) ユーザーのブックで指定された秘密度ラベルに更新しようとします。
SensitivityLabelDetails 子供 秘密度ラベルのサブラベルを取得します。
color 秘密度ラベルの色を取得します。
id 秘密度ラベルの一意識別子 (GUID) を取得します。
isEnabled ラベルが有効かどうかを示す値を取得します。
name 秘密度ラベルの名前を取得します。
order 秘密度ラベルの優先度を取得し、最も低い優先度は 0 です。
protectionType このラベルによって提供される保護の種類を示す値を取得します。
siteId 秘密度ラベルが属するテナントの一意識別子 (GUID) を取得します。
ヒント 秘密度ラベルの説明を取得します。
SensitivityLabelDetailsCollection getFirst() このコレクション内の最初の SensitivityLabelDetails オブジェクトを取得します。
getFirstOrNullObject() このコレクション内の最初の SensitivityLabelDetails オブジェクトを取得します。
items このコレクション内に読み込まれた子アイテムを取得します。
SensitivityLabelsCatalog getLabelingCapability 秘密度ラベルのカタログが Excel で有効になっているかどうかを取得します。
getLabels() 現在のユーザーが使用できる秘密度ラベルを取得します。
ShapeCollection addLocalImageReference(address: string) セル アドレスに格納されているローカル画像の参照を作成し、セル上の浮動図形として表示します。
addSvg(xml: string) XML 文字列からスケーラブルなベクター グラフィックス (SVG) を作成し、それをワークシートに追加します。
ShapeFont strikethrough フォントの取り消し線の状態を指定します。
subscript フォントの下付き文字の状態を指定します。
superscript フォントの上付き文字の状態を指定します。
tintAndShade 範囲フォントの色を明るくするか暗くする倍精度浮動小数点値を指定します。
Slicer nameInFormula 数式で使用されるスライサー名を指定します。
setStyle(style: string |SlicerStyle |BuiltInSlicerStyle) スライサーに適用されるスタイルを設定します。
slicerStyle スライサーに適用されるスタイル。
表 altTextDescription アクセシビリティの代替テキストを指定します。
altTextTitle スクリーン リーダーで使用されるものなど、表の概要を指定します。
clearStyle() 既定のテーブル スタイルを使用するようにテーブルを変更します。
comment テーブルに関連付けられているコメントを指定します。
isActive テーブルが現在アクティブかどうかを取得します。
onFiltered 特定のテーブルにフィルターが適用されたときに発生します。
setStyle(style: string |TableStyle |BuiltInTableStyle) テーブルに適用するスタイルを設定します。
source テーブルの元のデータ ソースの型を取得します。
tableStyle テーブルに適用されているスタイル。
TableCollection onFiltered ブックまたはワークシート内の任意のテーブルにフィルターが適用されている場合に発生します。
TableFilteredEventArgs tableId フィルターが適用されているテーブルの ID を取得します。
type イベントの種類を取得します。
worksheetId テーブルを含むワークシートの ID を取得します。
TimeoutErrorCellValue basicType この値を持つセルに対して Range.valueTypes によって返される値を表します。
basicValue この値を持つセルに対して Range.values によって返される値を表します。
errorSubType TimeoutErrorCellValueの種類を表します。
errorType ErrorCellValueの種類を表します。
type このセル値の型を表します。
Window rangeSelection ウィンドウ内の範囲の選択を取得します。
ブック autorunEventCompleted(AutorunEventCompletedOptions: Excel.AutorunEventCompletedOptions) 自動実行イベントでアドインのコードの実行が終了したことをホスト アプリケーションに通知します。
externalCodeServiceTimeout 外部コード サービスに依存する数式の完了に割り当てられる最大時間 (秒) を指定します。
inPreviewMode() ブックが現在プレビュー モードであるかどうかを返します。
localImage ブックに関連付けられている LocalImage オブジェクトを返します。
sensitivityLabel ブックの秘密度ラベルを返します。
showPivotFieldList ピボットテーブルのフィールド リスト ウィンドウをブック レベルで表示するかどうかを指定します。
タスク ブックに存在するタスクのコレクションを返します。
use1904DateSystem ブックの日付を 1904 年から計算する場合、true となります。
Worksheet onCalculationBusy ワークシート内のセルが非同期的に計算されるときに発生します。
onFiltered 特定のワークシートにフィルターが適用されている場合に発生します。
タスク ワークシートに存在するタスクのコレクションを返します。
WorksheetCalculationBusyEventArgs address 計算を開始した範囲のアドレス。
source イベントのソース。
type イベントの種類を取得します。
worksheetId 計算が発生したワークシートの ID。
WorksheetCollection addFromBase64(base64File: string, sheetNamesToInsert?: string[], positionType?: Excel.WorksheetPositionType, relativeTo?: Worksheet | string) あるブックの指定されたワークシートを現在のブックに挿入します。
onCalculationBusy ワークシート内のセルが非同期的に計算されるときに発生します。
onFiltered ブック内でワークシートのフィルターが適用されたときに発生します。
WorksheetFilteredEventArgs type イベントの種類を取得します。
worksheetId フィルターが適用されているワークシートの ID を取得します。

関連項目

  • Last updated on