Label (command)

ページにテキストラベルを配置します。

構文

label [options] message

1つ以上のオプションスイッチを追加することで、ラベルの作成方法を変更できます。ラベルによって表示されるメッセージは常に最後の引数です。labelコマンドでは複数のオプションを切り替えることができます。-xb, -yl, -xt, -yr, -zf, -zb を使用した場合は、それらが最後のオプション（ラベルメッセージの直前）である必要があります。また、-nを使用する場合は、最後のオプション（ラベルメッセージの直前）である必要があります。オプションは、それがそうすることが理にかなっているとき、そしてそれらが互いに競合しないときにのみ組み合わせることができます。

メッセージに文字列を入力することに加えて、$[OMGfileName].Section.Title を指定することもできます。これにより、メッセージファイル内の文字列タイトルにアクセスできるようになります。OMGfileName拡張子はOMGであると仮定されます。OMGfileNameが指定されていない場合は、 ORIGIN.OMG ファイルが使用されます。この構文を使用する例については、Typeコマンドを参照してください。

Note--エスケープシーケンスを使用してテキストフォーマットを制御する：

文字列内にエクスケープシーケンスを使用して、テキスト表示をカスタマイズすることができます。これらのシーケンスはバックスラッシュ文字 (\) で始まります。すべてのテキストオブジェクト（labelコマンドまたはテキストツールを使用して作成されたもの）およびラベル列からプロットされたテキストは、これらのシーケンスのルールに従って表示されます。

次のテキストフォーマットコマンドを使用できます。

\(ASCII character code)	指定したASCII記号を表示します。例： \(65); // "A"を意味する
\+(text)	テキストを上付き文字として設定します。
\-(text)	テキストを下付き文字として設定します。
\=(text1,text2)	text1を下付き文字、text2を上付き文字として書式設定します。
\ab(text)	テキストの上にバーを表示します。
\ad(text)	テキストの上にドットを表示します。
\at(text)	テキストの上にチルダを追加します。
\b(text)	テキストを太字に設定します。
\cnumber(text)	色ドロップダウンリストにある位置数で示される色でテキストを表示します。例： \c4(This is blue); // フォントの色を青に設定
\cp#(text)	現在のレイヤのインデックス付きプロットの色でテキストを表示します。 \cp2(color of 2nd plot); // 2番目のプロットの色に従うようにフォントの色を設定
\f:fontname(text)	テキストをfontnameのフォントを使用して表示します。フォント名は同定可能な範囲で略記可能です。例： \f:Times New Roman(This font is "Times New Roman");
\g(text)	テキストをギリシャ文字に設定します。例： \g(a); // アルファを表示
\h(text)	置換表記をブロックします。例： \h(\l(1) %(?Y)); // 文字列 \l(1) %(?Y)が表示される
\i(text)	テキストを斜体に設定します。
\p%pointsize(text)	テキストの大きさを%倍に変更します。200は2倍、100は大きさの変更なしです。例： \p200(Double font size);
\s(text)	テキストを打ち消します。
\sc(text)	連続する複数のスペースがある場合でも、文字列に条件付き水平スペースを1つ挿入します。例： \b(%(1Y,@LL)\sc%(1Y,@LD3)\sc%(1Y,@LD4)\sc(%(1Y,@LU)))//@LD3と@LD4が存在しないと仮定すると、スペースは2つになる\sc はスペースを1つだけ作成します。
\u(text)	テキストに下線を引きます。
\v(text)	エスケープシーケンスの解釈を上書きして、\nが新規行として認識されず、\rが改行として認識されないようにします。例： // \v() を使用しないとパスが正しく表示されない label -p 0 0 -s \v(My UFF is: %Y);

次の文字に対応していますが、一部は印刷できません。

