Excel.Query class
Power Query クエリを表します。
- Extends
注釈
[API セット: ExcelApi 1.14]
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| error | クエリが最後に更新されたときからクエリ エラー メッセージを取得します。 |
| loaded |
オブジェクト タイプに読み込まれたクエリを取得します。 |
| loaded |
クエリがデータ モデルに読み込まれるかどうかを指定します。 |
| name | クエリの名前を取得します。 クエリ名にピリオドや引用符を含めることはできません。 |
| refresh |
クエリが最後に更新された日時を取得します。 |
| rows |
クエリが最後に更新されたときに読み込まれた行数を取得します。 前回の更新でエラーがあった場合、値は -1 になります。 |
メソッド
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| toJSON() | API オブジェクトが |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;
プロパティ値
error
クエリが最後に更新されたときからクエリ エラー メッセージを取得します。
readonly error: Excel.QueryError | "Unknown" | "None" | "FailedLoadToWorksheet" | "FailedLoadToDataModel" | "FailedDownload" | "FailedToCompleteDownload";
プロパティ値
Excel.QueryError | "Unknown" | "None" | "FailedLoadToWorksheet" | "FailedLoadToDataModel" | "FailedDownload" | "FailedToCompleteDownload"
注釈
[API セット: ExcelApi 1.14]
loadedTo
オブジェクト タイプに読み込まれたクエリを取得します。
readonly loadedTo: Excel.LoadToType | "ConnectionOnly" | "Table" | "PivotTable" | "PivotChart";
プロパティ値
Excel.LoadToType | "ConnectionOnly" | "Table" | "PivotTable" | "PivotChart"
注釈
[API セット: ExcelApi 1.14]
loadedToDataModel
クエリがデータ モデルに読み込まれるかどうかを指定します。
readonly loadedToDataModel: boolean;
プロパティ値
boolean
注釈
[API セット: ExcelApi 1.14]
name
クエリの名前を取得します。 クエリ名にピリオドや引用符を含めることはできません。
readonly name: string;
プロパティ値
string
注釈
[API セット: ExcelApi 1.14]
refreshDate
クエリが最後に更新された日時を取得します。
readonly refreshDate: Date;
プロパティ値
Date
注釈
[API セット: ExcelApi 1.14]
rowsLoadedCount
クエリが最後に更新されたときに読み込まれた行数を取得します。 前回の更新でエラーがあった場合、値は -1 になります。
readonly rowsLoadedCount: number;
プロパティ値
number
注釈
[API セット: ExcelApi 1.14]
メソッドの詳細
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.QueryLoadOptions): Excel.Query;
パラメーター
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.Query;
パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Query;
パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
返品
toJSON()
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.Query オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.QueryData と型指定) を返します。
toJSON(): Excel.Interfaces.QueryData;