ドキュメンテーション

最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

Figure のプロパティ

Figure ウィンドウの外観と動作の制御

Figure は、グラフィックス コンポーネントまたはユーザー インターフェイス コンポーネントのコンテナーです。Figure プロパティは Figure の特定のインスタンスの外観と動作を制御します。Figure の外観と動作を変えるには、プロパティ値を変更します。

R2014b から、プロパティのクエリと設定にドット表記を使用できるようになりました。

fig = figure;
u = fig.Units;
fig.Units = 'inches';

それより前のリリースを使用している場合は、代わりに関数 get および set を使用してください。

Figure の外観

すべて展開する

背景色。RGB 3 成分、事前定義された色名または 'none' として指定します。'none' を指定した場合、背景色は画面上では黒く表示されますが、Figure を印刷するとその背景は Figure ウィンドウが透明であるかのように印刷されます。

RGB 3 成分は、色の赤、緑、青成分の強度を指定する 3 成分の行ベクトルです。強度値は [0,1] の範囲でなければなりません。たとえば [0.4 0.6 0.7] のようになります。次の表に、色の完全名および省略名のオプションと、等価の RGB 3 成分の値を示します。

完全名省略名RGB 3 成分
'yellow''y'[1 1 0]
'magenta''m'[1 0 1]
'cyan''c'[0 1 1]
'red''r'[1 0 0]
'green''g'[0 1 0]
'blue''b'[0 0 1]
'white''w'[1 1 1]
'black''k'[0 0 0]

データ型: double | char

対話型の figure のドッキング。次のいずれかとして指定されます。

  • 'on' — Figure は、MATLAB® デスクトップ内でドッキングすることができます。[デスクトップ][Figure をドックに入れる] メニュー項目およびメニュー バーの [Figure をドックに入れる] ボタン が有効になります。

  • 'off' — MATLAB は [デスクトップ][Figure をドックに入れる] メニュー項目を無効にし、[Figure をドックに入れる] ボタンを表示しません。

    WindowStyle'docked' に設定されている場合には、DockControls プロパティを 'off' に設定できません。

Figure のメニュー バー表示。'figure' または 'none' として指定します。MenuBar プロパティによって、Figure ウィンドウ上部にある既定のメニューを表示または非表示にできます。メニュー バーを表示するには 'figure' を指定します。非表示にするには 'none' を指定します。

このプロパティは既定のメニューにのみ影響し、uimenu コマンドによって定義されているメニューには影響しません。

メニュー バーは、WindowStyle プロパティが 'Modal' に設定されている Figure には表示されません。uimenu の子を含む Figure が 'Modal' に変更された場合、その uimenu の子は Figure の Children プロパティ内に存在したままになります。ただし、WindowStyle'Modal' に設定されている間、この uimenu は表示されません。

メモ

Figure に既定のメニューが表示されないようにするには、Figure を作成するときにこのプロパティを 'none' に設定します。

Figure 名。文字ベクトルとして指定します。

例: figure('Name','Results') は、Figure 名を 'Results' に設定します。

既定の名前は 'Figure n' です。ここで、n は整数です。Name プロパティを指定した場合、Figure のタイトルは 'Figure n: name' になります。Name の値のみを表示する場合は、IntegerHandle または NumberTitle'off' に設定します。

Figure タイトルへの番号の付加。'on' または 'off' として指定します。NumberTitle プロパティは、MATLAB がタイトル バーにラベル Figure n を含めるかどうかを決定します。ここで n は Figure の Number プロパティの値です。

IntegerHandle'off' に設定した場合、NumberTitle プロパティの設定にかかわらず Figure ウィンドウのタイトルに数字は表示されません。

Figure のツール バー表示。次のいずれかとして指定されます。

  • 'auto'MenuBar プロパティと同じ値を使用します。

  • 'figure' — ツール バーを表示します。

  • 'none' — ツール バーを表示しません。

このプロパティは既定のツール バーにのみ影響します。[カメラ ツール バー]、[プロット編集 ツール バー] などの他のツール バーには影響しません。Figure の [表示] メニューから [Figure ツール バー] を選択すると、このプロパティが関数 'figure' に設定されます。

ツール バーは、WindowStyle プロパティが 'Modal' に設定されている Figure には表示されません。ツール バーを含む Figure が 'Modal' に変更された場合、そのツール バーの子は Figure の Children プロパティ内に存在したままになります。ただし、WindowStyle'Modal' に設定されている間、このツール バーは表示されません。

メモ

既定のツール バーを非表示にするには、Figure を作成するときにこのプロパティを 'none' に設定します。

Figure の可視性。'on' または 'off' として指定します。Visible プロパティは、画面にこの figure を表示するかどうかを決定します。figure の Visible プロパティが 'off' に設定されている場合、figure 全体が非表示になりますが、その場合でもプロパティを指定したりアクセスしたりできます。

非表示の figure のサイズを変更した場合、figure が表示されるときに SizeChangedFcn コールバックがトリガーされます。

メモ:

figure の Visible プロパティを変更しても、その子コンポーネントの Visible プロパティは "変更されません"。これは figure を非表示にすることによって子の表示が妨げられる場合でも変わりません。

このプロパティは、Figure には影響しません。

座標軸とプロットの外観

すべて展開する

座標軸グラフィックスの平滑化。'on' または 'off' で指定します。平滑化によって座標軸グラフィックスのギザギザの線を減らします。MATLAB は GraphicsSmoothing'on' に設定され、次の条件のいずれかが真の場合に、座標軸グラフィックス (および座標軸のルーラー) に平滑化手法を適用します。

  • Renderer プロパティが 'painters' に設定されている。

  • Renderer プロパティが 'opengl' に設定され、ハードウェアのカードで OpenGL® がサポートされている。

座標軸グラフィックスのほとんどが垂直または水平のラインの場合、GraphicsSmoothing プロパティを 'on' に設定し、ラインの AlignVertexCenters プロパティを 'on' に設定することを検討してください。平滑化手法では、平滑さが向上する代わりに鮮明さがある程度損なわれます。これは、鮮明なグラフィックスの場合、特に顕著に表れます。

メモ

グラフィックスの平滑化はテキストには影響しません。MATLAB は、GraphicsSmoothing プロパティの値に関係なくテキストを平滑化します。

画面表示と印刷に対して使用されるレンダリング方法。次の値の 1 つとして指定します。

  • 'opengl' — OpenGL レンダラー。このオプションを使用すると、MATLAB はシステムで利用可能なグラフィックス ハードウェアにアクセスできます。OpenGL レンダラーは、モニター上の表示と同様に、オブジェクトを前から後ろの順に並べ替えて表示します。線と面がモニター上の同一場所にある場合、常に線が面の前面に描画されます。

  • 'painters' — Painters レンダラー。このオプションは、2 次元表示の座標軸で良好に機能します。2 次元では、Painters レンダラーは graphics オブジェクトを子の順序 (指定順序) で並べ替えます。3 次元では、Painters レンダラーはオブジェクトを手前から奥の順序で並べ替えます。ただし、3 次元では、交差する多角形が正しく描画されないことがあります。

メモ

'zbuffer' オプションは削除されました。代わりに 'opengl' または 'painters' を使用してください。

OpenGL のハードウェアとソフトウェアの実装

OpenGL は、MATLAB を実行しているすべてのコンピューターで使用できます。これは、ソフトウェア版の OpenGL が MATLAB に組み込まれているためです。ただし、ハードウェア アクセラレータ版の OpenGL をサポートするグラフィックス ハードウェアがある場合、MATLAB は自動的にそのハードウェア アクセラレータ版を使用して、パフォーマンスを向上します。

場合によっては、ハードウェア版の OpenGL が使用可能でも、MATLAB が自動的にソフトウェア版を使用することがあります。たとえば、既知のドライバーの問題があるグラフィックス ハードウェアを検出した場合、あるいは Windows® 上でバーチャル マシンやリモート デスクトップを使用していることを検出した場合、MATLAB はソフトウェア版を使用します。

MATLAB は、使用可能な OpenGL ライブラリを検出できない場合、警告を出力します。

ソフトウェア OpenGL の選択

ハードウェア版からソフトウェア版の OpenGL に切り替えるには、次の手順に従います。

  • Linux® システムでは、コマンド matlab -softwareopengl を使用して MATLAB を起動します。

  • Windows システムでは、MATLAB 内でコマンド opengl software を実行するか、コマンド matlab -softwareopengl を使用して MATLAB を起動します。

  • Macintosh システムでは、ソフトウェア版の OpenGL はサポートされていません。

以下のソフトウェア版を使用できます。

  • Linux システムでは、MATLAB は、配布されている MATLAB に含まれている OpenGL のソフトウェア実装を使用します。

  • Windows では、OpenGL はオペレーティング システムの一部として使用できます。OpenGL による問題が生じた場合には、使用しているグラフィックス ドライバーのベンダーに連絡し、最新の認定バージョンの OpenGL を入手してください。

  • Macintosh システムでは、ソフトウェア版の OpenGL は使用できません。

OpenGL のライブラリ バージョンの確認

システム上で MATLAB が使用している OpenGL ライブラリのバージョンおよびベンダーを確認するには、MATLAB プロンプトに次のコマンドを入力します。

opengl info

返された情報には、MATLAB がソフトウェア版の OpenGL を使用している (Software = true) かハードウェア アクセラレータ版の OpenGL を使用している (Software = false) かを示す行が含まれています。

また、このコマンドは、MATLAB が使用している特定のライブラリで使用可能な OpenGL 仕様の拡張のリストも返します。バグをレポートする際には、この情報を含めるようにしてください。

opengl info コマンドを発行すると、MATLAB は OpenGL を初期化する点に注意してください。

XServer 接続が失われた

Linux を使用しているときに XServer への接続が中断された場合、MATLAB はセグメンテーション違反によってクラッシュする可能性があります。これが発生した場合は、システムに最新の XServer がインストールされていることを確認してください。

Linux システムでは、OpenGL ドライバーのアップグレードを試行することも、次のコマンドを使用してソフトウェア版の OpenGL と共に MATLAB を起動することもできます。

 matlab -softwareopengl

