Class Slicer

Слайсер

Представляет собой фильтр , используемый для фильтрации диапазонов, диаграмм и сводных таблиц в несовместном режиме. Этот класс содержит методы для доступа к существующим фильтрам и их изменения. Для создания нового фильтра используйте Sheet.insertSlicer(range, anchorRowPos, anchorColPos) .

Методы

Метод Тип возвращаемого значения Краткое описание
get Background Color Object() Color |null Возвращает Color фона элемента управления.
get Column Position() Integer|null Возвращает позицию столбца (относительно диапазона данных среза), к которому применяется фильтр в срезе, или null если позиция столбца не задана.
get Container Info() Container Info Получает информацию о местоположении среза на листе.
get Filter Criteria() Filter Criteria |null Возвращает критерии фильтрации среза или null , если критерии фильтрации не заданы.
get Range() Range Получает диапазон данных, к которому применяется фильтр.
get Title() String Возвращает название среза.
get Title Horizontal Alignment() String Выравнивает заголовок по горизонтали.
get Title Text Style() Text Style Возвращает стиль текста заголовка фильтра.
is Applied To Pivot Tables() Boolean Возвращает значение, указывающее, применяется ли заданный фильтр к сводным таблицам.
remove() void Удаляет слайсер.
set Apply To Pivot Tables(applyToPivotTables) Slicer Определяет, следует ли применять данный фильтр к сводным таблицам на листе.
set Background Color(color) Slicer Задает цвет фона для инструмента нарезки.
set Background Color Object(color) Slicer Задает Color фона элемента управления нарезкой.
set Column Filter Criteria(columnPosition, filterCriteria) Slicer Задает индекс столбца и критерии фильтрации для фильтра.
set Position(anchorRowPos, anchorColPos, offsetX, offsetY) Slicer Задает положение инструмента нарезки на листе.
set Range(rangeApi) Slicer Задает диапазон данных, к которому применяется фильтр.
set Title(title) Slicer Задает заголовок среза.
set Title Horizontal Alignment(horizontalAlignment) Slicer Задает горизонтальное выравнивание заголовка в срезе.
set Title Text Style(textStyle) Slicer Задает стиль текста в срезе.

Подробная документация

getBackgroundColorObject()

Возвращает Color фона элемента управления.

Возвращаться

Color |null — Цвет фона этого среза. Возвращает null если цвет не задан.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getColumnPosition()

Возвращает позицию столбца (относительно диапазона данных среза), к которому применяется фильтр в срезе, или null если позиция столбца не задана. Это должна быть позиция столбца с индексом от 1, аналогично функции filter.

Возвращаться

Integer|null — Позиция столбца в этом фильтре.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getContainerInfo()

Получает информацию о местоположении среза на листе.

Возвращаться

ContainerInfo — Объект, содержащий позицию контейнера в срезе.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getFilterCriteria()

Возвращает критерии фильтрации среза или null , если критерии фильтрации не заданы.

Возвращаться

FilterCriteria |null — Критерии фильтрации для этого фильтра.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getRange()

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

Возвращаться

Range — Диапазон нарезки.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getTitle()

Возвращает название среза.

Возвращаться

String — Этот инструмент предназначен для создания цепочек строк.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getTitleHorizontalAlignment()

Выравнивает заголовок по горизонтали.

Возвращаться

String — Горизонтальное выравнивание заголовка этого среза.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getTitleTextStyle()

Возвращает стиль текста заголовка фильтра.

Возвращаться

TextStyle — Стиль текста заголовка этого фильтра.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

isAppliedToPivotTables()

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

Возвращаться

Booleantrue если этот фильтр применяется к сводным таблицам, в противном случае false .

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

remove()

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

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setApplyToPivotTables(applyToPivotTables)

Определяет, следует ли применять данный фильтр к сводным таблицам на листе.

Параметры

Имя Тип Описание
apply To Pivot Tables Boolean Указывает, следует ли применять этот фильтр к сводным таблицам.

Возвращаться

Slicer — Этот слайсер предназначен для нарезки цепочек.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setBackgroundColor(color)

Задает цвет фона среза. Значение null сбрасывает цвет фона.

Параметры

Имя Тип Описание
color String Новый цвет фона этого среза в формате CSS (например, '#ffffff').

Возвращаться

Slicer — Этот слайсер предназначен для нарезки цепочек.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setBackgroundColorObject(color)

Задает Color фона элемента управления. Значение null сбрасывает цвет фона.

Параметры

Имя Тип Описание
color Color Новый цвет фона этого инструмента нарезки.

Возвращаться

Slicer — Этот слайсер предназначен для нарезки цепочек.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setColumnFilterCriteria(columnPosition, filterCriteria)

Задает индекс столбца и критерии фильтрации для фильтра. Значение null сбрасывает фильтр фильтра.

Параметры

Имя Тип Описание
column Position Integer Новое положение столбца в этом срезе.
filter Criteria Filter Criteria Новые критерии фильтрации для этого среза.

Возвращаться

Slicer — Этот слайсер предназначен для нарезки цепочек.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

Задает положение фильтра на листе. Индексы позиций строк и столбцов привязки имеют индексацию от 1.

Параметры

Имя Тип Описание
anchor Row Pos Integer Верхняя сторона слайсера закреплена в этом ряду.
anchor Col Pos Integer Верхняя сторона слайсера закреплена в этом месте.
offsetX Integer Горизонтальное смещение от угла ячейки в пикселях.
offsetY Integer Вертикальное смещение от угла ячейки в пикселях.

Возвращаться

Slicer — Этот слайсер предназначен для нарезки цепочек.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setRange(rangeApi)

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

Параметры

Имя Тип Описание
range Api Range Новая линейка для этой слайсерной машины.

Возвращаться

Slicer — Этот слайсер предназначен для нарезки цепочек.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setTitle(title)

Задает заголовок среза. Пустой заголовок сбрасывает значение по умолчанию.

Параметры

Имя Тип Описание
title String Новое название этого слайсера.

Возвращаться

Slicer — Этот слайсер предназначен для нарезки цепочек.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setTitleHorizontalAlignment(horizontalAlignment)

Задает горизонтальное выравнивание заголовка в срезе. Значение null сбрасывает выравнивание.

Параметры

Имя Тип Описание
horizontal Alignment String Новое горизонтальное выравнивание заголовка этого инструмента для нарезки.

Возвращаться

Slicer — Этот слайсер предназначен для нарезки цепочек.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setTitleTextStyle(textStyle)

Задает стиль текста в срезе.

Параметры

Имя Тип Описание
text Style Text Style Новый стиль текста заголовка инструмента нарезки.

Возвращаться

Slicer — Этот слайсер предназначен для нарезки цепочек.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

Устаревшие методы