Excel.Query class
Représente une requête Power Query.
- Extends
Remarques
[ Ensemble d’API : ExcelApi 1.14 ]
Propriétés
| context | Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office. |
| error | Obtient le message d’erreur de requête de la dernière actualisation de la requête. |
| loaded |
Obtient la requête chargée dans le type d’objet. |
| loaded |
Spécifie si la requête a été chargée dans le modèle de données. |
| name | Obtient le nom de la requête. Les noms de requête ne peuvent pas contenir de points ou de guillemets. |
| refresh |
Obtient la date et l’heure de la dernière actualisation de la requête. |
| rows |
Obtient le nombre de lignes qui ont été chargées lors de la dernière actualisation de la requête. Si la dernière actualisation comporte des erreurs, la valeur sera -1. |
Méthodes
| load(options) | Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| toJSON() | Remplace la méthode JavaScript |
Détails de la propriété
context
Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
context: RequestContext;Valeur de propriété
error
Obtient le message d’erreur de requête de la dernière actualisation de la requête.
readonly error: Excel.QueryError | "Unknown" | "None" | "FailedLoadToWorksheet" | "FailedLoadToDataModel" | "FailedDownload" | "FailedToCompleteDownload";Valeur de propriété
Excel.QueryError | "Unknown" | "None" | "FailedLoadToWorksheet" | "FailedLoadToDataModel" | "FailedDownload" | "FailedToCompleteDownload"
Remarques
loadedTo
Obtient la requête chargée dans le type d’objet.
readonly loadedTo: Excel.LoadToType | "ConnectionOnly" | "Table" | "PivotTable" | "PivotChart";Valeur de propriété
Excel.LoadToType | "ConnectionOnly" | "Table" | "PivotTable" | "PivotChart"
Remarques
loadedToDataModel
Spécifie si la requête a été chargée dans le modèle de données.
readonly loadedToDataModel: boolean;Valeur de propriété
boolean
Remarques
name
Obtient le nom de la requête. Les noms de requête ne peuvent pas contenir de points ou de guillemets.
readonly name: string;Valeur de propriété
string
Remarques
[ Ensemble d’API : ExcelApi 1.14 ]
Exemples
// 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
Obtient la date et l’heure de la dernière actualisation de la requête.
readonly refreshDate: Date;Valeur de propriété
Date
Remarques
[ Ensemble d’API : ExcelApi 1.14 ]
Exemples
// 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
Obtient le nombre de lignes qui ont été chargées lors de la dernière actualisation de la requête. Si la dernière actualisation comporte des erreurs, la valeur sera -1.
readonly rowsLoadedCount: number;Valeur de propriété
number
Remarques
[ Ensemble d’API : ExcelApi 1.14 ]
Exemples
// 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 "));
});
Détails de la méthode
load(options)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(options?: Excel.Interfaces.QueryLoadOptions): Excel.Query;Paramètres
Fournit des options pour les propriétés de l’objet à charger.
Retours
load(propertyNames)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNames?: string | string[]): Excel.Query;Paramètres
- propertyNames
-
string | string[]
Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.
Retours
load(propertyNamesAndPaths)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Query;Paramètres
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.
Retours
toJSON()
Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.Query est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.QueryDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
toJSON(): Excel.Interfaces.QueryData;