レンダラーの選択。次のように指定します。

  • 'auto' — MATLAB は Figure 内のグラフィックス オブジェクトのサイズと複雑さに基づいて、印刷用と画面表示用のレンダリング手法を選択します。

  • 'manual' — MATLAB は Renderer プロパティで指定されたレンダラーを使用します。

Renderer プロパティに明示的に 'painters' または 'opengl' を設定した場合、MATLAB は RendererMode プロパティを 'manual' に設定します。

色と透明度のマッピング

すべて展開する

Axes コンテンツの透明度マップ。0 から 1 まで線形に増加する有限アルファ値の配列として指定します。配列のサイズは m 行 1 列または 1 行 m 列にすることができます。MATLAB はベクトルのインデックスを使用してアルファ値にアクセスします。Alphamap は、任意の長さに設定できます。

Alphamap は関数 surfaceimage および patch によって作成されたオブジェクトのレンダリングに影響しますが、その他のグラフィックス オブジェクトには影響しません。

Figure の座標軸コンテンツのカラーマップ。m 種類の個別の色を定義する m3 列の RGB (赤、緑、青) 3 成分配列として指定します。

例: figure('Colormap',[1 0 1; 0 0 1; 1 1 0]) は、カラーマップを、マゼンタ、青、黄の 3 色に設定します。

MATLAB は、行番号でこれらの色にアクセスします。

カラーマップは関数 surfaceimage および patch によって作成されたオブジェクトのレンダリングに影響しますが、一般にその他のグラフィックス オブジェクトには影響しません。

位置とサイズ

すべて展開する

描画可能領域の位置とサイズ。[left bottom width height] の形式のベクトルとして指定します。この領域には、Figure の境界線、タイトル バー、メニュー バーおよびツール バーは含まれません。

次の表で、Position ベクトルの各要素について説明します。

要素説明
leftプライマリ ディスプレイの左端から figure ウィンドウの内側の左端までの距離です。この値は、複数のモニターがあるシステムでは負の値になる場合があります。

Figure がドッキングしている場合、この値は、MATLAB デスクトップ内の Figure パネルを基準にした値になります。
bottomプライマリ ディスプレイの下端から figure ウィンドウの内側の下端までの距離です。この値は、複数のモニターがあるシステムでは負の値になる場合があります。

Figure がドッキングしている場合、この値は、MATLAB デスクトップ内の Figure パネルを基準にした値になります。
widthfigure の内側の左右の端の間の距離です。
heightfigure の内側の上下の端の間の距離です。

すべての測定値は、Units プロパティで指定した単位で表されます。

Figure がドッキングしているときには、Figure の Position プロパティは指定できません。

境界線、タイトル バー、メニュー バーおよびツール バーを含むウィンドウ全体を配置するには、OuterPosition プロパティを使用します。

メモ

Windows オペレーティング システムでは、最小ウィンドウ幅と最大ウィンドウ サイズが適用されます。これらの範囲を超える Figure サイズを指定した場合、表示される Figure は指定されたサイズではなく、これらの範囲に従います。

外側の境界の位置とサイズ。[left bottom width height] の形式のベクトルとして指定します。このプロパティは、Figure の外側の境界によって囲まれる領域 (境界線、タイトル バー、メニュー バーおよびツール バーを含む) を定義します。

次の表で、ベクトルの各要素について説明します。

要素説明
leftプライマリ ディスプレイの左端から figure ウィンドウの外側の左端までの距離です。この値は、複数のモニターがあるシステムでは負の値になる場合があります。

Figure がドッキングしている場合、この値は、MATLAB デスクトップ内の Figure パネルを基準にした値になります。
bottomプライマリ ディスプレイの下端から figure ウィンドウの外側の下端までの距離です。この値は、複数のモニターがあるシステムでは負の値になる場合があります。

Figure がドッキングしている場合、この値は、MATLAB デスクトップ内の Figure パネルを基準にした値になります。
widthfigure の外側の左右の端の間の距離です。
heightfigure の外側の上下の端の間の距離です。

すべての測定値は、Units プロパティで指定した単位で表されます。

Figure がドッキングしているときには、Figure の OuterPosition プロパティは指定できません。

メモ

Windows オペレーティング システムでは、最小ウィンドウ幅と最大ウィンドウ サイズが適用されます。これらの範囲を超える Figure サイズを指定した場合、表示される Figure は指定されたサイズではなく、これらの範囲に従います。

描画可能領域の位置とサイズ。[left bottom width height] の形式のベクトルとして指定します。この領域には、Figure の境界線、タイトル バー、メニュー バーおよびツール バーは含まれません。すべての測定値は、Units プロパティで指定した単位で表されます。

このプロパティ値は、Position プロパティ値と同一です。

測定の単位。次の表のいずれかの値を指定します。

単位の値説明
'pixels' (既定)

ピクセル。

R2015b 以降、Windows および Macintosh システムにおいて、ピクセル単位の距離はシステム解像度に依存していません。

  • Windows システムの 1 ピクセルは 1/96 インチです。

  • Macintosh システムの 1 ピクセルは 1/72 インチです。

Linux システムでは、ピクセルのサイズは使用しているシステムの解像度によって決まります。

'normalized'これらの単位は親コンテナーを基準として正規化されます。コンテナーの左下隅が (0,0) で、右上隅が (1,1) になります。
'inches'インチ。
'centimeters'センチメートル。
'points'ポイント。1 ポイントは 1/72 インチです。
'characters'

これらの単位は、グラフィックス ルート オブジェクトの既定の uicontrol フォントを基にしています。

  • 文字の幅 = 文字 x の幅。

  • 文字の高さ = 2 行のテキストのベースライン間の距離。

既定の uicontrol フォントにアクセスするには、get(groot,'defaultuicontrolFontName') または set(groot,'defaultuicontrolFontName') を使用します。

MATLAB ではすべての単位を親オブジェクトの左下隅から測定します。

このプロパティは Position プロパティに影響します。Units プロパティを変更した場合、この既定値を想定する他の関数に影響を与えないように、計算の完了後に値を既定値に戻すことを検討してください。

Units プロパティと Position プロパティを指定する順序は次のように影響します。

  • Position プロパティの前に Units プロパティを指定する場合、MATLAB は指定した単位を使用して Position を設定します。

  • Position プロパティの後に Units プロパティを指定する場合、MATLAB は既定の Units を使用して位置を設定します。その後、MATLAB は Position の値を、指定した単位における等価の値に変換します。

ウィンドウのサイズ変更モード。次のように指定します。

  • 'on' — ユーザーは Figure ウィンドウのサイズを変更できます。

  • 'off' — ユーザーは Figure ウィンドウのサイズを変更できません。Figure ウィンドウにはサイズ変更コントロールは表示されません。

サイズ変更のコールバック関数。次の値のいずれかとして指定します。

  • 関数ハンドル。

  • 最初の要素が関数ハンドルであるセル配列。セル配列内のその後の要素はコールバック関数に渡される引数です。

  • 有効な MATLAB 式を含む文字ベクトル。たとえば、'disp(''hello world'')' は関数 disp を呼び出します。MATLAB は、ベース ワークスペース内でこの式を評価します。

このコールバック関数を定義して、このコンテナーのサイズが変更されたときに (ユーザーがウィンドウのサイズを変更した場合など)、アプリのレイアウトをカスタマイズします。

SizeChangedFcn コールバックは、次の場合に実行されます。

  • このコンテナーがはじめて表示される。

  • このコンテナーがサイズ変更中に表示される。

  • このコンテナーがサイズ変更後にはじめて表示される。この状況は、コンテナーが非表示の間にサイズが変更され、その後表示される場合に発生します。

SizeChangedFcn コールバックを定義するときに検討しなければならないその他の重要な点は、次のとおりです。

  • SizeChangedFcn が使用する変数がすべて定義されるまで、このコンテナーの表示を遅延させることを検討します。これにより、SizeChangedFcn コールバックがエラーを返すのを防ぐことができます。コンテナーの表示を遅延させるには、Visible プロパティを 'off' に設定します。SizeChangedFcn コールバックが使用する変数を定義した後で、Visible プロパティを 'on' に設定します。

  • 入れ子にされたコンテナーがアプリに含まれる場合、コンテナーのサイズは内側から順に変更されます。

  • サイズを変更しているコンテナーに SizeChangedFcn 内からアクセスするには、ソース オブジェクト (コールバック内の最初の入力引数) を参照するか、関数 gcbo を使用します。

ヒント

SizeChangedFcn コールバックを指定する代わりの簡単な方法として、コンテナーの中に入れるすべてのオブジェクトの Units プロパティを 'normalized' に設定できます。これにより、これらのコンポーネントがコンテナーに比例してスケールされます。

例:一定の高さをもつ編集フィールド

SizeChangedFcn コールバックを使用して、UI コンポーネントのサイズを制限します。たとえば、次のコードは、ウィンドウの上部に編集フィールドをもつ UI を作成します。ユーザーがウィンドウのサイズを変更するときに、関数 sbar はその高さを 20 ピクセルまでに制限します。また、この関数は編集フィールドの幅を Figure の幅に設定します。

R2014b 以降を使用している場合は、ドット表記を使用してプロパティの設定とクエリを行います。

function myui
f = figure('Visible','off','SizeChangedFcn',@sbar); 
u = uicontrol('Style','edit','Tag','StatusBar');
f.Visible = 'on';
    function sbar(src,callbackdata)
       old_units = src.Units;
       src.Units = 'pixels';
       sbar_units = u.Units;
       u.Units = 'pixels';
       fpos = src.Position;
       upos = [1 fpos(4) - 20 fpos(3) 20];
       u.Position = upos;
       u.Units = sbar_units;
       src.Units = old_units;
       u.Visible = 'on';
    end
end

R2014a 以前のリリースを使用している場合は、代わりに次のコードを使用します。

