Excel.LinkedDataType class
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
リンクされたデータ型を表します。 リンクされたデータ型は、オンライン データ ソースに接続されたデータ型です。
- Extends
注釈
[ API セット: ExcelApi BETA (プレビューのみ) ]
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| data |
リンクされたデータ型のデータ プロバイダーの名前。 これは、サービスから情報を取得するときに変更される可能性があります。 |
| last |
リンクされたデータ型が最後に更新されたときにブックが開かれた後のローカル タイム ゾーンの日付と時刻。 |
| name | リンクされたデータ型の名前。 これは、サービスから情報を取得するときに変更される可能性があります。 |
| periodic |
リンクされたデータ型が "Periodic" に設定されている場合 |
| refresh |
リンクされたデータ型のデータを取得するメカニズム。 |
| service |
リンクされたデータ型の一意の ID。 |
| supported |
リンクされたデータ型でサポートされているすべての更新モードを持つ配列を返します。 サービスから情報を取得すると、配列の内容が変更される可能性があります。 |
メソッド
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| request |
リンクされたデータ型を更新する要求を行います。 サービスがビジー状態であるか、一時的にアクセスできない場合、要求は満たされません。 |
| request |
このリンクされたデータ型の更新モードを変更するように要求します。 指定された更新モードがこのリンクされたデータ型でサポートされていない場合、モードは変更されません。 "Periodic" に設定されている場合、更新間隔は、特定のリンクされたデータ型に基づいて事前に設定された値に設定されます。 |
| request |
このリンクされたデータ型の更新モードを変更するように要求します。 指定された更新モードがこのリンクされたデータ型でサポートされていない場合、モードは変更されません。 "Periodic" に設定されている場合、更新間隔は、特定のリンクされたデータ型に基づいて事前に設定された値に設定されます。 |
| toJSON() | API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript |
プロパティの詳細
context
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
dataProvider
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
リンクされたデータ型のデータ プロバイダーの名前。 これは、サービスから情報を取得するときに変更される可能性があります。
readonly dataProvider: string;プロパティ値
string
注釈
lastRefreshed
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
リンクされたデータ型が最後に更新されたときにブックが開かれた後のローカル タイム ゾーンの日付と時刻。 undefinedリンクされたデータ型が更新されていない場合は を返します。
readonly lastRefreshed: Date;プロパティ値
Date
注釈
name
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
リンクされたデータ型の名前。 これは、サービスから情報を取得するときに変更される可能性があります。
readonly name: string;プロパティ値
string
注釈
periodicRefreshInterval
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
リンクされたデータ型が "Periodic" に設定されている場合 refreshMode に更新される頻度 (秒単位)。
readonly periodicRefreshInterval: number;プロパティ値
number
注釈
refreshMode
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
リンクされたデータ型のデータを取得するメカニズム。
readonly refreshMode: Excel.LinkedDataTypeRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic";プロパティ値
Excel.LinkedDataTypeRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic"
注釈
serviceId
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
リンクされたデータ型の一意の ID。
readonly serviceId: number;プロパティ値
number
注釈
supportedRefreshModes
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
リンクされたデータ型でサポートされているすべての更新モードを持つ配列を返します。 サービスから情報を取得すると、配列の内容が変更される可能性があります。
readonly supportedRefreshModes: Excel.LinkedDataTypeRefreshMode[];プロパティ値
注釈
メソッドの詳細
load(options)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.LinkedDataTypeLoadOptions): Excel.LinkedDataType;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.LinkedDataType;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.LinkedDataType;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は、読み込むプロパティを指定するコンマ区切り文字列で propertyNamesAndPaths.expand 、読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
requestRefresh()
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
リンクされたデータ型を更新する要求を行います。 サービスがビジー状態であるか、一時的にアクセスできない場合、要求は満たされません。
requestRefresh(): void;戻り値
void
注釈
requestSetRefreshMode(refreshMode)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
このリンクされたデータ型の更新モードを変更するように要求します。 指定された更新モードがこのリンクされたデータ型でサポートされていない場合、モードは変更されません。 "Periodic" に設定されている場合、更新間隔は、特定のリンクされたデータ型に基づいて事前に設定された値に設定されます。
requestSetRefreshMode(refreshMode: Excel.LinkedDataTypeRefreshMode): void;パラメーター
- refreshMode
- Excel.LinkedDataTypeRefreshMode
このリンクされたデータ型の変更が要求される目的のモード。
戻り値
void
注釈
requestSetRefreshMode(refreshModeString)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
このリンクされたデータ型の更新モードを変更するように要求します。 指定された更新モードがこのリンクされたデータ型でサポートされていない場合、モードは変更されません。 "Periodic" に設定されている場合、更新間隔は、特定のリンクされたデータ型に基づいて事前に設定された値に設定されます。
requestSetRefreshMode(refreshModeString: "Unknown" | "Manual" | "OnLoad" | "Periodic"): void;パラメーター
- refreshModeString
-
"Unknown" | "Manual" | "OnLoad" | "Periodic"
このリンクされたデータ型の変更が要求される目的のモード。
戻り値
void
注釈
toJSON()
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを JSON.stringify()オーバーライドします。 (JSON.stringifyさらに、渡される オブジェクトの メソッドを呼び出 toJSON します)。元の Excel.LinkedDataType オブジェクトは API オブジェクトですが、メソッドは、元の toJSON オブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト (として Excel.Interfaces.LinkedDataTypeData型指定) を返します。
toJSON(): Excel.Interfaces.LinkedDataTypeData;戻り値
Office Add-ins
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示