Excel.Query class

Package:
excel

Représente une requête Power Query.

Extends
OfficeExtension.ClientObject

Remarques

[Jeu d’API : ExcelApi 1.14]

Propriétés

context

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
error

Obtient le message d’erreur de requête à partir de la dernière actualisation de la requête.
loadedTo

Permet de charger la requête dans le type d’objet.
loadedToDataModel

Spécifie si la requête est chargée dans le modèle de données.
name

Obtient le nom de la requête. Les noms des requêtes ne peuvent pas contenir de points ou de guillemets.
refreshDate

Obtient la date et l’heure de la dernière actualisation de la requête.
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 contient 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 context.sync() avant de lire les propriétés.
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(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.
toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle 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 simple (typé ) Excel.Interfaces.QueryDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

Détails de la propriété

context

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Excel.RequestContext

error

Obtient le message d’erreur de requête à partir 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

[Jeu d’API : ExcelApi 1.14]

loadedTo

Permet de charger la requête dans le type d’objet.

readonly loadedTo: Excel.LoadToType | "ConnectionOnly" | "Table" | "PivotTable" | "PivotChart";

Valeur de propriété

Excel.LoadToType | "ConnectionOnly" | "Table" | "PivotTable" | "PivotChart"

Remarques

[Jeu d’API : ExcelApi 1.14]

loadedToDataModel

Spécifie si la requête est chargée dans le modèle de données.

readonly loadedToDataModel: boolean;

Valeur de propriété

boolean

Remarques

[Jeu d’API : ExcelApi 1.14]

name

Obtient le nom de la requête. Les noms des requêtes ne peuvent pas contenir de points ou de guillemets.

readonly name: string;

Valeur de propriété

string

Remarques

[Jeu d’API : ExcelApi 1.14]

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

[Jeu d’API : ExcelApi 1.14]

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 contient des erreurs, la valeur sera -1.

readonly rowsLoadedCount: number;

Valeur de propriété

number

Remarques

[Jeu d’API : ExcelApi 1.14]

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

options
Excel.Interfaces.QueryLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Excel.Query

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 spécifiant les propriétés à charger.

Retours

Excel.Query

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

Excel.Query

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle 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 simple (typé ) Excel.Interfaces.QueryDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.QueryData;

Retours

Excel.Interfaces.QueryData