【GAS】スプレッドシートのテキスト方向機能まとめ【サンプルソース付】

GAS開発者向けにスプレッドシートのテキスト方向機能をすべてまとめました。

おそらく水平設定(setHorizontalAlignment)と動きは同じです。正直何が違うのかわかってません。

中央表示も可能な水平設定を使うならば、あまり使う機会はないかもしれませんが、何かの参考になればと思います。

テキスト方向に関するメソッドをすべて載せてます。少しでも参考になれば幸いです。

Google Apps Script スプレッドシート基礎リファレンス
テキスト方向列挙型[Enum TextDirection]
セル範囲クラス[Range]のテキスト方向設定
1. テキスト方向設定[setTextDirection(方向)]
2. テキスト方向配列設定[setTextDirections(方向's)]
セル範囲クラス[Range]のテキスト方向取得
1. テキスト方向取得[getTextDirection()]
2. テキスト方向配列取得[getTextDirections()]
セル範囲リストクラス[RangeList]のテキスト方向設定
1. テキスト方向設定[setTextDirection(方向)]
最後に

Google Apps Script スプレッドシート基礎リファレンス

当ページは、GAS公式リファレンスを元にスプレッドシートの機能毎にまとめた基礎的な内容となっております。

若干、文言がおかしい可能性がありますが、あらかじめご了承ください。

GAS基本メソッドまとめ一覧はコチラ↓↓↓です。スプレッドシートの基本的な機能をまとめてますので、ぜひご活用ください。

【GAS】スプレッドシート基本メソッドまとめ一覧【初心者入門】

GAS開発者向けにスプレッドシートの基本的なメソッドを一覧にまとめました。各機能ごとのクラス、メソッドごとのサンプルソース付ページへリンクする一覧です。初心者にとって、スプレッドシートの基本的な操作・機能単位のメソッドを知...

まずは実際に動かしてみることをオススメします。マクロの登録方法は以下を参照いただければと思います。

【GAS】Googleスプレッドシートでマクロの使い方入門【動画付】

Googleの「Google Apps Script」通称GAS。GoogleマップやGメールなど、いろんなGoogle関連のサービスと自由に連携できたり、独自のWebアプリを開発することもできる、いろんな可能性を秘めたワクワクの...

GASの本はまだまだ少ないですね。基礎レベルであれば、以下の参考書が初心者にはベストの本です。

基本的な仕様やよく使われる機能の設定方法がまとまっています。

リンク

※JavaScriptの知識が既にある程度ある人にとっては冗長かもしれません。

テキスト方向列挙型[Enum TextDirection]

セルのテキストの方向です。

Enum TextDirection
テキストの方向の列挙

Properties
プロパティ	タイプ	説明
LEFT_TO_RIGHT	Enum	左から右へのテキスト方向。
RIGHT_TO_LEFT	Enum	右から左へのテキスト方向。

参照：Google Apps Script | REFERENCE | SpreadSheet | Enum TextDirection

セル範囲クラス[Range]のテキスト方向設定

セル範囲のテキスト方向設定メソッドです。

テキスト方向設定[setTextDirection(方向)]

setTextDirection(direction)
範囲内のセルのテキスト方向を設定します。指定された方向がNULLの場合、方向は推測されてから設定されます。

function setTextDirectionSample() {
  // 範囲のテキストの方向を右から左に設定します。
  var sheet = SpreadsheetApp.getActiveSheet();
  var range = sheet.getRange("B5:C6");
  range.setTextDirection(SpreadsheetApp.TextDirection.RIGHT_TO_LEFT);
}

Parameters
名前	タイプ	説明
direction	TextDirection	設定するテキストの方向。nullの場合、方向は設定前に推測されます。

Return
Range - 連鎖用のセル範囲。

テキスト方向配列設定[setTextDirections(方向's)]

setTextDirections(directions)
テキスト方向の2次元配列を設定します。指定された方向がNULLの場合、方向は推測されてから設定されます。

function setTextDirectionsSample() {
  // 範囲A1:B2から範囲C5:D6にテキストの方向をすべてコピーします。
  var sheet = SpreadsheetApp.getActiveSheet();
  var range1 = sheet.getRange("A1:B2");
  var range2 = sheet.getRange("C5:D6");

  range2.setTextRotations(range1.getTextDirections());
}

Parameters
名前	タイプ	説明
directions	TextDirection[][]	設定するテキストの方向。指定された方向がnullの場合は、設定前に推測されます。

Return
Range - 連鎖用のセル範囲。

セル範囲クラス[Range]のテキスト方向取得

セル範囲のテキスト方向取得メソッドです。

テキスト方向取得[getTextDirection()]

getTextDirection()
範囲の左上のセルのテキスト方向を返します。セルテキストの方向が自動検出で決定されている場合はnullを返します。

function getTextDirectionSample() {
  // セルB1の文字方向を取得します。
  var sheet = SpreadsheetApp.getActiveSheet();
  var range = sheet.getRange("B1:D4");
  Logger.log(range.getTextDirection());
}

Return
TextDirection - 範囲内の左上のセルのテキスト方向。

テキスト方向配列取得[getTextDirections()]

getTextDirections()
範囲内のセルのテキスト方向を返します。自動検出を使用するセルでは、2D配列のエントリはnullです。

function getTextDirectionsSample() {
  // 範囲B5:C6内のすべてのセルのテキストの方向を取得します
  var sheet = SpreadsheetApp.getActiveSheet();
  var range = sheet.getRange("B5:C6");
  var directions = range.getTextDirections();

  for (var i = 0; i < directions.length; i++) {
    for (var j = 0; j < directions[i].length; j++) {
      Logger.log(directions[i][j]);
    }
  }
}

Return
TextDirection[][] - テキストの方向の2次元配列。

セル範囲リストクラス[RangeList]のテキスト方向設定

セル範囲リストのテキスト方向設定メソッドです。

テキスト方向設定[setTextDirection(方向)]

setTextDirection(direction)
範囲リスト内の各範囲内のセルのテキスト方向を設定します。指定された方向がNULLの場合、方向は推測されてから設定されます。

function setTextDirectionSample() {
  // 範囲リストの各範囲を右から左にテキストの方向を設定します。
  var sheet = SpreadsheetApp.getActiveSheet();
  var rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
  rangeList.setTextDirection(SpreadsheetApp.TextDirection.RIGHT_TO_LEFT);
}