ExcelScript.Slicer interface

Пакет:

ExcelScript

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

Комментарии

Примеры

/**
 * This script adds a slicer for an existing PivotTable.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable named "Farm Pivot".
  const farmPivot = workbook.getPivotTable("Farm Pivot");

  // Create the slicer. 
  // Note that this assumes "Type" is already added as a hierarchy to the PivotTable.
  const fruitSlicer: ExcelScript.Slicer = workbook.addSlicer(
    farmPivot, /* The table or PivotTale to be sliced. */
    farmPivot.getHierarchy("Type").getFields()[0] /* What source field to use as the slicer options. */
  );

  // Select the items to display.
  fruitSlicer.selectItems(["Lemon", "Lime"]);

  // Set the left margin of the slicer.
  fruitSlicer.setLeft(400);
}

Методы

clearFilters()	Удаляет все фильтры, примененные к срезу.
delete()	Удаляет срез.
getCaption()	Представляет подпись среза.
getHeight()	Представляет высоту среза (в пунктах). InvalidArgument Создает исключение, если задано отрицательное значение или ноль в качестве входных данных.
getId()	Представляет уникальный идентификатор среза.
getIsFilterCleared()	Значение равно , true если все фильтры, применяемые в данный момент к срезу, очищены.
getLeft()	Представляет расстояние в пунктах от левого края среза до левого края листа. Выдает ошибку InvalidArgument , если задано отрицательное значение в качестве входных данных.
getName()	Представляет имя среза.
getSelectedItems()	Возвращает массив имен выбранных ключей элементов.
getSlicerItem(key)	Получает элемент среза по ключу или имени. Если элемент среза не существует, этот метод возвращает undefined.
getSlicerItems()	Представляет коллекцию элементов среза, которые являются частью среза.
getSortBy()	Представляет порядок сортировки элементов в срезе. Возможные значения: "DataSourceOrder", "По возрастанию", "По убыванию".
getStyle()	Значение константы, представляющее стиль среза. Возможные значения: "SlicerStyleLight1" – "SlicerStyleLight6", "TableStyleOther1" – "TableStyleOther2", "SlicerStyleDark1" – "SlicerStyleDark6". Также можно указать настраиваемый пользовательский стиль, имеющийся в книге.
getTop()	Представляет расстояние в пунктах от верхнего края среза до верхнего края листа. Выдает ошибку InvalidArgument , если задано отрицательное значение в качестве входных данных.
getWidth()	Представляет ширину среза (в пунктах). Выдает ошибку InvalidArgument , если задано отрицательное значение или ноль в качестве входных данных.
getWorksheet()	Представляет лист, содержащий срез.
selectItems(items)	Выбирает элементы среза на основе их ключей. Предыдущие выбранные элементы будут сняты. Все элементы будут выбраны по умолчанию, если массив пуст.
setCaption(caption)	Представляет подпись среза.
setHeight(height)	Представляет высоту среза (в пунктах). InvalidArgument Создает исключение, если задано отрицательное значение или ноль в качестве входных данных.
setLeft(left)	Представляет расстояние в пунктах от левого края среза до левого края листа. Выдает ошибку InvalidArgument , если задано отрицательное значение в качестве входных данных.
setName(name)	Представляет имя среза.
setSortBy(sortBy)	Представляет порядок сортировки элементов в срезе. Возможные значения: "DataSourceOrder", "По возрастанию", "По убыванию".
setStyle(style)	Значение константы, представляющее стиль среза. Возможные значения: "SlicerStyleLight1" – "SlicerStyleLight6", "TableStyleOther1" – "TableStyleOther2", "SlicerStyleDark1" – "SlicerStyleDark6". Также можно указать настраиваемый пользовательский стиль, имеющийся в книге.
setTop(top)	Представляет расстояние в пунктах от верхнего края среза до верхнего края листа. Выдает ошибку InvalidArgument , если задано отрицательное значение в качестве входных данных.
setWidth(width)	Представляет ширину среза (в пунктах). Выдает ошибку InvalidArgument , если задано отрицательное значение или ноль в качестве входных данных.

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

clearFilters()

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

clearFilters(): void;

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

void

delete()

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

delete(): void;

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

void

getCaption()

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

getCaption(): string;

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

string

getHeight()

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

getHeight(): number;

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

number

getId()

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

getId(): string;

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

string

getIsFilterCleared()

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

getIsFilterCleared(): boolean;

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

boolean

getLeft()

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

getLeft(): number;

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

number

getName()

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

getName(): string;

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

string

getSelectedItems()

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

getSelectedItems(): string[];

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

string[]

getSlicerItem(key)

Получает элемент среза по ключу или имени. Если элемент среза не существует, этот метод возвращает undefined.

getSlicerItem(key: string): SlicerItem | undefined;

Параметры

key

string

Ключ или имя извлекаемого среза.

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

ExcelScript.SlicerItem | undefined

getSlicerItems()

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

getSlicerItems(): SlicerItem[];

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

ExcelScript.SlicerItem[]

getSortBy()

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

getSortBy(): SlicerSortType;

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

ExcelScript.SlicerSortType

getStyle()

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

getStyle(): string;

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

string

getTop()

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

getTop(): number;

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

number

getWidth()

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

getWidth(): number;

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

number

getWorksheet()

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

getWorksheet(): Worksheet;

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

ExcelScript.Worksheet

selectItems(items)

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

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

Параметры

items

string[]

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

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

void

setCaption(caption)

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

setCaption(caption: string): void;

Параметры

caption

string

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

void

setHeight(height)

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

setHeight(height: number): void;

Параметры

height

number

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

void

setLeft(left)

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

setLeft(left: number): void;

Параметры

left

number

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

void

setName(name)

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

setName(name: string): void;

Параметры

name

string

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

void

setSortBy(sortBy)

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

setSortBy(sortBy: SlicerSortType): void;

Параметры

sortBy

ExcelScript.SlicerSortType

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

void

setStyle(style)

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

setStyle(style: string): void;

Параметры

style

string

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

void

setTop(top)

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

setTop(top: number): void;

Параметры

top

number

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

void

setWidth(width)

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

setWidth(width: number): void;

Параметры

width

number

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

void