Google Apps Script (GAS) でスプレッドシートのアクティブなシートの行の高さや列の幅を取得したり設定する方法を説明します。
SpreadSheetクラスのメソッドを利用した手順について説明します。
アクティブなシートではなく、シートを指定したい場合は、下記のSheetクラスのメソッドを利用する方法をご覧ください。
Google Apps Scriptの基本的な使い方については下記をご覧ください。
GASによるスプレッドシート操作の概要
GASでスプレッドシートを操作するための「SpreadSheetサービス」は、主に下記のクラスで構成されています。
| クラス | 説明 |
|---|---|
| SpreadSheetApp | SpreadSheetサービスの親クラス |
| Spreadsheet | スプレッドシートを操作するクラス |
| Sheet | シートを操作するクラス |
| Range | セル範囲を操作するクラス |
それぞれ下記のような位置付けになります。
「SpreadSheetApp」→「SpreadSheet」→「Sheet」→「Range」という順の階層構造になっています。操作対象に応じて、下の階層にたどってオブジェクトを取得して利用します。
このページでは、上記の中のSpreadSheetクラスの下記のメソッドについて説明します。
| メソッド | 戻り値 | 説明 |
|---|---|---|
| getRowHeight(rowPosition) | Integer | 指定した行の高さを取得する |
| setRowHeight(rowPosition, height) | Sheet | 指定した行の高さを設定する |
| getColumnWidth(columnPosition) | Integer | 指定した列の幅を取得する |
| setColumnWidth(columnPosition, width) | Sheet | 指定した列の幅を設定する |
| autoResizeColumn(columnPosition) | Sheet | 指定した列の幅を自動調整する |
アクティブなシートの行の高さを取得・設定する
アクティブなシートの行の高さを取得したり、設定するメソッドを説明します。
指定した行の高さを取得する：getRowHeight(rowPosition)
指定した行の高さをピクセル単位で取得する方法です。
下記のように実行します。
|
1 2 3 4 |
function myFunction() { const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet(); console.log(testSpreadSheet.getRowHeight(3)); } |
下記のファイルに対して実行すると、
下記の結果になります。3行目は、46ピクセルの高さということになります。
|
1 |
46 |
アクティブなシートのデータを取得します。
シートを指定したい場合は、SheetクラスのgetRowHeightメソッドを利用します。
指定した行の高さを設定する：setRowHeight(rowPosition, height)
指定した行の高さをピクセル単位で設定する方法です。
下記のように実行します。
|
1 2 3 4 |
function myFunction() { const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet(); testSpreadSheet.setRowHeight(3, 100); } |
下記のファイルに対して実行すると、
下記の結果になります。指定した3行目が、100ピクセルの高さになります。
アクティブなシートのデータを取得します。
シートを指定したい場合は、SheetクラスのsetRowHeightメソッドを利用します。
アクティブなシートの列の幅を取得・設定する
スプレッドシートの列の幅を取得したり、設定するメソッドを説明します。
指定した列の幅を取得する：getColumnWidth(columnPosition)
指定した列の幅をピクセル単位で取得する方法です。
下記のように実行します。
|
1 2 3 4 |
function myFunction() { const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet(); console.log(testSpreadSheet.getColumnWidth(3)); } |
下記のファイルに対して実行すると、
下記の結果になります。3列目は、100ピクセルの幅ということになります。
|
1 |
100 |
アクティブなシートのデータを取得します。
シートを指定したい場合は、SheetクラスのgetColumnWidthメソッドを利用します。
指定した列の幅を設定する：setColumnWidth(columnPosition, width)
指定した列の幅をピクセル単位で設定する方法です。
下記のように実行します。
|
1 2 3 4 |
function myFunction() { const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet(); testSpreadSheet.setColumnWidth(3, 200); } |
下記のファイルに対して実行すると、
下記の結果になります。指定した3列目が、200ピクセルの幅になります。
アクティブなシートのデータを取得します。
シートを指定したい場合は、SheetクラスのsetColumnWidthメソッドを利用します。
指定した列の幅を自動調整する：autoResizeColumn(columnPosition)
指定した列の幅を、入力された値に合わせ自動調整する方法です。
下記のように実行します。
|
1 2 3 4 |
function myFunction() { const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet(); testSpreadSheet.autoResizeColumn(3); } |
下記のファイルに対して実行すると、
下記の結果になります。入力された値に全然合っていません。
スプレッドシートの列幅の自動調整は不完全で、特に日本語が入っているとうまく動作しないようです。
試しにアルファベットのみで実行してみると下記になります。左右の余白が少し大きいです。
スプレッドシート側で列の右側をダブルクリックして列幅を自動調整すると下記になりますので、少しズレがあります。
次に数字で試してみると、autoResizeColumnメソッドでは下記になります。これもズレています。
スプレッドシート側で列の右側をダブルクリックして列幅を自動調整すると下記になります。スプレッドシート側で操作してもズレています。スプレッドシート側で操作しても、数字の組み合わせによってはズレる場合があるようです。
autoResizeColumnメソッドを利用する場合は、よく動作確認してから利用することをおすすめします。
アクティブなシートのデータを取得します。
シートを指定したい場合は、SheetクラスのautoResizeColumnメソッドを利用します。
まとめ
Google Apps Script (GAS) でスプレッドシートのアクティブなシートの行の高さや列の幅を取得したり設定する方法を説明しました。
GASは無料で利用できてとても便利なツールです。
Googleスプレッドシート等のGoogleアプリケーションを利用されている方は、GASを習得することで作業を大きく効率化できます。
GASの基本構文を知りたい方は、下記もご覧ください。
