Excel.SlicerCollection class
Представляет коллекцию всех объектов среза в книге или на листе.
- Extends
Свойства
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| items | Получает загруженные дочерние элементы в этой коллекции. |
Методы
| add(slicer |
Добавляет новый срез в книгу. |
| get |
Возвращает количество срезов в коллекции. |
| get |
Получает объект среза по его имени или идентификатору. |
| get |
Получает срез на основе его позиции в коллекции. |
| get |
Получает срез по своему имени или идентификатору. Если среза не существует, этот метод возвращает объект со свойством |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
items
Получает загруженные дочерние элементы в этой коллекции.
readonly items: Excel.Slicer[];Значение свойства
Сведения о методе
add(slicerSource, sourceField, slicerDestination)
Добавляет новый срез в книгу.
add(slicerSource: string | PivotTable | Table, sourceField: string | PivotField | number | TableColumn, slicerDestination?: string | Worksheet): Excel.Slicer;Параметры
- slicerSource
-
string | Excel.PivotTable | Excel.Table
Источник данных, на котором будет основан новый срез. Это может быть объект, PivotTableTable объект или строка. Когда передается объект сводной таблицы, источником данных является его PivotTable источник.
Table Когда объект передается, источником данных является объект.Table Когда строка передается, она интерпретируется как имя или идентификатор сводной таблицы или таблицы.
- sourceField
-
string | Excel.PivotField | number | Excel.TableColumn
Поле в источнике данных для фильтрации. Это может быть объект, PivotFieldTableColumn объект, идентификатор или PivotField имя или идентификатор TableColumn.
- slicerDestination
-
string | Excel.Worksheet
Необязательный параметр. Лист, на котором будет создан срез. Это может быть Worksheet объект или имя или идентификатор листа. Этот параметр можно опустить, если коллекция срезов получена из листа.
Возвращаемое значение
Новый срез.
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Pivot");
const slicer = sheet.slicers.add(
"Farm Sales", /* The slicer data source. For PivotTables, this can be the PivotTable object reference or name. */
"Type" /* The field in the data source to filter by. For PivotTables, this can be a PivotField object reference or ID. */
);
slicer.name = "Fruit Slicer";
await context.sync();
});
getCount()
Возвращает количество срезов в коллекции.
getCount(): OfficeExtension.ClientResult<number>;Возвращаемое значение
OfficeExtension.ClientResult<number>
Комментарии
getItem(key)
Получает объект среза по его имени или идентификатору.
getItem(key: string): Excel.Slicer;Параметры
- key
-
string
Имя или идентификатор среза.
Возвращаемое значение
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml
await Excel.run(async (context) => {
const slicer = context.workbook.slicers.getItem("Fruit Slicer");
slicer.caption = "Fruit Types";
slicer.left = 395;
slicer.top = 15;
slicer.height = 135;
slicer.width = 150;
await context.sync();
});
getItemAt(index)
Получает срез на основе его позиции в коллекции.
getItemAt(index: number): Excel.Slicer;Параметры
- index
-
number
Значение индекса получаемого объекта. Используется нулевой индекс.
Возвращаемое значение
Комментарии
getItemOrNullObject(key)
Получает срез по своему имени или идентификатору. Если среза не существует, этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getItemOrNullObject(key: string): Excel.Slicer;Параметры
- key
-
string
Имя или идентификатор среза, который необходимо извлечь.
Возвращаемое значение
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.SlicerCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SlicerCollection;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.SlicerCollection;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.SlicerCollection;Параметры
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.SlicerCollection объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.SlicerCollectionData), который содержит массив «items» с неглубокими копиями любых загруженных свойств из элементов коллекции.
toJSON(): Excel.Interfaces.SlicerCollectionData;