Excel.Query class

Paquete:
excel

Representa una consulta de Power Query.

Extends
OfficeExtension.ClientObject

Comentarios

[Conjunto de API: ExcelApi 1.14]

Propiedades

context

El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.
error

Obtiene el mensaje de error de consulta de la última vez que se actualizó la consulta.
loadedTo

Carga la consulta en el tipo de objeto.
loadedToDataModel

Especifica si la consulta se cargó en el modelo de datos.
name

Obtiene el nombre de la consulta. Los nombres de consulta no pueden contener puntos ni comillas.
refreshDate

Obtiene la fecha y hora en que se actualizó por última vez la consulta.
rowsLoadedCount

Obtiene el número de filas que se cargaron cuando se actualizó la consulta por última vez. Si la última actualización tiene errores, el valor será -1.

Métodos

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
toJSON()

Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.Query es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.QueryData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.

Detalles de las propiedades

context

El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Excel.RequestContext

error

Obtiene el mensaje de error de consulta de la última vez que se actualizó la consulta.

readonly error: Excel.QueryError | "Unknown" | "None" | "FailedLoadToWorksheet" | "FailedLoadToDataModel" | "FailedDownload" | "FailedToCompleteDownload";

Valor de propiedad

Excel.QueryError | "Unknown" | "None" | "FailedLoadToWorksheet" | "FailedLoadToDataModel" | "FailedDownload" | "FailedToCompleteDownload"

Comentarios

[Conjunto de API: ExcelApi 1.14]

loadedTo

Carga la consulta en el tipo de objeto.

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

Valor de propiedad

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

Comentarios

[Conjunto de API: ExcelApi 1.14]

loadedToDataModel

Especifica si la consulta se cargó en el modelo de datos.

readonly loadedToDataModel: boolean;

Valor de propiedad

boolean

Comentarios

[Conjunto de API: ExcelApi 1.14]

name

Obtiene el nombre de la consulta. Los nombres de consulta no pueden contener puntos ni comillas.

readonly name: string;

Valor de propiedad

string

Comentarios

[Conjunto de API: ExcelApi 1.14]

refreshDate

Obtiene la fecha y hora en que se actualizó por última vez la consulta.

readonly refreshDate: Date;

Valor de propiedad

Date

Comentarios

[Conjunto de API: ExcelApi 1.14]

rowsLoadedCount

Obtiene el número de filas que se cargaron cuando se actualizó la consulta por última vez. Si la última actualización tiene errores, el valor será -1.

readonly rowsLoadedCount: number;

Valor de propiedad

number

Comentarios

[Conjunto de API: ExcelApi 1.14]

Detalles del método

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(options?: Excel.Interfaces.QueryLoadOptions): Excel.Query;

Parámetros

options
Excel.Interfaces.QueryLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Excel.Query

load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

Excel.Query

load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNamesAndPaths

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

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

Excel.Query

toJSON()

Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.Query es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.QueryData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.

toJSON(): Excel.Interfaces.QueryData;

Devoluciones

Excel.Interfaces.QueryData