GASでスプレッドシートの列の幅・行の高さを取得する方法(getColumnWidth、getRowHeight)

2022年1月18日

Google Apps Script(GAS)でスプレッドシートの列の幅と行の高さを取得する方法を解説します。

列の幅や行の高さがどれぐらいか、具体的な数値で確認することができます。

スプレッドシートの列幅や行の高さはGASで取得可能

スプレッドシートでは、セルに入力した文字分量に応じて列幅や行の高さを変更することができます。

スプレッドシートの列幅や行の高さはGoogle Apps Script(GAS)で取得可能

この列幅や行の高さがどれぐらいかというのは、スプレッドシート上では確認できません。

しかし、Google Apps Script(GAS)を使えば、列幅と行の高さの長さがどれぐらいか数値として確認できます。

GASでシートの列の幅を取得するgetColumnWidth

Google Apps Script(GAS)でスプレッドシートの列の幅の長さを取得するためには、getColumnWidthメソッドを使用します。

sheet.getColumnWidth(列番号)

getColumnWidthはsheetオブジェクトで実行可能です。

引数に指定した列番号の列幅がどれぐらいか数値(Number型)を返してくれます。

なお、複数列を一括で取得し、1次元配列で取得するメソッドはなく、幅を取得したい列を1列ずつgetColumnWidthメソッドの実行が必要です。

GASでシートの行の高さを取得するgetRowHeight

次にスプレッドシートの行の高さをGoogle Apps Script(GAS)で取得するためには、getRowHeightメソッドを使用します。

sheet.getRowHeight(行番号)

getRowHeightもsheetオブジェクトで実行し、引数に指定した行番号の高さがどれぐらいか数値(Number型)を返してくれます。

シートの列幅・行の高さを取得するGASサンプルコード

実際にGスプレッドシートの列幅と行の高さを取得する方法をoogle Apps Script(GAS)のサンプルコードで解説します。

下記のような列幅や行の高さを一部変更したスプレッドシートを使用します。

スプレッドシートの列幅や行の高さはGoogle Apps Script(GAS)で取得可能

このスプレッドシートに紐づくコンテナバインド型のGASスクリプトで列幅・行高を取得し、ログ出力します。

Google Apps Script(GAS)でスプレッドシートの列の幅と行の高さを取得してログ出力するサンプルコード
function getColumnRowSize() {
  //スクリプトに紐づくスプレッドシートのアクティブなシートを取得
  let mySheet = SpreadsheetApp.getActiveSheet();
  //シートの1列目(A列)の幅を取得
  console.log(mySheet.getColumnWidth(1));
  //シートの3列目(C列)の幅を取得
  console.log(mySheet.getColumnWidth(3));
  //シートの6行目の高さを取得
  console.log(mySheet.getRowHeight(6));
  //シートの7行目の高さを取得
  console.log(mySheet.getRowHeight(7));
}

GASのサンプルスクリプトを実行すると、実行ログに列幅と行高が数値で出力されます。

Google Apps Script(GAS)でスプレッドシートの列の幅と行の高さを取得してログ出力するサンプルコードを実行した結果

このようにして、GASで列幅や行の高さが実際にどれぐらいの長さか数値で確認可能です。

列幅・行の高さを変更したい場合

今回はGoogle Apps Script(GAS)でシートの列の幅や行の高さを取得しました。

GASでは取得するだけでなく、列幅・行高を変更することも可能です。

○列の幅と行の高さで設定したい場合

○列の幅と行の高さを入力内容に応じて自動調整したい場合

普段スプレッドシートで行っているような手動で列幅を変更する方法や、セルの入力内容に応じて自動拡大・縮小も可能です。

まとめ・終わりに

今回、Google Apps Script(GAS)でスプレッドシートの列の幅と行の高さを取得する方法を紹介しました。

列幅を取得したい場合はgetColumnWidth、行高を取得したい場合はgetRowHeightを実行します。

スプレッドシートのGUIではなんとなくのサイズでしかわかりませんが、GASを使えば正確な長さの数値を取ることができます。

取得した列の幅・行の高さに応じて、見栄えを変更する条件分岐の処理などに活用できるので、ぜひ覚えておきましょう。