function myui
f = figure('Visible','off','SizeChangedFcn',@sbar); 
u = uicontrol('Style','edit','Tag','StatusBar');
set(f,'Visible','on');
    function sbar(src,callbackdata)
       old_units = get(src,'Units');
       set(src,'Units','pixels');
       sbar_units = get(u,'Units');
       set(u,'Units','pixels');
       fpos = get(src,'Position');
       upos = [1 fpos(4) - 20 fpos(3) 20];
       set(u,'Position',upos);
       set(u,'Units',sbar_units);
       set(src,'Units',old_units);
       set(u,'Visible','on');
    end
end

データ型: function_handle | cell | char

figure のサイズが変更されたときに実行されるコールバック関数。次の値の 1 つとして指定します。

  • 関数ハンドル。

  • 最初の要素が関数ハンドルであるセル配列。セル配列内のその後の要素はコールバック関数に渡される引数です。

  • 有効な MATLAB 式を含む文字ベクトル。たとえば、'disp(''hello world'')' は関数 disp を呼び出します。MATLAB は、ベース ワークスペース内でこの式を評価します。

メモ

ResizeFcn プロパティの使用は推奨されていません。将来のリリースで削除される可能性があります。代わりに SizeChangedFcn を使用してください。

データ型: function_handle | cell | char

複数のプロット

すべて展開する

次のプロットの追加方法の命令。'add''new''replace' または 'replacechildren' として指定します。

次の表では、それぞれの値の効果について説明します。

プロパティ値効果
'new'

新規 Figure を作成し、現在の Figure として利用します。

'add'

現在の Figure をクリアしたり、リセットすることなく、新しいグラフィックス オブジェクトを追加します。

'replacechildren'

新しいオブジェクトを追加する前に、非表示になっていないすべての axes オブジェクトを削除します。Figure のプロパティをリセットしません。

clf コマンドを使用するのと同じです。

'replace'

新しいグラフィックス オブジェクトを追加する前に、すべての axes オブジェクトを削除し、Figure のプロパティを既定値にリセットします。

clf reset コマンドを使用するのと同じです。

関数 newplot を使用して NextPlot プロパティを処理することを検討してください。詳細は、座標軸の NextPlot プロパティと「グラフの Figure および座標軸の準備」を参照してください。

対話制御

すべて展開する

メモ

Selected プロパティの動作は R2014b で変更されており、推奨されません。figure には何も影響しなくなりました。このパラメーターは将来のリリースで削除される可能性があります。

メモ

figure SelectionHighlight プロパティの使用は推奨されていません。このパラメーターは将来のリリースで削除される可能性があります。

このプロパティは、Figure には影響しません。

コールバック実行制御

すべて展開する

コールバックの割り込み。'on' または 'off' として指定します。Interruptible プロパティは実行中のコールバックが割り込み可能かどうかを決定します。

次の 2 つのコールバックの状態について考慮する必要があります。

  • "実行中" コールバックは、現在実行しているコールバックです。

  • "割り込み" コールバックは、実行中のコールバックに割り込もうとするコールバックです。

MATLAB がコールバックを呼び出すたびに、そのコールバックは実行中のコールバックに割り込もうとします。実行中のコールバックを所有するオブジェクトの Interruptible プロパティが、割り込み可能かどうかを決定します。割り込みが許可されない場合は、割り込みコールバックを所有するオブジェクトの BusyAction プロパティが、そのコールバックを破棄するかキューに入れるかを決定します。

figure コールバックが実行中のコールバックの場合、Interruptible プロパティは、別のコールバックによるそのコールバックの割り込みが可能かどうかを決定します。Interruptible プロパティは次の 2 つの値をとることができます。

  • 'on' — コールバックは実行中のコールバックに割り込むことができます。drawnowfiguregetframewaitforpause などの、MATLAB が次にキューを処理するポイントで割り込みが発生します。

    • 実行中のコールバックにこれらいずれかのコマンドが含まれている場合、MATLAB はその場所でコールバックの実行を停止し、割り込みコールバックを実行します。割り込みコールバックが完了したときに MATLAB は実行中だったコールバックの実行を再開します。

    • 実行中のコールバックにこれらのコマンドが含まれていない場合、MATLAB はそのコールバックの実行を中断せずに終了させます。

  • 'off' — コールバックは実行中のコールバックに割り込むことができません。MATLAB は割り込みさせずに実行中のコールバックを終了させます。

メモ

コールバックの割り込みと実行は、以下の状況では動作が異なります。

  • 割り込みコールバックが DeleteFcnCloseRequestFcn または SizeChangedFcn コールバックの場合、Interruptible プロパティの値にかかわらず割り込みが発生します。

  • 実行中のコールバックが関数 waitfor を現在実行している場合、Interruptible プロパティの値にかかわらず割り込みが発生します。

  • Timer オブジェクトは、Interruptible プロパティ値にかかわらず、スケジュールに従って実行されます。

  • MATLAB は、割り込みが発生したときにプロパティの状態や表示を保存しません。たとえば、gca コマンドや gcf コマンドから返されたオブジェクトは、別のコールバックを実行するときに変更されている可能性があります。

Interruptible プロパティおよび BusyAction プロパティがプログラムの動作に及ぼす影響を示す例は、「コールバック実行の中断」を参照してください。

コールバック キューイング。'queue' (既定値) または 'cancel' として指定します。BusyAction プロパティは MATLAB による割り込みコールバックの実行の処理方法を決定します。次の 2 つのコールバックの状態について考慮する必要があります。

  • "実行中" コールバックは、現在実行しているコールバックです。

  • "割り込み" コールバックは、実行中のコールバックに割り込もうとするコールバックです。

割り込みコールバックの割り込み元の BusyAction プロパティは、MATLAB が割り込みコールバックの実行を処理する方法を決定します。BusyAction プロパティは次の値をとります。

  • 'queue' — 割り込みコールバックをキューに入れ、実行中のコールバックが終了した後に処理されるようにします。

  • 'cancel' — 割り込みコールバックを実行しません。

MATLAB がコールバックを呼び出すたびに、そのコールバックは実行中のコールバックに割り込もうとします。コールバックを実行中のオブジェクトの Interruptible プロパティが、割り込み可能かどうかを決定します。Interruptible は次のように設定します。

  • on — MATLAB が次にキューを処理するポイントで割り込みが発生します。これは既定値です。

  • off — 割り込みコールバックを所有するオブジェクトの BusyAction プロパティによって、MATLAB が割り込みコールバックをキューに追加するか無視するかを決定します。

BusyAction プロパティおよび Interruptible プロパティがプログラムの動作に及ぼす影響を示す例は、「コールバック実行の中断」を参照してください。

現在のオブジェクトになる能力。'on' または 'off' として指定します。

  • 値を 'on' に設定した場合、ユーザーがクリックしたときに figure は現在のオブジェクトになることができます。また 'on' の値は、この Figure の CurrentObject プロパティを使用可能にし、関数 gco が現在のオブジェクトとしてこの figure を報告できるようにします。

  • 値を 'off' に設定した場合、ユーザーが figure をクリックしたときにこの figure の CurrentObject プロパティを空の配列 GraphicsPlaceholder に設定します。

キーボード制御

すべて展開する

Figure 内で最後に押されたキー。1 文字として返されます。ユーザー入力を取得するために CurrentCharacter プロパティを使用します。

ユーザーがキーを押したときに実行されるコールバック関数。次の値の 1 つとして指定します。

  • 関数ハンドル。

  • 最初の要素が関数ハンドルであるセル配列。セル配列内のその後の要素はコールバック関数に渡される引数です。

  • 有効な MATLAB 式を含む文字ベクトル。たとえば、'disp(''hello world'')' は関数 disp を呼び出します。MATLAB は、ベース ワークスペース内でこの式を評価します。

例: figure('KeyPressFcn',@myfun) は、キーを押したときのコールバック関数を関数ハンドルとして指定します。

例: figure('KeyPressFcn',{@myfun,x}) は、キーを押したときのコールバック関数をセル配列として指定します。この場合、この関数は入力引数 x を受け入れます。

コールバックのプロパティ値を関数ハンドル、セル配列または文字ベクトルとして指定する方法の詳細については、「コールバック プロパティ値の指定方法」を参照してください。

このコールバック関数は、figure ウィンドウにフォーカスがあり、ユーザーがキーを押したときに実行されます。このプロパティに関数を定義しない場合、MATLAB はキーが押されていることをコマンド ウィンドウに渡します。キーを繰り返し押すと figure のフォーカスが維持され、キーが押されるたびに関数が実行されます。ユーザーが複数のキーをほぼ同時に押した場合、MATLAB は最後に押されたキーを検出します。

このプロパティを関数ハンドル (または関数ハンドルを含むセル配列) で指定した場合、MATLAB はコールバック データを含むオブジェクトをコールバック関数の 2 番目の引数として渡します。このオブジェクトには次の表で説明するプロパティが含まれています。コールバック関数内のこれらのプロパティには、ドット表記を使用してアクセスできます。

プロパティ

内容

Character

1 つのキーまたは複数のキーを押した結果として表示される文字です。文字は空の場合や出力できない場合があります。

Modifier

押されている 1 つ以上の修飾キー (controlaltshift など) の名前が格納されるセル配列です。Macintosh コンピューターの場合は、command 修飾キーが押されたときに、セル配列に 'command' が格納されます。

Key

押されたキーです。キー上の (小文字の) ラベルまたは説明用の語によって識別されます。

Sourceユーザーがキーを押したときのフォーカスのあるオブジェクトです。
Eventnameコールバック関数を実行する原因となったアクションです。

修飾キーを押すと、次のようにコールバック データに影響します。

  • 修飾キーは Character プロパティに影響を与える可能性がありますが、Key プロパティを変更することはありません。

  • 一部のキーと、Ctrl で修飾されたキーは、Character プロパティに出力不能文字を格納します。

  • CtrlAltShift および他のいくつかのキーは、Character プロパティ データを生成しません。

ユーザーがどの文字を押したかを判断するために、Figure の CurrentCharacter プロパティをクエリすることもできます。

