ChartGetInteger 関数
この関数は、指定したチャートの指定したプロパティ値を取得します。取得するプロパティ値は整数型(long・bool・datetime・enum型)です。関数の呼び出し方法には 2つの型があります。
データ型と構成・戻り値
// この関数には2つの型があります
long ChartGetInteger(①, ②, ③);
bool ChartGetInteger(①, ②, ③, ④);long型の時、戻り値は、long型の値を返します。
bool型の時、戻り値は、指定したプロパティが使用可能で、その値が引数④に格納されている場合は true、それ以外は falseを返します。
発生するエラーについては、GetLastError関数で取得することができます。
引数 [4]
ChartGetInteger関数は 3～4個の引数で構成されます。
| 番 号 | 引数名 | データ型 | 単位 | 初期値 | 説明 |
|---|---|---|---|---|---|
| ① | chart_id | long | － | － | チャートIDを指定します。現在のチャートIDは「0」を指定するか、ChartID関数を使うことで取得できます。 |
| ② | prop_id | int | － | － | チャートプロパティID。ENUM_CHART_PROPERTY_INTEGER 列挙値から選択。 |
| ③ | sub_window | int | － | 0 | チャートサブウィンドウの番号。 0はメインウィンドウになります。 |
| ④ | long_var | long& | － | － | 取得したプロパティ値が設定される long型の変数。 |
使用例
ChartGetInteger 関数によるチャートプロパティの取得
現在表示しているメインチャートの高さ、幅、背景色を ChartGetInteger関数を使って取得します。
コード
// ChartGetInteger関数によるチャートプロパティの取得
#property strict
void OnInit() {
Print("チャート高さ ：",ChartGetInteger(0,CHART_HEIGHT_IN_PIXELS,0)," ピクセル");
Print("チャート幅 ：",ChartGetInteger(0,CHART_WIDTH_IN_PIXELS,0)," ピクセル");
Print("チャート背景色：",(color)ChartGetInteger(0,CHART_COLOR_BACKGROUND,0));
}コードをコンパイルして実行する方法はこちらを参考にしてください。(デモ口座でお試しください)
結果
チャートの状態であるプロパティ値を設定する場合は ChartSetInteger関数を使います。