Excel.Query class
Power Query クエリを表します。
- Extends
注釈
プロパティ
context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
error | クエリが最後に更新されたときのクエリ エラー メッセージを取得します。 |
loaded |
オブジェクト型に読み込まれたクエリを取得します。 |
loaded |
クエリがデータ モデルに読み込まれるかどうかを指定します。 |
name | クエリの名前を取得します。 クエリ名にピリオドや引用符を含めることはできません。 |
refresh |
クエリが最後に更新された日時を取得します。 |
rows |
クエリが最後に更新されたときに読み込まれた行の数を取得します。 最後の更新でエラーが発生した場合、値は -1 になります。 |
メソッド
load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
toJSON() | API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;
プロパティ値
error
クエリが最後に更新されたときのクエリ エラー メッセージを取得します。
readonly error: Excel.QueryError | "Unknown" | "None" | "FailedLoadToWorksheet" | "FailedLoadToDataModel" | "FailedDownload" | "FailedToCompleteDownload";
プロパティ値
Excel.QueryError | "Unknown" | "None" | "FailedLoadToWorksheet" | "FailedLoadToDataModel" | "FailedDownload" | "FailedToCompleteDownload"
注釈
loadedTo
オブジェクト型に読み込まれたクエリを取得します。
readonly loadedTo: Excel.LoadToType | "ConnectionOnly" | "Table" | "PivotTable" | "PivotChart";
プロパティ値
Excel.LoadToType | "ConnectionOnly" | "Table" | "PivotTable" | "PivotChart"
注釈
loadedToDataModel
クエリがデータ モデルに読み込まれるかどうかを指定します。
readonly loadedToDataModel: boolean;
プロパティ値
boolean
注釈
name
クエリの名前を取得します。 クエリ名にピリオドや引用符を含めることはできません。
readonly name: string;
プロパティ値
string
注釈
例
// This function retrieves the query collection in a workbook,
// loads the query items in that collection, and then
// logs the name of each query to the console.
await Excel.run(async (context) => {
const queries = context.workbook.queries;
queries.load("items");
await context.sync();
console.log("Name of each query: ")
console.log(" " + queries.items.map((query) => query.name).join("\n "));
});
refreshDate
クエリが最後に更新された日時を取得します。
readonly refreshDate: Date;
プロパティ値
Date
注釈
例
// This function retrieves the query collection in a workbook,
// loads the query items in that collection, and then
// logs the last refresh date of each query to the console.
await Excel.run(async (context) => {
const queries = context.workbook.queries;
queries.load("items");
await context.sync();
console.log("Last refresh date of each query: ")
console.log(" " + queries.items.map((query) => query.refreshDate).join("\n "));
});
rowsLoadedCount
クエリが最後に更新されたときに読み込まれた行の数を取得します。 最後の更新でエラーが発生した場合、値は -1 になります。
readonly rowsLoadedCount: number;
プロパティ値
number
注釈
例
// This function retrieves the query collection in a workbook,
// loads the query items in that collection, and then
// logs the number of rows loaded in each query.
await Excel.run(async (context) => {
const queries = context.workbook.queries;
queries.load("items");
await context.sync();
console.log("Rows loaded from each query: ")
console.log(" " + queries.items.map((query) => query.rowsLoadedCount).join("\n "));
});
メソッドの詳細
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 オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript toJSON()
メソッドを JSON.stringify()
オーバーライドします。 (JSON.stringify
さらに、渡される オブジェクトの メソッドを呼び出 toJSON
します)。元の Excel.Query オブジェクトは API オブジェクトですが、メソッドは、元の toJSON
オブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト (として Excel.Interfaces.QueryData
型指定) を返します。
toJSON(): Excel.Interfaces.QueryData;
戻り値
Office Add-ins
フィードバック
https://aka.ms/ContentUserFeedback」を参照してください。
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「フィードバックの送信と表示