キーを離したときのコールバック関数。次の値のいずれかとして指定します。

  • 関数ハンドル。

  • 最初の要素が関数ハンドルであるセル配列。セル配列内のその後の要素はコールバック関数に渡される引数です。

  • 有効な MATLAB 式を含む文字ベクトル。たとえば、'disp(''hello world'')' は関数 disp を呼び出します。MATLAB は、ベース ワークスペース内でこの式を評価します。

例: figure('KeyReleaseFcn',@myfun) は、キーを離したときのコールバック関数を関数ハンドルとして指定します。

例: figure('KeyReleaseFcn',{@myfun,x}) は、キーを離したときのコールバック関数をセル配列として指定します。この場合、この関数は入力引数 x を受け入れます。

コールバックのプロパティ値を関数ハンドル、セル配列または文字ベクトルとして指定する方法の詳細については、「コールバック プロパティ値の指定方法」を参照してください。

このコールバック関数は、figure オブジェクトにフォーカスがあり、ユーザーがキーを離したときに実行されます。

メモ

このコールバックのトリガー動作は、キーを離すイベントに対するオペレーティング システムの応答によって決まります。

このプロパティを関数ハンドル (または関数ハンドルを含むセル配列) で指定した場合、MATLAB はコールバック データを含むオブジェクトをコールバック関数の 2 番目の引数として渡します。このオブジェクトには次の表で説明するプロパティが含まれています。コールバック関数内のこれらのプロパティには、ドット表記を使用してアクセスできます。

プロパティ

説明

例:

a

=

Shift

Shift-a

Character

離されたキーの文字解釈。

'a'

'='

''

'A'

Modifier

'control' のような現在の修正子または修正子がない場合は空のセル配列

{1x0 cell}

{1x0 cell}

{'shift'}

{'shift'}

Key

離されたキーです。キー上の (小文字の) ラベルまたは説明用の語によって識別されます。

'a'

'equal'

'shift'

'a'

Sourceユーザーがキーを押したときのフォーカスのあるオブジェクトです。figurefigurefigurefigure
Eventnameコールバック関数を実行する原因となったアクションです。'KeyRelease''KeyRelease''KeyRelease''KeyRelease'

修飾キーを押すと、次のようにコールバック データに影響します。

  • 修飾キーは Character プロパティに影響を与える可能性がありますが、Key プロパティを変更することはありません。

  • 一部のキーと、Ctrl で修飾されたキーは、Character プロパティに出力不能文字を格納します。

  • CtrlAltShift および他のいくつかのキーは、Character プロパティ データを生成しません。

ユーザーがどの文字を押したかを判断するために、Figure の CurrentCharacter プロパティをクエリすることもできます。

Figure ウィンドウでキーを押したときのコールバック関数。次の値の 1 つとして指定します。

  • 関数ハンドル。

  • 最初の要素が関数ハンドルであるセル配列。セル配列内のその後の要素はコールバック関数に渡される引数です。

  • 有効な MATLAB 式を含む文字ベクトル。たとえば、'disp(''hello world'')' は関数 disp を呼び出します。MATLAB は、ベース ワークスペース内でこの式を評価します。

例: figure('WindowKeyPressFcn',@myfun) は、キーを押したときのコールバック関数を関数ハンドルとして指定します。

例: figure('WindowKeyPressFcn',{@myfun,x}) は、キーを押したときのコールバック関数をセル配列として指定します。この場合、この関数は入力引数 x を受け入れます。

コールバック関数を記述し、それらをプロパティ値として指定する方法の詳細については、「コールバック プロパティ値の指定方法」を参照してください。

WindowKeyPressFcn コールバックは、Figure (または、その子のいずれか) にフォーカスがあるときにキーが押されると、必ず実行されます。

このプロパティを関数ハンドル (または関数ハンドルを含むセル配列) で指定した場合、MATLAB はコールバック データを含むオブジェクトをコールバック関数の 2 番目の引数として渡します。このオブジェクトには次の表で説明するプロパティが含まれています。コールバック関数内のこれらのプロパティには、ドット表記を使用してアクセスできます。

プロパティ

内容

Character

キーを押した結果として表示される文字です。文字は空の場合や出力できない場合があります。

Modifier

押されている 1 つ以上の修飾キー (controlaltshift など) の名前が格納されるセル配列です。Macintosh コンピューターの場合は、command 修飾キーを押したときに 'command' が格納されます。

Key

押されたキーです。キー上の (小文字の) ラベルまたは説明用の語によって識別されます。

Sourceユーザーがキーを押したときのフォーカスのあるオブジェクトです。
Eventnameコールバック関数を実行する原因となったアクションです。

Figure ウィンドウでキーを離したときのコールバック関数。次の値の 1 つとして指定します。

  • 関数ハンドル。

  • 最初の要素が関数ハンドルであるセル配列。セル配列内のその後の要素はコールバック関数に渡される引数です。

  • 有効な MATLAB 式を含む文字ベクトル。たとえば、'disp(''hello world'')' は関数 disp を呼び出します。MATLAB は、ベース ワークスペース内でこの式を評価します。

例: f = figure('WindowKeyReleaseFcn',@myfun) は、キーを離したときのコールバック関数を関数ハンドルとして指定します。

例: f = figure('WindowKeyReleaseFcn',{@myfun,x}) は、キーを離したときのコールバック関数をセル配列として指定します。この場合、この関数は入力引数 x を受け入れます。

コールバックのプロパティ値を関数ハンドル、セル配列または文字ベクトルとして指定する方法の詳細については、「コールバック プロパティ値の指定方法」を参照してください。

Figure ウィンドウまたは Figure ウィンドウのいずれかの子にフォーカスがあるときにキーを離すと、このコールバックが必ず実行されます。

このプロパティを関数ハンドル (または関数ハンドルを含むセル配列) で指定した場合、MATLAB はコールバック データを含むオブジェクトをコールバック関数の 2 番目の引数として渡します。このオブジェクトには次の表で説明するプロパティが含まれています。コールバック関数内のこれらのプロパティには、ドット表記を使用してアクセスできます。

プロパティ

内容

Character

1 つのキーまたは複数のキーを離した結果として表示される文字です。文字は空の場合や出力できない場合があります。

Modifier

離される 1 つ以上の修飾キー (controlaltshift など) の名前が格納されるセル配列です。Macintosh コンピューターの場合は、command 修飾キーを離したときに 'command' が格納されます。

Key

離されたキーです。キー上の (小文字の) ラベルまたは説明用の語によって識別されます。

Sourceユーザーがキーを離したときにフォーカスのあるオブジェクトです。
Eventnameコールバック関数を実行する原因となったアクションです。

マウス制御

すべて展開する

ボタンを押したときのコールバック関数。次の値の 1 つとして指定します。

  • 関数ハンドル。

  • 最初の要素が関数ハンドルであるセル配列。セル配列内のその後の要素はコールバック関数に渡される引数です。

  • 有効な MATLAB 式を含む文字ベクトル。たとえば、'disp(''hello world'')' は関数 disp を呼び出します。MATLAB は、ベース ワークスペース内でこの式を評価します。

コールバックのプロパティ値を関数ハンドル、セル配列または文字ベクトルとして指定する方法の詳細については、「コールバック プロパティ値の指定方法」を参照してください。

ポインターが Figure ウィンドウの中にあるが、uicontrol、uipanel、座標軸、座標軸の子などの子オブジェクトの上にはないときにユーザーがマウス ボタンをクリックすると、このコールバックが必ず実行されます。

修飾キーも押されているかどうかを判断するには、Figure の SelectionType プロパティを参照してください。

マウス ポインターの位置。2 要素ベクトルとして返されます。CurrentPoint プロパティには、Figure の左下隅から測定したマウス ポインターの座標 (x, y) が格納されます (単位は Units プロパティにより決定)。

Figure に WindowButtonMotionFcn コールバックが定義されていない限り、この座標は最後にマウスをクリックした位置を表します。WindowButtonMotionFcn コールバックが定義されている場合、座標はマウス ポインターの最後の位置を表します。

メモ

CurrentPoint が返した値を使用して点をプロットする場合、座標値に丸め誤差が含まれることがあります。

CurrentPoint と Cursor Motion

MATLAB は、Figure の WindowButtonMotionFcn プロパティおよび WindowButtonUpFcn プロパティで定義されたコールバック関数を実行する前に CurrentPoint を更新します。このため、これらのコールバック関数から CurrentPoint をクエリすることができます。次のように動作します。

  • WindowButtonMotionFcn プロパティまたは WindowButtonUpFcn プロパティにコールバック関数を定義した場合、MATLAB はユーザーが Figure ウィンドウ内でマウス ボタンを押したときにのみ CurrentPoint プロパティを更新します。

  • WindowButtonMotionFcn プロパティにコールバック関数を定義した場合、MATLAB はコールバックを実行する直前に CurrentPoint プロパティを更新します。WindowButtonMotionFcn プロパティは Figure ウィンドウ内でのみ実行されますが、ユーザーが Figure 内でマウス ボタンを押し、"マウスボタンを押したまま" 画面内でポインターを動かす場合は例外になります。この場合、ユーザーがマウス ボタンを離すまで画面内のどこであっても関数が実行されます (そして MATLAB は CurrentPoint プロパティを更新します)。

  • WindowButtonUpFcn プロパティにコールバック関数を定義した場合、MATLAB はコールバックを実行する直前に CurrentPoint プロパティを更新します。WindowButtonUpFcn コールバックはポインターが Figure ウィンドウ内にある場合にのみ実行されますが、ユーザーが Figure ウィンドウ内でマウス ボタンを押し、画面のどこかで "マウスボタンを離す" 場合は例外になります。この場合、CurrentPoint プロパティの値を更新した後で関数が実行されます。

  • uicontrol または uitable コンポーネントを Figure に追加した場合、MATLAB が CurrentPoint プロパティを更新するのは、ユーザーがそのコンポーネントを右クリックしたときまたはそのコンポーネントの Enable プロパティが 'off' または 'inactive' のときにコンポーネントを左クリックしたときです。

WindowButtonMotionFcn コールバックの実行に時間がかかる場合や、ユーザーがポインターを非常に速く移動した場合などの特定の状況では、実際のポインター位置が CurrentPoint プロパティに反映されず、WindowButtonMotionFcn コールバックの実行開始時の位置が反映されることがあります。

