dataTipTextRow

データヒントに行を追加

R2019a 以降

説明

特定のラベル、値のソース、および値の形式をもつ新しいデータヒント行を作成するには、関数 dataTipTextRow を使用します。新しいデータヒント行は、その作成後、プロットされるオブジェクトの DataTipTemplate プロパティに追加しなければなりません。

作成

構文

r = dataTipTextRow(label,value)

r = dataTipTextRow(label,value,format)

説明

例

r = dataTipTextRow(label,value) は、指定されたラベルと値のソースを使用する、新しいデータヒント行を作成します。

r = dataTipTextRow(label,value,format) は、表示される値の形式を追加指定します。

プロパティ

すべて展開する

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

ラベル。文字ベクトルまたは string スカラーとして指定します。

例: 'My Label'

`Value` — 値のソース
文字ベクトル | string スカラー | ベクトル | 関数ハンドル

値のソース。データプロパティの名前 ('XData' など)、ワークスペース名、または table 変数名を含む文字ベクトルもしくは string スカラーとして、あるいはベクトルまたは関数ハンドルとして指定します。ソース値の数はデータ点の数と一致しなければなりません。

例: 'XData' は、プロットされるオブジェクトの XData プロパティとして値のソースを指定します。

例: [1 2 3 4 5] は、ベクトルとして値のソースを指定します。

例: @(x)sin(x) は関数ハンドルを指定します。x はオブジェクトの XData 値です。

例: @(x,y)sin(y) は関数ハンドルを指定します。y はオブジェクトの YData 値です。

`Format` — 値の形式
`'auto'` (既定値) | 文字ベクトル | string スカラー

値の形式。'auto' として、あるいは数値、datetime、または duration の形式をもつ文字ベクトルまたは string スカラーとして指定します。指定する形式の型は、Value プロパティの値の型と一致しなければなりません。

例: r = dataTipTextRow(label,value,'usd') は、事前定義された米国ドルの数値形式を指定します。

例: r = dataTipTextRow(label,value,'%#4.4g') は数値形式を指定します。

例: r = dataTipTextRow(label,value,'yyyy-MM-dd') は datetime 形式を指定します。

例: r = dataTipTextRow(label,value,'hh:mm:ss') は duration 形式を指定します。

数値形式

次の表にリストされている事前定義された形式のいずれかを指定できます。あるいは、カスタム数値形式を指定できます。

事前定義された形式	説明
`'usd'`	米国ドル。このオプションは、`'$%,.2f'` を使用するのと同等です。ラベルが科学表記を使用する場合、このオプションは指数値を 0 に設定します。
`'eur'`	ユーロ。このオプションは、指数値 0 で `'\x20AC%,.2f'` を使用するのと同等です。
`'gbp'`	英国ポンド。このオプションは、指数値 0 で `'\x00A3%,.2f'` を使用するのと同等です。
`'jpy'`	日本円。このオプションは、指数値 0 で `'\x00A5%,d'` を使用するのと同等です。
`'degrees'`	値の後に度記号を表示します。このオプションは、既定の指数値で `'%g\x00B0'` を使用するのと同等です。
`'percentage'`	値の後にパーセント記号を表示します。このオプションは、既定の指数値で `'%g%%'` を使用するのと同等です。
`'auto'`	既定の指数値を使用した `'%g'` の既定の形式です。

上記の表で示されたいずれの形式も必要な形式と合致しない場合は、識別子をもつカスタムの文字ベクトルまたは string を作成します。

Sample custom character vector with required and optional identifiers

パーセント記号と変換文字を除き、識別子の指定はオプションです。次の順序で形式を作成します。

