チャート作成の概要

plot、scatter、bar などのチャート関数を使うと、色やラインスタイルなどの特性の基本的な制御をしつつ、データをすばやく可視化することができます。カスタムチャートを作成するには、複数のグラフィックスオブジェクトを組み合わせ、それらのオブジェクトにプロパティを設定し、あるいは追加の関数を呼び出すことができます。R2019a 以前のリリースでは、カスタマイズコードを保存し他者と共有する一般的な方法は、スクリプトまたは関数の作成です。

R2019b 以降は、ChartContainer 基底クラスのサブクラスを定義することにより、チャートのクラスの実装を作成することができます。クラスを作成することで、以下が可能になります。

ユーザーに便利なインターフェイスを提供 — ユーザーがチャートの特性をカスタマイズする場合、グラフィックスコードの変更と再実行を行うことなしに、プロパティを設定することができます。ユーザーはコマンドラインでプロパティを変更したり、プロパティインスペクターでプロパティを確認できます。
アルゴリズムとプリミティブグラフィックスオブジェクトをカプセル化 — 計算を実行し、基となるグラフィックスオブジェクトを管理するメソッドを実装します。コードをこの方法で整理することで、ユーザーに対し実装の詳細を非表示にすることができます。

この基底クラスから派生するチャートを定義した場合、チャートのインスタンスはグラフィックスオブジェクト階層のメンバーになります。その結果、チャートはグラフィックスシステムと多くの面で互換性を有するようになります。たとえば、関数 gca と関数 findobj はチャートのインスタンスを返すことができます。

チャートクラスの構造

チャートクラスの最初の行は、matlab.graphics.chartcontainer.ChartContainer クラスをスーパークラスとして指定します。たとえば、ConfidenceChart というクラスの最初の行は、次のようになります。

classdef ConfidenceChart < matlab.graphics.chartcontainer.ChartContainer

スーパークラスの指定に加えて、以下のコンポーネントをユーザークラス定義に含めます。

コンポーネント	説明
パブリックプロパティブロック (推奨)	このブロックは、ユーザーにアクセス権をもたせるすべてのプロパティを定義します。これらのプロパティが一緒になって、チャートのユーザーインターフェイスを構成します。
プライベートプロパティブロック (推奨)	このブロックには、ユーザーによるアクセスが望ましくない、基となるグラフィックスオブジェクトと実装の他の詳細が保存されます。このブロックでは、以下の属性値が設定されます。 `Access = private` `Transient` `NonCopyable`
`setup` メソッド (必須)	このメソッドは、チャートの初期状態を設定します。MATLAB^® がオブジェクトを作成すると 1 回実行されます。保護されたブロック内でこのメソッドを定義します。
`update` メソッド (必須)	このメソッドは、チャート内の基となるオブジェクトを更新します。次回の `drawnow` の実行中、ユーザーが 1 つ以上のプロパティ値を変更した後に実行されます。このメソッドは、`setup` メソッドと同じ保護されたブロック内で定義します。

暗黙的なコンストラクターメソッド

コンストラクターは ChartContainer 基底クラスから継承されるため、ユーザークラス用にコンストラクターメソッドを作成する必要はありません。コンストラクターは、オプションの入力引数 (親コンテナーと、チャートにプロパティを設定するための任意数の名前と値のペアの引数) を受け入れます。たとえば、パブリックプロパティ XData および YData をもつ ConfidenceChart というクラスを定義する場合、次のいずれかのコマンドを使用してユーザークラスのインスタンスを作成できます。

c = ConfidenceChart(gcf,'XData',[1 2 3],'YData',[4 5 6])
c = ConfidenceChart('XData',[1 2 3],'YData',[4 5 6])

通常の関数と同じやり方で入力引数を受け入れるインターフェイスを提供する場合は、カスタムコンストラクターメソッドを定義できます。詳細については、チャートクラスのコンストラクターの作成を参照してください。

パブリックおよびプライベートのプロパティブロック

ユーザークラスのプロパティを、少なくとも 2 つのブロック間で分割します。

ユーザー向けインターフェイスのコンポーネントを保存するためのパブリックブロック
非表示にする実装の詳細を保存するためのプライベートブロック

パブリックブロックに収められるプロパティは、ユーザーの指定する入力値を保存します。たとえば、ラインを表示するチャートでは、x 座標と y 座標のベクトルが 2 つのパブリックプロパティに保存される場合があります。プロパティの名前と値のペアの引数は暗黙的なコンストラクターメソッドのオプション入力であるため、パブリックプロパティを既定値に初期化する方法が推奨されます。座標の値を保存するパブリックプロパティを定義する場合、それらを NaN 値や空の配列に初期化すると、入力なしでユーザーがそのコンストラクターを呼び出した場合には空のチャートが構成されます。

