yline

定数の y 値をもつ水平線

構文

yline(y)

yline(y,LineSpec)

yline(y,LineSpec,labels)

yline(___,Name,Value)

yline(ax,___)

yl = yline(___)

説明

yline(y) は、現在の座標軸における 1 つ以上の y 座標の位置に水平線を作成します。たとえば、yline(2) は y=2 の位置にラインを作成します。

yline(y,LineSpec) はライン スタイル、ラインの色、またはその両方を指定します。たとえば、yline([12 20 33],'--b') は 3 本の青の破線を作成します。

yline(y,LineSpec,labels) はラインにラベルを追加します。

yline(___,Name,Value) は 1 つ以上の名前と値のペアの引数を使用して、定数直線のプロパティを指定します。プロパティの一覧については、ConstantLine のプロパティ を参照してください。名前と値のペアは他のすべての入力引数の後で指定します。

yline(ax,___) は、現在の座標軸ではなく、指定された座標軸にラインを作成します。現在の座標軸を決定するには、gca を使用します。

yl = yline(___) は ConstantLine オブジェクトまたは ConstantLine オブジェクトの配列を返します。yl を使用して、ラインが作成された後にそのプロパティの変更やクエリを行います。

例

水平線の作成

y = 2.5 の位置に水平線を作成します。

yline(2.5);

ラベルの追加

ラベル付きのラインを作成するには、ライン スタイルも指定しなければなりません。既定のライン スタイルは実線 '-' です。

fplot(@(x) log(x));
xlim([0 15]);
ylim([0 4]);
yline(3,'-','Threshold');

ラベルが付いた複数のラインの作成

一連の x と y のベクトルを定義してプロットします。その後、プロットされた最大値よりも上と最小値よりも下の y 軸に余白をパディングします。

x = 0:0.1:60;
y = 4.*cos(x)./(x+2);
plot(x,y)
ylim padded

y の最大値と最小値を求めます。それらの位置に 'Max' および 'Min' というラベル付きの水平線を作成します。

ymax = max(y);
ymin = min(y);
yline([ymax ymin],'--',{'Max','Min'})

ライン スタイルと色の指定

y = 4 の位置に青い一点鎖線を作成します。

yline(4,'-.b');

ライン スタイル、太さ、およびラベルの配置の指定

ラベルと指定されたライン幅を使用して水平の破線を作成します。

x = -2:0.25:2;
[X,Y] = meshgrid(x);
Z = X.*exp(-X.^2-Y.^2);
contour(X,Y,Z,30)

yl = yline(0,'--','y = 0','LineWidth',3);

ラベルの水平方向の配置とラインの色を変更します。

yl.LabelHorizontalAlignment = 'center';
yl.Color = [.80 0 .40];

特定の座標軸にラインを追加

関数 tiledlayout を呼び出して、1 行 2 列のタイル表示チャート レイアウトを作成します。関数 nexttile を呼び出して、axes オブジェクト ax1 および ax2 を作成します。次に、各座標軸にプロットします。ax1 を関数 yline に引き渡すことで、水平線を最初のプロットに追加します。

tiledlayout(1,2)
ax1 = nexttile;
x = -pi/2:pi/60:pi/2;
y1 = tan(sin(x)) + cos(sin(x)); 
plot(ax1,x,y1)

ax2 = nexttile;
x = -pi/2:pi/60:pi/2;
y2 = tan(cos(x)) + exp(x);
plot(ax2,x,y2)

yline(ax1,1.0);

入力引数

y — y 座標

スカラー | ベクトル

y 座標。数値、categorical 値、datetime 値、または duration 値を含むスカラーまたはベクトルとして指定します。y のデータ型は y 軸のデータ型と一致しなければなりません。

例: yline(10) は y=10 の位置にラインを表示します。

例: yline([13 20 33]) は y=13、y=20、および y=33 の位置にラインを表示します。

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical | categorical | datetime | duration

