Excel JavaScript API オンラインのみの要件セット

ExcelApiOnline要件セットは、Excel on the webでのみ使用できる機能を含む特別な要件セットです。 この要件セットの API は、Excel on the web アプリケーションの運用 API (文書化されていない動作または構造の変更の対象ではない) と見なされます。 ExcelApiOnline API は、他のプラットフォーム (Windows、Mac、iOS) では "プレビュー" API と見なされ、これらのプラットフォームでサポートされていない場合があります。

ExcelApiOnline要件セットの API がすべてのプラットフォームでサポートされている場合は、次にリリースされた要件セット (ExcelApi 1.[NEXT]) に追加されます。 その新しい要件セットが公開されると、これらの API は ExcelApiOnlineから削除されます。 これは、プレビューからリリースに移行する API に似たプロモーション プロセスと考えてください。

重要

ExcelApiOnline は、最新の番号付き要件セットのスーパーセットです。

重要

ExcelApiOnline 1.1 は、オンライン専用 API の唯一のバージョンです。 これは、Excel on the web に常に最新バージョンの 1 つのバージョンがユーザーに提供されるためです。

次の表は API の簡潔な概要を示し、後続の API リスト の表は現在の ExcelApiOnline API の詳細なリストを示しています。

機能領域 説明 関連オブジェクト
リンクされたブック ブック リンクの更新と解除のサポートなど、ブック間のリンクを管理します。 LinkedWorkbook、 LinkedWorkbookCollection
名前付きシート ビュー ユーザーごとのワークシート ビューをプログラムで制御できます。 NamedSheetView、NamedSheetViewCollection
ワークシートの移動イベント コレクション内でワークシートが移動されたタイミング、ワークシートの位置、および変更のソースを検出します。 WorksheetCollection、 WorksheetMovedEventArgs
ワークシート保護 承認されていないユーザーがワークシート内で指定した範囲を変更できないようにします。 WorksheetProtection、 AllowEditRange、 AllowEditRangeCollection、 AllowEditRangeOptions

ExcelApiOnline API は Excel on the web でのみサポートされるため、これらの API を呼び出す前に、アドインで要件セットがサポートされているかどうかをチェックする必要があります。 これにより、別のプラットフォームでオンライン専用 API を呼び出す必要がなくなります。

if (Office.context.requirements.isSetSupported("ExcelApiOnline", "1.1")) {
   // Any API exclusive to the ExcelApiOnline requirement set.
}

API がクロスプラットフォーム要件セットになったら、isSetSupported チェックを削除または編集する必要があります。 これにより、他のプラットフォームでのアドインの機能が有効になります。 この変更を行う際は、必ずそれらのプラットフォームで機能をテストしてください。

重要

マニフェストでアクティブ化要件として ExcelApiOnline 1.1 を指定できません。 これは、Set 要素で使用する有効な値ではありません。

API リスト

次の表に、現在 ExcelApiOnline 要件セットに含まれている Excel JavaScript API を示します。 すべての Excel JavaScript API ( ExcelApiOnline API と以前にリリースされた API を含む) の完全な一覧については、「 すべての Excel JavaScript API」を参照してください。