ルートの PointerLocation プロパティには、ポインターの移動に同期して更新されたポインターの位置が含まれます。ただし、位置は Figure ウィンドウではなく、画面に対して測定されます。

マウスの選択タイプ。'normal''extend''alt' または 'open' として返されます。MATLAB は、このプロパティを使用して、Figure ウィンドウ内で最後にマウス ボタンがクリックされたときの情報を提供します。この情報は、行われた選択のタイプを示します。選択タイプは、ユーザー インターフェイス ソフトウェアからの特定の応答に MATLAB が通常関連付けるアクションです (たとえば、グラフィックス オブジェクトのシングルクリックで移動モードまたはサイズ変更モードに移行したり、ファイル名のダブルクリックでファイルを開くなど)。

このプロパティの値は、マウス クリックの種類と、ユーザーのオペレーティング システムによって異なります。

選択タイプ

Microsoft® Windows

Linux

Mac

'normal'

左マウス ボタンをクリック

左マウス ボタンをクリック

左マウス ボタンをクリック

'extend'

以下のいずれかを行います。

  • Shift キーを押しながら左マウス ボタンをクリック

  • 左と右の両方のマウス ボタンをクリック

以下のいずれかを行います。

  • Shift キーを押しながら左マウス ボタンをクリック

  • 中央のマウス ボタンをクリック

以下のいずれかを行います。

  • Shift キーを押しながら左マウス ボタンをクリック

  • 中央のマウス ボタンをクリック

  • 左と右の両方のマウス ボタンをクリック

'alt'

Control キーを押しながら左マウス ボタンをクリック、または右ボタンをクリック

Control キーを押しながら左マウス ボタンをクリック、または右ボタンをクリック

Control キーを押しながら左マウス ボタンをクリック、または右ボタンをクリック

'open'

任意のマウス ボタンをダブルクリック

任意のマウス ボタンをダブルクリック

任意のマウス ボタンをダブルクリック

メモ

リスト ボックス (uicontrol) の場合、ダブルクリックの 2 番目のクリックで SelectionType プロパティが 'open' に設定されます。

ボタンを押したときのコールバック関数。次の値の 1 つとして指定します。

  • 関数ハンドル。

  • 最初の要素が関数ハンドルであるセル配列。セル配列内のその後の要素はコールバック関数に渡される引数です。

  • 有効な MATLAB 式を含む文字ベクトル。たとえば、'disp(''hello world'')' は関数 disp を呼び出します。MATLAB は、ベース ワークスペース内でこの式を評価します。

例: figure('WindowButtonDownFcn',@myfun) は、ボタンを押したときのコールバック関数を関数ハンドルとして指定します。

例: figure('WindowButtonDownFcn',{@myfun,x}) は、ボタンを押したときのコールバック関数をセル配列として指定します。この場合、この関数は入力引数 x を受け入れます。

コールバックのプロパティ値を関数ハンドル、セル配列または文字ベクトルとして指定する方法の詳細については、「コールバック プロパティ値の指定方法」を参照してください。

このコールバックは、figure 内にあるその他すべての ButtonDownFcn コールバックの前に実行されます。

メモ

Macintosh システムで 2 つボタンまたは 3 つボタンのマウスを使用している場合、右ボタンと中央ボタンが押されていることは必ずしもレポートされません。この状況は、マウス カーソルの下に新しい Figure ウィンドウが表示され、ユーザーがマウスを移動せずにクリックした場合に "のみ" 発生します。この状況で WindowButtonDownFcn コールバックを動作させるには、ユーザーは次のいずれかを実行する必要があります。

  • Figure の作成後にマウスを移動し、任意のマウス ボタンをクリックする

  • Shift キーまたは Ctrl キーを押しながら左マウス ボタンをクリックし、拡張および代替の選択タイプを実行する

左マウス ボタン (または単一のマウス ボタン) が押されたことは、上記のアクションを実行しなくても機能します。

コールバックの動作方法についての詳細は、Interruptible プロパティおよび BusyAction プロパティを参照してください。

マウスを移動したときのコールバック関数。次の値の 1 つとして指定します。

  • 関数ハンドル。

  • 最初の要素が関数ハンドルであるセル配列。セル配列内のその後の要素はコールバック関数に渡される引数です。

  • 有効な MATLAB 式を含む文字ベクトル。たとえば、'disp(''hello world'')' は関数 disp を呼び出します。MATLAB は、ベース ワークスペース内でこの式を評価します。

コールバックのプロパティ値を関数ハンドル、セル配列または文字ベクトルとして指定する方法の詳細については、「コールバック プロパティ値の指定方法」を参照してください。

ユーザーがポインターを Figure ウィンドウ内で動かすと、このコールバック関数が必ず実行されます。

メモ

一部のシステムでは、MATLAB が Figure を作成したときに、Figure 内でマウスの移動がなかった場合でも WindowButtonMotionFcn コールバックが実行されます。

コールバック関数では、関数 drawnow または pause を呼び出して表示を更新する必要が生じる場合があります。このとき、MATLAB はキュー内のすべてのコールバックを処理します。コールバック キューの処理によってコールバック関数への再入が発生する可能性があります。そのため、再入を処理できるようにコードを設計し、再入中に状態が変化する可能性のあるグローバル変数には依存しないようにする必要があります。

コールバックの動作方法についての詳細は、Interruptible プロパティおよび BusyAction プロパティを参照してください。

例:ウィンドウ ボタン コールバック関数のコーディング

この例では、3 つすべてのウィンドウ ボタン コールバック関数をコーディングして、ユーザーがマウス操作によって線を描けるようにする方法について説明します。

システムの書き込み可能なフォルダーのファイルに次のコードをコピーして保存します。そして、コードを実行します。座標軸でマウスの左ボタンをクリックし、カーソルを動かします。左クリックして線の終点を指定します。右クリックして描画モードを終了します。

function window_motion_test
figure('WindowButtonDownFcn',@wbdcb)
ah = axes('SortMethod','childorder');
axis ([1 10 1 10])
title('Click and drag')
   function wbdcb(src,callbackdata)
     seltype = src.SelectionType;
     % This code uses dot notation to set properties
     % Dot notation runs in R2014b and later.
     % For R2014a and earlier: seltype = get(src,'SelectionType');
     if strcmp(seltype,'normal')
        src.Pointer = 'circle';
        cp = ah.CurrentPoint;
        % For R2014a and earlier: 
        % set(src,'Pointer','circle');
        % cp = get(ah,'CurrentPoint');
        xinit = cp(1,1);
        yinit = cp(1,2);
        hl = line('XData',xinit,'YData',yinit,...
        'Marker','p','color','b');
        src.WindowButtonMotionFcn = @wbmcb;
        src.WindowButtonUpFcn = @wbucb;
        % For R2014a and earlier: 
        % set(src,'WindowButtonMotionFcn',@wbmcb);
        % set(src,'WindowButtonUpFcn',@wbucb);

     end    
 
        function wbmcb(src,callbackdata)
           cp = ah.CurrentPoint;
           % For R2014a and earlier: 
           % cp = get(ah,'CurrentPoint');
           xdat = [xinit,cp(1,1)];
           ydat = [yinit,cp(1,2)];
           hl.XData = xdat;
           hl.YData = ydat;
           % For R2014a and earlier: 
           % set(hl,'XData',xdat);
           % set(hl,'YData',ydat);
           drawnow
        end
   
        function wbucb(src,callbackdata)
           last_seltype = src.SelectionType;
           % For R2014a and earlier: 
           % last_seltype = get(src,'SelectionType');
           if strcmp(last_seltype,'alt')
              src.Pointer = 'arrow';
              src.WindowButtonMotionFcn = '';
              src.WindowButtonUpFcn = '';
              % For R2014a and earlier:
              % set(src,'Pointer','arrow');
              % set(src,'WindowButtonMotionFcn','');
              % set(src,'WindowButtonUpFcn','');
           else
              return
           end
        end
  end
end

ボタンを離したときのコールバック関数。次の値の 1 つとして指定します。

  • 関数ハンドル。

  • 最初の要素が関数ハンドルであるセル配列。セル配列内のその後の要素はコールバック関数に渡される引数です。

  • 有効な MATLAB 式を含む文字ベクトル。たとえば、'disp(''hello world'')' は関数 disp を呼び出します。MATLAB は、ベース ワークスペース内でこの式を評価します。

例: figure('WindowButtonUpFcn',@myfun) は、ボタンを離したときのコールバック関数を関数ハンドルとして指定します。

例: figure('WindowButtonUpFcn',{@myfun,x}) は、ボタンを離したときのコールバック関数をセル配列として指定します。この場合、この関数は入力引数 x を受け入れます。

コールバックのプロパティ値を関数ハンドル、セル配列または文字ベクトルとして指定する方法の詳細については、「コールバック プロパティ値の指定方法」を参照してください。

このコールバック関数は、ユーザーがマウス ボタンを離したときに必ず実行されます。

ボタンアップ コールバックは、前にボタンを押す操作が発生した Figure ウィンドウに関連付けられています。そのため、ユーザーがボタンを離してボタンアップ コールバックが発生するときに、Figure ウィンドウ内にポインターがある必要はありません。

WindowButtonDownFcn プロパティまたは WindowButtonMotionFcn プロパティによって定義されているコールバック関数がdrawnow コマンドを含んでいるかまたは drawnow コマンドを含む他の関数を呼び出しており、Interruptible プロパティが 'off' に設定されている場合、WindowButtonUpFcn コールバックは呼び出されない可能性があります。この状況は Interruptible プロパティを 'on' に設定することで防ぐことができます。

コールバック関数では、関数 drawnow または pause を呼び出して表示を更新する必要が生じる場合があります。このとき、MATLAB はキュー内のすべてのコールバックを処理します。このキューの処理によってコールバック関数への再入が発生する可能性があります。たとえば、WindowButtonUpFcn コールバック内の drawnow コマンドにより、WindowButtonUpFcn コールバックの最初の呼び出しが終了する前に、これが再度呼び出されることがあります。そのため、再入を処理できるようにコードを設計し、再入中に状態が変化する可能性のあるグローバル変数には依存しないようにする必要があります。