LineSpec — ラインのスタイルと色

文字ベクトル | string スカラー

ラインのスタイルと色。文字と記号を含む文字ベクトルまたは string スカラーとして指定します。文字と記号の順番は任意です。ライン スタイル、ラインの色、またはその両方を指定できます。'o' などのマーカー記号は無視されます。

例: '--g' は緑色の破線です。

ライン スタイル	説明	結果として得られる線
"-"	実線
"--"	破線
":"	点線
"-."	一点鎖線

色名	省略名	外観
'red'	'r'
'green'	'g'
'blue'	'b'
'cyan'	'c'
'magenta'	'm'
'yellow'	'y'
'black'	'k'
'white'	'w'

ax — ターゲット座標軸

現在の座標軸 (既定値) | Axes オブジェクト

ターゲット座標軸。Axes オブジェクトとして指定します。yline によって現在の座標軸以外の座標軸にプロットする場合は、この引数を使用します。

labels — ライン ラベル

'' (既定値) | 文字ベクトル | string スカラー | 文字ベクトルの cell 配列 | string 配列

ライン ラベル。文字ベクトル、文字ベクトルの cell 配列、string 配列、または数値配列として指定します。複数行のラベルを作成するには、string 配列、または文字ベクトルの cell 配列を使用します。

1 本のラインのラベルを作成

1 行のテキストを表示するには、文字ベクトルまたは string スカラーを指定します。複数行のテキストを表示するには、文字ベクトルの cell 配列または string 配列を指定します。

表示	labels の指定方法	例
1 行のテキスト	文字ベクトルまたは string スカラーを指定します。	yline(12,'-','Sample')
複数行のテキスト	文字ベクトルの cell 配列または string 配列を指定します。配列の各要素は、テキストの各行です。	yline(12,'-',{'Sample','x=12'})

複数のラインのラベルを作成

すべてのラインの横に同じテキストを表示するには、文字ベクトルまたは string スカラーを指定します。ラインごとに異なるテキストを表示するには、文字ベクトルの cell 配列または string 配列を指定します。

表示	labels の指定方法	例
1 つの共有のテキスト ラベル	文字ベクトルまたは string スカラーを指定します。	yline([13 20 33],'-','Sample')
ラインごとに異なるラベル	文字ベクトルの cell 配列または string 配列を指定します。配列の各要素は、それぞれのラインのラベルです。labels 配列の要素の数は x の長さと一致しなければなりません。	label = {'Sample 1','Sample 2','Sample 3'}; yline([13 20 33],'-',label)
一部が複数行の異なるラベル	文字ベクトルの cell 配列または string 配列を作成します。関数 sprintf を使用してテキストに改行文字 ('\n') を挿入します。	label = {'Sample 1',sprintf('Sample 2\nx=20'),'Sample 3'}; yline([13 20 33],'-',label)

名前と値の引数

引数のオプションのペアを Name1=Value1,...,NameN=ValueN として指定します。ここで Name は引数名で、Value は対応する値です。名前と値の引数は他の引数の後になければなりませんが、ペアの順序は重要ではありません。

R2021a より前では、コンマを使用してそれぞれの名前と値を区切り、Name を引用符で囲みます。

例: yline(3,':','Median Price','LabelHorizontalAlignment','center') は、ラベルの水平方向の配置を 'center' として指定します。

メモ

ここでは、プロパティの一部だけを紹介しています。完全な一覧については、ConstantLine のプロパティ を参照してください。

Color — ラインの色

[0.15 0.15 0.15] (既定値) | RGB 3 成分 | 16 進数カラー コード | 'r' | 'g' | 'b' | ...

ラインの色。RGB 3 成分、16 進数カラー コード、色名、または省略名として指定します。

カスタム色を使用する場合は、RGB 3 成分または 16 進数カラー コードを指定します。