プライベートブロックに収められるプロパティには、保存するすべての計算値に加えて、チャートを構成する基となるグラフィックスオブジェクトが保存されます。最終的に、ユーザークラスはパブリックプロパティ内のデータを使用して、基となるオブジェクトを構成します。プライベートブロックに Transient 属性と NonCopyable 属性を含めることで、ユーザーがチャートのインスタンスをコピーする場合や保存する場合に、冗長な情報が保存されることを回避します。

たとえば、次に挙げるのは Line オブジェクトと Patch オブジェクトを表示するチャートのプロパティブロックです。パブリックプロパティブロックには、ラインの x 座標と y 座標、信頼余裕の値、マーカー記号、カラー値など、ユーザーが制御できる値が保存されています。プライベートプロパティブロックには、Line オブジェクトと Patch オブジェクトが保存されています。

properties
    XData = NaN
    YData = NaN
    ConfidenceMargin = 0.15
    MarkerSymbol = 'o'
    Color = [1 0 0]    
end
    
properties(Access = private,Transient,NonCopyable)
    LineObject
    PatchObject
end

setup メソッド

setup メソッドは、MATLAB がチャートオブジェクトを構成する際に 1 回実行されます。名前と値のペアの引数としてコンストラクターメソッドに渡されたプロパティ値は、このメソッドの実行後に割り当てられます。

次の場合に setup メソッドを使用します。

プロット関数を呼び出して、チャートで使用するプリミティブグラフィックスオブジェクトを作成する。
プロット関数で返されるプリミティブオブジェクトを、プライベートプロパティとしてチャートオブジェクトに保存する。
プリミティブグラフィックスオブジェクトを構成する。
座標軸を構成する。

多くのグラフィックス関数には、ターゲットの axes オブジェクトを指定するためのオプションの入力引数があります。このような関数には、プロット関数 (plot、scatter、bar など)、および座標軸を変更する関数 (hold、grid、title など) が含まれます。クラスメソッド内からこれらのタイプの関数を呼び出す場合は、ターゲットの axes オブジェクトを指定しなければなりません。axes オブジェクトにアクセスするには、getAxes メソッドを呼び出します。このメソッドは axes オブジェクトを返します。ただし、チャートに axes オブジェクトがまだない場合は、直交 axes オブジェクトを作成します。

注意

プロット関数、または座標軸を変更する関数を呼び出すときにターゲット座標軸を指定しない場合、予期しない結果の生じることがあります。

setup メソッドでプロット関数を呼び出す場合は、座標データとして一時的な値 (NaN など) を指定します。また、クラスのパブリックプロパティに対応する他の引数にも一時的な値を指定します。これにより、setup メソッドと update メソッドの両方に同じプロパティ値を設定することが回避されます。

複数のプリミティブオブジェクトを座標軸に表示する場合は、プロットコマンドの間で関数 hold を呼び出します。最後のプロットコマンドの後で、ホールド状態を 'off' に戻します。

たとえば、ラインとパッチを表示するチャートの場合を考えます。次の 3 つのプロパティがあります。

ラインの x 座標と y 座標を保存するための、XData および YData という 2 つのパブリックプロパティ
LineObject および PatchObject という 2 つのプライベートプロパティ

setup メソッドは、getAxes メソッドを呼び出すことで axes オブジェクトを取得します。続いて、関数 patch を呼び出し、その出力を PatchObject プロパティに格納します。コードの次の行では、座標軸のホールド状態を 'on' に設定してから、関数 plot を呼び出して LineObject プロパティを作成します。コードの最終行では、座標軸のホールド状態が 'off' に戻されます。

function setup(obj)
    % Get the axes
    ax = getAxes(obj);
            
    % Create Patch and Line objects
    obj.PatchObject = patch(ax,NaN,NaN,'r','FaceAlpha',0.2,...
        'EdgeColor','none');
    hold(ax,'on')
    obj.LineObject = plot(ax,NaN,NaN);
            
    % Turn hold state off
    hold(ax,'off')
end

update メソッド

ユーザーが 1 つ以上のプロパティ値をチャートオブジェクトで変更すると、MATLAB はそのチャートオブジェクトを更新用にマークします。update メソッドは、setup メソッドの実行後に初めて実行されます。その後、drawnow の次回の実行時に実行されます。関数 drawnow は、ユーザーの MATLAB セッションにおけるグラフィックス環境の状態に基づき、定期的に自動実行されます。したがって、プロパティ値を変更してから、それら変更の結果が表示されるまでには遅延が生ずる場合があります。

update メソッドを使用して、プロパティの新しい値を基に、チャート内の基となるグラフィックスオブジェクトを再構成します。通常、このメソッドではどのプロパティが変更されたかを区別しません。プロパティに依存する、基となるグラフィックスオブジェクトのすべての特性が再構成されます。