Figure の Interruptible プロパティおよび BusyAction プロパティを使用して、コールバック間の相互作用を制御できます。

マウス スクロール ホイールのコールバック。次の値の 1 つとして指定します。

  • 関数ハンドル。

  • 最初の要素が関数ハンドルであるセル配列。セル配列内のその後の要素はコールバック関数に渡される引数です。

  • 有効な MATLAB 式を含む文字ベクトル。たとえば、'disp(''hello world'')' は関数 disp を呼び出します。MATLAB は、ベース ワークスペース内でこの式を評価します。

コールバックのプロパティ値を関数ハンドル、セル配列または文字ベクトルとして指定する方法の詳細については、「コールバック プロパティ値の指定方法」を参照してください。

このコールバックは、Figure にフォーカスがあるときにユーザーがマウス スクロール ホイールを動かすと実行されます。MATLAB はマウス スクロール ホイールが 1 クリック分動くたびにこのコールバックを実行します。

マウス スクロール ホイールの移動を他のオブジェクトが MATLAB からキャプチャする可能性があることに注意してください。たとえばマウス スクロール ホイールの移動をリッスンする Java® または ActiveX® のコントロール オブジェクトが Figure に含まれている場合、これらのオブジェクトが移動操作をキャプチャし、WindowScrollWheelFcn コールバックの実行が妨げられる可能性があります。

WindowScrollWheelFcn のコールバック データ

このコールバックが関数ハンドル (または関数ハンドルを含むセル配列) の場合、MATLAB はコールバック データを含むオブジェクトをコールバック関数の 2 番目の引数として渡します。このオブジェクトには次の表で説明するプロパティが含まれています。コールバック関数内のこれらのプロパティには、ドット表記を使用してアクセスできます。

プロパティ

内容

VerticalScrollCount

マウス スクロール ホイールのクリック数を示す正または負の整数。正の値は、下方向にスクロールされたホイールのクリックを示します。負の値は、上方向にスクロールされたホイールのクリックを示します。

VerticalScrollAmount

スクロール ホイールのクリックごとにスクロールされる行数に関する現在のシステム設定。スクロールに関するマウス プロパティ設定が One screen at a time に設定されている場合、VerticalScrollAmount プロパティは 1 です。

他のプロパティに対する影響

WindowScrollWheelFcn プロパティ値は、他のプロパティに次のような影響があります。

  • CurrentObject プロパティ — WindowScrollWheelFcn プロパティは CurrentObject プロパティに影響しません。

  • CurrentPoint プロパティ — WindowScrollWheelFcn プロパティに対してコールバックが定義されていない場合、スクロール ホイールの回転では、MATLAB は CurrentPoint プロパティを更新しません。ただし、WindowScrollWheelFcn プロパティに対してコールバックが定義されている場合、MATLAB は、コールバックを実行する直前に CurrentPoint プロパティを更新します。これにより、マウスのスクロールが発生したポイントを調べることができます。

  • SelectionType プロパティ — WindowScrollWheelFcn プロパティは SelectionType プロパティに影響しません。

VerticalScrollCount の戻り値

ユーザーがマウスのスクロール ホイールを 1 クリックずつ動かすと、MATLAB は、スクロールの方向に応じて +/- 1 ずつカウントをインクリメントします (スクロール ダウンの方向が正)。MATLAB が WindowScrollWheelFcn コールバックを呼び出すと、カウンターはリセットされます。多くの場合、戻り値の絶対値は 1 となります。ただし、WindowScrollWheelFcn コールバックが値を返すまでに長い時間を要する場合や、ユーザーがスクロール ホイールを非常に高速に回転させた場合 (またはその両方) には、戻り値の絶対値が 1 より大きくなる場合もあります。

VerticalScrollCount プロパティから実際に返される値は、前回の処理以降に発生したマウス スクロール ホイールの全クリックの代数和です。これにより、コールバックがユーザーのアクションに正しく応答することができます。

例:WindowScrollWheelFcn コールバックのコード

この例ではグラフを作成し、ユーザーがマウス スクロール ホイールを使用して範囲を変更すると、その範囲で MATLAB が数学関数を評価するようにします。また、ユーザーがスクロール ホイールを回転すると、新しい範囲を反映するようにグラフを更新します。

システムの書き込み可能なフォルダーに関数をコピーして保存します。そして、コードを実行します。Figure 上にマウスを置き、マウス ホイールをスクロールさせます。

function scroll_wheel
% Illustrates how to use WindowScrollWheelFcn property
%
   f = figure('WindowScrollWheelFcn',@figScroll,'Name','Scroll Wheel Demo');
   x = [0:.1:40];
   y = 4.*cos(x)./(x+2);
   a = axes; 
   h = plot(x,y);
   title('Rotate the scroll wheel')
   function figScroll(src,callbackdata)
      if callbackdata.VerticalScrollCount > 0 
         xd = h.XData;
         % This code uses dot notation to set properties
         % Dot notation runs in R2014b and later.
         % For R2014a and earlier: xd = get(h,'XData');
         inc = xd(end)/20;
         x = [0:.1:xd(end)+inc];
         re_eval(x)
      elseif callbackdata.VerticalScrollCount < 0 
         xd = h.XData;
         % For R2014a and earlier: xd = get(h,'XData');
         inc = xd(end)/20;
         x = [0:.1:xd(end)-inc+.1]; % Don't let xd = 0;
         re_eval(x)
      end
   end

   function re_eval(x)
      y = 4.*cos(x)./(x+2);
      h.YData = y;
      h.XData = x;
      a.XLim = [0 x(end)];
      % For R2014a and earlier: 
      % set(h,'YData',y);
      % set(h,'XData',x);
      % set(a,'XLim',[0 x(end)]);
      drawnow
   end
end

Figure コンテキスト メニュー。uicontextmenu オブジェクトとして指定します。このプロパティを使用して、ユーザーが figure 上で右クリックしたときにコンテキスト メニューを表示します。関数 uicontextmenu を使用して、コンテキスト メニューを作成します。

ウィンドウ制御

すべて展開する

Figure のクローズ要求のコールバック関数。次の値の 1 つとして指定します。

  • 関数ハンドル。

  • 最初の要素が関数ハンドルであるセル配列。セル配列内のその後の要素はコールバック関数に渡される引数です。

  • 有効な MATLAB 式を含む文字ベクトル。たとえば、'disp(''hello world'')' は関数 disp を呼び出します。MATLAB は、ベース ワークスペース内でこの式を評価します。

コールバックのプロパティ値を関数ハンドル、セル配列または文字ベクトルとして指定する方法の詳細については、「コールバック プロパティ値の指定方法」を参照してください。

このコールバックは、ユーザーが Figure ウィンドウを閉じようとするときに必ず実行されます。たとえば、ダイアログ ボックスを表示して、閉じる操作の確定またはキャンセルをユーザーに求めたり、UI を含む Figure を閉じる操作をユーザーからはできないようにしたりできます。

基本的なメカニズムは以下のとおりです。

  1. ユーザーがコマンド ラインから close または close all コマンドを発行するか、コンピューターのウィンドウ マネージャー メニューから Figure を閉じるか、MATLAB を終了して Figure を閉じます。

  2. 閉じる操作によって、Figure の CloseRequestFcn プロパティで定義された関数が実行されます。既定の関数は closereq です。

    関数 closereq は、現在の Figure を無条件で削除し、ウィンドウを破棄します。関数 closereq は、対応するクローズ要求関数が呼び出される前に、close コマンドによって引数として指定されたそれぞれの Figure が 現在の Figure になることを利用します。

Figure を削除する際に、関数 closereqShowHiddenHandles プロパティの設定に従うため、非表示の Figure を削除しません。

クローズ要求関数が関数 delete または関数 close を呼び出さない限り、MATLAB がこの Figure を閉じることはありません(非破壊的なクローズ要求関数をもつウィンドウを作成した場合は、コマンド ラインから delete(f) を呼び出すことができます)。

例:ダイアログ ボックスを表示する CloseRequestFcn のコーディング

この例では、閉じる操作の確認をユーザーに求める質問ダイアログ ボックスを表示するようにクローズ要求関数をコーディングする方法について説明します。次のコードをシステムの書き込み可能なフォルダーに保存します。

function my_closereq(src,callbackdata)
% Close request function 
% to display a question dialog box 
   selection = questdlg('Close This Figure?',...
      'Close Request Function',...
      'Yes','No','Yes'); 
   switch selection, 
      case 'Yes',
         delete(gcf)
      case 'No'
      return 
   end
end

次に、my_closereqCloseRequestFcn に指定して Figure を作成します。

figure('CloseRequestFcn',@my_closereq)

Figure ウィンドウを閉じると質問のダイアログ ボックスが表示されます。

Figure ウィンドウの動作。次のいずれかとして指定します。

  • 'normal' — Figure ウィンドウは他のウィンドウから独立しており、この Figure の表示中に他のウィンドウにアクセスできます。

  • 'modal' — この Figure は、既存のすべての Figure ウィンドウの上に表示されます。この一番上に表示された Figure が存在してモーダルな状態である限り、既存のウィンドウへのアクセスができなくなります。ただし、モーダルな Figure の後に作成された新しい Figure は表示されます。

    複数のモーダルなウィンドウが存在する場合、最後に作成されたウィンドウがフォーカスされ、他のすべてのウィンドウの前面に表示されます。この状態は、不可視になるか、通常のウィンドウ スタイルに戻るか、削除されるまで継続します。継続が終了した場合、フォーカスは、最後にフォーカスされたウィンドウに戻ります。

  • 'docked' — Figure はデスクトップまたはドキュメント ウィンドウに表示されます。WindowStyle プロパティが 'docked' に設定されている場合には、DockControls プロパティを 'off' に設定できません。

メモ