• RGB 3 成分は、色の赤、緑、青成分の強度を指定する 3 成分の行ベクトルです。強度値は [0,1] の範囲でなければなりません。たとえば [0.4 0.6 0.7] のようになります。

• 16 進数カラー コードは、ハッシュ記号 (#) で始まり、3 桁または 6 桁の 0 から F までの範囲の 16 進数が続く string スカラーまたは文字ベクトルです。この値は大文字と小文字を区別しません。したがって、カラー コード "#FF8800"、"#ff8800"、"#F80"、および "#f80" は等価です。

あるいは、名前を使用して一部の一般的な色を指定できます。次の表に、名前の付いた色オプション、等価の RGB 3 成分、および 16 進数カラー コードを示します。

色名	省略名	RGB 3 成分	16 進数カラー コード	外観
"red"	"r"	[1 0 0]	"#FF0000"
"green"	"g"	[0 1 0]	"#00FF00"
"blue"	"b"	[0 0 1]	"#0000FF"
"cyan"	"c"	[0 1 1]	"#00FFFF"
"magenta"	"m"	[1 0 1]	"#FF00FF"
"yellow"	"y"	[1 1 0]	"#FFFF00"
"black"	"k"	[0 0 0]	"#000000"
"white"	"w"	[1 1 1]	"#FFFFFF"
"none"	該当なし	該当なし	該当なし	色なし

MATLAB^® の多くのタイプのプロットで使用されている既定の色の RGB 3 成分および 16 進数カラー コードを次に示します。

RGB 3 成分	16 進数カラー コード	外観
[0 0.4470 0.7410]	"#0072BD"
[0.8500 0.3250 0.0980]	"#D95319"
[0.9290 0.6940 0.1250]	"#EDB120"
[0.4940 0.1840 0.5560]	"#7E2F8E"
[0.4660 0.6740 0.1880]	"#77AC30"
[0.3010 0.7450 0.9330]	"#4DBEEE"
[0.6350 0.0780 0.1840]	"#A2142F"

例: 'g'

例: [0.6 0.2 0.5]

例: '#D2F9A7'

LineWidth — ライン幅

0.5 (既定値) | 正の値

ライン幅。ポイント単位の正の値として指定します。

DisplayName — 凡例ラベル

'' (既定値) | 文字ベクトル | string スカラー

凡例ラベル。文字ベクトルまたは string スカラーとして指定します。legend コマンドを呼び出すまで、凡例は表示されません。テキストを指定しない場合、legend は 'dataN' 形式を使用してラベルを設定します。

LabelHorizontalAlignment — ラベルの水平方向の配置

'right' (既定値) | 'left' | 'center'

ラインに対するラベルの水平方向の配置。次の表のいずれかのオプションとして指定します。

オプション	説明	例
'right'	ラインの右側
'left'	ラインの左側
'center'	ラインの中心

LabelVerticalAlignment — ラベルの垂直方向の配置

'top' (既定値) | 'middle' | 'bottom'

ラインに対するラベルの垂直方向の配置。次の表のいずれかのオプションとして指定します。

オプション	説明	例
'top'	ラインの上方。
'middle'	ラインの中央。ラベルによってラインは分割されます。
'bottom'	ラインの下方。

LabelOrientation — ラベルの向き

'aligned' (既定値) | 'horizontal'

ラベルの向き。'aligned' または 'horizontal' として指定します。例を表に示します。

向き	説明	例
'aligned'	ラベルの向きは指定されたラインの向きと同じです。
'horizontal'	ラインの向きに関係なく、ラベルは水平です。

アルゴリズム

座標軸の 3 次元表示で、定数直線は z 軸の範囲の中点に位置する x-y 平面に表示されます。座標軸が回転すると、それに従って定数直線も回転します。

バージョン履歴

R2018b で導入

参考

関数

• xline | yregion | xregion

プロパティ

• ConstantLine のプロパティ