パーセント符号
1 つ以上のフラグ — 正の値の前にプラス記号を付けるなどのオプション。オプションの完全なリストは、オプションのフラグの表を参照してください。
フィールド幅 — 目盛りラベルに出力する文字の最小数。フィールド幅は整数値として指定します。目盛り値の有効桁数がフィールド幅より小さい場合、ラベルは空白でパディングされます。
精度 — 変換文字に応じた、小数点以下の桁数または有効桁数。精度は整数値として指定します。
変換文字 — 値のタイプ。オプションの完全なリストは、変換文字の表を参照してください。データに適さない変換を指定すると、MATLAB^® は指定した変換をオーバーライドし、%e を使用します。

また、形式の先頭または末尾にリテラルテキストを指定できます。一重引用符を出力するには、'' を使用します。パーセント記号を出力するには、%% を使用します。

'$%.2f' — 各値の前にドル記号を表示し、小数点以下 2 桁の固定小数点表記を使用します。
'%.3f Million' — 各値の後に Million を表示し、小数点以下 3 桁の固定小数点表記を使用します。

オプションのフラグ	説明	数値形式の例
`+`	`'+100'` のように、正の値に符号文字 (+) を出力します。	`'%+4.4g'`
`0`	`'0100'` のように、先頭に空白の代わりにゼロを付けてフィールド幅をパディングします。	`'%04.4g'`
`–`	左揃え。値の先頭ではなく末尾を空白でパディングします。たとえば、フィールド幅が `4` の場合、このフラグはラベルを `' 100'` ではなく `'100 '` に書式設定します。	`'%-4.4g'`
`#`	`%f`、`%e` および `%g` の各変換文字の場合は、`'100.'` のように、精度が 0 であっても小数点が出力されます。`%g` の場合、後続のゼロは削除しません。	`'%#4.4g'`

変換文字	説明	例
`d` または `i`	基数 10 の符号付き整数。精度値は有効桁数を示します。	`'%.4d'` は、π を `0003` として表示します。
`f`	固定小数点表記。精度値は小数点以下の桁数を示します。	`'%.4f'` は、π を `3.1416` として表示します。
`e`	指数表現。精度値は小数点以下の桁数を示します。	`'%.4e'` は、π を `3.1416x10⁰` として表示します。
`g`	`e` または `f` のいずれかコンパクトな方のバージョン。後続のゼロは除きます。精度値は小数点以下の最大桁数を示します。	`'%.4g'` は、π を `3.1416` として表示します。

datetime の形式

次の表に、いくつかの一般的な形式と、ニューヨーク市の 2014 年 4 月 19 日 (土) 9:41:06.12345 PM の書式設定された入力の例を示します。

`Format` の値	例
`'yyyy-MM-dd'`	`2014-04-19`
`'dd/MM/yyyy'`	`19/04/2014`
`'dd.MM.yyyy'`	`19.04.2014`
`'yyyy年 MM月 dd日'`	`2014年 04月 19日`
`'MMMM d, yyyy'`	`4 月 19, 2014`
`'eeee, MMMM d, yyyy h:mm a'`	`土曜日, 4 月 19, 2014 9:41 午後`
`'MMMM d, yyyy HH:mm:ss Z'`	`4 月 19, 2014 21:41:06 -0400`
`'yyyy-MM-dd''T''HH:mmXXX'`	`2014-04-19T21:41-04:00`

次の表に、datetime 形式の作成に使用できる文字識別子を示します。フィールドを区切るには、ハイフン、スペース、コロンなどのアルファベット以外の文字、または任意の非 ASCII 文字を使用します。識別子は、Unicode^® ロケールデータマークアップ言語 (LDML) の標準の日付表記に対応します。

表の識別子を使用して、日付と時刻のフィールドの表示形式を指定します。