WindowStyle プロパティにはいくつかの重要な特徴と推奨されるベスト プラクティスがあります。

  • UI ウィンドウを作成するときは、常に WindowStyle プロパティを指定します。さらに Figure の ResizePosition または OuterPosition プロパティも設定する場合は、WindowStyle プロパティを最初に設定します。

  • Figure の WindowStyle プロパティは、Figure が可視な場合や子オブジェクトを含む場合を含め、いつでも変更できます。ただし、一部のシステムではノーマル ウィンドウとモーダル ウィンドウの実装によっては、このプロパティを設定することで、Figure の点滅や非表示後に再表示される現象が発生する場合もあります。視覚的に最良な結果を得るには、WindowStyle プロパティの設定は、Figure の作成時または非表示のときに行います。

  • Figure で reset を呼び出しても WindowStyle プロパティの値は変更されません。

モーダル ウィンドウ スタイルの動作

WindowStyle'modal' に設定されている場合、Figure ウィンドウが可視である限り、Figure ウィンドウはすべての MATLAB ウィンドウ上のすべてのキーボード操作とマウス操作をトラップします。MATLAB 以外のアプリケーションのウィンドウには影響しません。

モーダルな Figure にフォーカスがあるときに Ctrl + C を入力すると、Figure は 'normal' WindowStyle プロパティ設定に戻ります。これによりユーザーはコマンド ラインに入力できます。

WindowStyle プロパティが 'modal' に、Visible プロパティが 'off' に設定された Figure は、MATLAB が表示しない限りモーダル動作になりません。このためモーダル ウィンドウを破棄する代わりに、後で再利用するために非表示にすることができます。

モーダルな Figure は uimenu の子、組み込みのメニュー、ツール バーを表示しません。しかし、モーダルな Figure 内で uimenu を作成したり、uimenu の子をもつ Figure で WindowStyle プロパティ設定を 'modal' に変更したりするのは誤りではありません。その uimenu オブジェクトは存在し、Figure はそれを維持します。Figure の WindowStyle プロパティを 'normal' にリセットすると、その uimenu は表示されます。

作成と削除の制御

すべて展開する

このプロパティは読み取り専用です。

削除状態。'off' または 'on' として返されます。MATLAB はオブジェクトの削除関数が実行を開始したときに BeingDeleted プロパティを 'on' に設定します (DeleteFcn プロパティを参照)。オブジェクトが存在しなくなるまで BeingDeleted プロパティは 'on' に設定されたままです。

クエリや変更の前にオブジェクトが削除されようとしていないか確認するために BeingDeleted プロパティの値をチェックします。

Figure 作成関数。次の値のいずれかとして指定します。

  • 関数ハンドル。

  • 最初の要素が関数ハンドルであるセル配列。セル配列内のその後の要素はコールバック関数に渡される引数です。

  • 有効な MATLAB 式を含む文字ベクトル。たとえば、'disp(''hello world'')' は関数 disp を呼び出します。MATLAB は、ベース ワークスペース内でこの式を評価します。

コールバックのプロパティ値を関数ハンドル、セル配列または文字ベクトルとして指定する方法の詳細については、「コールバック プロパティ値の指定方法」を参照してください。

このプロパティは、MATLAB が figure を作成するときに実行されるコールバック関数を指定します。MATLAB は CreateFcn コールバックを実行する前に figure のすべてのプロパティの値を初期化します。CreateFcn プロパティを指定しない場合、MATLAB は既定の作成関数を実行します。

作成中の figure のハンドルを取得するには、CreateFcn コードの中で関数 gcbo を使用します。

既存の figure に CreateFcn プロパティを設定しても効果はありません。

メモ

copyobj または textwrap (関数 copyobj を呼び出す) を CreateFcn 内で呼び出さないでください。figure オブジェクトをコピーすると、CreateFcn コールバックが繰り返し実行されます。

Figure 削除関数。次の値のいずれかとして指定します。

  • 関数ハンドル。

  • 最初の要素が関数ハンドルであるセル配列。セル配列内のその後の要素はコールバック関数に渡される引数です。

  • 有効な MATLAB 式を含む文字ベクトル。たとえば、'disp(''hello world'')' は関数 disp を呼び出します。MATLAB は、ベース ワークスペース内でこの式を評価します。

コールバックのプロパティ値を関数ハンドル、セル配列または文字ベクトルとして指定する方法の詳細については、「コールバック プロパティ値の指定方法」を参照してください。

DeleteFcn プロパティは、MATLAB が figure を削除するときに実行されるコールバック関数を指定します (エンド ユーザーが Figure を削除するときなど)。MATLAB は figure のプロパティを破棄する前に DeleteFcn コールバックを実行します。DeleteFcn プロパティを指定しない場合、MATLAB は既定の削除関数を実行します。

削除中の figure のハンドルを取得するには、DeleteFcn コードの中で関数 gcbo を使用します。

識別子

すべて展開する

現在の Figure のターゲットの座標軸。Axes オブジェクト、PolarAxes オブジェクト、または HeatmapChart などのグラフィックス オブジェクトとして指定します。

axes オブジェクトの子オブジェクトが存在するすべての Figure には、常に現在の座標軸があります。現在の座標軸は、最上層の座標軸でなくてもかまいません。また、ある座標軸を現在の座標軸に設定しても、他のすべての座標軸より上位に再スタックされることはありません。Figure に座標軸が含まれていない場合、get(gcf,'CurrentAxes') コマンドは空の配列を返します。

座標軸が存在しない場合に座標軸の作成を強制せずに現在の axes オブジェクトを取得するには、CurrentAxes プロパティをクエリします。

Figure 内で最後に選択されたコンポーネント。オブジェクトとして指定します。MATLAB は CurrentObject プロパティにユーザーが最後にクリックしたオブジェクトを設定します。これは、最前面に表示されるオブジェクトです。このプロパティは、ユーザーが選択したオブジェクトを判定するために使用できます。

オブジェクトの HitTest プロパティは、このオブジェクトが CurrentObject になるかどうかを制御します。

HandleVisibility プロパティが off であるオブジェクト (軸ラベルやタイトルなど) をクリックすると、CurrentObject プロパティは空に設定されます。ユーザーが非表示のオブジェクトをクリックしたときに空の値が返るのを回避するには、非表示のオブジェクトの HitTest プロパティを 'off' に設定します。

カーソルをオブジェクトの上に移動しても CurrentObject は更新されません。このプロパティを更新するには、ユーザーはオブジェクトをクリックしなければなりません。関連情報については、CurrentPoint プロパティを参照してください。

現在のオブジェクトに素早くアクセスする手段が必要な場合は、gco コマンドの使用を検討してください。

FIG ファイル名。文字ベクトルとして指定します。GUIDE はこのプロパティを使用して、保存する UI レイアウト ファイルの名前を格納します。

例: figure('FileName','myfile.fig') は、FIG ファイル名を myfile.fig に設定します。

Figure の番号を割り当てる機能。'on' または 'off' で指定します。

IntegerHandle プロパティを 'on' に設定した場合、MATLAB は既存の Figure によって使用されていない最小の整数値を探して、その値を Number プロパティに設定します。Figure を削除した場合、MATLAB はその番号を新しい Figure ウィンドウで再利用します。

IntegerHandle プロパティを 'off' に設定した場合、MATLAB はその Figure に整数値を割り当てず、Number プロパティを空の配列 ([]) に設定します。

このプロパティは読み取り専用です。

Figure の番号。整数または空の配列として返されます。この値を使用して Figure を参照できます。たとえば、figure(2) と指定すると、Number プロパティ値が 2 の Figure が現在の Figure になります。

IntegerHandle プロパティが 'off' に設定されている場合、Number は空の配列です。

IntegerHandle'on' の場合、Number プロパティの値は整数です。Figure オブジェクトが削除された場合、MATLAB は次の Figure にその番号を再使用します。

このプロパティは読み取り専用です。

Figure オブジェクトのタイプ。'figure' として返されます。このプロパティを使用して、プロット階層内にある特定のタイプのすべてのオブジェクトを見つけます。

Figure 識別子。文字ベクトルとして指定します。この値は、figure の識別子として機能します。コードの他の部分から figure にアクセスする必要がある場合、関数 findobj を使用して Tag 値に基づいて figure を検索できます。

例: figure('Tag','plotwindow') は、タグ識別子が 'plotwindow' の Figure を作成します。

figure オブジェクトに関連付けるデータ。任意の配列として指定します。UserData を指定すると、UI 内や複数の UI 間でデータ値を共有するときに役立ちます。詳細は、「コールバック間のデータ共有」を参照してください。

例: [1 2 3]

例: 'April 21'

例: struct('value1',[1 2 3],'value2','April 21')

例: {[1 2 3],'April 21'}

親/子

すべて展開する

Figure の親。root オブジェクトとして返されます。

figure の子。空の GraphicsPlaceholder または 1 次元のオブジェクト配列として返されます。

figure の Children プロパティを使用して子の追加や削除を行うことはできません。このプロパティは、子のリストの参照や子の並べ替えに使用します。この配列内の子の順序は、画面上のコンポーネントの前から後ろへの順序 (重なり順序) を反映します。

このリストに子を追加するには、子コンポーネントの Parent プロパティをこの figure オブジェクトに設定します。

HandleVisibility プロパティが 'off' に設定されているオブジェクトは、Children プロパティにリストされません。詳細は、HandleVisibility プロパティの説明を参照してください。

figure オブジェクトの可視性。'on''callback' または 'off' として指定します。

このプロパティは、figure が親 (root) オブジェクトの子のリストに含まれるかどうかを決定します。HandleVisibility は、ユーザー インターフェイス コンポーネント (ダイアログ ボックスなど) のみを含む Figure 内にコマンド ラインから誤って描画したり、Figure を削除することを防ぐ場合に有効です。

オブジェクトが親オブジェクトの子のリストに含まれていない場合、オブジェクト階層を探索してオブジェクトを検出する関数やプロパティのクエリによってこのオブジェクトが返されることはありません。このような関数には、getfindobj, gcagcfgco, newplotclaclfclose などがあります。