たとえば、次のプロパティをもつチャートについて考えます。

XData および Color という 2 つのパブリックプロパティ
LineObject および PatchObject という 2 つのプライベートプロパティ

update メソッドは、Line オブジェクトと Patch オブジェクトの XData プロパティと Color プロパティを更新します。

function update(obj)
            
    % Update XData of line object
    obj.LineObject.XData = obj.XData;
            
    % Update patch XData 
    x = obj.XData;
    obj.PatchObject.XData = [x x(end:-1:1)];
            
    % Update line object colors
    obj.LineObject.Color = obj.Color;
    obj.PatchObject.FaceColor = obj.Color;
           
end

例: 信頼限界チャート

この例では、ラインを信頼限界付きでプロットするチャートの作成方法を説明します。ConfidenceChart.m という名前のクラス定義ファイルを、MATLAB パス上にあるフォルダー内に作成します。以下の手順に従ってクラスを定義します。

手順	実装
`ChartContainer` 基底クラスから派生させます。	classdef ConfidenceChart < matlab.graphics.chartcontainer.ChartContainer
パブリックプロパティを定義します。	properties XData = NaN YData = NaN ConfidenceMargin = 0.15 MarkerSymbol = 'o' Color = [1 0 0] end
プライベートプロパティを定義します。	properties(Access = private,Transient,NonCopyable) LineObject PatchObject end
`setup` メソッドを実装します。この場合、関数 `plot` と関数 `patch` を呼び出して、それぞれ `Patch` オブジェクトと `Line` オブジェクトを作成します。これらのオブジェクトを、対応するプライベートプロパティに保存します。メソッドを終了する前に、座標軸のホールド状態を `'off'` に戻します。	methods(Access = protected) function setup(obj) % get the axes ax = getAxes(obj); % Create Patch and Line objects obj.PatchObject = patch(ax,NaN,NaN,'r','FaceAlpha',0.2,... 'EdgeColor','none'); hold(ax,'on') obj.LineObject = plot(ax,NaN,NaN); % Turn hold state off hold(ax,'off') end
`update` メソッドを実装します。この場合、基となるオブジェクトの x 座標と y 座標、色、およびマーカー記号を更新します。	function update(obj) % Update XData and YData of Line obj.LineObject.XData = obj.XData; obj.LineObject.YData = obj.YData; % Update patch XData and YData x = obj.XData; obj.PatchObject.XData = [x x(end:-1:1)]; y = obj.YData; c = obj.ConfidenceMargin; obj.PatchObject.YData = [y+c y(end:-1:1)-c]; % Update colors obj.LineObject.Color = obj.Color; obj.PatchObject.FaceColor = obj.Color; % Update markers obj.LineObject.Marker = obj.MarkerSymbol; end end end

次に、いくつかのパブリックプロパティを指定して暗黙的なコンストラクターメソッドを呼び出すことで、チャートのインスタンスを作成します。

x = 0:0.2:10;
y = besselj(0,x);
c = ConfidenceChart('XData',x,'YData',y,'ConfidenceMargin',0.15);

色の変更

c.Color = [0 0 1];

ヒント

ドキュメンテーションで提供されている例のほかにも、コミュニティで作成されたさまざまな例が MATLAB Central™ の File Exchange で公開されています。

共通のグラフィックス機能のサポート

既定では、チャートのインスタンスは、すべての MATLAB チャートに共通する機能の多くをサポートします。たとえば、関数 gca と関数 findobj はチャートのインスタンスを返すことができます。チャートのインスタンスを関数 set と関数 get に渡すこともでき、チャートのプロパティをプロパティインスペクターで構成することもできます。

次の表で説明されている機能は、チャートで有効にした場合にのみサポートされます。

機能	説明	詳細
凡例	関数 `legend` と Figure ツールバーの凡例ツールを有効にします。	`matlab.graphics.chartcontainer.mixin.Legend`
カラーバー	関数 `colorbar` と Figure ツールバーのカラーバーツールを有効にします。	`matlab.graphics.chartcontainer.mixin.Colorbar`
異なるタイプの座標軸、または複数の座標軸	1 つ以上の直交座標プロット、極座標プロットまたは地理プロットを表示します。	極座標軸、地理座標軸または複数の座標軸をもつチャートの作成
関数	関数 `title`、`xlim`、`ylim` など、座標軸にプロパティを設定する関数を有効にします。	座標軸プロパティを設定するための簡易関数の有効化
保存と読み込み	ユーザーがチャートを操作した後に変更内容を保管することで、チャートを保存して、MATLAB に読み戻す際にその状態を復元できるようにします。	チャートクラスのインスタンスの保存と読み込み

参考