このサービスを使用すると、スクリプトで Google スプレッドシート ファイルの作成、アクセス、変更を行うことができます。スプレッドシートへのデータの保存ガイドもご覧ください。
1 つのメソッドに対して複数の呼び出しを行う場合など、パフォーマンス向上のためにスプレッドシートのオペレーションがバンドルされている場合もあります。スクリプトの実行中にユーザーに情報を表示する場合など、保留中の変更をすべて直ちに処理したい場合は、SpreadsheetApp.flush()
を呼び出します。
クラス
Name | 概要 |
---|---|
AutoFillSeries | 自動入力される値の計算に使用される系列を列挙します。 |
Banding | 範囲の行または列に適用される縞模様(カラーパターン)にアクセスして変更します。 |
BandingTheme | バンディングテーマを列挙したものです。 |
BigQueryDataSourceSpec | 既存の BigQuery データソース仕様にアクセスします。 |
BigQueryDataSourceSpecBuilder | BigQueryDataSourceSpecBuilder のビルダー。 |
BooleanCondition | ConditionalFormatRules のブール条件にアクセスします。 |
BooleanCriteria | 条件付き書式またはフィルタで使用できるブール値の条件を表す列挙型。 |
BorderStyle | Range.setBorder(top, left, bottom, right, vertical, horizontal, color, style) を使用して範囲に設定できるスタイル。 |
CellImage | セルに追加する画像を表します。 |
CellImageBuilder | CellImage のビルダー。 |
Color | 色の表現。 |
ColorBuilder | ColorBuilder のビルダー。 |
ConditionalFormatRule | 条件付き書式ルールにアクセスします。 |
ConditionalFormatRuleBuilder | 条件付き書式ルールのビルダー。 |
ContainerInfo | シート内のグラフの位置にアクセスします。 |
CopyPasteType | 可能な特殊なペーストタイプの列挙です。 |
DataExecutionErrorCode | データ実行エラーコードの列挙。 |
DataExecutionState | データ実行状態の列挙。 |
DataExecutionStatus | データの実行ステータス。 |
DataSource | 既存のデータソースにアクセスして変更する。 |
DataSourceChart | 既存のデータソースのグラフにアクセスして変更します。 |
DataSourceColumn | データソースの列にアクセスして変更します。 |
DataSourceFormula | 既存のデータソースの数式にアクセスして変更する。 |
DataSourceParameter | 既存のデータソース パラメータにアクセスします。 |
DataSourceParameterType | データソース パラメータの型の列挙型。 |
DataSourcePivotTable | 既存のデータソースのピボット テーブルにアクセスして変更する。 |
DataSourceRefreshSchedule | 既存の更新スケジュールにアクセスして変更する。 |
DataSourceRefreshScheduleFrequency | 更新スケジュールの頻度(更新頻度とタイミングを指定する)にアクセスします。 |
DataSourceRefreshScope | 更新のスコープを列挙します。 |
DataSourceSheet | 既存のデータソース シートにアクセスして変更する。 |
DataSourceSheetFilter | 既存のデータソース シートのフィルタにアクセスして変更する。 |
DataSourceSpec | 既存のデータソース仕様の全般設定にアクセスします。 |
DataSourceSpecBuilder | DataSourceSpec のビルダー。 |
DataSourceTable | 既存のデータソース テーブルにアクセスして変更します。 |
DataSourceTableColumn | DataSourceTable の既存の列にアクセスして変更する。 |
DataSourceTableFilter | 既存のデータソース テーブル フィルタにアクセスして変更します。 |
DataSourceType | データソース タイプの列挙型。 |
DataValidation | データの入力規則にアクセスします。 |
DataValidationBuilder | データ入力規則のビルダー。 |
DataValidationCriteria | 範囲に対して設定できるデータ検証基準を表す列挙型。 |
DateTimeGroupingRule | 既存の日時グループ化ルールにアクセスします。 |
DateTimeGroupingRuleType | 日時のグループ化ルールのタイプ。 |
DeveloperMetadata | デベロッパー メタデータにアクセスして変更する。 |
DeveloperMetadataFinder | スプレッドシートでデベロッパーのメタデータを検索する。 |
DeveloperMetadataLocation | デベロッパー メタデータの位置情報にアクセスする。 |
DeveloperMetadataLocationType | デベロッパー メタデータのロケーション タイプのタイプを列挙します。 |
DeveloperMetadataVisibility | デベロッパー メタデータの公開設定を列挙します。 |
Dimension | スプレッドシートに保存できるデータの方向を列挙したものです。 |
Direction | 矢印キーを使用してスプレッドシート内で移動できる方向を列挙する列挙型。 |
Drawing | スプレッドシート内のシート上の描画を表します。 |
EmbeddedAreaChartBuilder | 面グラフのビルダー。 |
EmbeddedBarChartBuilder | 棒グラフのビルダー。 |
EmbeddedChart | スプレッドシートに埋め込まれたグラフを表します。 |
EmbeddedChartBuilder | EmbeddedChart の編集に使用するビルダー。 |
EmbeddedColumnChartBuilder | 縦棒グラフのビルダー。 |
EmbeddedComboChartBuilder | 複合グラフのビルダー。 |
EmbeddedHistogramChartBuilder | ヒストグラム グラフのビルダー。 |
EmbeddedLineChartBuilder | 折れ線グラフのビルダー。 |
EmbeddedPieChartBuilder | 円グラフのビルダー。 |
EmbeddedScatterChartBuilder | 散布図のビルダー。 |
EmbeddedTableChartBuilder | 表グラフのビルダー。 |
Filter | このクラスを使用して、デフォルトのシートタイプである Grid シートの既存のフィルタを変更します。 |
FilterCriteria | このクラスを使用して、既存のフィルタに関する情報を取得したり、既存のフィルタの条件をコピーしたりできます。 |
FilterCriteriaBuilder | フィルタに条件を追加するには、次の操作を行います。
|
FrequencyType | 頻度型の列挙型。 |
GradientCondition | ConditionalFormatRuleApis でグラデーション(色)条件にアクセスします。 |
Group | スプレッドシート グループにアクセスして変更する。 |
GroupControlTogglePosition | グループ コントロールの切り替えに配置できる可能性のある位置を表す列挙型。 |
InterpolationType | ConditionalFormatRule の GradientCondition で使用する値を計算するための補間オプションを表す列挙型。 |
NamedRange | スプレッドシートで名前付き範囲を作成、アクセス、変更できます。 |
OverGridImage | スプレッドシートのグリッド上にある画像を表します。 |
| 以前のバージョンの Google スプレッドシートで、保護されているシートへのアクセスと変更を行います。 |
PivotFilter | ピボット テーブルのフィルタにアクセスして変更できます。 |
PivotGroup | ピボット テーブルのブレイクアウト グループにアクセスして変更する。 |
PivotGroupLimit | ピボット テーブル グループの上限にアクセスして変更する。 |
PivotTable | ピボット テーブルにアクセスして変更する。 |
PivotTableSummarizeFunction | ピボット テーブルのデータを集計する関数の列挙です。 |
PivotValue | ピボット テーブルの値グループにアクセスして変更できます。 |
PivotValueDisplayType | ピボット値を別の値の関数として表示する方法を列挙したものです。 |
Protection | 保護されている範囲やシートへのアクセスと変更。 |
ProtectionType | 編集から保護できるスプレッドシートの部分を表す列挙型。 |
Range | スプレッドシートの範囲にアクセスして変更する。 |
RangeList | 同じシート内の 1 つ以上の Range インスタンスのコレクション。 |
RecalculationInterval | スプレッドシートの再計算に使用される可能性のある間隔を表す列挙型。 |
RelativeDate | 日付ベースの BooleanCriteria で使用する値を計算するための相対日付オプションを表す列挙型。 |
RichTextValue | セルテキストを表すための定型化されたテキスト文字列。 |
RichTextValueBuilder | リッチテキスト値のビルダー。 |
Selection | アクティブ シートで現在アクティブな選択内容にアクセスします。 |
Sheet | スプレッドシート シートにアクセスして変更する。 |
SheetType | スプレッドシート内に存在できるシートの種類。 |
Slicer | スライサーを表します。これは、範囲、グラフ、ピボット テーブルをコラボレーション以外の方法でフィルタリングするために使用されます。 |
SortOrder | 並べ替え順を表す列挙型。 |
SortSpec | 並べ替えの仕様。 |
Spreadsheet | Google スプレッドシート ファイルにアクセスして変更する。 |
SpreadsheetApp | Google スプレッドシート ファイルにアクセスして作成する。 |
SpreadsheetTheme | 既存のテーマにアクセスして変更する。 |
TextDirection | テキスト方向の列挙。 |
TextFinder | 範囲、シート、スプレッドシート内のテキストを検索または置換します。 |
TextRotation | セルのテキスト回転設定にアクセスします。 |
TextStyle | セル内のテキストの表示スタイル。 |
TextStyleBuilder | テキスト スタイルのビルダー。 |
TextToColumnsDelimiter | テキストの列を複数の列に分割できるプリセット区切り文字の種類の列挙。 |
ThemeColor | テーマカラーの表現。 |
ThemeColorType | テーマでサポートされているさまざまなカラーエントリを記述する列挙型。 |
ValueType | スプレッドシート サービスの Range クラスから Range.getValue() と Range.getValues() によって返される値の型の列挙型です。 |
WrapStrategy | セルテキストの折り返しを処理するために使用される戦略を列挙します。 |
AutoFillSeries
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
DEFAULT_SERIES | Enum | デフォルトです。 |
ALTERNATE_SERIES | Enum | この設定が自動入力されると、拡張された範囲内の空のセルに既存の値のコピーが入力されます。 |
Banding
Methods
BandingTheme
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
LIGHT_GREY | Enum | ライトグレーの縞模様。 |
CYAN | Enum | シアンのバンディングのテーマ。 |
GREEN | Enum | 緑色の縞模様がテーマ。 |
YELLOW | Enum | 黄色の縞模様がテーマ。 |
ORANGE | Enum | オレンジ色の縞模様が描かれたテーマ。 |
BLUE | Enum | 青い縞模様のテーマ。 |
TEAL | Enum | 青緑の縞模様が描かれたテーマ。 |
GREY | Enum | グレーの縞模様。 |
BROWN | Enum | 茶色の帯状のテーマ。 |
LIGHT_GREEN | Enum | ライトグリーンの縞模様。 |
INDIGO | Enum | 藍色の縞模様。 |
PINK | Enum | ピンクの縞模様。 |
BigQueryDataSourceSpec
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
copy() | DataSourceSpecBuilder | このデータソースの設定に基づいて DataSourceSpecBuilder を作成します。 |
getDatasetId() | String | BigQuery データセット ID を取得します。 |
getParameters() | DataSourceParameter[] | データソースのパラメータを取得します。 |
getProjectId() | String | 課金プロジェクト ID を取得します。 |
getRawQuery() | String | 未加工のクエリ文字列を取得します。 |
getTableId() | String | BigQuery テーブル ID を取得します。 |
getTableProjectId() | String | テーブルの BigQuery プロジェクト ID を取得します。 |
getType() | DataSourceType | データソースのタイプを取得します。 |
BigQueryDataSourceSpecBuilder
Methods
BooleanCondition
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getBackgroundObject() | Color | このブール値の条件の背景色を取得します。 |
getBold() | Boolean | このブール条件がテキストを太字にする場合、true を返し、このブール条件によってテキストから太字が取り除かれた場合は false を返します。 |
getCriteriaType() | BooleanCriteria | BooleanCriteria 列挙型で定義されているルールの条件タイプを取得します。 |
getCriteriaValues() | Object[] | ルールの条件に対応する引数の配列を取得します。 |
getFontColorObject() | Color | このブール条件のフォント色を取得します。 |
getItalic() | Boolean | このブール条件がテキストを斜体にした場合は true を返し、このブール条件によってテキストから斜体を削除すると false を返します。 |
getStrikethrough() | Boolean | このブール条件がテキストをストライクした場合は true を返し、このブール条件がテキストから取り消し線を削除すると false を返します。 |
getUnderline() | Boolean | このブール条件がテキストに下線を引く場合は true を返し、このブール条件によってテキストから下線を削除する場合は false を返します。 |
BooleanCriteria
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
CELL_EMPTY | Enum | セルが空の場合、条件が満たされます。 |
CELL_NOT_EMPTY | Enum | セルが空でない場合、条件が満たされています。 |
DATE_AFTER | Enum | 日付が指定された値より後の場合、条件は満たされます。 |
DATE_BEFORE | Enum | 日付が指定された値より前である場合、条件は満たされます。 |
DATE_EQUAL_TO | Enum | 日付が指定された値と等しいときに、条件が満たされます。 |
DATE_NOT_EQUAL_TO | Enum | 日付が指定された値と等しくない場合、条件は満たされます。 |
DATE_AFTER_RELATIVE | Enum | 日付が相対日付値より後の場合、条件は満たされます。 |
DATE_BEFORE_RELATIVE | Enum | 日付が相対日付値よりも前の場合に条件が満たされます。 |
DATE_EQUAL_TO_RELATIVE | Enum | 日付が相対日付値と等しい場合に条件が満たされます。 |
NUMBER_BETWEEN | Enum | 指定した値の範囲内にある数値が条件に一致します。 |
NUMBER_EQUAL_TO | Enum | 数値が指定された値と等しい場合、条件は満たされます。 |
NUMBER_GREATER_THAN | Enum | 数値が指定された値より大きい場合、条件が満たされます。 |
NUMBER_GREATER_THAN_OR_EQUAL_TO | Enum | 数値が指定された値以上の場合に条件が満たされます。 |
NUMBER_LESS_THAN | Enum | 数値が指定された値より小さい場合、条件が満たされます。 |
NUMBER_LESS_THAN_OR_EQUAL_TO | Enum | 数値が指定された値以下である場合、条件が満たされます。 |
NUMBER_NOT_BETWEEN | Enum | 指定した値の範囲にない数値が条件に一致している。 |
NUMBER_NOT_EQUAL_TO | Enum | 数値が指定された値と等しくない場合、条件が満たされます。 |
TEXT_CONTAINS | Enum | 入力に指定された値が含まれている場合、条件が満たされます。 |
TEXT_DOES_NOT_CONTAIN | Enum | 指定した値が入力内容に含まれない場合、条件が満たされます。 |
TEXT_EQUAL_TO | Enum | 入力が指定された値と等しいときに条件が満たされます。 |
TEXT_NOT_EQUAL_TO | Enum | 入力が指定された値と等しくない場合、条件が満たされます。 |
TEXT_STARTS_WITH | Enum | 入力が指定された値で始まる場合、条件は満たされます。 |
TEXT_ENDS_WITH | Enum | 入力が指定された値で終わると、条件が満たされます。 |
CUSTOM_FORMULA | Enum | 入力によって特定の数式が true と評価されると、条件が満たされます。 |
BorderStyle
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
DOTTED | Enum | 点線の枠線。 |
DASHED | Enum | 破線の枠線。 |
SOLID | Enum | 細い実線の枠線。 |
SOLID_MEDIUM | Enum | 中程度の実線の枠線。 |
SOLID_THICK | Enum | 太い実線の枠線。 |
DOUBLE | Enum | 2 本の実線の枠線。 |
CellImage
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
valueType | ValueType | 画像の値のタイプを表す ValueType.IMAGE に設定されたフィールド。 |
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getAltTextDescription() | String | この画像の代替テキストの説明を返します。 |
getAltTextTitle() | String | この画像の代替テキストのタイトルを返します。 |
getContentUrl() | String | Google がホストする画像の URL を返します。 |
getUrl() | String | 画像のソース URL を取得します。URL を使用できない場合は null を返します。 |
toBuilder() | CellImageBuilder | 画像をセルに配置できるように、画像を画像値の型に変換するビルダーを作成します。 |
CellImageBuilder
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
valueType | ValueType | 画像の値のタイプを表す ValueType.IMAGE に設定されたフィールド。 |
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
build() | CellImage | セルに画像を追加するために必要な画像値の型を作成します。 |
getAltTextDescription() | String | この画像の代替テキストの説明を返します。 |
getAltTextTitle() | String | この画像の代替テキストのタイトルを返します。 |
getContentUrl() | String | Google がホストする画像の URL を返します。 |
getUrl() | String | 画像のソース URL を取得します。URL を使用できない場合は null を返します。 |
setAltTextDescription(description) | CellImage | この画像の代替テキストの説明を設定します。 |
setAltTextTitle(title) | CellImage | この画像の代替テキストのタイトルを設定します。 |
setSourceUrl(url) | CellImageBuilder | 画像のソース URL を設定します。 |
toBuilder() | CellImageBuilder | 画像をセルに配置できるように、画像を画像値の型に変換するビルダーを作成します。 |
Color
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
asRgbColor() | RgbColor | この色を RgbColor に変換します。 |
asThemeColor() | ThemeColor | この色を ThemeColor に変換します。 |
getColorType() | ColorType | この色のタイプを取得します。 |
ColorBuilder
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
asRgbColor() | RgbColor | この色を RgbColor に変換します。 |
asThemeColor() | ThemeColor | この色を ThemeColor に変換します。 |
build() | Color | ビルダーに渡された設定からカラー オブジェクトを作成します。 |
getColorType() | ColorType | この色のタイプを取得します。 |
setRgbColor(cssString) | ColorBuilder | RGB カラーとして設定します。 |
setThemeColor(themeColorType) | ColorBuilder | テーマの色として設定します。 |
ConditionalFormatRule
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
copy() | ConditionalFormatRuleBuilder | このルールの設定を含むルール作成ツールのプリセットを返します。 |
getBooleanCondition() | BooleanCondition | このルールがブール条件条件を使用する場合、ルールの BooleanCondition 情報を取得します。 |
getGradientCondition() | GradientCondition | このルールでグラデーション条件の条件を使用する場合は、ルールの GradientCondition 情報を取得します。 |
getRanges() | Range[] | この条件付き書式ルールが適用される範囲を取得します。 |
ConditionalFormatRuleBuilder
Methods
ContainerInfo
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getAnchorColumn() | Integer | グラフの左側がこの列に固定されています。 |
getAnchorRow() | Integer | グラフの上部がこの行に固定されています。 |
getOffsetX() | Integer | グラフの左上隅は、アンカー列からこのピクセル数だけオフセットされます。 |
getOffsetY() | Integer | グラフの左上隅は、アンカー行からこのピクセル数だけオフセットされます。 |
CopyPasteType
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
PASTE_NORMAL | Enum | 値、数式、書式、結合を貼り付けます。 |
PASTE_NO_BORDERS | Enum | 値、数式、書式、結合を枠線なしで貼り付けます。 |
PASTE_FORMAT | Enum | 書式のみ貼り付けてください。 |
PASTE_FORMULA | Enum | 数式のみを貼り付けます。 |
PASTE_DATA_VALIDATION | Enum | データの検証のみ貼り付けてください。 |
PASTE_VALUES | Enum | 値のみ貼り付けてください。書式、数式、結合は含めないでください。 |
PASTE_CONDITIONAL_FORMATTING | Enum | 色のルールのみを貼り付けます。 |
PASTE_COLUMN_WIDTHS | Enum | 列幅のみを貼り付けます。 |
DataExecutionErrorCode
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
DATA_EXECUTION_ERROR_CODE_UNSUPPORTED | Enum | Apps Script でサポートされていないデータ実行のエラーコード。 |
NONE | Enum | データの実行でエラーはありません。 |
TIME_OUT | Enum | データの実行がタイムアウトしました。 |
TOO_MANY_ROWS | Enum | データを実行すると、上限を超える行が返されます。 |
TOO_MANY_COLUMNS | Enum | データの実行により、制限を超える列が返されます。 |
TOO_MANY_CELLS | Enum | データを実行すると、制限を超える数のセルが返されます。 |
ENGINE | Enum | データ実行エンジンでエラーが発生しました。 |
PARAMETER_INVALID | Enum | データ実行パラメータが無効です。 |
UNSUPPORTED_DATA_TYPE | Enum | データを実行すると、サポートされていないデータ型が返されます。 |
DUPLICATE_COLUMN_NAMES | Enum | データを実行すると、重複する列名が返されます。 |
INTERRUPTED | Enum | データの実行は中断される。 |
OTHER | Enum | その他のエラー。 |
TOO_MANY_CHARS_PER_CELL | Enum | データを実行すると、1 つのセルに許容される最大文字数を超える値が返されます。 |
DATA_NOT_FOUND | Enum | データソースが参照しているデータベースが見つかりません。 |
PERMISSION_DENIED | Enum | データソースで参照されるデータベースへのアクセス権がありません。 |
DataExecutionState
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
DATA_EXECUTION_STATE_UNSUPPORTED | Enum | Apps Script ではデータ実行状態はサポートされていません。 |
RUNNING | Enum | データの実行が開始され、実行されています。 |
SUCCESS | Enum | データの実行が完了し、成功しました。 |
ERROR | Enum | データの実行が完了し、エラーが発生しました。 |
NOT_STARTED | Enum | データの実行は開始されていません。 |
DataExecutionStatus
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getErrorCode() | DataExecutionErrorCode | データ実行のエラーコードを取得します。 |
getErrorMessage() | String | データ実行のエラー メッセージを取得します。 |
getExecutionState() | DataExecutionState | データ実行の状態を取得します。 |
getLastExecutionTime() | Date | 実行状態に関係なく、最後のデータ実行が完了した時刻を取得します。 |
getLastRefreshedTime() | Date | データが最後に正常に更新された時刻を取得します。 |
isTruncated() | Boolean | 最後に成功した実行のデータが切り捨てられた場合は true を返し、それ以外の場合は false を返します。 |
DataSource
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
createCalculatedColumn(name, formula) | DataSourceColumn | 計算された列を作成します。 |
createDataSourcePivotTableOnNewSheet() | DataSourcePivotTable | 新しいシートの最初のセルに、このデータソースからデータソースのピボット テーブルを作成します。 |
createDataSourceTableOnNewSheet() | DataSourceTable | 新しいシートの最初のセルに、このデータソースからデータソース テーブルを作成します。 |
getCalculatedColumnByName(columnName) | DataSourceColumn | 列名と一致するデータソース内の計算された列を返します。 |
getCalculatedColumns() | DataSourceColumn[] | データソース内で計算されたすべての列を返します。 |
getColumns() | DataSourceColumn[] | データソース内のすべての列を返します。 |
getDataSourceSheets() | DataSourceSheet[] | このデータソースに関連付けられているデータソース シートを返します。 |
getSpec() | DataSourceSpec | データソース仕様を取得します。 |
refreshAllLinkedDataSourceObjects() | void | データソースにリンクされているすべてのデータソース オブジェクトを更新します。 |
updateSpec(spec) | DataSource | データソース仕様を更新し、このデータソースにリンクされているデータソース オブジェクトを新しい仕様で更新します。 |
updateSpec(spec, refreshAllLinkedObjects) | DataSource | データソース仕様を更新し、リンクされている data
source sheets を新しい仕様で更新します。 |
waitForAllDataExecutionsCompletion(timeoutInSeconds) | void | リンクされたデータソース オブジェクトの現在の実行がすべて完了するまで待機し、指定された秒数後にタイムアウトします。 |
DataSourceChart
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
forceRefreshData() | DataSourceChart | 現在の状態に関係なく、このオブジェクトのデータを更新します。 |
getDataSource() | DataSource | オブジェクトがリンクされているデータソースを取得します。 |
getStatus() | DataExecutionStatus | オブジェクトのデータ実行ステータスを取得します。 |
refreshData() | DataSourceChart | オブジェクトのデータを更新します。 |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | 現在の実行が完了するまで待機し、指定された秒数後にタイムアウトします。 |
DataSourceColumn
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getDataSource() | DataSource | データソース列に関連付けられているデータソースを取得します。 |
getFormula() | String | データソース列の数式を取得します。 |
getName() | String | データソース列の名前を取得します。 |
hasArrayDependency() | Boolean | 列に配列の依存関係があるかどうかを返します。 |
isCalculatedColumn() | Boolean | 列が計算された列かどうかを返します。 |
remove() | void | データソース列を削除します。 |
setFormula(formula) | DataSourceColumn | データソース列の式を設定します。 |
setName(name) | DataSourceColumn | データソース列の名前を設定します。 |
DataSourceFormula
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
forceRefreshData() | DataSourceFormula | 現在の状態に関係なく、このオブジェクトのデータを更新します。 |
getAnchorCell() | Range | このデータソース式が固定されているセルを表す Range を返します。 |
getDataSource() | DataSource | オブジェクトがリンクされているデータソースを取得します。 |
getDisplayValue() | String | データソースの数式の表示値を返します。 |
getFormula() | String | このデータソース式の数式を返します。 |
getStatus() | DataExecutionStatus | オブジェクトのデータ実行ステータスを取得します。 |
refreshData() | DataSourceFormula | オブジェクトのデータを更新します。 |
setFormula(formula) | DataSourceFormula | 数式を更新します。 |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | 現在の実行が完了するまで待機し、指定された秒数後にタイムアウトします。 |
DataSourceParameter
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getName() | String | パラメータ名を取得します。 |
getSourceCell() | String | パラメータが値を持つソースセルを取得します。パラメータの型が DataSourceParameterType.CELL でない場合は null を取得します。 |
getType() | DataSourceParameterType | パラメータの型を取得します。 |
DataSourceParameterType
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
DATA_SOURCE_PARAMETER_TYPE_UNSUPPORTED | Enum | Apps Script でサポートされていないデータソース パラメータ タイプ。 |
CELL | Enum | データソース パラメータはセルに基づいて値が設定されます。 |
DataSourcePivotTable
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
addColumnGroup(columnName) | PivotGroup | 指定されたデータソース列に基づいて新しいピボット列グループを追加します。 |
addFilter(columnName, filterCriteria) | PivotFilter | 指定したフィルタ条件を使用して、指定したデータソース列に基づいて新しいフィルタを追加します。 |
addPivotValue(columnName, summarizeFunction) | PivotValue | 指定された集計関数を使用して、指定されたデータソース列に基づいて新しいピボット値を追加します。 |
addRowGroup(columnName) | PivotGroup | 指定されたデータソース列に基づいて新しいピボット行グループを追加します。 |
asPivotTable() | PivotTable | データソースのピボット テーブルを通常のピボット テーブル オブジェクトとして返します。 |
forceRefreshData() | DataSourcePivotTable | 現在の状態に関係なく、このオブジェクトのデータを更新します。 |
getDataSource() | DataSource | オブジェクトがリンクされているデータソースを取得します。 |
getStatus() | DataExecutionStatus | オブジェクトのデータ実行ステータスを取得します。 |
refreshData() | DataSourcePivotTable | オブジェクトのデータを更新します。 |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | 現在の実行が完了するまで待機し、指定された秒数後にタイムアウトします。 |
DataSourceRefreshSchedule
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getFrequency() | DataSourceRefreshScheduleFrequency | 更新スケジュールの頻度を取得し、更新するタイミングと頻度を指定します。 |
getScope() | DataSourceRefreshScope | この更新スケジュールのスコープを取得します。 |
getTimeIntervalOfNextRun() | TimeInterval | この更新スケジュールの次回の実行の時間枠を取得します。 |
isEnabled() | Boolean | この更新スケジュールを有効にするかどうかを指定します。 |
DataSourceRefreshScheduleFrequency
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getDaysOfTheMonth() | Integer[] | データソースを更新する日を数値(1 ~ 28)で取得します。 |
getDaysOfTheWeek() | Weekday[] | データソースを更新する曜日を取得します。 |
getFrequencyType() | FrequencyType | 頻度タイプを取得します。 |
getStartHour() | Integer | 更新スケジュールを実行する時間間隔の開始時間を(0 ~ 23 の数値で)取得します。 |
DataSourceRefreshScope
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
DATA_SOURCE_REFRESH_SCOPE_UNSUPPORTED | Enum | データソースの更新スコープはサポートされていません。 |
ALL_DATA_SOURCES | Enum | 更新は、スプレッドシート内のすべてのデータソースに適用されます。 |
DataSourceSheet
Methods
DataSourceSheetFilter
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getDataSourceColumn() | DataSourceColumn | このフィルタが適用されるデータソース列を返します。 |
getDataSourceSheet() | DataSourceSheet | このフィルタが属する DataSourceSheet を返します。 |
getFilterCriteria() | FilterCriteria | このフィルタのフィルタ条件を返します。 |
remove() | void | データソース オブジェクトからこのフィルタを削除します。 |
setFilterCriteria(filterCriteria) | DataSourceSheetFilter | このフィルタのフィルタ条件を設定します。 |
DataSourceSpec
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
asBigQuery() | BigQueryDataSourceSpec | BigQuery データソースの仕様を取得します。 |
copy() | DataSourceSpecBuilder | このデータソースの設定に基づいて DataSourceSpecBuilder を作成します。 |
getParameters() | DataSourceParameter[] | データソースのパラメータを取得します。 |
getType() | DataSourceType | データソースのタイプを取得します。 |
DataSourceSpecBuilder
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
asBigQuery() | BigQueryDataSourceSpecBuilder | BigQuery データソースのビルダーを取得します。 |
build() | DataSourceSpec | このビルダーの設定からデータソース仕様を作成します。 |
copy() | DataSourceSpecBuilder | このデータソースの設定に基づいて DataSourceSpecBuilder を作成します。 |
getParameters() | DataSourceParameter[] | データソースのパラメータを取得します。 |
getType() | DataSourceType | データソースのタイプを取得します。 |
removeAllParameters() | DataSourceSpecBuilder | すべてのパラメータを削除します。 |
removeParameter(parameterName) | DataSourceSpecBuilder | 指定したパラメータを削除します。 |
setParameterFromCell(parameterName, sourceCell) | DataSourceSpecBuilder | パラメータを追加するか、この名前のパラメータが存在する場合は、そのソースセルを更新します。 |
DataSourceTable
Methods
DataSourceTableColumn
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getDataSourceColumn() | DataSourceColumn | データソース列を取得します。 |
remove() | void | DataSourceTable から列を削除します。 |
DataSourceTableFilter
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getDataSourceColumn() | DataSourceColumn | このフィルタが適用されるデータソース列を返します。 |
getDataSourceTable() | DataSourceTable | このフィルタが属する DataSourceTable を返します。 |
getFilterCriteria() | FilterCriteria | このフィルタのフィルタ条件を返します。 |
remove() | void | データソース オブジェクトからこのフィルタを削除します。 |
setFilterCriteria(filterCriteria) | DataSourceTableFilter | このフィルタのフィルタ条件を設定します。 |
DataSourceType
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
DATA_SOURCE_TYPE_UNSUPPORTED | Enum | Apps Script でサポートされていないデータソースの種類。 |
BIGQUERY | Enum | BigQuery データソース。 |
DataValidation
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
copy() | DataValidationBuilder | このルールの設定に基づいて、データ入力規則のビルダーを作成します。 |
getAllowInvalid() | Boolean | ルールが入力データの検証に失敗した場合に警告を表示する場合は true を返し、入力を完全に拒否する場合は false を返します。 |
getCriteriaType() | DataValidationCriteria | DataValidationCriteria 列挙型で定義されているルールの条件タイプを取得します。 |
getCriteriaValues() | Object[] | ルールの条件に対応する引数の配列を取得します。 |
getHelpText() | String | ルールのヘルプテキストを取得します。ヘルプテキストが設定されていない場合は null を取得します。 |
DataValidationBuilder
Methods
DataValidationCriteria
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
DATE_AFTER | Enum | 指定した値より後の日付が必要です。 |
DATE_BEFORE | Enum | 指定した値より前の日付が必要です。 |
DATE_BETWEEN | Enum | 指定した値の間の日付が必要です。 |
DATE_EQUAL_TO | Enum | 指定した値と等しい日付を指定する必要があります。 |
DATE_IS_VALID_DATE | Enum | 日付を指定する必要があります。 |
DATE_NOT_BETWEEN | Enum | 指定した値の範囲外の日付を指定する必要があります。 |
DATE_ON_OR_AFTER | Enum | 指定した値以降の日付が必要です。 |
DATE_ON_OR_BEFORE | Enum | 指定した値以前の日付が必要です。 |
NUMBER_BETWEEN | Enum | 指定した値の間の数値が必要です。 |
NUMBER_EQUAL_TO | Enum | 指定された値と等しい数値が必要です。 |
NUMBER_GREATER_THAN | Enum | 指定した値より大きい数値が必要です。 |
NUMBER_GREATER_THAN_OR_EQUAL_TO | Enum | 指定された値以上の数値が必要です。 |
NUMBER_LESS_THAN | Enum | 指定された値より小さい数値が必要です。 |
NUMBER_LESS_THAN_OR_EQUAL_TO | Enum | 指定した値以下の数値が必要です。 |
NUMBER_NOT_BETWEEN | Enum | 指定された値の範囲内にない数値が必要です。 |
NUMBER_NOT_EQUAL_TO | Enum | 指定された値と等しくない数値が必要です。 |
TEXT_CONTAINS | Enum | 入力に指定された値が含まれている必要があります。 |
TEXT_DOES_NOT_CONTAIN | Enum | 入力が指定された値を含まないことを必須にします。 |
TEXT_EQUAL_TO | Enum | 入力が指定された値と等しい必要があります。 |
TEXT_IS_VALID_EMAIL | Enum | メールアドレスの形式で入力する必要があります。 |
TEXT_IS_VALID_URL | Enum | URL 形式で入力する必要があります。 |
VALUE_IN_LIST | Enum | 入力が指定された値のいずれかと等しい必要があります。 |
VALUE_IN_RANGE | Enum | 入力が指定範囲内の値と等しい必要があります。 |
CUSTOM_FORMULA | Enum | 入力によって、指定された数式が true と評価されることが必要です。 |
CHECKBOX | Enum | 入力がカスタム値またはブール値である必要があります。チェックボックスとして表示されます。 |
DateTimeGroupingRule
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getRuleType() | DateTimeGroupingRuleType | 日時のグループ化ルールのタイプを取得します。 |
DateTimeGroupingRuleType
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
UNSUPPORTED | Enum | サポートされていない日時のグループ化ルールの種類です。 |
SECOND | Enum | 日時を 0 ~ 59 の秒でグループ化します。 |
MINUTE | Enum | 日時を 0 ~ 59 の分単位でグループ化します。 |
HOUR | Enum | 24 時間制(0 ~ 23)を使用して、日時を時間でグループ化します。 |
HOUR_MINUTE | Enum | 24 時間制を使用して、日時を時間と分でグループ化します(例: 19:45 )。 |
HOUR_MINUTE_AMPM | Enum | 12 時間表記を使用して、日時を時間と分でグループ化します(例: 7:45 PM )。 |
DAY_OF_WEEK | Enum | 曜日で日時をグループ化します(例: Sunday )。 |
DAY_OF_YEAR | Enum | 1 ~ 366 の範囲で日時をグループ化します。 |
DAY_OF_MONTH | Enum | 日時を 1 ~ 31 の範囲でグループ化します。 |
DAY_MONTH | Enum | 日時を日と月でグループ化します(例: 22-Nov )。 |
MONTH | Enum | 日時を月ごとにグループ化します(例: Nov )。 |
QUARTER | Enum | 「Q1」(1 月~ 3 月を表す)など、四半期ごとに日時をグループ化します。 |
YEAR | Enum | 日時を年別にグループ化します(例: 2008)。 |
YEAR_MONTH | Enum | 年と月で日時をグループ化します(例: 2008-Nov )。 |
YEAR_QUARTER | Enum | 年と四半期で日時をグループ化します(例: 2008 Q4 )。 |
YEAR_MONTH_DAY | Enum | 年、月、日で日時をグループ化します(例: 2008-11-22 )。 |
DeveloperMetadata
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getId() | Integer | このデベロッパー メタデータに関連付けられている一意の ID を返します。 |
getKey() | String | このデベロッパー メタデータに関連付けられているキーを返します。 |
getLocation() | DeveloperMetadataLocation | このデベロッパー メタデータの場所を返します。 |
getValue() | String | このデベロッパー メタデータに関連付けられている値を返します。メタデータに値がない場合は null を返します。 |
getVisibility() | DeveloperMetadataVisibility | このデベロッパー メタデータの公開設定を返します。 |
moveToColumn(column) | DeveloperMetadata | このデベロッパー メタデータを指定された列に移動します。 |
moveToRow(row) | DeveloperMetadata | このデベロッパー メタデータを指定の行に移動します。 |
moveToSheet(sheet) | DeveloperMetadata | このデベロッパー メタデータを指定されたシートに移動します。 |
moveToSpreadsheet() | DeveloperMetadata | このデベロッパーのメタデータを最上位のスプレッドシートに移動します。 |
remove() | void | このメタデータを削除します。 |
setKey(key) | DeveloperMetadata | このデベロッパー メタデータのキーを指定された値に設定します。 |
setValue(value) | DeveloperMetadata | このデベロッパー メタデータに関連付けられている値を、指定された値に設定します。 |
setVisibility(visibility) | DeveloperMetadata | このデベロッパー メタデータの公開設定を、指定された公開設定に設定します。 |
DeveloperMetadataFinder
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
find() | DeveloperMetadata[] | この検索を実行し、一致するメタデータを返します。 |
onIntersectingLocations() | DeveloperMetadataFinder | メタデータを含む場所が交差することを考慮するように検索を設定します。 |
withId(id) | DeveloperMetadataFinder | この検索を、指定した ID に一致するメタデータのみに限定します。 |
withKey(key) | DeveloperMetadataFinder | この検索を、指定したキーに一致するメタデータのみに限定します。 |
withLocationType(locationType) | DeveloperMetadataFinder | この検索の対象を、指定した地域タイプに一致するメタデータのみに限定します。 |
withValue(value) | DeveloperMetadataFinder | この検索を、指定した値に一致するメタデータのみに限定します。 |
withVisibility(visibility) | DeveloperMetadataFinder | この検索を、指定した公開設定に一致するメタデータのみに限定します。 |
DeveloperMetadataLocation
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getColumn() | Range | このメタデータの列の場所を示す Range を返します。ロケーション タイプが DeveloperMetadataLocationType.COLUMN でない場合は null を返します。 |
getLocationType() | DeveloperMetadataLocationType | ビジネスのタイプを取得します。 |
getRow() | Range | このメタデータの行の場所を示す Range を返します。ロケーション タイプが DeveloperMetadataLocationType.ROW でない場合は null を返します。 |
getSheet() | Sheet | このメタデータの Sheet 位置情報、または位置情報タイプが DeveloperMetadataLocationType.SHEET でない場合は null を返します。 |
getSpreadsheet() | Spreadsheet | このメタデータの Spreadsheet を返します。ロケーション タイプが DeveloperMetadataLocationType.SPREADSHEET でない場合は null を返します。 |
DeveloperMetadataLocationType
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
SPREADSHEET | Enum | 最上位のスプレッドシートに関連付けられているデベロッパー メタデータのロケーション タイプ。 |
SHEET | Enum | シート全体に関連付けられているデベロッパー メタデータの場所タイプ。 |
ROW | Enum | 行に関連付けられたデベロッパー メタデータのロケーション タイプ。 |
COLUMN | Enum | 列に関連付けられているデベロッパー メタデータのロケーション タイプ。 |
DeveloperMetadataVisibility
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
DOCUMENT | Enum | ドキュメント可視のメタデータは、そのドキュメントにアクセスできるすべてのデベロッパー プロジェクトからアクセスできます。 |
PROJECT | Enum | プロジェクトに表示されるメタデータは、メタデータを作成したデベロッパー プロジェクトのみが表示してアクセスできる。 |
Dimension
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
COLUMNS | Enum | 列(縦方向)のディメンション。 |
ROWS | Enum | 行(水平方向)のディメンション。 |
Direction
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
UP | Enum | 行インデックスの減少方向。 |
DOWN | Enum | 行インデックスが増加する方向。 |
PREVIOUS | Enum | 列インデックスの減少方向。 |
NEXT | Enum | 列インデックスが増加する方向。 |
Drawing
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getContainerInfo() | ContainerInfo | シート内の図形描画の位置に関する情報を取得します。 |
getHeight() | Integer | この描画の実際の高さをピクセル単位で返します。 |
getOnAction() | String | この図形描画に関連付けられているマクロの名前を返します。 |
getSheet() | Sheet | この図形描画が表示されるシートを返します。 |
getWidth() | Integer | この描画の実際の幅をピクセル単位で返します。 |
getZIndex() | Number | この図形描画の Z-index を返します。 |
remove() | void | スプレッドシートからこの図形描画を削除します。 |
setHeight(height) | Drawing | この図形描画の実際の高さをピクセル単位で設定します。 |
setOnAction(macroName) | Drawing | この図形描画にマクロ関数を割り当てます。 |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | Drawing | 図形描画がシート上で表示される位置を設定します。 |
setWidth(width) | Drawing | この描画の実際の幅をピクセル単位で設定します。 |
setZIndex(zIndex) | Drawing | この図形描画の Z-Index を設定します。 |
EmbeddedAreaChartBuilder
Methods
EmbeddedBarChartBuilder
Methods
EmbeddedChart
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
asDataSourceChart() | DataSourceChart | グラフがデータソース グラフの場合は、データソース グラフ インスタンスにキャストします。それ以外の場合は null にキャストします。 |
getAs(contentType) | Blob | このオブジェクト内のデータを、指定されたコンテンツ タイプに変換された blob として返します。 |
getBlob() | Blob | このオブジェクト内のデータを blob として返します。 |
getChartId() | Integer | グラフを含むスプレッドシート全体で一意のグラフの不変 ID を返します。グラフがスプレッドシート内にない場合は null を返します。 |
getContainerInfo() | ContainerInfo | シート内のグラフの位置に関する情報を返します。 |
getHiddenDimensionStrategy() | ChartHiddenDimensionStrategy | 非表示の行と列の処理に使用する戦略を返します。 |
getMergeStrategy() | ChartMergeStrategy | 範囲が複数ある場合に使用される結合戦略を返します。 |
getNumHeaders() | Integer | 範囲がヘッダーとして扱う行数または列数を返します。 |
getOptions() | ChartOptions | このグラフのオプション(高さ、色、軸など)を返します。 |
getRanges() | Range[] | このグラフがデータソースとして使用する範囲を返します。 |
getTransposeRowsAndColumns() | Boolean | true の場合、グラフに入力される行と列が入れ替わります。 |
modify() | EmbeddedChartBuilder | このグラフの変更に使用できる EmbeddedChartBuilder を返します。 |
EmbeddedChartBuilder
Methods
EmbeddedColumnChartBuilder
Methods
EmbeddedComboChartBuilder
Methods
EmbeddedHistogramChartBuilder
Methods
EmbeddedLineChartBuilder
Methods
EmbeddedPieChartBuilder
Methods
EmbeddedScatterChartBuilder
Methods
EmbeddedTableChartBuilder
Methods
Filter
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getColumnFilterCriteria(columnPosition) | FilterCriteria | 指定された列のフィルタ条件を取得します。列にフィルタ条件が適用されていない場合は null を取得します。 |
getRange() | Range | このフィルタが適用される範囲を取得します。 |
remove() | void | このフィルタを削除します。 |
removeColumnFilterCriteria(columnPosition) | Filter | 指定した列からフィルタ条件を削除します。 |
setColumnFilterCriteria(columnPosition, filterCriteria) | Filter | 指定した列にフィルタ条件を設定します。 |
sort(columnPosition, ascending) | Filter | 指定した列でフィルタされた範囲を並べ替え、このフィルタが適用される範囲内の最初の行(ヘッダー行)を除外します。 |
FilterCriteria
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
copy() | FilterCriteriaBuilder | このフィルタ条件をコピーして、別のフィルタに適用できる条件ビルダーを作成します。 |
getCriteriaType() | BooleanCriteria | 条件のブール値型を返します(例: CELL_EMPTY )。 |
getCriteriaValues() | Object[] | ブール値の条件に対応する引数の配列を返します。 |
getHiddenValues() | String[] | フィルタで非表示になっている値を返します。 |
getVisibleBackgroundColor() | Color | フィルタ条件に使用される背景色を返します。 |
getVisibleForegroundColor() | Color | フィルタ条件として使用する前景の色を返します。 |
getVisibleValues() | String[] | ピボット テーブルのフィルタが表示する値を返します。 |
FilterCriteriaBuilder
Methods
FrequencyType
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
FREQUENCY_TYPE_UNSUPPORTED | Enum | フリークエンシータイプはサポートされていません。 |
DAILY | Enum | 毎日更新してください。 |
WEEKLY | Enum | 毎週特定の曜日に更新する。 |
MONTHLY | Enum | 毎月、決まった日に更新します。 |
GradientCondition
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getMaxColorObject() | Color | このグラデーション条件の最大値に設定されているカラーセットを取得します。 |
getMaxType() | InterpolationType | このグラデーション条件の最大値に対する補間タイプを取得します。 |
getMaxValue() | String | このグラデーション条件の最大値を取得します。 |
getMidColorObject() | Color | このグラデーション条件の中間値の色セットを取得します。 |
getMidType() | InterpolationType | このグラデーション条件の中間値の補間タイプを取得します。 |
getMidValue() | String | このグラデーション条件の中間値を取得します。 |
getMinColorObject() | Color | このグラデーション条件の最小値に設定されたカラーセットを取得します。 |
getMinType() | InterpolationType | この勾配条件の最小値に対する補間型を取得します。 |
getMinValue() | String | このグラデーション条件の最小値を取得します。 |
Group
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
collapse() | Group | このグループを折りたたみます。 |
expand() | Group | このグループを展開します。 |
getControlIndex() | Integer | このグループのコントロール切り替えインデックスを返します。 |
getDepth() | Integer | このグループの深度を返します。 |
getRange() | Range | このグループが存在する範囲を返します。 |
isCollapsed() | Boolean | このグループが折りたたまれている場合、true を返します。 |
remove() | void | シートからこのグループを削除し、range のグループの深度を 1 つ下げます。 |
GroupControlTogglePosition
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
BEFORE | Enum | グループの前のコントロール切り替え位置(低いインデックス)。 |
AFTER | Enum | グループの後にあるコントロールの切り替えの位置(高インデックス)。 |
InterpolationType
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
NUMBER | Enum | この数値をグラデーション条件の特定の補間点として使用します。 |
PERCENT | Enum | 数値をグラデーション条件のパーセンテージ補間点として使用します。 |
PERCENTILE | Enum | 数値をグラデーション条件のパーセンタイル補間ポイントとして使用します。 |
MIN | Enum | 最小数を勾配条件の特定の補間点として推測します。 |
MAX | Enum | 勾配条件の特定の補間点として最大数を推測します。 |
NamedRange
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getName() | String | この名前付き範囲の名前を取得します。 |
getRange() | Range | この名前付き範囲によって参照される範囲を取得します。 |
remove() | void | この名前付き範囲を削除します。 |
setName(name) | NamedRange | 名前付き範囲の名前を設定または更新します。 |
setRange(range) | NamedRange | この名前付き範囲の範囲を設定または更新します。 |
OverGridImage
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
assignScript(functionName) | OverGridImage | 指定された関数名を持つ関数をこの画像に割り当てます。 |
getAltTextDescription() | String | この画像の代替テキストの説明を返します。 |
getAltTextTitle() | String | この画像の代替テキストのタイトルを返します。 |
getAnchorCell() | Range | 画像が固定されているセルを返します。 |
getAnchorCellXOffset() | Integer | アンカーセルからの水平ピクセル オフセットを返します。 |
getAnchorCellYOffset() | Integer | アンカーセルからの垂直ピクセル オフセットを返します。 |
getHeight() | Integer | この画像の実際の高さをピクセル単位で返します。 |
getInherentHeight() | Integer | この画像固有の高さをピクセル単位で返します。 |
getInherentWidth() | Integer | この画像固有の高さをピクセル単位で返します。 |
getScript() | String | この画像に割り当てられた関数の名前を返します。 |
getSheet() | Sheet | この画像が表示されるシートを返します。 |
getUrl() | String | 画像のソース URL を取得します。URL を使用できない場合は null を返します。 |
getWidth() | Integer | この画像の実際の幅をピクセル単位で返します。 |
remove() | void | スプレッドシートからこの画像を削除します。 |
replace(blob) | OverGridImage | この画像を、指定された BlobSource で指定された画像に置き換えます。 |
replace(url) | OverGridImage | この画像を、指定された URL の画像に置き換えます。 |
resetSize() | OverGridImage | この画像を固有のサイズにリセットします。 |
setAltTextDescription(description) | OverGridImage | この画像の代替テキストの説明を設定します。 |
setAltTextTitle(title) | OverGridImage | この画像の代替テキストのタイトルを設定します。 |
setAnchorCell(cell) | OverGridImage | 画像を固定するセルを設定します。 |
setAnchorCellXOffset(offset) | OverGridImage | アンカーセルからの水平ピクセル オフセットを設定します。 |
setAnchorCellYOffset(offset) | OverGridImage | アンカーセルからの垂直ピクセル オフセットを設定します。 |
setHeight(height) | OverGridImage | この画像の実際の高さをピクセル単位で設定します。 |
setWidth(width) | OverGridImage | この画像の実際の幅をピクセル単位で設定します。 |
PageProtection
PivotFilter
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getFilterCriteria() | FilterCriteria | このピボット フィルタのフィルタ条件を返します。 |
getPivotTable() | PivotTable | このフィルタが属する PivotTable を返します。 |
getSourceDataColumn() | Integer | このフィルタが適用されるソースデータ列の数を返します。 |
getSourceDataSourceColumn() | DataSourceColumn | フィルタが適用されるデータソース列を返します。 |
remove() | void | ピボット テーブルからこのピボット フィルタを削除します。 |
setFilterCriteria(filterCriteria) | PivotFilter | このピボット フィルタのフィルタ条件を設定します。 |
PivotGroup
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
addManualGroupingRule(groupName, groupMembers) | PivotGroup | このピボット グループの手動グループ化ルールを追加します。 |
areLabelsRepeated() | Boolean | ラベルが繰り返しとして表示されるかどうかを返します。 |
clearGroupingRule() | PivotGroup | このピボット グループからグループ化ルールを削除します。 |
clearSort() | PivotGroup | このグループに適用されている並べ替えを解除します。 |
getDateTimeGroupingRule() | DateTimeGroupingRule | ピボット グループに対する日時のグループ化ルールを返します。日時のグループ化ルールが設定されていない場合は null を返します。 |
getDimension() | Dimension | 行グループと列グループのどちらであるかを返します。 |
getGroupLimit() | PivotGroupLimit | ピボット グループに対するピボット グループの制限を返します。 |
getIndex() | Integer | 現在のグループ順序でこのピボット グループのインデックスを返します。 |
getPivotTable() | PivotTable | このグループが属する PivotTable を返します。 |
getSourceDataColumn() | Integer | このグループで要約されたソースデータ列の数を返します。 |
getSourceDataSourceColumn() | DataSourceColumn | ピボット グループを適用するデータソース列を返します。 |
hideRepeatedLabels() | PivotGroup | このグループの繰り返しラベルを非表示にします。 |
isSortAscending() | Boolean | 並べ替えが昇順の場合は true を返し、並べ替え順が降順の場合は false を返します。 |
moveToIndex(index) | PivotGroup | 行または列グループの現在のリストの指定された位置にこのグループを移動します。 |
remove() | void | 表からこのピボット グループを削除します。 |
removeManualGroupingRule(groupName) | PivotGroup | 指定された groupName の手動グループ化ルールを削除します。 |
resetDisplayName() | PivotGroup | ピボット テーブル内のこのグループの表示名をデフォルト値にリセットします。 |
setDateTimeGroupingRule(dateTimeGroupingRuleType) | PivotGroup | ピボット グループに日時のグループ化ルールを設定します。 |
setDisplayName(name) | PivotGroup | ピボット テーブル内のこのグループの表示名を設定します。 |
setGroupLimit(countLimit) | PivotGroup | ピボット グループにピボット グループの制限を設定します。 |
setHistogramGroupingRule(minValue, maxValue, intervalSize) | PivotGroup | このピボット グループのヒストグラムのグループ化ルールを設定します。 |
showRepeatedLabels() | PivotGroup | 行または列のグループ化が複数ある場合、このメソッドは、後続のグループ化のエントリごとに、このグループのラベルを表示します。 |
showTotals(showTotals) | PivotGroup | このピボット グループの合計値を表に表示するかどうかを設定します。 |
sortAscending() | PivotGroup | 並べ替え順を昇順に設定します。 |
sortBy(value, oppositeGroupValues) | PivotGroup | 指定された PivotValue で oppositeGroupValues の値についてこのグループを並べ替えます。 |
sortDescending() | PivotGroup | 並べ替え順を降順に設定します。 |
totalsAreShown() | Boolean | このピボット グループの合計値が現在表示されているかどうかを返します。 |
PivotGroupLimit
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getCountLimit() | Integer | ピボット グループ内の行または列の上限数を取得します。 |
getPivotGroup() | PivotGroup | 制限が属するピボット グループを返します。 |
remove() | void | ピボット グループの制限を解除します。 |
setCountLimit(countLimit) | PivotGroupLimit | ピボット グループ内の行または列の上限を設定します。 |
PivotTable
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
addCalculatedPivotValue(name, formula) | PivotValue | 指定された name を使用して、指定された formula から計算されたピボット テーブルに新しいピボット値を作成します。 |
addColumnGroup(sourceDataColumn) | PivotGroup | ピボット テーブル内で新しいピボット列のグループを定義します。 |
addFilter(sourceDataColumn, filterCriteria) | PivotFilter | ピボット テーブルの新しいピボット フィルタを作成します。 |
addPivotValue(sourceDataColumn, summarizeFunction) | PivotValue | 指定された summarizeFunction でピボット テーブルの新しいピボット値を定義します。 |
addRowGroup(sourceDataColumn) | PivotGroup | ピボット テーブル内で新しいピボット行のグループを定義します。 |
asDataSourcePivotTable() | DataSourcePivotTable | ピボット テーブルが DataSource にリンクされている場合はそのピボット テーブルをデータソースのピボット テーブルとして返します。それ以外の場合は null を返します。 |
getAnchorCell() | Range | このピボット テーブルが固定されているセルを表す Range を返します。 |
getColumnGroups() | PivotGroup[] | このピボット テーブルの列グループの順序付きリストを返します。 |
getFilters() | PivotFilter[] | このピボット テーブル内のフィルタの順序付きリストを返します。 |
getPivotValues() | PivotValue[] | このピボット テーブルのピボット値の順序付きリストを返します。 |
getRowGroups() | PivotGroup[] | このピボット テーブルの行グループの順序付きリストを返します。 |
getSourceDataRange() | Range | ピボット テーブルを構成するソースデータの範囲を返します。 |
getValuesDisplayOrientation() | Dimension | 値が行または列のどちらとして表示されるかを返します。 |
remove() | void | このピボット テーブルを削除します。 |
setValuesDisplayOrientation(dimension) | PivotTable | 値を列または行として表示するように、このピボット テーブルのレイアウトを設定します。 |
PivotTableSummarizeFunction
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
CUSTOM | Enum | カスタム関数です。この値は計算フィールドでのみ有効です。 |
SUM | Enum | SUM 関数 |
COUNTA | Enum | COUNTA 関数 |
COUNT | Enum | COUNT 関数 |
COUNTUNIQUE | Enum | COUNTUNIQUE 関数 |
AVERAGE | Enum | AVERAGE 関数 |
MAX | Enum | MAX 関数 |
MIN | Enum | MIN 関数 |
MEDIAN | Enum | MEDIAN 関数 |
PRODUCT | Enum | PRODUCT 関数 |
STDEV | Enum | STDEV 関数 |
STDEVP | Enum | STDEVP 関数 |
VAR | Enum | VAR 関数 |
VARP | Enum | VARP 関数 |
PivotValue
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getDisplayType() | PivotValueDisplayType | このピボット値が表で現在どのように表示されているかを示す表示タイプを返します。 |
getFormula() | String | この値の計算に使用された数式を返します。 |
getPivotTable() | PivotTable | この値が属する PivotTable を返します。 |
getSourceDataColumn() | Integer | ピボット値が集計するソースデータ列の数を返します。 |
getSourceDataSourceColumn() | DataSourceColumn | ピボット値が集計したデータソース列を返します。 |
getSummarizedBy() | PivotTableSummarizeFunction | このグループの要約関数を返します。 |
remove() | void | ピボット テーブルからこの値を削除します。 |
setDisplayName(name) | PivotValue | ピボット テーブル内に、この値の表示名を設定します。 |
setFormula(formula) | PivotValue | この値の計算に使用する数式を設定します。 |
showAs(displayType) | PivotValue | この値をピボット テーブルに別の値の関数として表示します。 |
summarizeBy(summarizeFunction) | PivotValue | 要約関数を設定します。 |
PivotValueDisplayType
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
DEFAULT | Enum | デフォルトです。 |
PERCENT_OF_ROW_TOTAL | Enum | ピボット値をその行の合計に対する割合として表示します。 |
PERCENT_OF_COLUMN_TOTAL | Enum | ピボット値を、その列の合計に対する割合として表示します。 |
PERCENT_OF_GRAND_TOTAL | Enum | ピボット値を総計に対する割合で表示します。 |
Protection
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
addEditor(emailAddress) | Protection | 保護されているシートまたは範囲の編集者のリストに、指定したユーザーを追加します。 |
addEditor(user) | Protection | 保護されているシートまたは範囲の編集者のリストに、指定したユーザーを追加します。 |
addEditors(emailAddresses) | Protection | 指定されたユーザー配列を、保護されているシートまたは範囲の編集者リストに追加します。 |
addTargetAudience(audienceId) | Protection | 指定した対象グループを保護されている範囲の編集者として追加します。 |
canDomainEdit() | Boolean | スプレッドシートを所有するドメイン内のすべてのユーザーに、保護された範囲またはシートの編集権限があるかどうかを指定します。 |
canEdit() | Boolean | ユーザーに、保護されている範囲やシートの編集権限があるかどうかを指定します。 |
getDescription() | String | 保護されている範囲またはシートの説明を取得します。 |
getEditors() | User[] | 保護されている範囲またはシートの編集者のリストを取得します。 |
getProtectionType() | ProtectionType | 保護地域のタイプ(RANGE または SHEET )を取得します。 |
getRange() | Range | 保護されている範囲を取得します。 |
getRangeName() | String | 名前付き範囲に関連付けられている場合、保護されている範囲の名前を取得します。 |
getTargetAudiences() | TargetAudience[] | 保護されている範囲を編集できる対象グループの ID を返します。 |
getUnprotectedRanges() | Range[] | 保護されたシート内の保護されていない範囲の配列を取得します。 |
isWarningOnly() | Boolean | 保護地域が「警告ベース」の保護を使用しているかどうかを判定します。 |
remove() | void | 範囲またはシートの保護を解除します。 |
removeEditor(emailAddress) | Protection | 保護されているシートまたは範囲の編集者のリストから、指定したユーザーを削除します。 |
removeEditor(user) | Protection | 保護されているシートまたは範囲の編集者のリストから、指定したユーザーを削除します。 |
removeEditors(emailAddresses) | Protection | 保護されているシートまたは範囲の編集者のリストから、指定されたユーザー配列を削除します。 |
removeTargetAudience(audienceId) | Protection | 保護されている範囲の編集者として、指定した対象グループを削除します。 |
setDescription(description) | Protection | 保護されている範囲またはシートの説明を設定します。 |
setDomainEdit(editable) | Protection | スプレッドシートを所有するドメイン内のすべてのユーザーに、保護された範囲またはシートを編集する権限を与えるかどうかを設定します。 |
setNamedRange(namedRange) | Protection | 保護されている範囲を既存の名前付き範囲に関連付けます。 |
setRange(range) | Protection | 保護する範囲を調整します。 |
setRangeName(rangeName) | Protection | 保護されている範囲を既存の名前付き範囲に関連付けます。 |
setUnprotectedRanges(ranges) | Protection | 保護されたシート内の指定された範囲の配列の保護を解除します。 |
setWarningOnly(warningOnly) | Protection | この保護されている範囲で「警告ベース」の保護を使用するかどうかを設定します。 |
ProtectionType
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
RANGE | Enum | 範囲の保護。 |
SHEET | Enum | シートの保護です。 |
Range
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
activate() | Range | 指定された範囲を active range として設定し、範囲内の左上のセルを current cell として設定します。 |
activateAsCurrentCell() | Range | 指定されたセルを current cell として設定します。 |
addDeveloperMetadata(key) | Range | 指定されたキーを持つデベロッパー メタデータを範囲に追加します。 |
addDeveloperMetadata(key, visibility) | Range | 指定されたキーと公開設定のデベロッパー メタデータを範囲に追加します。 |
addDeveloperMetadata(key, value) | Range | 指定されたキーと値を含むデベロッパー メタデータを範囲に追加します。 |
addDeveloperMetadata(key, value, visibility) | Range | 指定されたキー、値、可視性を含むデベロッパー メタデータを範囲に追加します。 |
applyColumnBanding() | Banding | 範囲にデフォルトの列縞模様テーマを適用します。 |
applyColumnBanding(bandingTheme) | Banding | 指定した列のバンディングのテーマを範囲に適用します。 |
applyColumnBanding(bandingTheme, showHeader, showFooter) | Banding | 指定したヘッダーとフッターの設定を使用して、指定した列のバンドのテーマを範囲に適用します。 |
applyRowBanding() | Banding | 範囲にデフォルトの行縞模様テーマを適用します。 |
applyRowBanding(bandingTheme) | Banding | 指定した行の縞模様テーマを範囲に適用します。 |
applyRowBanding(bandingTheme, showHeader, showFooter) | Banding | 指定したヘッダーとフッターの設定の範囲に、指定した行の縞模様を適用します。 |
autoFill(destination, series) | void | この範囲のデータに基づいて、destinationRange にデータを入力します。 |
autoFillToNeighbor(series) | void | 隣接するセルに基づいて新しいデータを入力する範囲を計算し、この範囲に含まれるデータに基づいてその範囲を自動的に新しい値で埋めます。 |
breakApart() | Range | 範囲内の複数列のセルを再び個別のセルに分割します。 |
canEdit() | Boolean | 範囲内のすべてのセルを編集する権限をユーザーに付与するかどうかを指定します。 |
check() | Range | 範囲内のチェックボックスの状態を「オン」に変更します。 |
clear() | Range | コンテンツと形式の範囲をクリアします。 |
clear(options) | Range | 指定された詳細オプションで指定されているコンテンツ、形式、データ検証ルール、コメントの範囲をクリアします。 |
clearContent() | Range | 範囲のコンテンツをクリアし、書式を維持します。 |
clearDataValidations() | Range | 範囲のデータ入力規則をクリアします。 |
clearFormat() | Range | この範囲の表示形式をクリアします。 |
clearNote() | Range | 指定したセル内のメモを消去します。 |
collapseGroups() | Range | 範囲内に完全に含まれるすべてのグループを閉じます。 |
copyFormatToRange(gridId, column, columnEnd, row, rowEnd) | void | 範囲の書式を指定の場所にコピーします。 |
copyFormatToRange(sheet, column, columnEnd, row, rowEnd) | void | 範囲の書式を指定の場所にコピーします。 |
copyTo(destination) | void | セル範囲のデータを別のセル範囲にコピーします。 |
copyTo(destination, copyPasteType, transposed) | void | セル範囲のデータを別のセル範囲にコピーします。 |
copyTo(destination, options) | void | セル範囲のデータを別のセル範囲にコピーします。 |
copyValuesToRange(gridId, column, columnEnd, row, rowEnd) | void | 範囲の内容を指定された場所にコピーします。 |
copyValuesToRange(sheet, column, columnEnd, row, rowEnd) | void | 範囲の内容を指定された場所にコピーします。 |
createDataSourcePivotTable(dataSource) | DataSourcePivotTable | データソースから空のデータソース ピボット テーブルを作成し、この範囲の最初のセルに固定します。 |
createDataSourceTable(dataSource) | DataSourceTable | データソースから、この範囲の最初のセルに固定された空のデータソース テーブルを作成します。 |
createDeveloperMetadataFinder() | DeveloperMetadataFinder | この範囲内のデベロッパー メタデータを検索するための DeveloperMetadataFinderApi を返します。 |
createFilter() | Filter | フィルタを作成し、シート上の指定した範囲に適用します。 |
createPivotTable(sourceData) | PivotTable | この範囲の最初のセルに固定された sourceData から空のピボット テーブルを作成します。 |
createTextFinder(findText) | TextFinder | 範囲のテキスト ファインダーを作成します。これにより、この範囲内のテキストの検索と置換を行うことができます。 |
deleteCells(shiftDimension) | void | このセル範囲を削除します。 |
expandGroups() | Range | 範囲またはコントロールの切り替えがこの範囲と交差している折りたたみグループを展開します。 |
getA1Notation() | String | 範囲を説明する文字列を A1 表記で返します。 |
getBackground() | String | 範囲内の左上のセルの背景色を返します(例: '#ffffff' )。 |
getBackgroundObject() | Color | 範囲内の左上のセルの背景色を返します。 |
getBackgroundObjects() | Color[][] | 範囲内のセルの背景色を返します。 |
getBackgrounds() | String[][] | 範囲内のセルの背景色を返します(例: '#ffffff' )。 |
getBandings() | Banding[] | この範囲内のセルに適用されるすべての縞模様を返します。 |
getCell(row, column) | Range | 範囲内の指定されたセルを返します。 |
getColumn() | Integer | この範囲の開始列位置を返します。 |
getDataRegion() | Range | 4 つの基数 Direction で拡張されている範囲のコピーを返し、隣接するすべてのセルをデータでカバーします。 |
getDataRegion(dimension) | Range | 指定されたディメンションが Dimension.ROWS の場合、拡張された範囲の Direction.UP と Direction.DOWN のコピーを返します。ディメンションが Dimension.COLUMNS の場合は Direction.NEXT と Direction.PREVIOUS を返します。 |
getDataSourceFormula() | DataSourceFormula | 範囲内の最初のセルの DataSourceFormula を返します。セルにデータソース式が含まれていない場合は null を返します。 |
getDataSourceFormulas() | DataSourceFormula[] | 範囲内のセルの DataSourceFormula を返します。 |
getDataSourcePivotTables() | DataSourcePivotTable[] | 範囲と交差するすべてのデータソースのピボット テーブルを取得します。 |
getDataSourceTables() | DataSourceTable[] | 範囲と交差するすべてのデータソース テーブルを取得します。 |
getDataSourceUrl() | String | この範囲内のデータの URL を返します。この URL を使用してグラフやクエリを作成できます。 |
getDataTable() | DataTable | このオブジェクト内のデータを DataTable として返します。 |
getDataTable(firstRowIsHeader) | DataTable | この範囲内のデータを DataTable として返します。 |
getDataValidation() | DataValidation | 範囲内の左上のセルのデータ入力規則を返します。 |
getDataValidations() | DataValidation[][] | 範囲内のすべてのセルに対するデータの入力規則を返します。 |
getDeveloperMetadata() | DeveloperMetadata[] | この範囲に関連付けられているデベロッパー メタデータを取得します。 |
getDisplayValue() | String | 範囲内の左上のセルの表示値を返します。 |
getDisplayValues() | String[][] | この範囲の値の長方形グリッドを返します。 |
getFilter() | Filter | この範囲が属するシートのフィルタを返します。シートにフィルタがない場合は null を返します。 |
getFontColorObject() | Color | 範囲の左上のセルのフォント色を返します。 |
getFontColorObjects() | Color[][] | 範囲内のセルのフォント色を返します。 |
getFontFamilies() | String[][] | 範囲内のセルのフォント ファミリーを返します。 |
getFontFamily() | String | 範囲の左上隅にあるセルのフォント ファミリーを返します。 |
getFontLine() | String | 範囲('underline' 、'line-through' 、または 'none' )の左上隅にあるセルの線スタイルを取得します。 |
getFontLines() | String[][] | 範囲('underline' 、'line-through' 、または 'none' )内のセルの線スタイルを取得します。 |
getFontSize() | Integer | 範囲の左上隅にあるセルのポイントサイズでフォントサイズを返します。 |
getFontSizes() | Integer[][] | 範囲内のセルのフォントサイズを返します。 |
getFontStyle() | String | 範囲の左上隅にあるセルのフォント スタイル('italic' または 'normal' )を返します。 |
getFontStyles() | String[][] | 範囲内のセルのフォント スタイルを返します。 |
getFontWeight() | String | 範囲の左上隅にあるセルのフォントの太さ(標準/太字)を返します。 |
getFontWeights() | String[][] | 範囲内のセルのフォントの太さを返します。 |
getFormula() | String | 範囲の左上のセルの数式(A1 表記)を返します。セルが空の場合または数式が含まれていない場合は空の文字列を返します。 |
getFormulaR1C1() | String | 指定されたセルの数式(R1C1 表記)を返します。存在しない場合は null を返します。 |
getFormulas() | String[][] | 範囲内のセルの数式(A1 表記)を返します。 |
getFormulasR1C1() | String[][] | 範囲内のセルの数式(R1C1 表記)を返します。 |
getGridId() | Integer | 範囲の親シートのグリッド ID を返します。 |
getHeight() | Integer | 範囲の高さを返します。 |
getHorizontalAlignment() | String | 範囲の左上隅にあるセルのテキスト(左/中央/右)の水平方向の配置を返します。 |
getHorizontalAlignments() | String[][] | 範囲内のセルの水平方向の配置を返します。 |
getLastColumn() | Integer | 終了列の位置を返します。 |
getLastRow() | Integer | 終了行の位置を返します。 |
getMergedRanges() | Range[] | 現在の範囲内にあるか、現在の範囲内に 1 つ以上のセルを含む、結合されたセルを表す Range オブジェクトの配列を返します。 |
getNextDataCell(direction) | Range | 範囲の最初の列と行のセルから開始して、指定された方向の次のセル(データを含むセルの連続範囲の端)、またはスプレッドシートのその方向の端にあるセルを返します。 |
getNote() | String | 指定した範囲に関連付けられているメモを返します。 |
getNotes() | String[][] | 範囲内のセルに関連付けられているメモを返します。 |
getNumColumns() | Integer | この範囲内の列の数を返します。 |
getNumRows() | Integer | この範囲内の行数を返します。 |
getNumberFormat() | String | 指定された範囲の左上のセルの数値または日付の形式を取得します。 |
getNumberFormats() | String[][] | 範囲内のセルについて、数値または日付の形式を返します。 |
getRichTextValue() | RichTextValue | 範囲の左上のセルのリッチテキスト値を返します。セル値がテキストでない場合は null を返します。 |
getRichTextValues() | RichTextValue[][] | 範囲内のセルのリッチテキスト値を返します。 |
getRow() | Integer | この範囲の行の位置を返します。 |
getRowIndex() | Integer | この範囲の行の位置を返します。 |
getSheet() | Sheet | この範囲が属するシートを返します。 |
getTextDirection() | TextDirection | 範囲の左上のセルのテキスト方向を返します。 |
getTextDirections() | TextDirection[][] | 範囲内のセルに対するテキストの向きを返します。 |
getTextRotation() | TextRotation | 範囲の左上のセルのテキスト回転設定を返します。 |
getTextRotations() | TextRotation[][] | 範囲内のセルのテキスト回転設定を返します。 |
getTextStyle() | TextStyle | 範囲の左上のセルのテキスト スタイルを返します。 |
getTextStyles() | TextStyle[][] | 範囲内のセルのテキスト スタイルを返します。 |
getValue() | Object | 範囲内の左上のセルの値を返します。 |
getValues() | Object[][] | この範囲の値の長方形グリッドを返します。 |
getVerticalAlignment() | String | 範囲の左上隅にあるセルの垂直方向の配置(上/中央/下)を返します。 |
getVerticalAlignments() | String[][] | 範囲内のセルの垂直方向の配置を返します。 |
getWidth() | Integer | 範囲の幅を列単位で返します。 |
getWrap() | Boolean | セル内のテキストが折り返されるかどうかを返します。 |
getWrapStrategies() | WrapStrategy[][] | 範囲内のセルのテキスト折り返し方法を返します。 |
getWrapStrategy() | WrapStrategy | 範囲の左上のセルのテキスト折り返し方法を返します。 |
getWraps() | Boolean[][] | セル内のテキストが折り返されるかどうかを返します。 |
insertCells(shiftDimension) | Range | この範囲に空白セルを挿入します。 |
insertCheckboxes() | Range | 範囲内の各セルにチェックボックスを挿入します。オンの場合は true 、オフの場合は false で構成します。 |
insertCheckboxes(checkedValue) | Range | 範囲内の各セルにチェックボックスを挿入します。オンの場合はカスタム値、オフの場合は空の文字列が設定されます。 |
insertCheckboxes(checkedValue, uncheckedValue) | Range | チェックボックスを範囲内の各セルに挿入します。チェックボックスは、オンの状態とオフの状態を表すカスタム値で構成されます。 |
isBlank() | Boolean | 範囲が完全に空白の場合、true を返します。 |
isChecked() | Boolean | 範囲内のすべてのセルのチェックボックスの状態が「オン」かどうかを返します。 |
isEndColumnBounded() | Boolean | 範囲の末尾を特定の列にバインドするかどうかを指定します。 |
isEndRowBounded() | Boolean | 範囲の末尾を特定の行にバインドするかどうかを指定します。 |
isPartOfMerge() | Boolean | 現在の範囲内のセルが結合したセルと重なる場合に、true を返します。 |
isStartColumnBounded() | Boolean | 範囲の先頭を特定の列にバインドするかどうかを指定します。 |
isStartRowBounded() | Boolean | 範囲の先頭を特定の行にバインドするかどうかを指定します。 |
merge() | Range | 範囲内のセルを 1 つのブロックに結合します。 |
mergeAcross() | Range | 範囲内の列のすべてのセルを結合します。 |
mergeVertically() | Range | 範囲内のセルを結合します。 |
moveTo(target) | void | この範囲から対象範囲に(形式と値の両方)を切り取って貼り付けます。 |
offset(rowOffset, columnOffset) | Range | この範囲から、指定された行数と列数(負の数も可能)だけオフセットされた新しい範囲を返します。 |
offset(rowOffset, columnOffset, numRows) | Range | 現在の範囲を基準として、現在の範囲から指定された行と列の位置を左上端とし、セルに指定された高さを持つ新しい範囲を返します。 |
offset(rowOffset, columnOffset, numRows, numColumns) | Range | 現在の範囲を基準として、現在の範囲から指定された行と列分のオフセット、セル内に指定された高さと幅を持つ新しい範囲を返します。 |
protect() | Protection | 権限を持つユーザーによる編集から範囲を保護できるオブジェクトを作成します。 |
randomize() | Range | 指定された範囲内の行の順序をランダム化します。 |
removeCheckboxes() | Range | 範囲からすべてのチェックボックスを削除します。 |
removeDuplicates() | Range | この範囲内で、前の行の値と重複する値を含む行を削除します。 |
removeDuplicates(columnsToCompare) | Range | この範囲内で、指定された列の値と前の行の値と重複する値を含む行を削除します。 |
setBackground(color) | Range | 範囲内のすべてのセルの背景色を CSS 表記('#ffffff' 、'white' など)で設定します。 |
setBackgroundObject(color) | Range | 範囲内のすべてのセルの背景色を設定します。 |
setBackgroundObjects(color) | Range | 背景色の長方形のグリッドを設定します(この範囲のサイズと一致する必要があります)。 |
setBackgroundRGB(red, green, blue) | Range | RGB 値(0 ~ 255 の整数)を使用して、指定した色に背景を設定します。 |
setBackgrounds(color) | Range | 背景色の長方形のグリッドを設定します(この範囲のサイズと一致する必要があります)。 |
setBorder(top, left, bottom, right, vertical, horizontal) | Range | 枠線プロパティを設定します。 |
setBorder(top, left, bottom, right, vertical, horizontal, color, style) | Range | 枠線のプロパティを色やスタイルで設定します。 |
setDataValidation(rule) | Range | 範囲内のすべてのセルに対して 1 つのデータ入力規則を設定します。 |
setDataValidations(rules) | Range | 範囲内のすべてのセルに対してデータの入力規則を設定します。 |
setFontColor(color) | Range | フォントの色を CSS 表記('#ffffff' 、'white' など)で設定します。 |
setFontColorObject(color) | Range | 指定した範囲のフォントの色を設定します。 |
setFontColorObjects(colors) | Range | フォントの色の長方形のグリッドを設定します(この範囲のサイズと一致する必要があります)。 |
setFontColors(colors) | Range | フォントの色の長方形のグリッドを設定します(この範囲のサイズと一致する必要があります)。 |
setFontFamilies(fontFamilies) | Range | フォント ファミリーの長方形のグリッドを設定します(この範囲のサイズと一致する必要があります)。 |
setFontFamily(fontFamily) | Range | フォント ファミリーを設定します(「snippet」や「Helvetica」など)。 |
setFontLine(fontLine) | Range | 指定された範囲('underline' 、'line-through' 、または 'none' )のフォント ライン スタイルを設定します。 |
setFontLines(fontLines) | Range | 線スタイルの長方形グリッドを設定します(この範囲のサイズと一致する必要があります)。 |
setFontSize(size) | Range | フォントサイズを設定します。サイズは、使用するポイントサイズです。 |
setFontSizes(sizes) | Range | フォントサイズの長方形のグリッドを設定します(この範囲のサイズと一致する必要があります)。 |
setFontStyle(fontStyle) | Range | 指定した範囲('italic' または 'normal' )のフォント スタイルを設定します。 |
setFontStyles(fontStyles) | Range | フォント スタイルの長方形グリッドを設定します(この範囲のサイズと一致する必要があります)。 |
setFontWeight(fontWeight) | Range | 指定した範囲のフォントの太さを設定します(標準/太字)。 |
setFontWeights(fontWeights) | Range | フォントの太さの長方形のグリッドを設定します(この範囲のサイズと一致する必要があります)。 |
setFormula(formula) | Range | この範囲の数式を更新します。 |
setFormulaR1C1(formula) | Range | この範囲の数式を更新します。 |
setFormulas(formulas) | Range | 数式の長方形のグリッドを設定します(この範囲のディメンションと一致する必要があります)。 |
setFormulasR1C1(formulas) | Range | 数式の長方形のグリッドを設定します(この範囲のディメンションと一致する必要があります)。 |
setHorizontalAlignment(alignment) | Range | 指定した範囲(左/中央/右)の水平方向の配置(左から右)を設定します。 |
setHorizontalAlignments(alignments) | Range | 水平方向の配置の長方形のグリッドを設定します。 |
setNote(note) | Range | 指定された値にメモを設定します。 |
setNotes(notes) | Range | メモの長方形グリッドを設定します(この範囲のサイズと一致する必要があります)。 |
setNumberFormat(numberFormat) | Range | 数値または日付の形式を、指定された書式設定文字列に設定します。 |
setNumberFormats(numberFormats) | Range | 数値形式または日付形式の長方形グリッドを設定します(この範囲の寸法と一致する必要があります)。 |
setRichTextValue(value) | Range | 範囲内のセルにリッチテキスト値を設定します。 |
setRichTextValues(values) | Range | リッチテキスト値で長方形のグリッドを設定します。 |
setShowHyperlink(showHyperlink) | Range | 範囲にハイパーリンクを表示するかどうかを設定します。 |
setTextDirection(direction) | Range | 範囲内のセルのテキスト方向を設定します。 |
setTextDirections(directions) | Range | テキスト方向の長方形のグリッドを設定します。 |
setTextRotation(degrees) | Range | 範囲内のセルのテキスト回転設定を設定します。 |
setTextRotation(rotation) | Range | 範囲内のセルのテキスト回転設定を設定します。 |
setTextRotations(rotations) | Range | テキストを回転させるための長方形のグリッドを設定します。 |
setTextStyle(style) | Range | 範囲内のセルのテキスト スタイルを設定します。 |
setTextStyles(styles) | Range | テキスト スタイルの長方形のグリッドを設定します。 |
setValue(value) | Range | 範囲の値を設定します。 |
setValues(values) | Range | 値の長方形のグリッドを設定します(この範囲のディメンションと一致する必要があります)。 |
setVerticalAlignment(alignment) | Range | 指定した範囲(上部/中央/下部)の垂直方向の配置(上から下)を設定します。 |
setVerticalAlignments(alignments) | Range | 垂直方向の配置の長方形のグリッドを設定します(この範囲のサイズと一致する必要があります)。 |
setVerticalText(isVertical) | Range | 範囲内のセルにテキストを積み重ねるかどうかを設定します。 |
setWrap(isWrapEnabled) | Range | 指定した範囲のセル折り返しを設定します。 |
setWrapStrategies(strategies) | Range | ラップ戦略の長方形のグリッドを設定します。 |
setWrapStrategy(strategy) | Range | 範囲内のセルのテキスト折り返し方法を設定します。 |
setWraps(isWrapEnabled) | Range | ワードラップ ポリシーの長方形のグリッドを設定します(この範囲のサイズと一致している必要があります)。 |
shiftColumnGroupDepth(delta) | Range | 範囲の列のグループ化の深さを、指定された量だけ変更します。 |
shiftRowGroupDepth(delta) | Range | 範囲の行グループ化の深さを、指定された量だけ変更します。 |
sort(sortSpecObj) | Range | 指定した範囲内のセルを、指定した列および順序で並べ替えます。 |
splitTextToColumns() | void | 自動検出された区切り文字に基づいて、テキストの列を複数の列に分割します。 |
splitTextToColumns(delimiter) | void | 指定された文字列をカスタムの区切り文字として使用し、テキストの列を複数の列に分割します。 |
splitTextToColumns(delimiter) | void | 指定された区切り文字に基づいて、テキストの列を複数の列に分割します。 |
trimWhitespace() | Range | この範囲内のすべてのセルの空白(スペース、タブ、改行など)を削除します。 |
uncheck() | Range | 範囲内のチェックボックスの状態を「オフ」に変更します。 |
RangeList
Methods
RecalculationInterval
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
ON_CHANGE | Enum | 値が変更された場合にのみ再計算します。 |
MINUTE | Enum | 値が変更されたタイミングと 1 分ごとに再計算します。 |
HOUR | Enum | 値が変更されたときと 1 時間ごとに再計算する |
RelativeDate
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
TODAY | Enum | 現在の日付と比較した日付。 |
TOMORROW | Enum | 現在の日付より後の日付と比較します。 |
YESTERDAY | Enum | 現在の日付より前の日付と比較します。 |
PAST_WEEK | Enum | 過去 1 週間以内の日付。 |
PAST_MONTH | Enum | 過去の 1 か月以内の日付。 |
PAST_YEAR | Enum | 過去 1 年以内の日付。 |
RichTextValue
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
copy() | RichTextValueBuilder | このリッチテキスト値で初期化されたリッチテキスト値のビルダーを返します。 |
getEndIndex() | Integer | セル内のこの値の終了インデックスを取得します。 |
getLinkUrl() | String | この値のリンク URL を返します。 |
getLinkUrl(startOffset, endOffset) | String | startOffset から endOffset へのテキストのリンク URL を返します。 |
getRuns() | RichTextValue[] | リッチテキスト文字列を実行の配列に分割し、各実行が一貫したテキスト スタイルを持つ最も長い部分文字列を返します。 |
getStartIndex() | Integer | セル内のこの値の開始インデックスを取得します。 |
getText() | String | この値のテキストを返します。 |
getTextStyle() | TextStyle | この値のテキスト スタイルを返します。 |
getTextStyle(startOffset, endOffset) | TextStyle | startOffset から endOffset までのテキストのテキスト スタイルを返します。 |
RichTextValueBuilder
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
build() | RichTextValue | このビルダーからリッチテキスト値を作成します。 |
setLinkUrl(startOffset, endOffset, linkUrl) | RichTextValueBuilder | この値で指定された部分文字列のリンク URL を設定するか、linkUrl が null の場合はクリアします。 |
setLinkUrl(linkUrl) | RichTextValueBuilder | 値全体のリンク URL を設定するか、linkUrl が null の場合はクリアします。 |
setText(text) | RichTextValueBuilder | この値のテキストを設定し、既存のテキスト スタイルをすべてクリアします。 |
setTextStyle(startOffset, endOffset, textStyle) | RichTextValueBuilder | この値の指定された部分文字列にテキスト スタイルを適用します。 |
setTextStyle(textStyle) | RichTextValueBuilder | 値全体にテキスト スタイルを適用します。 |
Selection
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getActiveRange() | Range | アクティブ シート内の選択した範囲を返します。アクティブ範囲がない場合は null を返します。 |
getActiveRangeList() | RangeList | アクティブ シート内のアクティブ範囲のリストを返します。アクティブな範囲がない場合は null を返します。 |
getActiveSheet() | Sheet | スプレッドシート内のアクティブなシートを返します。 |
getCurrentCell() | Range | 有効な範囲のいずれかで選択された現在の(ハイライト表示された)セルを返します。現在のセルがない場合は null を返します。 |
getNextDataRange(direction) | Range | current cell と active range から始めて、指定された方向に移動すると、現在のセルをカバーしながら next data cell をカバーするように範囲の適切な端がずれた、調整された範囲を返します。 |
Sheet
Methods
SheetType
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
GRID | Enum | グリッドを含むシート。 |
OBJECT | Enum | 単一の埋め込みオブジェクト(EmbeddedChart など)を含むシート。 |
DATASOURCE | Enum | DataSource を含むシート。 |
Slicer
Methods
SortOrder
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
ASCENDING | Enum | 昇順の並べ替え順。 |
DESCENDING | Enum | 降順の並べ替え順。 |
SortSpec
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getBackgroundColor() | Color | 並べ替えに使用される背景色を返します。背景色が存在しない場合は null を返します。 |
getDataSourceColumn() | DataSourceColumn | 並べ替え仕様が適用されるデータソース列を取得します。 |
getDimensionIndex() | Integer | ディメンションのインデックス、またはローカル フィルタにリンクされていない場合は null を返します。 |
getForegroundColor() | Color | 並べ替えに使用される前景の色を返します。指定しない場合は null を返します。 |
getSortOrder() | SortOrder | 並べ替え順を返します。 |
isAscending() | Boolean | 並べ替え順が昇順かどうかを返します。 |
Spreadsheet
Methods
SpreadsheetApp
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
AutoFillSeries | AutoFillSeries | 自動入力される値の計算に使用される系列を列挙します。 |
BandingTheme | BandingTheme | 考えられるバンディングテーマを列挙します。 |
BooleanCriteria | BooleanCriteria | 条件付き書式のブール値条件の列挙です。 |
BorderStyle | BorderStyle | Range に枠線を設定するための有効なスタイルの列挙です。 |
ColorType | ColorType | 使用可能な色タイプの列挙です。 |
CopyPasteType | CopyPasteType | 可能な貼り付けタイプの列挙です。 |
DataExecutionErrorCode | DataExecutionErrorCode | データ実行の可能性のあるエラーコードを列挙します。 |
DataExecutionState | DataExecutionState | 可能なデータ実行状態の列挙。 |
DataSourceParameterType | DataSourceParameterType | 有効なデータソース パラメータの型の列挙型。 |
DataSourceRefreshScope | DataSourceRefreshScope | データソースの更新スコープを列挙します。 |
DataSourceType | DataSourceType | 有効なデータソース タイプの列挙です。 |
DataValidationCriteria | DataValidationCriteria | 範囲に対して設定できるデータ検証基準を表す列挙型。 |
DateTimeGroupingRuleType | DateTimeGroupingRuleType | 日時のグループ化ルールの列挙。 |
DeveloperMetadataLocationType | DeveloperMetadataLocationType | デベロッパー メタデータの位置情報タイプを列挙します。 |
DeveloperMetadataVisibility | DeveloperMetadataVisibility | デベロッパー メタデータの公開設定を列挙します。 |
Dimension | Dimension | スプレッドシートの可能なディメンションを列挙します。 |
Direction | Direction | 矢印キーを使用してスプレッドシート内で移動できる方向を列挙したもの。 |
FrequencyType | FrequencyType | 有効な頻度の型の列挙です。 |
GroupControlTogglePosition | GroupControlTogglePosition | グループ コントロールの切り替えの位置を列挙します。 |
InterpolationType | InterpolationType | 条件付き書式のグラデーション補間タイプの列挙。 |
PivotTableSummarizeFunction | PivotTableSummarizeFunction | ピボット テーブル内の値の集計に使用できる関数の列挙です。 |
PivotValueDisplayType | PivotValueDisplayType | ピボット値の表示方法を列挙したものです。 |
ProtectionType | ProtectionType | 編集から保護できるスプレッドシートの部分を表す列挙型。 |
RecalculationInterval | RecalculationInterval | スプレッドシートの再計算に使用できる間隔を列挙します。 |
RelativeDate | RelativeDate | 日付ベースの BooleanCriteria で使用する値を計算するための相対日付オプションの列挙。 |
SheetType | SheetType | スプレッドシートに存在することができるさまざまな種類のシートを列挙したものです。 |
SortOrder | SortOrder | 並べ替え順の列挙。 |
TextDirection | TextDirection | 有効なテキスト方向の列挙。 |
TextToColumnsDelimiter | TextToColumnsDelimiter | テキストを列に分割するためにプリセットされた区切り文字の列挙。 |
ThemeColorType | ThemeColorType | 有効なテーマのカラータイプを列挙します。 |
ValueType | ValueType | スプレッドシート サービスの Range クラスから Range.getValue() と Range.getValues() によって返される値の型の列挙型です。 |
WrapStrategy | WrapStrategy | セルをラップするために使用される戦略を列挙します。 |
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
create(name) | Spreadsheet | 指定した名前で新しいスプレッドシートを作成します。 |
create(name, rows, columns) | Spreadsheet | 指定した名前と指定した行数と列数で、新しいスプレッドシートを作成します。 |
enableAllDataSourcesExecution() | void | すべての種類のデータソースに対してデータ実行を有効にします。 |
enableBigQueryExecution() | void | BigQuery データソースのデータ実行をオンにします。 |
flush() | void | スプレッドシートの保留中の変更をすべて適用します。 |
getActive() | Spreadsheet | 現在アクティブなスプレッドシートを返します。スプレッドシートがない場合は null を返します。 |
getActiveRange() | Range | アクティブ シート内の選択した範囲を返します。アクティブ範囲がない場合は null を返します。 |
getActiveRangeList() | RangeList | アクティブ シート内のアクティブ範囲のリストを返します。範囲が選択されていない場合は null を返します。 |
getActiveSheet() | Sheet | スプレッドシート内のアクティブ シートを取得します。 |
getActiveSpreadsheet() | Spreadsheet | 現在アクティブなスプレッドシートを返します。スプレッドシートがない場合は null を返します。 |
getCurrentCell() | Range | アクティブ シート内のアクティブ範囲のいずれかで選択された現在の(ハイライト表示された)セルを返します。現在のセルがない場合は null を返します。 |
getSelection() | Selection | スプレッドシートの現在の Selection を返します。 |
getUi() | Ui | スプレッドシートのユーザー インターフェース環境のインスタンスを返します。この環境では、スクリプトがメニュー、ダイアログ、サイドバーなどの機能を追加できます。 |
newCellImage() | CellImageBuilder | CellImage のビルダーを作成します。 |
newColor() | ColorBuilder | Color のビルダーを作成します。 |
newConditionalFormatRule() | ConditionalFormatRuleBuilder | 条件付き書式ルールのビルダーを作成します。 |
newDataSourceSpec() | DataSourceSpecBuilder | DataSourceSpec のビルダーを作成します。 |
newDataValidation() | DataValidationBuilder | データ入力規則のビルダーを作成します。 |
newFilterCriteria() | FilterCriteriaBuilder | FilterCriteria のビルダーを作成します。 |
newRichTextValue() | RichTextValueBuilder | リッチテキスト値のビルダーを作成します。 |
newTextStyle() | TextStyleBuilder | テキスト スタイルのビルダーを作成します。 |
open(file) | Spreadsheet | 指定した File オブジェクトに対応するスプレッドシートを開きます。 |
openById(id) | Spreadsheet | 指定された ID のスプレッドシートを開きます。 |
openByUrl(url) | Spreadsheet | 指定した URL のスプレッドシートを開きます。 |
setActiveRange(range) | Range | 指定された範囲を active range として設定し、範囲内の左上のセルを current cell として設定します。 |
setActiveRangeList(rangeList) | RangeList | 指定された範囲リストを active ranges として設定します。 |
setActiveSheet(sheet) | Sheet | スプレッドシートにアクティブ シートを設定します。 |
setActiveSheet(sheet, restoreSelection) | Sheet | スプレッドシート内のアクティブなシートを設定し、そのシート内の最新の選択を復元するオプションを提供します。 |
setActiveSpreadsheet(newActiveSpreadsheet) | void | アクティブなスプレッドシートを設定します。 |
setCurrentCell(cell) | Range | 指定されたセルを current cell として設定します。 |
SpreadsheetTheme
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getConcreteColor(themeColorType) | Color | 有効なテーマカラータイプの具体的な Color を返します。 |
getFontFamily() | String | テーマのフォント ファミリーを返します。null テーマの場合は null を返します。 |
getThemeColors() | ThemeColorType[] | 現在のテーマで使用できるすべてのテーマカラータイプのリストを返します。 |
setConcreteColor(themeColorType, color) | SpreadsheetTheme | このカラーパターンの ThemeColorType に関連付けられている具体的な色を、指定された色に設定します。 |
setConcreteColor(themeColorType, red, green, blue) | SpreadsheetTheme | このカラーパターンの ThemeColorType に関連付けられた具体的な色を、指定された色(RGB 形式)に設定します。 |
setFontFamily(fontFamily) | SpreadsheetTheme | テーマのフォント ファミリーを設定します。 |
TextDirection
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
LEFT_TO_RIGHT | Enum | 文章方向(左から右)。 |
RIGHT_TO_LEFT | Enum | 文章方向(右から左)。 |
TextFinder
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
findAll() | Range[] | 検索条件に一致するすべてのセルを返します。 |
findNext() | Range | 検索条件に一致する次のセルを返します。 |
findPrevious() | Range | 検索条件に一致する前のセルを返します。 |
getCurrentMatch() | Range | 検索条件に一致する現在のセルを返します。 |
ignoreDiacritics(ignoreDiacritics) | TextFinder | true の場合、照合の際に発音区別符号を無視するように検索を構成します。それ以外の場合は、発音区別符号と照合されます。 |
matchCase(matchCase) | TextFinder | true の場合、検索テキストの大文字と小文字が完全に一致するように検索を構成します。それ以外の場合は、デフォルトで大文字と小文字を区別しません。 |
matchEntireCell(matchEntireCell) | TextFinder | true の場合、セルのコンテンツ全体に一致するように検索を構成します。それ以外の場合は、デフォルトで部分一致になります。 |
matchFormulaText(matchFormulaText) | TextFinder | true の場合、数式テキスト内に含まれる一致が返されるように検索を構成します。それ以外の場合、数式を含むセルは、表示されている値に基づいて考慮されます。 |
replaceAllWith(replaceText) | Integer | 一致する文字列をすべて指定したテキストに置き換えます。 |
replaceWith(replaceText) | Integer | 現在一致しているセルの検索テキストを指定されたテキストに置き換え、置き換えたオカレンスの数を返します。 |
startFrom(startRange) | TextFinder | 指定したセル範囲の直後に検索を開始するように検索を設定します。 |
useRegularExpression(useRegEx) | TextFinder | true の場合、検索文字列が正規表現として解釈されるように検索を構成します。それ以外の場合、検索文字列は通常のテキストとして解釈されます。 |
TextRotation
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getDegrees() | Integer | 標準のテキストの向きと現在のテキストの向きとの間の角度を取得します。 |
isVertical() | Boolean | テキストが縦方向に積み重ねられている場合は true を返し、それ以外の場合は false を返します。 |
TextStyle
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
copy() | TextStyleBuilder | このテキスト スタイルの値で初期化されるテキスト スタイル ビルダーを作成します。 |
getFontFamily() | String | テキストのフォント ファミリーを取得します。 |
getFontSize() | Integer | テキストのフォントサイズをポイント単位で取得します。 |
getForegroundColorObject() | Color | テキストのフォントの色を取得します。 |
isBold() | Boolean | テキストが太字かどうかを取得します。 |
isItalic() | Boolean | セルが斜体かどうかを取得します。 |
isStrikethrough() | Boolean | セルに取り消し線が引かれているかどうかを取得します。 |
isUnderline() | Boolean | セルに下線が引かれるかどうかを取得します。 |
TextStyleBuilder
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
build() | TextStyle | このビルダーからテキスト スタイルを作成します。 |
setBold(bold) | TextStyleBuilder | テキストを太字にするかどうかを設定します。 |
setFontFamily(fontFamily) | TextStyleBuilder | 「snippet」などのテキストのフォント ファミリーを設定します。 |
setFontSize(fontSize) | TextStyleBuilder | テキストのフォントサイズをポイント単位で設定します。 |
setForegroundColor(cssString) | TextStyleBuilder | テキストのフォントの色を設定します。 |
setForegroundColorObject(color) | TextStyleBuilder | テキストのフォントの色を設定します。 |
setItalic(italic) | TextStyleBuilder | テキストが斜体かどうかを設定します。 |
setStrikethrough(strikethrough) | TextStyleBuilder | テキストに取り消し線を引くかどうかを設定します。 |
setUnderline(underline) | TextStyleBuilder | テキストに下線を引くかどうかを設定します。 |
TextToColumnsDelimiter
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
COMMA | Enum | "," 区切り文字。 |
SEMICOLON | Enum | ";" 区切り文字。 |
PERIOD | Enum | "." 区切り文字。 |
SPACE | Enum | " " 区切り文字。 |
ThemeColor
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getColorType() | ColorType | この色のタイプを取得します。 |
getThemeColorType() | ThemeColorType | この色のテーマカラータイプを取得します。 |
ThemeColorType
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
UNSUPPORTED | Enum | サポートされていないテーマカラーを表します。 |
TEXT | Enum | テキストの色を表します。 |
BACKGROUND | Enum | グラフの背景に使用する色を表します。 |
ACCENT1 | Enum | 最初のアクセント カラーを表します。 |
ACCENT2 | Enum | 2 番目のアクセント カラーを表します。 |
ACCENT3 | Enum | 3 番目のアクセント カラーを表します。 |
ACCENT4 | Enum | 4 番目のアクセント カラーを表します。 |
ACCENT5 | Enum | 5 番目のアクセント カラーを表します。 |
ACCENT6 | Enum | 6 番目のアクセント カラーを表します。 |
HYPERLINK | Enum | ハイパーリンクに使用する色を表します。 |
ValueType
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
IMAGE | Enum | セルに画像が含まれている場合の値の型。 |
WrapStrategy
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
WRAP | Enum | セル幅よりも長い行を新しい行で折り返す。 |
OVERFLOW | Enum | そのセルが空である限り、次のセルに行をはみ出します。 |
CLIP | Enum | セルの幅よりも長い線をクリップする。 |