クラス フィールド 説明
AllowEditRange address オブジェクトに関連付けられている範囲を指定します。
delete() AllowEditRangeCollectionからオブジェクトを削除します。
isPasswordProtected オブジェクトがパスワードで保護されているかどうかを指定します。
pauseProtection(password?: string) 現在のセッションのユーザーのオブジェクトのワークシート保護を一時停止します。
setPassword(password?: string) オブジェクトに関連付けられているパスワードを変更します。
title オブジェクトのタイトルを指定します。
AllowEditRangeCollection add(title: string, rangeAddress: string, options?: Excel.AllowEditRangeOptions) ワークシートに AllowEditRange オブジェクトを追加します。
getCount() コレクション内の AllowEditRange オブジェクトの数を返します。
getItem(key: string) タイトルで AllowEditRange オブジェクトを取得します。
getItemAt(index: number) コレクション内のインデックスで AllowEditRange オブジェクトを返します。
getItemOrNullObject(key: string) タイトルで AllowEditRange オブジェクトを取得します。
items このコレクション内に読み込まれた子アイテムを取得します。
pauseProtection(password: string) 現在のセッションでユーザーに指定されたパスワードを持つ、このワークシートで見つかったすべての AllowEditRange オブジェクトのワークシート保護を一時停止します。
AllowEditRangeOptions password AllowEditRangeに関連付けられているパスワード。
LinkedWorkbook breakLinks() リンクされたブックを指すリンクを解除する要求を行います。
id リンクされているブックを指す元の URL。
refresh() リンクされたブックから取得したデータを更新する要求を行います。
LinkedWorkbookCollection breakAllLinks() リンクされているブックへのすべてのリンクを解除します。
getItem(key: string) リンクされたブックに関する情報をその URL で取得します。
getItemOrNullObject(key: string) リンクされたブックに関する情報をその URL で取得します。
items このコレクション内に読み込まれた子アイテムを取得します。
refreshAll() すべてのブック リンクを更新する要求を行います。
workbookLinksRefreshMode ブック リンクの更新モードを表します。
NamedSheetView activate() このシート ビューをアクティブにします。
delete() ワークシートからシート ビューを削除します。
duplicate(name?: string) このシート ビューのコピーを作成します。
name シート ビューの名前を指定します。
NamedSheetViewCollection add(name: string) 指定した名前で新しいシート ビューを作成します。
enterTemporary() 新しい一時シート ビューを作成してアクティブ化します。
exit() 現在アクティブなシート ビューを終了します。
getActive() ワークシートの現在アクティブなシート ビューを取得します。
getCount() このワークシート内のシート ビュー数を取得します。
getItem(key: string) 名前を使用してシート ビューを取得します。
getItemAt(index: number) コレクション内のインデックスによってシート ビューを取得します。
items このコレクション内に読み込まれた子アイテムを取得します。
TableRowCollection deleteRows(rows: number[] |TableRow[]) テーブルから複数の行を削除する。
deleteRowsAt(index: number, count?: number) テーブルから、指定したインデックスから始まる指定した数の行を削除します。
ブック linkedWorkbooks リンクされたブックのコレクションを返します。
ワークシート namedSheetViews ワークシートに存在するシート ビューのコレクションを返します。
WorksheetProtection allowEditRanges このワークシートで見つかった AllowEditRangeCollection オブジェクトを示します。
canPauseProtection このワークシートの保護を一時停止できるかどうかを示します。
checkPassword(password?: string) パスワードを使用してワークシート保護のロックを解除できるかどうかを示します。
isPasswordProtected シートがパスワードで保護されているかどうかを示します。
isPaused ワークシート保護を一時停止するかどうかを示します。
pauseProtection(password?: string) 現在のセッションのユーザーに対して、指定されたワークシート オブジェクトのワークシート保護を一時停止します。
resumeProtection() 特定のセッションのユーザーに対して、指定されたワークシート オブジェクトのワークシート保護を再開します。
savedOptions ワークシートに保存される保護オプションを示します。
setPassword(password?: string) WorksheetProtection オブジェクトに関連付けられているパスワードを変更します。
updateOptions(options: Excel.WorksheetProtectionOptions) WorksheetProtection オブジェクトに関連付けられているワークシート保護オプションを変更します。
WorksheetProtectionChangedEventArgs allowEditRangesChanged いずれかの AllowEditRange オブジェクトが変更されたかどうかを指定します。
protectionOptionsChanged WorksheetProtectionOptionsが変更されたかどうかを指定します。
sheetPasswordChanged ワークシートのパスワードが変更されたかどうかを指定します。

関連項目

  • Last updated on