Excel.TableSort class

Пакет:

excel

Управляет операциями сортировки объектов Table .

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.2 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
fields	Указывает текущие условия, используемые для последней сортировки таблицы.
matchCase	Указывает, влияет ли регистр на последний тип таблицы.
method	Представляет метод упорядочения символов на китайском языке, который последний раз использовался для сортировки таблицы.

Методы

apply(fields, matchCase, method)	Выполняет сортировку.
apply(fields, matchCase, methodString)	Выполняет сортировку.
clear()	Удаляет текущие параметры сортировки таблицы. При этом сбрасывается состояние кнопок в заголовках, но порядок сортировки таблицы остается неизменным.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
reapply()	Повторно применяет текущие параметры сортировки к таблице.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Excel.TableSort является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.TableSortData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

context

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

context: RequestContext;

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

Excel.RequestContext

fields

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

readonly fields: Excel.SortField[];

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

Excel.SortField[]

Комментарии

[ Набор API: ExcelApi 1.2 ]

matchCase

Указывает, влияет ли регистр на последний тип таблицы.

readonly matchCase: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.2 ]

method

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

readonly method: Excel.SortMethod | "PinYin" | "StrokeCount";

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

Excel.SortMethod | "PinYin" | "StrokeCount"

Комментарии

[ Набор API: ExcelApi 1.2 ]

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

apply(fields, matchCase, method)

Выполняет сортировку.

apply(fields: Excel.SortField[], matchCase?: boolean, method?: Excel.SortMethod): void;

Параметры

fields

Excel.SortField[]

Список условий для сортировки.

matchCase

boolean

Необязательный параметр. Указывает, необходимо ли учитывать регистр при сортировке строк.

method

Excel.SortMethod

Необязательный параметр. Метод сортировки, используемый для китайских символов.

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

void

Комментарии

[ Набор API: ExcelApi 1.2 ]

Примеры

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    table.sort.apply([ 
            {
                key: 2,
                ascending: true
            },
        ], true);
    await context.sync(); 
});

apply(fields, matchCase, methodString)

Выполняет сортировку.

apply(fields: Excel.SortField[], matchCase?: boolean, methodString?: "PinYin" | "StrokeCount"): void;

Параметры

fields

Excel.SortField[]

Список условий для сортировки.

matchCase

boolean

Необязательный параметр. Указывает, необходимо ли учитывать регистр при сортировке строк.

methodString

"PinYin" | "StrokeCount"

Необязательный параметр. Метод сортировки, используемый для китайских символов.

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

void

Комментарии

[ Набор API: ExcelApi 1.2 ]

clear()

Удаляет текущие параметры сортировки таблицы. При этом сбрасывается состояние кнопок в заголовках, но порядок сортировки таблицы остается неизменным.

clear(): void;

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

void

Комментарии

[ Набор API: ExcelApi 1.2 ]

load(options)

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

load(options?: Excel.Interfaces.TableSortLoadOptions): Excel.TableSort;

Параметры

options

Excel.Interfaces.TableSortLoadOptions

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

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

Excel.TableSort

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.TableSort

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Excel.TableSort

reapply()

Повторно применяет текущие параметры сортировки к таблице.

reapply(): void;

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

void

Комментарии

[ Набор API: ExcelApi 1.2 ]

toJSON()

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

toJSON(): Excel.Interfaces.TableSortData;

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

Excel.Interfaces.TableSortData