Excel.TableSort class
Управляет операциями Table сортировки объектов.
- Extends
Свойства
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| fields | Указывает текущие условия, используемые для последней сортировки таблицы. |
| match |
Указывает, влияет ли регистр на последний вид таблицы. |
| method | Представляет метод сортировки китайских иероглифов, используемый последним для сортировки таблицы. |
Методы
| apply(fields, match |
Выполняет сортировку. |
| apply(fields, match |
Выполняет сортировку. |
| clear() | Удаляет текущие параметры сортировки таблицы. При этом сбрасывается состояние кнопок в заголовках, но порядок сортировки таблицы остается неизменным. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| reapply() | Повторно применяет текущие параметры сортировки к таблице. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
fields
Указывает текущие условия, используемые для последней сортировки таблицы.
readonly fields: Excel.SortField[];Значение свойства
Комментарии
matchCase
Указывает, влияет ли регистр на последний вид таблицы.
readonly matchCase: boolean;Значение свойства
boolean
Комментарии
method
Представляет метод сортировки китайских иероглифов, используемый последним для сортировки таблицы.
readonly method: Excel.SortMethod | "PinYin" | "StrokeCount";Значение свойства
Excel.SortMethod | "PinYin" | "StrokeCount"
Комментарии
Сведения о методе
apply(fields, matchCase, method)
Выполняет сортировку.
apply(fields: Excel.SortField[], matchCase?: boolean, method?: Excel.SortMethod): void;Параметры
- fields
Список условий для сортировки.
- matchCase
-
boolean
Необязательный параметр. Указывает, необходимо ли учитывать регистр при сортировке строк.
- method
- Excel.SortMethod
Необязательный параметр. Метод сортировки, используемый для китайских символов.
Возвращаемое значение
void
Комментарии
Примеры
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, method)
Выполняет сортировку.
apply(fields: Excel.SortField[], matchCase?: boolean, method?: "PinYin" | "StrokeCount"): void;Параметры
- fields
Список условий для сортировки.
- matchCase
-
boolean
Необязательный параметр. Указывает, необходимо ли учитывать регистр при сортировке строк.
- method
-
"PinYin" | "StrokeCount"
Необязательный параметр. Метод сортировки, используемый для китайских символов.
Возвращаемое значение
void
Комментарии
clear()
Удаляет текущие параметры сортировки таблицы. При этом сбрасывается состояние кнопок в заголовках, но порядок сортировки таблицы остается неизменным.
clear(): void;Возвращаемое значение
void
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.TableSortLoadOptions): Excel.TableSort;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.TableSort;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.TableSort;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
reapply()
Повторно применяет текущие параметры сортировки к таблице.
reapply(): void;Возвращаемое значение
void
Комментарии
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.TableSort объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.TableSortData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
toJSON(): Excel.Interfaces.TableSortData;