HandleVisibility プロパティの値が 'callback' または 'off' の設定によって制限されている場合、そのオブジェクトは親オブジェクトの Children プロパティに出現せず、Figure はルートの CurrentFigure プロパティに出現せず、オブジェクトはルートの CallbackObject プロパティまたは Figure の CurrentObject プロパティに出現せず、座標軸は親の CurrentAxes プロパティに出現しません。

ルートの ShowHiddenHandles プロパティを 'on' に設定すると、個々のオブジェクトの HandleVisibility の設定にかかわりなく、すべてのオブジェクトが可視になります。これによって HandleVisibility プロパティの値が影響を受けることはありません。

ポインター

すべて展開する

ポインター シンボル。次の表のシンボル名のいずれかまたは 'custom' として指定します。シンボルの外観はオペレーティングシステムによって異なります。

シンボル名

結果のシンボル (システム依存)

'arrow'

'ibeam'

'crosshair'

'watch' (処理中のシステム)

'topl' または 'botr'

'topr' または 'botl'

'circle'

'cross'

'fleur'

'left' または 'right'

'top' または 'bottom'

'hand'

メモ

'fullcrosshair' オプションは R2014b で削除されました。

カスタム ポインター シンボル

カスタム ポインター シンボルを作成するには、Pointer プロパティを 'custom' に設定し、PointerShapeCData プロパティを使用してシンボルを定義します。詳細は、PointerShapeCData プロパティを参照してください。

カスタム ポインター シンボル。3232 列の行列 (32 x 32 ピクセルのポインター) または 1616 列の行列 (16 x 16 ピクセルのポインター) として指定します。Figure は、Pointer プロパティが 'custom' に設定されている場合にこのポインター シンボルを使用します。

行列の各要素が、ポインター内の 1 ピクセルの輝度を定義します。行例の要素 (1,1) が、ポインターの左上隅のピクセルに対応します。行列の要素を次の値のいずれかに設定します。

  • 1 — 黒のピクセル。

  • 2 — 白のピクセル。

  • NaN — 透明なピクセル。下の画面をそのまま表示します。

ポインターのアクティブなピクセル。2 要素ベクトルとして指定します。このベクトルには、目的のアクティブなピクセルに対応する PointerShapeCData 行列の特定要素の行と列のインデックスが含まれます。既定値 [1 1] は、ポインターの左上隅のピクセルに対応します。

PointerShapeCData 行列の範囲外の値を指定すると、ポインターは、代わりに既定のアクティブなピクセル [1 1] を使用します。

このプロパティは、Pointer プロパティが 'custom' に設定されている場合にのみ適用されます。

印刷と保存

すべて展開する

印刷時または保存時のページ上での Figure のサイズと位置。[left bottom width height] の形式の 4 要素ベクトルとして指定します。

  • left 値と bottom 値 — ページの左下隅から Figure の左下隅までの距離を制御します。これらの値は、PNG 形式や EPS 形式など、ページのない形式で Figure を保存する場合は無視されます。

  • width 値と height 値 — Figure のサイズを制御します。幅と高さの値が大きすぎる場合、Figure が指定サイズに達しないことがあります。Figure が指定サイズに達しない場合、その Figure 上の UI コンポーネント (uicontrol や uitable など) が期待どおりに保存または印刷されない場合があります。

PaperUnits プロパティは、PaperPosition 値の測定単位を決定します。PaperUnits プロパティを 'normalized' に設定することを検討してください。この設定を使用すると、MATLAB は、ページ サイズにかかわらず印刷ページの相対的な占有サイズが同じになるように、Figure のサイズを自動的に調整します。

例: figure('PaperPosition',[.25 .25 8 6]) は、出力する Figure のサイズと位置を [.25 .25 8 6] に設定します。

印刷時または保存時に Figure の表示サイズを使用する命令。'auto' または 'manual' として指定します。

  • 'auto' — Figure の印刷サイズまたは保存サイズを Figure の表示サイズに一致させます。PaperPosition プロパティの width 値と height 値がディスプレイ上の Figure のサイズと等しくなります。leftbottom の値は、Figure が中央に配置される値になります。ディスプレイ上で Figure のサイズが変更された場合、PaperPosition プロパティは適切なサイズと位置の値に自動的に更新されます。

  • 'manual' — Figure の印刷サイズまたは保存サイズが Figure の表示サイズと一致しないことがあります。ディスプレイ上とは異なるサイズを使用して Figure の印刷や保存を行う場合、あるいは印刷ページや保存ページの中央に Figure を配置しない場合に、このオプションを使用します。PaperPosition プロパティを目的のサイズと位置に設定します。ディスプレイ上の Figure のサイズが変更された場合、PaperPosition プロパティは自動的に更新されません。

表示されている Figure と同じサイズと解像度 (DPI) をもつ出力を生成するには、Figure の PaperPositionMode プロパティを 'auto' に設定し、print-r0 オプションを指定して Figure を保存します。-r0 オプションを使用すると、出力の解像度がディスプレイの解像度と確実に同じになります。解像度が異なる場合、生成された出力のサイズは Figure の測定単位での表示サイズ (インチ、cm、ポイント) と一致しますが、ピクセル単位では一致しません。たとえば、ディスプレイの解像度が 100 DPI の場合、4 x 5 インチの Figure は 400 x 500 ピクセルです。出力の解像度が 200 DPI の場合、Figure の印刷サイズまたは保存サイズはインチ単位では同じサイズですが、800 x 1000 ピクセルになります。

メモ

R2016a 以降、既定値は 'auto' となります。従来の既定値は 'manual' でした。

既定値を変更するには、次のいずれかの手法を使用します。

  • 印刷設定を指定する。印刷設定はすべての MATLAB セッションで維持されます。印刷設定は 'auto' または 'manual' のいずれかに設定でき、たとえば次のようになります。

    matlab.graphics.internal.setPrintPreferences('DefaultPaperPositionMode','manual')
    現在の印刷設定の値をクエリするには、次のコマンドを使用します。設定が指定されている場合、このコマンドは 'auto' または 'manual' を返します。設定が指定されていない場合、このコマンドは 'unset' を返します。
    matlab.graphics.internal.getPrintPreferences

  • root オブジェクトに既定値を設定する。このオプションは、現在の MATLAB セッションの新しい Figure のみに適用され、たとえば次のようになります。

    set(groot,'defaultFigurePaperPositionMode','manual')

印刷時または保存時の Figure の背景色。次のいずれかの値として指定します。

  • 'on' — Figure の背景色および座標軸の背景色を白に変更します。

  • 'off' — ディスプレイ上と同じ色を使用します。ディスプレイ上の Figure の背景色を変更するには、Figure の Color プロパティを使用します。座標軸の背景色を変更するには、座標軸の Color プロパティを使用します。

ページ付き形式 (PDF および PostScript® の形式) で Figure を印刷または保存するときの標準ページ サイズ。次の表のいずれかの値として指定します。PaperType プロパティを指定すると、PaperSize プロパティが対応するページ サイズに設定されます。

ページ サイズ (幅 x 高さ)

'usletter'

8.5 x 11 インチ (米国での既定値)

'uslegal'

8.5 x 14 インチ

'tabloid'

11 x 17 インチ

'a0'

84.1 x 118.9 cm

'a1'

59.4 x 84.1 cm

'a2'

42 x 59.4 cm

'a3'

29.7 x 42 cm

'a4'

21 x 29.7 cm (ヨーロッパおよびアジアでの既定値)

'a5'

14.8 x 21 cm

'b0'

102.9 x 145.6 cm

'b1

72.8 x 102.8 cm

'b2'

51.4 x 72.8 cm

'b3'

36.4 x 51.4 cm

'b4'

25.7 x 36.4 cm

'b5'

18.2 x 25.7 cm

'arch-a'

9 x 12 インチ

'arch-b'

12 x 18 インチ

'arch-c'

18 x 24 インチ

'arch-d'

24 x 36 インチ

'arch-e'

36 x 48 インチ

'a'

8.5 x 11 インチ

'b'

11 x 17 インチ

'c'

17 x 22 インチ

'd'

22 x 34 インチ

'e'

34 x 43 インチ

'custom'

カスタム ページ サイズ。PaperSize プロパティを使用して非標準のページ サイズを指定すると PaperPosition がこの値に設定されます。

ページ付き形式 (PDF および PostScript の形式) で Figure を印刷または保存するときのカスタム ページ サイズ。[width height] の形式の 2 要素ベクトルとして指定します。米国での既定値は [8.5 11] です。ヨーロッパおよびアジアでの既定値は [21 29.7] です。

メモ

Figure をファイルに保存する場合、PaperSize プロパティは PDF および PostScript のファイル形式にのみ作用します。その他のファイル形式では、このプロパティは無視されます。保存済みの Figure のサイズを制御するには、PaperPosition プロパティを使用してください。

PaperUnits プロパティは、PaperSize プロパティの測定単位を決定します。PaperUnits プロパティが 'normalized' に設定されている場合、PaperSize プロパティを設定することはできません。設定しようとするとエラーになります。

PaperSize プロパティを指定すると、PaperType プロパティが存在する場合は対応するタイプに設定され、それ以外の場合には 'custom' に設定されます。

Figure をページ付き形式 (PDF および PostScript の形式) に印刷または保存するときのページの向き。次のいずれかの値として指定します。

  • 'portrait' — 用紙の長辺を縦方向にします。

  • 'landscape' — 用紙の長辺を横方向にします。

詳細は、関数 orient を参照してください。

PaperSize および PaperPosition に使用される単位。次のいずれかの値として指定します。

  • 'inches' — インチ単位の値。ロケールが米国の場合の既定値です。

  • 'normalized' — 正規化された単位。ページの左下隅は (0,0) にマッピングされ、右上隅は (1,1) にマッピングされます。

  • 'centimeters' — cm 単位の値。ロケールがヨーロッパまたはアジアの場合の既定値です。

  • 'points' — ポイント単位の値。1 ポイントは 1/72 インチです。

メモ

PaperUnits プロパティの値を変更した場合、PaperUnits プロパティが変更されていないことを前提としている他の関数に影響を及ぼさないように、計算終了後に元の値に戻すことをお勧めします。

この情報は役に立ちましたか?