Class Slicer

スライサー

スライサーを表します。範囲、グラフ、ピボット テーブルを非共同編集方式でフィルタするために使用されます。このクラスには、既存のスライサーにアクセスして変更するメソッドが含まれています。新しいスライサーを作成するには、Sheet.insertSlicer(range, anchorRowPos, anchorColPos) を使用します。

メソッド

メソッド戻り値の型概要
getBackgroundColorObject()Colorスライサーの背景 Color を返します。
getColumnPosition()Integerスライサーでフィルタが適用されている列の位置（スライサーのデータ範囲を基準とする）を返します。列の位置が設定されていない場合は null を返します。
getContainerInfo()ContainerInfoシート内でのスライサーの位置に関する情報を取得します。
getFilterCriteria()FilterCriteriaスライサーのフィルタ条件を返します。フィルタ条件が設定されていない場合は null を返します。
getRange()Rangeスライサーが適用されるデータ範囲を取得します。
getTitle()Stringスライサーのタイトルを返します。
getTitleHorizontalAlignment()Stringタイトルの水平方向の配置を取得します。
getTitleTextStyle()TextStyleスライサーのタイトルのテキスト スタイルを返します。
isAppliedToPivotTables()Boolean指定されたスライサーがピボット テーブルに適用されているかどうかを返します。
remove()voidスライサーを削除します。
setApplyToPivotTables(applyToPivotTables)Slicer指定したスライサーをワークシート内のピボット テーブルに適用するかどうかを設定します。
setBackgroundColor(color)Slicerスライサーの背景色を設定します。
setBackgroundColorObject(color)Slicerスライサーの背景 Color を設定します。
setColumnFilterCriteria(columnPosition, filterCriteria)Slicerスライサーの列番号とフィルタ条件を設定します。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)Slicerシート上にスライサーが表示される位置を設定します。
setRange(rangeApi)Slicerスライサーを適用するデータ範囲を設定します。
setTitle(title)Slicerスライサーのタイトルを設定します。
setTitleHorizontalAlignment(horizontalAlignment)Slicerスライサーのタイトルの水平方向の配置を設定します。
setTitleTextStyle(textStyle)Slicerスライサーのテキスト スタイルを設定します。
メソッド戻り値の型概要
getBackgroundColor()Stringスライサーの背景色を CSS 表記（「#ffffff」など）で返します。

詳細なドキュメント

getBackgroundColorObject()

スライサーの背景 Color を返します。

戻る

Color - このスライサーの背景色。色が設定されていない場合は null を返します。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

getColumnPosition()

スライサーでフィルタが適用されている列の位置（スライサーのデータ範囲を基準とする）を返します。列の位置が設定されていない場合は null を返します。これは、フィルタと同様に、1 からインデックスされた列の位置にする必要があります。

戻る

Integer - このスライサーの列位置。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

getContainerInfo()

シート内でのスライサーの位置に関する情報を取得します。

戻る

ContainerInfo - スライサーのコンテナの位置を含むオブジェクト。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

getFilterCriteria()

スライサーのフィルタ条件を返します。フィルタ条件が設定されていない場合は null を返します。

戻る

FilterCriteria - このスライサーのフィルタ条件。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

getRange()

スライサーが適用されるデータ範囲を取得します。

戻る

Range - スライサーの範囲。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

getTitle()

スライサーのタイトルを返します。

戻る

String - チェーン用のスライサー。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

getTitleHorizontalAlignment()

タイトルの水平方向の配置を取得します。

戻る

String - このスライサーのタイトルの水平方向の配置。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

getTitleTextStyle()

スライサーのタイトルのテキスト スタイルを返します。

戻る

TextStyle - このスライサーのタイトルのテキスト スタイル。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

isAppliedToPivotTables()

指定されたスライサーがピボット テーブルに適用されているかどうかを返します。

戻る

Boolean - このスライサーがピボット テーブルに適用されている場合は true、それ以外の場合は false。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

remove()

スライサーを削除します。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

setApplyToPivotTables(applyToPivotTables)

指定したスライサーをワークシート内のピボット テーブルに適用するかどうかを設定します。

パラメータ

名前型説明
applyToPivotTablesBooleanこのスライサーをピボット テーブルに適用するかどうかを指定します。

戻る

Slicer - チェーン用のスライサー。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

setBackgroundColor(color)

スライサーの背景色を設定します。null 値は背景色をリセットします。

パラメータ

名前型説明
colorStringこのスライサーの新しい背景色（CSS 表記:「#ffffff」など）。

戻る

Slicer - チェーン用のスライサー。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

setBackgroundColorObject(color)

スライサーの背景 Color を設定します。null 値は背景色をリセットします。

パラメータ

名前型説明
colorColorこのスライサーの新しい背景色。

戻る

Slicer - チェーン用のスライサー。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

setColumnFilterCriteria(columnPosition, filterCriteria)

スライサーの列番号とフィルタ条件を設定します。null 値はスライサー フィルタをリセットします。

パラメータ

名前型説明
columnPositionIntegerこのスライサーの新しい列位置。
filterCriteriaFilterCriteriaこのスライサーの新しいフィルタ条件。

戻る

Slicer - チェーン用のスライサー。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

シート上にスライサーが表示される位置を設定します。アンカーの行と列の位置のインデックスは 1 から始まります。

パラメータ

名前型説明
anchorRowPosIntegerスライサーの上部は、この行に固定されます。
anchorColPosIntegerスライサーの上部がこの列に固定されます。
offsetXIntegerセルの角からの水平方向のオフセット（ピクセル単位）。
offsetYIntegerセルの角からの垂直オフセット（ピクセル単位）。

戻る

Slicer - チェーン用のスライサー。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

setRange(rangeApi)

スライサーを適用するデータ範囲を設定します。

パラメータ

名前型説明
rangeApiRangeこのスライサーの新しい範囲。

戻る

Slicer - チェーン用のスライサー。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

setTitle(title)

スライサーのタイトルを設定します。タイトルが空白の場合、タイトルはデフォルト値にリセットされます。

パラメータ

名前型説明
titleStringこのスライサーの新しいタイトル。

戻る

Slicer - チェーン用のスライサー。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

setTitleHorizontalAlignment(horizontalAlignment)

スライサーのタイトルの水平方向の配置を設定します。null 値は、配置をリセットします。

パラメータ

名前型説明
horizontalAlignmentStringこのスライサーのタイトルの新しい水平方向の配置。

戻る

Slicer - チェーン用のスライサー。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

setTitleTextStyle(textStyle)

スライサーのテキスト スタイルを設定します。

パラメータ

名前型説明
textStyleTextStyleスライサーのタイトルの新しいテキスト スタイル。

戻る

Slicer - チェーン用のスライサー。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

サポート終了のメソッド

非推奨。getBackgroundColorObject() に置き換え

スライサーの背景色を CSS 表記（「#ffffff」など）で返します。

戻る

String - このスライサーの背景色。色が設定されていない場合は null を返します。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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