Excel.SlicerCollection interface

Представляет коллекцию всех объектов срезов в книге или листе.

Методы

add(slicerSource, sourceField, slicerDestination)

Добавляет новый срез в книгу.

getCount()

Возвращает количество срезов в коллекции.

getItem(key)

Получает объект slicer по его имени или ИД.

getItemAt(index)

Получает срез на основе его позиции в коллекции.

getItemOrNullObject(key)

Получает срез по его имени или ИД. Если срез не существует, возвращает пустой объект.

load(propertyNames)

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

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

add(slicerSource, sourceField, slicerDestination)

Добавляет новый срез в книгу.

add(
            slicerSource: string | PivotTable | Table,
            sourceField: string | PivotField | number | TableColumn,
            slicerDestination?: string | Worksheet
        ): Slicer;

Параметры

slicerSource
string | PivotTable | Table

Источник данных, на котором будет основан новый срез. Это может быть объект PivotTable, объект Table или строка. Когда объект сводной таблицы передается, источником данных является источник объекта сводной таблицы. Когда передается объект Table, источником данных является объект Table. Когда строка передается, она интерпретируется как имя/идентификатор сводной таблицы или таблицы.

sourceField
string | PivotField | number | TableColumn

Поле в источнике данных, по которому выполняется фильтрация. Это может быть объект PivotField, объект TableColumn, идентификатор PivotField или идентификатор и имя TableColumn.

slicerDestination
string | Worksheet

Необязательный параметр. Лист, в котором будет создан новый срез. Это может быть объект листа или имя или идентификатор листа. Этот параметр можно опустить, если коллекция срезов извлекается из листа.

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

Примеры

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Pivot");
    let 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(): ClientResult<number>;

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

ClientResult<number>

getItem(key)

Получает объект slicer по его имени или ИД.

getItem(key: string): Slicer;

Параметры

key
string

Имя или идентификатор среза.

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

getItemAt(index)

Получает срез на основе его позиции в коллекции.

getItemAt(index: number): Slicer;

Параметры

index
number

Значение индекса получаемого объекта. Используется нулевой индекс.

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

getItemOrNullObject(key)

Получает срез по его имени или ИД. Если срез не существует, возвращает пустой объект.

getItemOrNullObject(key: string): Slicer;

Параметры

key
string

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

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

load(propertyNames)

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

load(propertyNames?: string | string[]): void;

Параметры

propertyNames
string | string[]

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

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

void