文字識別子	説明	表示
`G`	紀元	`CE`
`y`	先頭に 0 を付けない表記の年。この表の後のメモを参照してください。	`2014`
`yy`	下 2 桁表記の年。この表の後のメモを参照してください。	`14`
`yyy`, `yyyy` ...	`'y'` の数に対応する桁数以上で表記した年	2014 年の場合、`'yyy'` では `2014` と表示され、`'yyyyy'` では `02014` と表示されます。
`u`, `uu`, ...	ISO 年。年を単一の数値で表したものです。ISO 年では、紀元後の年が正の値、紀元前の年が負の値で表され、紀元前 1 年が 0 年になります。	`2014`
`Q`	1 桁表記の四半期	`2`
`QQ`	2 桁表記の四半期	`02`
`QQQ`	省略形で表記した四半期	`Q2`
`QQQQ`	完全名で表記した四半期	`第2四半期`
`M`	1 桁または 2 桁の数値で表記した月	`4`
`MM`	2 桁の数値で表記した月	`04`
`MMM`	短縮名で表記した月	`4月`
`MMMM`	完全名で表記した月	`4月`
`MMMMM`	大文字の頭文字で表記した月	`A`
`W`	月間通算週	`1`
`d`	1 桁または 2 桁表記の月間通算日	`5`
`dd`	2 桁表記の月間通算日	`05`
`D`	1 ～ 3 桁表記の年間通算日	`95`
`DD`	2 桁表記の年間通算日	`95`
`DDD`	3 桁表記の年間通算日	`095`
`e`	1 桁または 2 桁の数値で表記した曜日	`7` (週の始まりは日曜日)
`ee`	2 桁の数値で表記した曜日	`07`
`eee`	短縮名で表記した曜日	`土`
`eeee`	完全名で表記した曜日	`土曜日`
`eeeee`	先頭文字で表記した曜日	`土`
`a`	午前と午後の区分	`午後`
`h`	1 桁または 2 桁表記の 12 時間制の時間	`9`
`hh`	2 桁表記の 12 時間制の時間	`09`
`H`	1 桁または 2 桁表記の 24 時間制の時間	`21`
`HH`	2 桁表記の 24 時間制の時間	`21`
`m`	1 桁または 2 桁表記の分	`41`
`mm`	2 桁表記の分	`41`
`s`	1 桁または 2 桁表記の秒	`6`
`ss`	2 桁表記の秒	`06`
`S`, `SS`, ..., `SSSSSSSSS`	`'S'` の数に対応する桁数で表記した秒の小数部 (最大 9 桁)	`'SSS'` の場合、6.12345 秒は `123` までに切り捨てられます。

ヒントと考慮事項:

2 桁の年番号を読み取る場合に形式を y または yy として指定すると、その年の世紀はピボット年に基づいて判別されます。
ゼロに近い年番号を扱うときは、文字 y の代わりに文字 u を 1 文字以上使用します。
紀元後 144683 年より後または紀元前 140743 年より前の datetime 値については、指定した形式の値に関係なく、年番号のみが表示されます。

次の表の識別子を使用して、タイムゾーンオフセットの表示形式を指定します。タイムゾーンオフセットは、特定の日付および時刻と UTC との時差です。これは、1 年の特定時期のオフセットを定義するルールを構成するタイムゾーンとは異なります。時刻の成分が必ず明確に表示されるようにする場合は、タイムゾーンオフセットの識別子を含めます。

文字識別子	説明	表示
`z`	タイムゾーンオフセットの省略名。この値が指定されていない場合、タイムゾーンオフセットには `UTC-4` などの短い UTC 形式が使用されます。	`EDT`
`Z`	ISO 8601 基本形式。時、分、秒 (オプション) の各フィールドがあります。	`-0400`
`ZZZZ`	長い UTC 形式。	`UTC-04:00`
`ZZZZZ`	ISO 8601 拡張形式。時、分、秒 (オプション) の各フィールドがあります。ISO 8601 UTC 指定子 "Z" として 0 の時間オフセットが表示されます。	`-04:00`
`x` または `X`	ISO 8601 基本形式。時、分 (オプション) の各フィールドがあります。`X` を指定すると、ISO 8601 UTC 指定子 "Z" として 0 の時間オフセットが表示されます。	`-04`
`xx` または `XX`	ISO 8601 基本形式。時、分の各フィールドがあります。`XX` を指定すると、ISO 8601 UTC 指定子 "Z" として 0 の時間オフセットが表示されます。	`-0400`
`xxx` または `XXX`	ISO 8601 拡張形式。時、分の各フィールドがあります。`XXX` を指定すると、ISO 8601 UTC 指定子 "Z" として 0 の時間オフセットが表示されます。	`-04:00`
`xxxx` または `XXXX`	ISO 8601 基本形式。時、分、秒 (オプション) の各フィールドがあります。`XXXX` を指定すると、ISO 8601 UTC 指定子 "Z" として 0 の時間オフセットが表示されます。	`-0400`
`xxxxx` または `XXXXX`	ISO 8601 拡張形式。時、分、秒 (オプション) の各フィールドがあります。`XXXXX` を指定すると、ISO 8601 UTC 指定子 "Z" として 0 の時間オフセットが表示されます。	`-04:00`

