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

Excel.Slicer class

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

Slicer Представляет объект в книге.

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.10 ]

Свойства

caption

Представляет подпись среза.
context

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

Представляет высоту среза (в пунктах). InvalidArgument Создает исключение, если задано отрицательное значение или ноль в качестве входных данных.
id

Представляет уникальный идентификатор среза.
isFilterCleared

Значение равно , true если все фильтры, применяемые в данный момент к срезу, очищены.
left

Представляет расстояние в пунктах от левого края среза до левого края листа. Выдает ошибку InvalidArgument , если задано отрицательное значение в качестве входных данных.
name

Представляет имя среза.
nameInFormula

Представляет имя среза, используемое в формуле.
slicerItems

Представляет коллекцию элементов среза, которые являются частью среза.
slicerStyle

Стиль, применяемый к срезу.
sortBy

Представляет порядок сортировки элементов в срезе. Возможные значения: "DataSourceOrder", "По возрастанию", "По убыванию".
style

Значение константы, представляющее стиль среза. Возможные значения: "SlicerStyleLight1" – "SlicerStyleLight6", "TableStyleOther1" – "TableStyleOther2", "SlicerStyleDark1" – "SlicerStyleDark6". Также можно указать настраиваемый пользовательский стиль, имеющийся в книге.
top

Представляет расстояние в пунктах от верхнего края среза до верхнего края листа. Выдает ошибку InvalidArgument , если задано отрицательное значение в качестве входных данных.
width

Представляет ширину среза (в пунктах). Выдает ошибку InvalidArgument , если задано отрицательное значение или ноль в качестве входных данных.
worksheet

Представляет лист, содержащий срез.

Методы

clearFilters()

Удаляет все фильтры, примененные к срезу.
delete()

Удаляет срез.
getSelectedItems()

Возвращает массив имен выбранных ключей элементов.
load(options)

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

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

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

Выбирает элементы среза на основе их ключей. Предыдущие выбранные элементы будут сняты. Все элементы будут выбраны по умолчанию, если массив пуст.
set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
setStyle(style)

Задает стиль, применяемый к срезу.
toJSON()

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

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

caption

Представляет подпись среза.

caption: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.10 ]

context

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

context: RequestContext;

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

Excel.RequestContext

height

Представляет высоту среза (в пунктах). InvalidArgument Создает исключение, если задано отрицательное значение или ноль в качестве входных данных.

height: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.10 ]

id

Представляет уникальный идентификатор среза.

readonly id: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.10 ]

isFilterCleared

Значение равно , true если все фильтры, применяемые в данный момент к срезу, очищены.

readonly isFilterCleared: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.10 ]

left

Представляет расстояние в пунктах от левого края среза до левого края листа. Выдает ошибку InvalidArgument , если задано отрицательное значение в качестве входных данных.

left: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.10 ]

name

Представляет имя среза.

name: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.10 ]

nameInFormula

Примечание

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

Представляет имя среза, используемое в формуле.

nameInFormula: string;

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

string

Комментарии

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

slicerItems

Представляет коллекцию элементов среза, которые являются частью среза.

readonly slicerItems: Excel.SlicerItemCollection;

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

Excel.SlicerItemCollection

Комментарии

[ Набор API: ExcelApi 1.10 ]

slicerStyle

Примечание

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

Стиль, применяемый к срезу.

readonly slicerStyle: Excel.SlicerStyle;

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

Excel.SlicerStyle

Комментарии

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

sortBy

Представляет порядок сортировки элементов в срезе. Возможные значения: "DataSourceOrder", "По возрастанию", "По убыванию".

sortBy: Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending";

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

Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending"

Комментарии

[ Набор API: ExcelApi 1.10 ]

style

Значение константы, представляющее стиль среза. Возможные значения: "SlicerStyleLight1" – "SlicerStyleLight6", "TableStyleOther1" – "TableStyleOther2", "SlicerStyleDark1" – "SlicerStyleDark6". Также можно указать настраиваемый пользовательский стиль, имеющийся в книге.

style: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.10 ]

Примеры

// 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.style = "SlicerStyleLight6";
    await context.sync();
});

top

Представляет расстояние в пунктах от верхнего края среза до верхнего края листа. Выдает ошибку InvalidArgument , если задано отрицательное значение в качестве входных данных.

top: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.10 ]

width

Представляет ширину среза (в пунктах). Выдает ошибку InvalidArgument , если задано отрицательное значение или ноль в качестве входных данных.

width: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.10 ]

worksheet

Представляет лист, содержащий срез.

readonly worksheet: Excel.Worksheet;

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

Excel.Worksheet

Комментарии

[ Набор API: ExcelApi 1.10 ]

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

clearFilters()

Удаляет все фильтры, примененные к срезу.

clearFilters(): void;

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

void

Комментарии

[ Набор API: ExcelApi 1.10 ]

Примеры

// 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.clearFilters();
    await context.sync();
});

delete()

Удаляет срез.

delete(): void;

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

void

Комментарии

[ Набор API: ExcelApi 1.10 ]

Примеры

// 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.getActiveWorksheet();
    sheet.slicers.getItemAt(0).delete();
    await context.sync();
});

getSelectedItems()

Возвращает массив имен выбранных ключей элементов.

getSelectedItems(): OfficeExtension.ClientResult<string[]>;

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

OfficeExtension.ClientResult<string[]>

Комментарии

[ Набор API: ExcelApi 1.10 ]

load(options)

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

load(options?: Excel.Interfaces.SlicerLoadOptions): Excel.Slicer;

Параметры

options
Excel.Interfaces.SlicerLoadOptions

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

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

Excel.Slicer

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.Slicer

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Excel.Slicer

selectItems(items)

Выбирает элементы среза на основе их ключей. Предыдущие выбранные элементы будут сняты. Все элементы будут выбраны по умолчанию, если массив пуст.

selectItems(items?: string[]): void;

Параметры

items

string[]

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

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

void

Комментарии

[ Набор API: ExcelApi 1.10 ]

Примеры

// 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.selectItems(["Lemon", "Lime", "Orange"]);
    await context.sync();
});

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.SlicerUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties
Excel.Interfaces.SlicerUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options
OfficeExtension.UpdateOptions

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

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

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Excel.Slicer): void;

Параметры

properties
Excel.Slicer

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

void

setStyle(style)

Примечание

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

Задает стиль, применяемый к срезу.

setStyle(style: string | SlicerStyle | BuiltInSlicerStyle): void;

Параметры

style

string | Excel.SlicerStyle | Excel.BuiltInSlicerStyle

Стиль, применяемый к срезу. Если InvalidArgument указана строка, не соответствующая имени стиля, возникает ошибка.

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

void

Комментарии

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

toJSON()

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

toJSON(): Excel.Interfaces.SlicerData;

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

Excel.Interfaces.SlicerData