# captions

グラフの表題を描画

## 呼び出し手順

    hl=captions(h, strings [,location])

## 引数

h

  ポリラインエンティティのハンドルのベクトル.

strings

  n個の文字列のベクトル , strings(i) は i番目のポリラインの表題

hl

  "`Legend`"型のハンドル, 表題の情報を含む構造体を指します (legend_properties参照).

location

  文字列で,以下の値を指定できます:

  - `"in_upper_right"` :表題は 軸ボックスの右上隅に描画されます.

  - `"in_upper_left"`: 表題は 軸ボックスの左上隅に描画されます.

  - `"in_lower_right"`: 表題は 軸ボックスの右下隅に描画されます.

  - `"in_lower_left"`: 表題は 軸ボックスの左下隅に描画されます.

  - `"out_upper_right"`: 表題は 軸ボックスの右上隅の右に描画されます.

  - `"out_upper_left"`: 表題は 軸ボックスの左上隅の左に描画されます.

  - `"out_lower_right"`: 表題は 軸ボックスの右下隅の右に描画されます.

  - `"out_lower_left"`: 表題は 軸ボックスの左下隅の左に描画されます.

  - `"upper_caption"`: 表題は 軸ボックスの左上隅の上に描画されます.

  - `"lower_caption"`: 表題は 軸ボックス左下隅の下に描画されます. このオプションはplot2dの`leg`引数に対応します.

  - `"by_coordinates"`: 表題ボックスの左上隅をデータ構造体の "position"フィールドで指定します. `x`および `y`座標は `axes_bounds`の大きさに対する 比で指定します.

## 説明

カレントのプロットの表題を指定した文字列をラベルにして グラフィックウインドウの左下隅に配置します. `captions` は対応するポリラインを想定した ラベルを前に付加します. 型とプロパティは指定したハンドルから取得されます:

`captions` 関数は Legend データ構造体を作成します.

各軸に付随した`Legend`が最大1個作成されます. caption 関数が`Legend`がまだ存在する時に 再度コールされた場合,古いものが置換されます.

## 例

t=0:0.1:2*%pi; a=gca();a.data_bounds=[t(1) -1.8;t($) 1.8]; a.margins(4)=0.2;

plot2d(t,[cos(t'),cos(2*t'),cos(3*t')],[1,2 3]); e=gce(); e.children(1).thickness=3; e.children(2).line_style=4;

hl=captions(e.children,['cos(t)';'cos(2*t)';'cos(3*t)']); hl=captions(e.children,['cos(t)';'cos(2*t)';'cos(3*t)'],'in_upper_right');

## 例

    t=0:0.1:2*%pi;
    a=gca();a.data_bounds=[t(1) -1.8;t($) 1.8];
    a.margins(4)=0.2;

    plot2d(t,[cos(t'),cos(2*t'),cos(3*t')],[1,2 3]);
    e=gce();
    e.children(1).thickness=3;
    e.children(2).line_style=4;

    hl=captions(e.children,['cos(t)';'cos(2*t)';'cos(3*t)']);
    hl=captions(e.children,['cos(t)';'cos(2*t)';'cos(3*t)'],'in_upper_right');

    hl.legend_location='in_upper_right'
    hl.fill_mode='on';

## 参照

- plot2d
- legend
- polyline_properties
- legend_properties