次の方法で共有

Excel.LinkedDataType class

  • リファレンス
パッケージ:
excel

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

リンクされたデータ型を表します。 リンクされたデータ型は、オンライン データ ソースに接続されたデータ型です。

Extends
OfficeExtension.ClientObject

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

プロパティ

context

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
dataProvider

リンクされたデータ型のデータ プロバイダーの名前。 これは、サービスから情報を取得するときに変更される可能性があります。
lastRefreshed

リンクされたデータ型が最後に更新されたときにブックが開かれた後のローカル タイム ゾーンの日付と時刻。 リンクされたデータ型が更新されていない場合は、 undefined を返します。
name

リンクされたデータ型の名前。 これは、サービスから情報を取得するときに変更される可能性があります。
periodicRefreshInterval

refreshModeが "Periodic" に設定されている場合にリンクされたデータ型が更新される頻度 (秒単位)。
refreshMode

リンクされたデータ型のデータを取得するメカニズム。
serviceId

リンクされたデータ型の一意の ID。
supportedRefreshModes

リンクされたデータ型でサポートされているすべての更新モードを持つ配列を返します。 サービスから情報を取得すると、配列の内容が変更される可能性があります。

メソッド

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
requestRefresh()

リンクされたデータ型を更新するように要求します。 サービスがビジー状態であるか、一時的にアクセスできない場合、要求は満たされません。
requestSetRefreshMode(refreshMode)

このリンクされたデータ型の更新モードを変更するように要求します。 指定された更新モードがこのリンクされたデータ型でサポートされていない場合、モードは変更されません。 "Periodic" に設定されている場合、更新間隔は、特定のリンクされたデータ型に基づいて事前に設定された値に設定されます。
requestSetRefreshMode(refreshModeString)

このリンクされたデータ型の更新モードを変更するように要求します。 指定された更新モードがこのリンクされたデータ型でサポートされていない場合、モードは変更されません。 "Periodic" に設定されている場合、更新間隔は、特定のリンクされたデータ型に基づいて事前に設定された値に設定されます。
toJSON()

API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.LinkedDataType オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.LinkedDataTypeData として型指定) を返します。

プロパティの詳細

context

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

Excel.RequestContext

dataProvider

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

リンクされたデータ型のデータ プロバイダーの名前。 これは、サービスから情報を取得するときに変更される可能性があります。

readonly dataProvider: string;

プロパティ値

string

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

lastRefreshed

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

リンクされたデータ型が最後に更新されたときにブックが開かれた後のローカル タイム ゾーンの日付と時刻。 リンクされたデータ型が更新されていない場合は、 undefined を返します。

readonly lastRefreshed: Date;

プロパティ値

Date

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

name

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

リンクされたデータ型の名前。 これは、サービスから情報を取得するときに変更される可能性があります。

readonly name: string;

プロパティ値

string

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

periodicRefreshInterval

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

refreshModeが "Periodic" に設定されている場合にリンクされたデータ型が更新される頻度 (秒単位)。

readonly periodicRefreshInterval: number;

プロパティ値

number

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

refreshMode

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

リンクされたデータ型のデータを取得するメカニズム。

readonly refreshMode: Excel.LinkedDataTypeRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic";

プロパティ値

Excel.LinkedDataTypeRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic"

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

serviceId

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

リンクされたデータ型の一意の ID。

readonly serviceId: number;

プロパティ値

number

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

supportedRefreshModes

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

リンクされたデータ型でサポートされているすべての更新モードを持つ配列を返します。 サービスから情報を取得すると、配列の内容が変更される可能性があります。

readonly supportedRefreshModes: Excel.LinkedDataTypeRefreshMode[];

プロパティ値

Excel.LinkedDataTypeRefreshMode[]

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

メソッドの詳細

load(options)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Excel.Interfaces.LinkedDataTypeLoadOptions): Excel.LinkedDataType;

パラメーター

options
Excel.Interfaces.LinkedDataTypeLoadOptions

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

Excel.LinkedDataType

load(propertyNames)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames?: string | string[]): Excel.LinkedDataType;

パラメーター

propertyNames

string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

Excel.LinkedDataType

load(propertyNamesAndPaths)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.LinkedDataType;

パラメーター

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。

戻り値

Excel.LinkedDataType

requestRefresh()

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

リンクされたデータ型を更新するように要求します。 サービスがビジー状態であるか、一時的にアクセスできない場合、要求は満たされません。

requestRefresh(): void;

戻り値

void

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

requestSetRefreshMode(refreshMode)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

このリンクされたデータ型の更新モードを変更するように要求します。 指定された更新モードがこのリンクされたデータ型でサポートされていない場合、モードは変更されません。 "Periodic" に設定されている場合、更新間隔は、特定のリンクされたデータ型に基づいて事前に設定された値に設定されます。

requestSetRefreshMode(refreshMode: Excel.LinkedDataTypeRefreshMode): void;

パラメーター

refreshMode
Excel.LinkedDataTypeRefreshMode

このリンクされたデータ型の変更が要求される目的のモード。

戻り値

void

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

requestSetRefreshMode(refreshModeString)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

このリンクされたデータ型の更新モードを変更するように要求します。 指定された更新モードがこのリンクされたデータ型でサポートされていない場合、モードは変更されません。 "Periodic" に設定されている場合、更新間隔は、特定のリンクされたデータ型に基づいて事前に設定された値に設定されます。

requestSetRefreshMode(refreshModeString: "Unknown" | "Manual" | "OnLoad" | "Periodic"): void;

パラメーター

refreshModeString

"Unknown" | "Manual" | "OnLoad" | "Periodic"

このリンクされたデータ型の変更が要求される目的のモード。

戻り値

void

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

toJSON()

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.LinkedDataType オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.LinkedDataTypeData として型指定) を返します。

toJSON(): Excel.Interfaces.LinkedDataTypeData;

戻り値

Excel.Interfaces.LinkedDataTypeData