Поделиться через

Excel.Query class

  • Ссылка
Пакет:
excel

Представляет запрос Power Query.

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.14 ]

Свойства

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
error

Возвращает сообщение об ошибке запроса с момента последнего обновления запроса.
loadedTo

Возвращает запрос, загруженный в тип объекта.
loadedToDataModel

Указывает, загружен ли запрос в модель данных.
name

Возвращает имя запроса. Имена запросов не могут содержать точки или кавычки.
refreshDate

Возвращает дату и время последнего обновления запроса.
rowsLoadedCount

Возвращает количество строк, которые были загружены при последнем обновлении запроса. Если последнее обновление содержит ошибки, значение будет равно -1.

Методы

delete()

Удаляет запрос и связанное с ним подключение. Таблицы, связанные с запросом, больше не будут подключены.
load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
refresh()

Обновляет запрос. Это только запускает обновление.
toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.Query объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.QueryData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

Сведения о свойстве

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

Excel.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 ]

Примеры

// 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

Комментарии

[ Набор API: ExcelApi 1.14 ]

Примеры

// 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

Комментарии

[ Набор API: ExcelApi 1.14 ]

Примеры

// 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  "));
});

Сведения о методе

delete()

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Удаляет запрос и связанное с ним подключение. Таблицы, связанные с запросом, больше не будут подключены.

delete(): void;

Возвращаемое значение

void

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

options
Excel.Interfaces.QueryLoadOptions

Предоставляет параметры свойств объекта для загрузки.

Возвращаемое значение

Excel.Query

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

Возвращаемое значение

Excel.Query

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNamesAndPaths

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

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

Возвращаемое значение

Excel.Query

refresh()

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Обновляет запрос. Это только запускает обновление.

refresh(): void;

Возвращаемое значение

void

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.Query объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.QueryData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Excel.Interfaces.QueryData;

Возвращаемое значение

Excel.Interfaces.QueryData