Main Content

uicheckbox

チェック ボックス コンポーネントの作成

説明

cbx = uicheckbox は、チェック ボックスを新しい Figure ウィンドウ内に作成し、CheckBox オブジェクトを返します。MATLAB® は関数 uifigure を呼び出してこの Figure を作成します。

cbx = uicheckbox(parent) は、指定された親コンテナー内にチェック ボックスを作成します。親には、関数 uifigure を使用して作成された Figure オブジェクトか、またはその子コンテナーのいずれかを指定できます。

cbx = uicheckbox(___,Name,Value) は、1 つ以上の名前と値の引数を使用して、CheckBox プロパティを指定します。たとえば、uicheckbox("Value",1) は、オンになっているチェック ボックスを作成します。このオプションは、前述の構文のすべての入力引数の組み合わせで使用できます。

すべて折りたたむ

UI Figure 内にチェック ボックスを作成します。

fig = uifigure;
cbx = uicheckbox(fig);

Figure contains an object of type uicheckbox.

UI Figure 内にチェック ボックスを作成し、チェック ボックスのテキストを指定します。

fig = uifigure;
cbx = uicheckbox(fig,"Text","Subscribe");

Figure contains an object of type uicheckbox.

チェック ボックスの値をクエリします。

val = cbx.Value
val = logical
   0

Value プロパティを更新して、プログラムによってチェック ボックスをオンにします。

cbx.Value = 1;

Figure contains an object of type uicheckbox.

ユーザーがプロットの凡例の表示と非表示を切り替えることができるアプリを作成します。

toggleLegendApp.m という名前のファイルで、アプリを実装する関数を作成します。

  • UI Figure およびグリッド レイアウト マネージャーを作成してアプリをレイアウトします。

  • グリッド レイアウト マネージャーで UI 座標軸とチェック ボックスを作成し、座標軸にデータをプロットします。

  • プロットの凡例の表示と非表示を切り替える checkBoxChanged という名前のコールバック関数を作成し、その関数をチェック ボックスの ValueChangedFcn コールバック プロパティに割り当てます。コールバックの詳細については、プログラムで作成したアプリ用のコールバックの作成を参照してください。

function toggleLegendApp
fig = uifigure;
g = uigridlayout(fig,[2 3]);
g.RowHeight = {'1x','fit'};
g.ColumnWidth = {'1x','fit','1x'};

ax = uiaxes(g);
ax.Layout.Row = 1;
ax.Layout.Column = [1 3];
plot(ax,magic(3));
lgd = legend(ax,"hide");
cbx = uicheckbox(g,"Text","Show legend");
cbx.Layout.Row = 2;
cbx.Layout.Column = 2;

cbx.ValueChangedFcn = @(src,event) checkBoxChanged(src,event,lgd);
end

function checkBoxChanged(src,event,lgd)
val = event.Value;
lgd.Visible = val;
end

関数 toggleLegendApp を実行します。チェック ボックスをオンにして凡例を表示します。

UI figure window with axes showing some plotted data, a legend, and a selected "Show legend" check box below the axes

入力引数

すべて折りたたむ

親コンテナー。関数 uifigure を使用して作成された Figure オブジェクト、またはその子コンテナー (TabPanelButtonGroup または GridLayout) のいずれかとして指定します。親コンテナーを指定しない場合、MATLAB は関数 uifigure を呼び出し、親コンテナーとして機能する新しい Figure オブジェクトを作成します。

名前と値の引数

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

例: uicheckbox(Value=1) は、画面にオンの状態のチェック ボックスを表示するように指定します。

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

例: uicheckbox("Value",1) は、画面にオンの状態のチェック ボックスを表示するように指定します。

メモ

以下にリストするプロパティは、利用できるプロパティの一部です。完全なリストについては、CheckBox のプロパティ を参照してください。

チェック ボックスの状態。0 (false) または 1 (true) として指定します。Value プロパティが 1 に設定されている場合、チェック ボックスはオンです。Value プロパティが 0 に設定されている場合、チェック ボックスはオフです。

値が変更されたときのコールバック。次の値のいずれかとして指定します。

  • 関数ハンドル。

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

  • 有効な MATLAB 式を含む文字ベクトル (非推奨)。MATLAB は、この式をベース ワークスペースで評価します。

このコールバックは、ユーザーがアプリでチェック ボックスをオンまたはオフにしたときに実行されます。チェック ボックスの値がプログラムによって変更された場合にはコールバックは実行されません。

このコールバック関数は、ユーザーのチェック ボックス操作に関する特定の情報にアクセスできます。MATLAB は、この情報を ValueChangedData オブジェクトに格納して、2 番目の引数としてコールバック関数に渡します。App Designer では、引数は event と呼ばれます。ドット表記を使用して、オブジェクトのプロパティをクエリできます。たとえば、event.PreviousValue はチェック ボックスの直前の値を返します。ValueChangedData オブジェクトは、文字ベクトルとして指定されているコールバック関数では使用できません。

次の表に、ValueChangedData オブジェクトのプロパティを示します。

プロパティ
Valueアプリ ユーザーによる最新操作の後のチェック ボックスの値。
PreviousValueアプリ ユーザーによる最新操作の前のチェック ボックスの値。
Sourceコールバックを実行するコンポーネント。
EventName'ValueChanged'

コールバックの記述の詳細については、App Designer のコールバックを参照してください。

親を基準にしたチェック ボックスの位置とサイズ。ベクトル [left bottom width height] として指定します。次の表で、ベクトルの各要素について説明します。

要素説明
left親コンテナーの内側左端からチェック ボックスの外側左端までの距離
bottom親コンテナーの内側下端からチェック ボックスの外側下端までの距離
widthチェック ボックスの外側の右端と左端の間の距離
heightチェック ボックスの外側の上端と下端の間の距離

Position の値の基準は、親コンテナーの "描画可能領域" です。描画可能領域は、コンテナーの境界線の内側にある領域で、メニュー バーやタイトルなどの装飾が占める領域は含まれません。

すべての測定単位はピクセルです。

例: [200 200 102 15]

バージョン履歴

R2016a で導入

すべて展開する

参考

関数

プロパティ

ツール