\\	バックスラッシュ
\'	一重引用符
\"	二重引用符
\y(')	フルハイトプライム
\y(")	フルハイトダブルプライム
\+(\y('))	プライムの組み合わせ
\+(\y("))	ダブルプライムの組み合わせ
\n	新規行
\r	改行
\d	削除/バックスペース
\t	タブ
\xhh	16進数表記のASCII文字。hhは2桁の16進数です。

Note: エスケープシーケンスの中には上記の2つの表に記載されていないものもあります。詳細については、ユーザーガイドを参照してください。

オプション：

オプションなし、名前のないラベルをデフォルトの場所に配置する

構文： label message

名前のないテキストラベルメッセージを、アクティブなウィンドウのページ上のデフォルトの場所に配置します。

label test; //デフォルトの場所に"test"と表示されているラベルを追加

-a; デカルト座標の指定したポイントに新しいラベルを配置する

構文： label -a x y message

xy座標にラベルを配置します（xとyはデカルト座標値）。

label -a 10 15 test; //(10,15)に"test"と表示されているラベルを追加

-al; 2D凡例オブジェクトを複数の列に配置する

構文： label -al number of columns

label -al 3; //凡例の内容を3列に配置

legendコマンドフラグ-av と -ahも参照してください。

-b; ラベルの境界線のスタイルを設定する

構文： label -b n message

テキストオブジェクトダイアログボックスの枠の設定で、テキストラベルの境界線スタイルをn番目のスタイルに設定します。

// test2 というテキストラベルを追加し、背景は 
//2番目のスタイル "Black Line"とする
label -b 2 test2;

-d; 画面ピクセル単位で指定したポイントに新しいラベルを配置する

構文： label -d x y message

ページの左上隅から画面ピクセルで測定した座標xyにラベルを配置します。

-e; 指定したメッセージを表示してオブジェクトプロパティダイアログボックスを開く

構文： label -e message

テキストボックスにmessageが表示されたテキストオブジェクトダイアログボックスを開きます。OKをクリックして、メッセージ付きのテキストラベルを作成します。

label -e test5;

-f; ラベルのフォントタイプを変更する

構文： label -f fontName message

ラベルフォントタイプをfontNameに変更します。fontNameは名前が一意である限り省略できます。複数単語のフォント名の場合は、fontNameを引用符で囲む必要があります。

-fp; エスケープコードを削除する

構文： label -fp name

nameオブジェクトのエスケープコードを削除します。

構文： label -fpp *

レイヤ内のすべてのテキストオブジェクトのエスケープコードを削除します。

-j; ラベルメッセージテキストの位置を揃える

構文： label -j n message

ラベルメッセージテキストの位置を合わせます。nは0(左)、1(中央)、2(右)のいずれかです。軸タイトルの位置合わせは事前設定されており、変更できません。

label -j 1 test6;

-l, -lr; 接続されているすべてのグラフオブジェクトを取得する

構文： label -l graphicObject stringArray

graphicObjectに接続されているすべてのグラフィックオブジェクトを取得します。stringArrayはそれらの名前を格納するのに使われます。

StringArray sa;
// rectに接続されたすべてのオブジェクトを取得し、それらの名前をsaに保存
label -l rect sa;

構文： label -lr graphicObject stringArray

graphicObjectのすべての接続されたグラフィックオブジェクトを再帰的に取得します。stringArrayはそれらの名前を格納するのに使われます。再帰的に検索するため、graphicObject自体の名前もstringArrayに格納されます。

StringArray sa;
// rectに再帰的に接続されたすべてのオブジェクトを取得し、その名前をsaに保存
label -lr rect sa;

-n; 新しいラベルを作成する、または指定したラベルを置き換える

構文： label -n labelName message

名前付きラベルの新しいmessageを作成するか、既存のmessageを置き換えます。labelNameは、テキストオブジェクトダイアログボックスに表示されるラベルの名前を指定します。

label -n text1 aa; //text1のラベルを新規ラベルaaに置き換える

Note: -nスイッチは最後のスイッチ、つまりラベルメッセージの直前に配置する必要があります。

-o; ラベルオフセットを設定する

構文： label -o dx dy message

ラベルオフセット（パーセント単位）を設定します。このオプションは、レイヤとスケールに接続されたラベル（ラベルのテキストオブジェクトダイアログボックスの「接続先」）にのみ適用されます。

//現在のマウスの位置から10%オフセットした場所に
//"tt"というラベルを追加
label -o 10 10 tt;

-p; 距離のパーセントで指定したポイントに新しいラベルを配置する

構文： label -p x y message

xy座標にラベルを配置します（xとyはレイヤ枠の左上隅からの距離のパーセント）。

label -p 50 50 Center; //レイヤ枠の中央にラベルを追加

-px; ピクセルで指定したポイントにラベルを配置する

構文： label -px x y message

ラベルを(x,y)に配置します。ここで、xとyはグラフウィンドウの左上隅からのピクセル距離を表します。

label -px 10 20 Place Label by Pixel;

-q; n番目の四半期にラベルを配置する

構文： label -q n message

ラベルを4つのアクティブなレイヤ象限nのいずれかに配置します。象限には、右上から反時計回りに1から4までの番号が付けられています。

label -q 3 hello; //3番目の象限にラベルを追加

-r; 指定したラベルまたはグラフオブジェクトを削除する

構文： label -r labelName/objectName

必要なOriginのバージョン: Origin 8.51 SR0以降

labelNameという名前のラベルを削除します（接続されているオブジェクトは除く）。

label -r text2; //ラベルtext2を削除
label -r Rect; // アクティブなグラフページの長方形オブジェクトを削除

Note: ここでのobjectNameはワイルドカードをサポートします。例：

 label -r text*; // "text"で始まるすべてのオブジェクトを削除

-ra; ラベル名に指定された接頭辞を持つすべてのラベルを削除する

構文： label -ra labelNamePrefix

名前がlabelNamePrefixで始まるすべてのオブジェクトを削除します。labelNamePrefixが含まれていない場合、ページ上のすべてのラベルが削除されます。

label -ra text; //接頭辞"text"が付いたラベルをすべて削除

-rc; 指定されたラベルとそれに接続されているすべてのラベルを削除する

構文： label -rc labelName

labelNameという名前のグラフオブジェクトを、接続されたオブジェクトとともに削除します。

//新しいグラフウィンドウで線と長方形を描画し、
//オブジェクト名は"line"と"rect"であると仮定します。次のスクリプトを実行します。

// 線を長方形に接続
line.connect(rect, 1);
// 線を削除すると、接続されている長方形も削除される
label -rc line;

-s; 引数文字列での置換表記(%と$)の使用を有効にする

構文： label -s message

引数文字列での置換表記(%と$)の使用を有効にします。デフォルトでは、labelコマンドは %と$表記を置換しません。このオプションを使用すると、ラベルメッセージに数値変数と文字列変数を挿入できます。

// ユーザファイルフォルダのパスとして表示されるラベルを追加
// Note: ファイルパス内の "\" を正しく表示するために、
// エスケープシーケンス \v() を使用する必要がある
label -s \v(%Y);

-sa; \r\n\t表記の変換を有効にする

構文： label -sa message

\r\n\t表記の変換を有効にします。スクリプトに新しい行を追加せずに複数の行テキストラベル(\r\n)を作成するには、このオプションを使用します。置換も有効にするには、-s -saを一緒に使用します。

label -sa Hello\nHello;

このコマンドは次のように表示されるラベルを追加します。

Hello
Hello

-sl; 「変数へのリンク」チェックボックスがオンのメッセージラベルを作成する

構文： label -sl message

メッセージラベルを作成しテキストオブジェクトダイアログボックスの変数へのリンクチェックボックスをオンにします。以下の例を参照してください。

-t; メッセージ付きのラベルを作成する

構文： label -t message

メッセージ付きのラベルを作成し、オブジェクトTITLEに名前を付けます。

label -t abc; //TITLEという名前の、 "abc" と表示されるラベルを追加

-xb; 下X軸タイトルをリセットする

構文： label -xb message

新しい下X軸タイトルを作成するか、既存の下軸タイトルを置換します。

label -xb time; //下X軸のタイトルを time と設定

-xt; 上X軸タイトルをリセットする

構文： label -xt message

新しい上X軸タイトルを作成するか、既存の上X軸タイトルを置換します。

-yl; 左Y軸タイトルをリセットする

構文： label -yl message

新しい左Y軸タイトルを作成するか、既存の左Y軸タイトルを置換します。

-yr; 右Y軸タイトルをリセットする

構文： label -yr message

新しい右Y軸タイトルを作成するか、既存の右Y軸タイトルを置換します。

-zb; 後Z軸タイトルをリセットする

構文： label -zb message

新しい後Z軸タイトルを作成するか、既存の後Z軸タイトルを置換します。

-zf; 前Z軸タイトルをリセットする

構文： label -zf message

新しい前Z軸タイトルを作成するか、既存の前Z軸タイトルを置換します。

サンプル：

サンプル 1

次のスクリプトは、中央揃えで MYLABEL という名前の「New Label Text」というラベルを作成します。アクティブウィンドウのアクティブレイヤの象限3にラベルを描画します。

label -q 3 -j 2 -n MYLABEL New Label Text;

サンプル 2

次のスクリプトでは、下X軸ラベルMaximum Currentを作成します。

lab -xb (Maximum Current);

サンプル 3

次のスクリプトは、myLabelという名前のラベルの内容を実行時の値で更新します。テキストオブジェクトダイアログボックスで変数へのリンクオプションを有効にして、同じテキストでラベルを設定することもできることに注意してください（次の例を参照）。

%A = "position = $(x)";
label -s -n myLabel %A;

サンプル 4

次のスクリプトでは、テキストオブジェクトダイアログボックスの変数へのリンクチェックボックスをオンにしたmyLabelという名前のラベルが作成されます。ラベルはxシステム変数の現在の値を表示します。これは、スクリーンリーダー、データリーダー、またはデータセレクタツールの現在のX座標です。

label -sl -n mylabel "position = $(x)";

サンプル 5

このスクリプトは、グラフラベルとしてファイルパスを追加し、グラフをエクスポートした後に削除する方法を示します。。%Gと %Xは現在のファイル名とパスの文字列レジスタであり、\v()はエスケープシーケンスです。

label -s -px 20 10 -n ForPrintOnly \v(Generated from %X%G.opj);
expGraph type:=png filename:=MySampleGraph path:=D:\;
label -r ForPrintOnly;