duration の形式

duration の形式は、時間単位を伴う単一の数値 ('0.5 yrs' など)、またはデジタルタイマー (時間、分、秒を表す 'hh:mm:ss' など) のいずれかにすることができます。

時間単位を伴う数値には、次のいずれかを指定します。

'y' — 固定長の年数。ここで、1 年は 365.2425 日に等しい
'd' — 固定長の日数。ここで、1 日は 24 時間に等しい
'h' — 時間数
'm' — 分数
's' — 秒数

デジタルタイマー形式には、次のいずれかを指定します。

'dd:hh:mm:ss'
'hh:mm:ss'
'mm:ss'
'hh:mm'
最初の 3 つの形式のいずれかに、秒の小数部を表す文字 S (最大 9 桁) を加えた 'hh:mm:ss.SSSS' のような形式

例

すべて折りたたむ

データヒントに行を追加

ライブスクリプトを開く

サンプルの事故データを読み込んで散布図を作成します。次に、既定のデータヒントに 3 行目を追加します。ラベルには、State を使用します。値のソースには、ワークスペース変数 statelabel を使用します。作成した新しい行を、Scatter オブジェクトの DataTipTemplate プロパティに追加します。

load('accidents.mat','hwydata','statelabel')
s = scatter(hwydata(:,5),hwydata(:,4));
row = dataTipTextRow('State',statelabel);
s.DataTipTemplate.DataTipRows(end+1) = row;

対話的に、または関数 datatip を使用してデータヒントを作成します。

dt = datatip(s,11246.7,1493);

Figure contains an axes object. The axes object contains an object of type scatter.

表示される値の形式を変更

ライブスクリプトを開く

正弦値のラインプロットを作成します。既定のデータヒントに、余弦値を表示する 3 行目を追加します。表示される余弦値の数値形式を指定します。この例では、'%+4.4g' を使用して正の値の符号文字 (+) を含めます。作成した新しい行を、Line オブジェクトの DataTipTemplate プロパティに追加します。

x = linspace(0,10);
y1 = sin(x);
y2 = cos(x);
p = plot(x,y1);
row = dataTipTextRow('Cosine',y2,'%+4.4g');
p.DataTipTemplate.DataTipRows(end+1) = row;

対話的に、または関数 datatip を使用してデータヒントを作成します。

dt = datatip(p,6.56566,0.27873);

Figure contains an axes object. The axes object contains an object of type line.

バージョン履歴

R2019a で導入

参考

datatip | DataTipTemplate のプロパティ

トピック

カスタムデータヒントの作成

dataTipTextRow

説明

作成

構文

説明

プロパティ

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

Value — 値のソース 文字ベクトル | string スカラー | ベクトル | 関数ハンドル

Format — 値の形式 'auto' (既定値) | 文字ベクトル | string スカラー

数値形式

datetime の形式

duration の形式

例

データ ヒントに行を追加

表示される値の形式を変更

バージョン履歴

参考

トピック

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

`Value` — 値のソース
文字ベクトル | string スカラー | ベクトル | 関数ハンドル

`Format` — 値の形式
`'auto'` (既定値) | 文字ベクトル | string スカラー

データヒントに行を追加