Text のプロパティ
プロットのグリッドにおけるテキストの外観と動作
Text
プロパティは、サブプロットのグリッドにタイトルを付けるために使用される Text
オブジェクトの外観と動作を制御します。プロパティの値を変更することによって、テキストの特定の要素を変更できます。以下に例を示します。
t = sgtitle('Title Text') t.FontSize = 14;
テキスト
String
— 表示するテキスト
''
(既定値) | 文字ベクトル | 文字ベクトルの cell 配列 | string 配列 | categorical 配列 | 数値
表示するテキスト。文字ベクトル、文字ベクトルの cell 配列、string 配列、categorical 配列、または数値として指定します。
例: 'my label'
例: {'first line','second line'}
例: string('my label')
例: 123
テキストに数値変数を含めるには、関数 num2str
を使用します。以下に例を示します。
x = 42;
txt = ['The value is ',num2str(x)];
上付き文字、下付き文字、ギリシャ文字、数学記号などの特殊文字を含めるには、TeX マークアップを使用します。サポートされるマークアップの一覧については、Interpreter
プロパティを参照してください。
複数行のテキストを作成する方法は次のとおりです。
cell 配列を使用して、
{'first line','second line'}
のように、各セルにテキストを 1 行ずつ含めます。string 配列を使用して、
string({'line one','line two'})
のように、各要素にテキストを 1 行ずつ含めます。文字配列を使用して、
['abc'; 'ab ']
のように、各行に同じ数の文字を含めます。sprintf
を使用して、sprintf('first line \n second line')
のように、改行文字を含むテキストを作成します。このプロパティは、改行文字を含むテキストを cell 配列に変換します。
数値のみを含むテキストは、sprintf('%g',value)
を使用して変換されます。たとえば、12345678
は 1.23457e+07
として表示されます。
このプロパティを categorical 配列として指定した場合、MATLAB® はカテゴリではなく、配列内の値を使用します。
Color
— テキストの色
[0 0 0]
(既定値) | RGB 3 成分 | 16 進数カラー コード | 'r'
| 'g'
| 'b'
| ...
テキストの色。RGB 3 成分、16 進数カラー コード、色名、または省略名として指定します。既定値 [0 0 0]
は、黒に相当します。
カスタム色を使用する場合は、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" |
例: 'blue'
例: [0 0 1]
例: '#0000FF'
Interpreter
— テキスト インタープリター
'tex'
(既定値) | 'latex'
| 'none'
テキスト インタープリター。次の値のいずれかとして指定します。
'tex'
— TeX マークアップのサブセットを使用して文字を解釈します。'latex'
— LaTeX マークアップを使用して文字を解釈します。'none'
— リテラル文字を表示します。
TeX マークアップ
MATLAB では、既定で TeX マークアップのサブセットをサポートしています。TeX マークアップを使用して、上付き文字や下付き文字の追加、フォントのタイプや色の変更、テキストへの特殊文字の挿入を行うことができます。
修飾子の効果はテキストの末尾まで適用されます。上付き文字と下付き文字は例外であり、次の 1 文字または中かっこで囲まれた文字にのみ適用されます。インタープリターを 'tex'
に設定した場合にサポートされる修飾子は次のとおりです。
修飾子 | 説明 | 例 |
---|---|---|
^{ } | 上付き文字 | 'text^{superscript}' |
_{ } | 下付き文字 | 'text_{subscript}' |
\bf | 太字フォント | '\bf text' |
\it | イタリック フォント | '\it text' |
\sl | 斜体フォント (通常はイタリック フォントと同じ) | '\sl text' |
\rm | 標準フォント | '\rm text' |
\fontname{ | フォント名 — をフォント ファミリの名前に置き換えます。これは他の修飾子と組み合わせて使用できます。 | '\fontname{Courier} text' |
\fontsize{ | フォント サイズ — をポイント単位の数値スカラーに置き換えます。 | '\fontsize{15} text' |
\color{ | フォントの色 — を、red 、green 、yellow 、magenta 、blue 、black 、white 、gray 、darkGreen 、orange 、lightBlue の色のいずれかに置き換えます。 | '\color{magenta} text' |
\color[rgb]{specifier} | フォントのカスタムの色 — を RGB 3 成分に置き換えます。 | '\color[rgb]{0,0.5,0.5} text' |
次の表に、'tex'
インタープリターでサポートされる特殊文字を示します。
文字列 | 記号 | 文字列 | 記号 | 文字列 | 記号 |
---|---|---|---|---|---|
| α |
| υ |
| ~ |
| ∠ |
| ϕ |
| ≤ |
|
|
| χ |
| ∞ |
| β |
| ψ |
| ♣ |
| γ |
| ω |
| ♦ |
| δ |
| Γ |
| ♥ |
| ϵ |
| Δ |
| ♠ |
| ζ |
| Θ |
| ↔ |
| η |
| Λ |
| ← |
| θ |
| Ξ |
| ⇐ |
| ϑ |
| Π |
| ↑ |
| ι |
| Σ |
| → |
| κ |
| ϒ |
| ⇒ |
| λ |
| Φ |
| ↓ |
| µ |
| Ψ |
| º |
| ν |
| Ω |
| ± |
| ξ |
| ∀ |
| ≥ |
| π |
| ∃ |
| ∝ |
| ρ |
| ∍ |
| ∂ |
| σ |
| ≅ |
| • |
| ς |
| ≈ |
| ÷ |
| τ |
| ℜ |
| ≠ |
| ≡ |
| ⊕ |
| ℵ |
| ℑ |
| ∪ |
| ℘ |
| ⊗ |
| ⊆ |
| ∅ |
| ∩ |
| ∈ |
| ⊇ |
| ⊃ |
| ⌈ |
| ⊂ |
| ∫ |
| · |
| ο |
| ⌋ |
| ¬ |
| ∇ |
| ⌊ |
| x |
| ... |
| ⊥ |
| √ |
| ´ |
| ∧ |
| ϖ |
| ∅ |
| ⌉ |
| 〉 |
| | |
| ∨ |
| 〈 |
| © |
LaTeX マークアップ
LaTeX マークアップを使用するには、インタープリターを 'latex'
に設定します。インライン モードでは、マークアップを 1 つのドル記号 ($
) で囲みます。表示モードでは、マークアップを 2 つのドル記号 ($$
) で囲みます。
LaTeX モード | 例 | 結果 |
---|---|---|
インライン |
'$\int_1^{20} x^2 dx$' |
|
表示 |
'$$\int_1^{20} x^2 dx$$' |
|
テキストは LaTeX の既定のフォント スタイルで表示され、FontName
、FontWeight
、FontAngle
のプロパティは無視されます。フォント スタイルを変更するには、LaTeX マークアップを使用します。
LaTeX インタープリターで使用できるテキストの最大サイズは 1200 文字です。複数行のテキストの場合は、さらに 1 行につき 10 文字ほど文字数が少なくなります。
TeX および LaTeX の使用例については、チャートのテキスト内のギリシャ文字と特殊文字を参照してください。LaTeX システムの詳細については、LaTeX プロジェクトの Web サイト (https://www.latex-project.org/) を参照してください。
HorizontalAlignment
— 水平方向の配置
'center'
(既定値) | 'left'
| 'right'
テキスト ボックス内におけるテキストの水平方向の配置。'center'
、'left'
、または 'right'
として指定します。
フォント
FontName
— フォント名
サポートされているフォント名 | "FixedWidth"
フォント名。サポートされているフォント名または "FixedWidth"
として指定します。テキストを正しく表示し印刷するには、システムでサポートされているフォントを選択しなければなりません。既定のフォントは、オペレーティング システムとロケールによって異なります。
どのロケールでもテキストが整って見える固定幅のフォントを使用するには、"FixedWidth"
を使用します。固定幅フォントは、ルートの FixedWidthFontName
プロパティによって決まります。ルートの FixedWidthFontName
プロパティを設定すると、表示内容が新しいフォントを使用して直ちに更新されます。
FontSize
— フォント サイズ
ゼロより大きいスカラー値
フォント サイズ。ポイント単位のゼロより大きいスカラー値として指定します。既定のフォント サイズは、特定のオペレーティング システムとロケールによって異なります。1 ポイントは 1/72
インチです。フォントの単位を変更するには、FontUnits
プロパティを使用します。
例: 12
データ型: single
| double
| int8
| int16
| int32
| int64
| uint8
| uint16
| uint32
| uint64
FontSizeMode
— フォント サイズの選択モード
'auto'
(既定値) | 'manual'
フォント サイズの選択モード。'auto'
または 'manual'
のいずれかとして指定します。
FontWeight
— 文字の太さ
'normal'
(既定値) | 'bold'
文字の太さ。'normal'
または 'bold'
として指定します。
MATLAB ではフォントは、FontWeight
プロパティを使用して、ユーザーのシステムで使用可能なフォントから選択します。すべてのフォントに太字があるとは限りません。そのため、太字フォントを指定しても標準フォントの太さと変わらない場合があります。
FontAngle
— 文字の傾斜
'normal'
(既定値) | 'italic'
文字の傾斜。'normal'
または 'italic'
として指定します。
すべてのフォントに両方のフォント スタイルがあるとは限りません。そのため、イタリック フォントを指定しても標準フォントと変わらない場合があります。
FontUnits
— フォント サイズの単位
'points'
(既定値) | 'inches'
| 'centimeters'
| 'normalized'
| 'pixels'
フォント サイズの単位。次の表のいずれかの値を指定します。
Units | 説明 |
---|---|
'points' | ポイント。1 ポイントは 1/72 インチです。 |
'inches' | インチ。 |
'centimeters' | センチメートル。 |
'normalized' | フォント サイズを座標軸のプロット ボックスの高さに対する割合として解釈します。座標軸のサイズを変更すると、それに合わせてフォント サイズが変更されます。たとえば、FontSize が正規化された単位の 0.1 である場合、テキストはプロット ボックスの高さの 1/10 になります。 |
'pixels' | ピクセル。 R2015b 以降、Windows® および Macintosh システムにおいて、ピクセル単位の距離はシステム解像度に依存しません。
Linux® システムでは、ピクセルのサイズは使用しているシステムの解像度によって決まります。 |
1 回の関数呼び出しでフォント サイズとフォントの単位の両方を設定する場合は、指定したフォント サイズが正しく解釈されるように、先に FontUnits
プロパティを設定しなければなりません。
テキスト ボックス
EdgeColor
— ボックスの外枠の色
'none'
(既定値) | 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" |
例: 'blue'
例: [0 0 1]
例: '#0000FF'
BackgroundColor
— テキスト ボックスの背景色
'none'
(既定値) | 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" |
例: 'blue'
例: [0 0 1]
例: '#0000FF'
LineStyle
— ボックスの外枠のライン スタイル
'-'
(既定値) | '--'
| ':'
| '-.'
| 'none'
ボックスの外枠のライン スタイル。次の表のいずれかのオプションを指定します。
ライン スタイル | 説明 | 結果として得られる線 |
---|---|---|
"-" | 実線 |
|
"--" | 破線 |
|
":" | 点線 |
|
"-." | 一点鎖線 |
|
"none" | ラインなし | ラインなし |
LineWidth
— ボックスの外枠の幅
0.5
(既定値) | スカラー数値
ボックスの外枠の幅。ポイント単位のスカラー数値として指定します。1 ポイントは 1/72 インチです。
例: 1.5
データ型: single
| double
| int8
| int16
| int32
| int64
| uint8
| uint16
| uint32
| uint64
Margin
— テキスト ボックス内のテキスト周囲の余白
3
(既定値) | スカラー数値
テキスト ボックス内のテキスト周囲の余白。ポイント単位のスカラー数値として指定します。
MATLAB は、Extent
プロパティ値に Margin
プロパティ値を加えた値を使用してテキスト ボックスのサイズを決定します。
例: 8
データ型: single
| double
| int8
| int16
| int32
| int64
| uint8
| uint16
| uint32
| uint64
対話機能
Visible
— 可視性の状態
"on"
(既定値) | on/off logical 値
可視性の状態。"on"
または "off"
、もしくは数値または logical 1
(true
) または 0
(false
) として指定します。"on"
の値は true
と等価であり、"off"
は false
と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState
型の on/off logical 値として格納されます。
"on"
— オブジェクトを表示します。"off"
— オブジェクトを削除せずに非表示にします。非表示のオブジェクトのプロパティには引き続きアクセスできます。
ContextMenu
— コンテキスト メニュー
空の GraphicsPlaceholder
配列 (既定値) | ContextMenu
オブジェクト
コンテキスト メニュー。ContextMenu
オブジェクトとして指定します。このプロパティは、オブジェクトを右クリックしたときにコンテキスト メニューを表示するために使用します。関数 uicontextmenu
を使用して、コンテキスト メニューを作成します。
メモ
PickableParts
プロパティが 'none'
に設定されている場合または HitTest
プロパティが 'off'
に設定されている場合には、このコンテキスト メニューは表示されません。
Selected
— 選択状態
'off'
(既定値) | on/off logical 値
選択状態。'on'
または 'off'
、もしくは数値または logical 1
(true
) または 0
(false
) として指定します。'on'
の値は true と等価であり、'off'
は false
と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState
型の on/off logical 値として格納されます。
'on'
— 選択されています。プロット編集モードでオブジェクトをクリックした場合、MATLAB はSelected
プロパティを'on'
に設定します。SelectionHighlight
プロパティも'on'
に設定されている場合、MATLAB はオブジェクトの周囲に選択ハンドルを表示します。'off'
— 選択されていません。
SelectionHighlight
— 選択ハンドルの表示
'on'
(既定値) | on/off logical 値
選択時の選択ハンドルの表示。'on'
または 'off'
、もしくは数値または logical 1
(true
) または 0
(false
) として指定します。'on'
の値は true と等価であり、'off'
は false
と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState
型の on/off logical 値として格納されます。
'on'
—Selected
プロパティが'on'
に設定されているときに選択ハンドルを表示します。'off'
—Selected
プロパティが'on'
に設定されている場合でも選択ハンドルを表示しません。
コールバック
ButtonDownFcn
— マウスクリック コールバック
''
(既定値) | 関数ハンドル | cell 配列 | 文字ベクトル
マウスクリック コールバック。次の値のいずれかとして指定します。
関数ハンドル
関数ハンドルと追加の引数を含む cell 配列
ベース ワークスペース内で評価される有効な MATLAB コマンドまたは MATLAB 関数の文字ベクトル (非推奨)
このプロパティは、オブジェクトをクリックしたときにコードを実行するために使用します。関数ハンドルを使用してこのプロパティを指定した場合、MATLAB はコールバックを実行するときに次の 2 つの引数をコールバック関数に渡します。
クリックしたオブジェクト — コールバック関数内から、クリックしたオブジェクトのプロパティにアクセスします。
イベント データ — 空の引数です。この引数が使用されないことを示すために、関数定義の中でこの引数をチルダ文字 (
~
) に置換します。
関数ハンドルを使用してコールバック関数を定義する方法についての詳細は、グラフィックス オブジェクトのコールバックの作成を参照してください。
メモ
PickableParts
プロパティが 'none'
に設定されている場合または HitTest
プロパティが 'off'
に設定されている場合には、このコールバックは実行されません。
CreateFcn
— 作成関数
''
(既定値) | 関数ハンドル | cell 配列 | 文字ベクトル
オブジェクト作成関数。次の値のいずれかとして指定します。
関数ハンドル。
最初の要素が関数ハンドルである cell 配列。cell 配列内のその後の要素はコールバック関数に渡される引数です。
有効な MATLAB 式を含む文字ベクトル (非推奨)。MATLAB は、この式をベース ワークスペースで評価します。
コールバックを関数ハンドル、cell 配列、または文字ベクトルとして指定する方法の詳細については、グラフィックス オブジェクトのコールバックの作成を参照してください。
このプロパティは、MATLAB がオブジェクトを作成するときに実行されるコールバック関数を指定します。MATLAB は CreateFcn
コールバックを実行する前に、すべてのプロパティ値を初期化します。CreateFcn
プロパティを指定しない場合、MATLAB は既定の作成関数を実行します。
既存のコンポーネントに CreateFcn
プロパティを設定しても効果はありません。
このプロパティを関数ハンドルまたは cell 配列として指定した場合、コールバック関数の最初の引数を使用して、作成中のオブジェクトにアクセスできます。それ以外の場合は、関数 gcbo
を使用してオブジェクトにアクセスします。
DeleteFcn
— 削除関数
''
(既定値) | 関数ハンドル | cell 配列 | 文字ベクトル
オブジェクト削除関数。次の値のいずれかとして指定します。
関数ハンドル。
最初の要素が関数ハンドルである cell 配列。cell 配列内のその後の要素はコールバック関数に渡される引数です。
有効な MATLAB 式を含む文字ベクトル (非推奨)。MATLAB は、この式をベース ワークスペースで評価します。
コールバックを関数ハンドル、cell 配列、または文字ベクトルとして指定する方法の詳細については、グラフィックス オブジェクトのコールバックの作成を参照してください。
このプロパティは、MATLAB がオブジェクトを削除するときに実行されるコールバック関数を指定します。MATLAB は、オブジェクトのプロパティを破棄する前に DeleteFcn
コールバックを実行します。DeleteFcn
プロパティを指定しない場合、MATLAB は既定の削除関数を実行します。
このプロパティを関数ハンドルまたは cell 配列として指定した場合、コールバック関数の最初の引数を使用して、削除されるオブジェクトにアクセスできます。それ以外の場合は、関数 gcbo
を使用してオブジェクトにアクセスします。
コールバック実行制御
Interruptible
— コールバックの割り込み
'on'
(既定値) | on/off logical 値
コールバックの割り込み。'on'
または 'off'
、もしくは数値または logical 1
(true
) または 0
(false
) として指定します。'on'
の値は true
と等価であり、'off'
は false
と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState
型の on/off logical 値として格納されます。
このプロパティは実行中のコールバックが割り込み可能かどうかを決定します。次の 2 つのコールバックの状態について考慮する必要があります。
"実行中" コールバックは、現在実行しているコールバックです。
"割り込み" コールバックは、実行中のコールバックに割り込もうとするコールバックです。
MATLAB は、コールバック キューを処理するコマンドを実行するたびにコールバックの割り込み動作を判別します。これらのコマンドには、drawnow
、figure
、uifigure
、getframe
、waitfor
、pause
があります。
実行中コールバックにこれらのコマンドが含まれていない場合、割り込みは発生しません。MATLAB は、実行中コールバックの実行を先に終了させ、その後に割り込みコールバックを実行します。
実行中コールバックにこれらのいずれかのコマンドが含まれている場合、実行中コールバックを所有するオブジェクトの Interruptible
プロパティに応じて割り込みが発生するかどうかが決まります。
Interruptible
の値が'off'
の場合、割り込みは発生しません。代わりに、割り込みコールバックを所有するオブジェクトのBusyAction
プロパティに応じて、割り込みコールバックが破棄されるかコールバック キューに追加されるかが決まります。Interruptible
の値が'on'
の場合、割り込みが発生します。MATLAB は、コールバック キューの次回処理時に、実行中コールバックの実行を停止し、割り込みコールバックを実行します。割り込みコールバックが完了した後、MATLAB は実行中だったコールバックの実行を再開します。
メモ
コールバックの割り込みと実行は、以下の状況では動作が異なります。
割り込みコールバックが
DeleteFcn
、CloseRequestFcn
またはSizeChangedFcn
コールバックの場合、Interruptible
プロパティの値にかかわらず割り込みが発生します。実行中のコールバックが関数
waitfor
を現在実行している場合、Interruptible
プロパティの値にかかわらず割り込みが発生します。割り込みコールバックが
Timer
オブジェクトで所有されている場合、Interruptible
プロパティの値にかかわらずスケジュールに従ってコールバックが実行されます。
BusyAction
— コールバック キューイング
'queue'
(既定値) | 'cancel'
コールバック キューイング。'queue'
または 'cancel'
として指定します。BusyAction
プロパティは MATLAB による割り込みコールバックの実行の処理方法を決定します。次の 2 つのコールバックの状態について考慮する必要があります。
"実行中" コールバックは、現在実行しているコールバックです。
"割り込み" コールバックは、実行中のコールバックに割り込もうとするコールバックです。
BusyAction
プロパティによってコールバック キューイングの動作が決まるのは、次の両方の条件を満たす場合のみです。
これらの条件に当てはまる場合、割り込みコールバックを所有するオブジェクトの BusyAction
プロパティに応じて MATLAB による割り込みコールバックの処理方法が決まります。BusyAction
プロパティは次の値を取ることができます。
'queue'
— 割り込みコールバックをキューに入れ、実行中のコールバックが終了した後に処理されるようにします。'cancel'
— 割り込みコールバックを実行しません。
PickableParts
— マウス クリック キャプチャ機能
'visible'
(既定値) | 'all'
| 'none'
マウス クリック キャプチャ機能。次の値の 1 つとして指定します。
'visible'
— 表示されている場合にのみマウス クリックをキャプチャします。Visible
プロパティは、'on'
に設定しなければなりません。Text
オブジェクトがクリックに応答するか、先祖がクリックに応答するかは、HitTest
プロパティが決定します。'all'
— 表示状態に関係なくマウス クリックをキャプチャします。Visible
プロパティは'on'
または'off'
に設定できます。Text
オブジェクトがクリックに応答するか、先祖がクリックに応答するかは、HitTest
プロパティが決定します。'none'
— マウス クリックをキャプチャしません。Text
オブジェクトをクリックすると、Figure ウィンドウの現在のビュー内でその下にあるオブジェクト (通常は axes または figure) にクリックが渡されます。HitTest
プロパティは無効になります。
クリック可能にしない他のオブジェクトの下にあるオブジェクトをクリック可能にする場合は、他のオブジェクトをクリックが通過するように、それらのオブジェクトの PickableParts
プロパティを 'none'
に設定します。
HitTest
— キャプチャしたマウス クリックへの応答
'on'
(既定値) | on/off logical 値
キャプチャしたマウス クリックへの応答。'on'
または 'off'
、もしくは数値または logical 1
(true
) または 0
(false
) として指定します。'on'
の値は true と等価であり、'off'
は false
と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState
型の on/off logical 値として格納されます。
'on'
—Text
オブジェクトのButtonDownFcn
コールバックをトリガーします。ContextMenu
プロパティが定義されている場合は、コンテキスト メニューを呼び出します。'off'
—Text
オブジェクトの先祖のうち、次のいずれかの条件を満たす最も近い先祖のコールバックをトリガーします。HitTest
プロパティが'on'
に設定されているPickableParts
プロパティが、先祖によるマウス クリックのキャプチャを有効にする値に設定されている
メモ
PickableParts
プロパティは、Text
オブジェクトがマウス クリックをキャプチャできるかどうかを決定します。キャプチャできない場合、HitTest
プロパティは無効です。
BeingDeleted
— 削除状態
on/off logical 値
この プロパティ は読み取り専用です。
削除状態。matlab.lang.OnOffSwitchState
型の on/off logical 値として返されます。
MATLAB は、DeleteFcn
コールバックが実行を開始すると、BeingDeleted
プロパティを 'on'
に設定します。コンポーネント オブジェクトが存在しなくなるまで BeingDeleted
プロパティは 'on'
に設定されたままです。
クエリや変更の前にオブジェクトが削除されようとしていないか確認するために BeingDeleted
プロパティの値をチェックします。
親/子
Parent
— 親
Figure
オブジェクト
親。Figure
オブジェクトとして指定します。
Children
— 子
空の GraphicsPlaceholder
配列
このオブジェクトには子がありません。このプロパティは設定できません。
HandleVisibility
— オブジェクト ハンドルの可視性
"on"
(既定値) | "off"
| "callback"
親の Children
プロパティ内でのオブジェクト ハンドルの可視性。次の値のいずれかとして指定します。
"on"
— オブジェクト ハンドルは常に表示されます。"off"
— オブジェクト ハンドルは常に非表示です。このオプションは、他の関数による意図しない変更を防止するために役立ちます。HandleVisibility
を"off"
に設定すると、その関数の実行中にハンドルが一時的に非表示になります。"callback"
— オブジェクト ハンドルはコールバック内から、あるいはコールバックにより呼び出される関数から参照できます。しかし、コマンド ラインから呼び出される関数からは参照できません。このオプションを使用すると、コマンド ラインからのオブジェクトへのアクセスがブロックされますが、コールバック関数からのアクセスは許可されます。
オブジェクトが親の Children
プロパティ内にリストされない場合、オブジェクト階層の検索またはハンドル プロパティのクエリによってオブジェクト ハンドルを取得する関数は、そのオブジェクト ハンドルを返しません。こうした関数の例としては、関数 get
、findobj
、gca
、gcf
、gco
、newplot
、cla
、clf
、および close
などが挙げられます。
非表示のオブジェクト ハンドルは有効なままです。ルートの ShowHiddenHandles
プロパティを "on"
に設定すると、HandleVisibility
プロパティの設定にかかわらず、すべてのオブジェクト ハンドルがリストされます。
識別子
Type
— グラフィックス オブジェクトのタイプ
'subplottext'
この プロパティ は読み取り専用です。
グラフィックス オブジェクトのタイプ。'subplottext'
として返されます。プロット階層内にある特定のタイプのすべてのオブジェクトを検出するためにこのプロパティを使用できます。たとえば findobj
を使用してタイプを検索します。
Tag
— オブジェクト識別子
''
(既定値) | 文字ベクトル | string スカラー
オブジェクト識別子。文字ベクトルまたは string スカラーとして指定します。オブジェクトの識別子として機能する一意の Tag
値を指定できます。コードの他の部分からオブジェクトにアクセスする必要がある場合、関数 findobj
を使用して Tag
値に基づいてオブジェクトを検索できます。
UserData
— ユーザー データ
[]
(既定値) | 配列
ユーザー データ。任意の MATLAB 配列として指定します。たとえば、スカラー、ベクトル、行列、cell 配列、文字配列、table、または構造体を指定できます。このプロパティを使用して、任意のデータをオブジェクトに保存します。
App Designer を使用している場合は、UserData
プロパティを使用する代わりに、アプリでパブリック プロパティまたはプライベート プロパティを作成してデータを共有します。詳細については、App Designer アプリ内でのデータの共有を参照してください。
バージョン履歴
R2018b で導入R2020a: UIContextMenu
プロパティは非推奨
UIContextMenu
プロパティの設定や取得は推奨されていません。代わりに、ContextMenu
プロパティを使用してください。これは、UIContextMenu
プロパティと同じタイプの入力を受け入れ、同じように動作します。
UIContextMenu
プロパティを削除する予定はありませんが、関数 set
、get
、または properties
を Text
オブジェクトで呼び出す際にリストされなくなりました。
MATLAB コマンド
次の MATLAB コマンドに対応するリンクがクリックされました。
コマンドを MATLAB コマンド ウィンドウに入力して実行してください。Web ブラウザーは MATLAB コマンドをサポートしていません。
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)