次の方法で共有


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 の詳細な一覧を示します。

機能領域 説明 関連オブジェクト
リンクされたブック ブック間のリンクを管理します。これには、ブックリンクの更新や中断のサポートが含まれます。 LinkedWorkbookLinkedWorkbookCollection
名前付きシート ビュー ユーザーごとのワークシート ビューをプログラムで制御できます。 NamedSheetViewNamedSheetViewCollection
ワークシートの移動イベント コレクション内のワークシートの移動、ワークシートの位置、変更のソースを検出します。 WorksheetCollectionWorksheetMovedEventArgs
ワークシート保護 許可されていないユーザーがワークシート内の指定された範囲に変更を加えないようにします。 WorksheetProtectionAllowEditRangeAllowEditRangeCollectionAllowEditRangeOptions

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 ワークシートのパスワードが変更されたかどうかを指定します。

関連項目