パッケージ org.opengion.hayabusa.io

## クラス JsChartData

- java.lang.Object
- - org.opengion.hayabusa.io.JsChartData

-     public class JsChartData
      extends Object

  JsChartData は、JsChartData の個別属性を管理しているデータ管理クラスです。 内部には、data:datasets: の 要素の属性と、options:scales:yAxes: の 要素の属性を管理します。 chartColumn 、useAxis 属性は別管理で、ticks と、gridLines は、関連する属性を無効化します。 datasetOptions と、yAxesOptions は、直接追加されますので、既存の属性をセットしている場合は、 動作保障できません。
  変更履歴:
    5.9.17.2 (2017/02/08) 新規作成, 7.0.1.1 (2018/10/22) 大幅見直し
  バージョン
    5.9.17.2 2017/02/08
  作成者
    T.OTA
  導入されたバージョン:
    JDK7.0

- - ### フィールドの概要

    フィールド
    修飾子とタイプ | フィールド | 説明
    --- | --- | ---
    `static String` | `AXIS` | ﾁｬｰﾄ属性 "axis"
    `static String` | `DATASET` | ﾁｬｰﾄ属性 "dataset"
    `static String` | `GRID_LINES` | ﾁｬｰﾄ属性 "gridLines"
    `static String` | `SCALE_LABEL` | ﾁｬｰﾄ属性 "scaleLabel"
    `static String` | `TICKS` | ﾁｬｰﾄ属性 "ticks"
    `static String` | `TIME` | ﾁｬｰﾄ属性 "time"

  - ### コンストラクタの概要

    コンストラクタ
    コンストラクタ | 説明
    --- | ---
    `JsChartData()` | デフォルトコンストラクター

  - ### メソッドの概要

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッド | 説明
    --- | --- | ---
    `void` | `addAxis​(String key, String val, boolean isNum)` | キーと設定値をaxisに追加します。
    `void` | `addDataset​(String key, String val, boolean isNum)` | キーと設定値をdatasetに追加します。
    `void` | `addOptions​(String bufKey, String val)` | 指定のバッファーに、オプション属性を追加します。
    `void` | `addTicks​(String key, String val, boolean isNum)` | キーと設定値をaxisのticks に追加します。
    `void` | `addTime​(String key, String val, boolean isNum)` | キーと設定値をaxisのtime に追加します。
    `boolean` | `contains​(String bufKey, String key)` | バッファキー内に、設定キーの値がすでに登録済みかどうか(あればtrue)を判定します。
    `String` | `getAxis()` | JsChartData オブジェクトのoptions:scales:yAxes: パラメータ情報を取得します。
    `String` | `getAxisKey()` | JsChartData オブジェクトのoptions:scales:yAxes: パラメータ情報の変数名を取得します。
    `String` | `getChartColumn()` | JsChartData オブジェクトを作成する時のチャートカラムを取得します。
    `String` | `getDataset​(char xy)` | JsChartData オブジェクトのdata:datasets: パラメータ情報を取得します。
    `String` | `getDatasetKey()` | JsChartData オブジェクトのdata:datasets: パラメータ情報の変数名を取得します。
    `boolean` | `isUseAxis()` | y軸表示を使用するかどうか(true/false)を設定します。
    `void` | `setChartColumn​(String chartColumn)` | チャートカラムを設定します。
    `void` | `setId​(String id)` | ﾃﾞｰﾀﾁｬｰﾄのIDを指定します。
    `void` | `setUseAxis​(boolean flag)` | y軸表示を使用するかどうか(true/false)を設定します。
    `void` | `setUseTime​(boolean flag)` | x軸の時間表示を使用するかどうか(true/false)を設定します。
    `String` | `toString()` | 内部バッファを文字列にして返します。

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### フィールドの詳細

    - #### DATASET

          public static final String DATASET

      ﾁｬｰﾄ属性 "dataset"
      関連項目:
        定数フィールド値

    - #### AXIS

          public static final String AXIS

      ﾁｬｰﾄ属性 "axis"
      関連項目:
        定数フィールド値

    - #### TICKS

          public static final String TICKS

      ﾁｬｰﾄ属性 "ticks"
      関連項目:
        定数フィールド値

    - #### TIME

          public static final String TIME

      ﾁｬｰﾄ属性 "time"
      関連項目:
        定数フィールド値

    - #### SCALE_LABEL

          public static final String SCALE_LABEL

      ﾁｬｰﾄ属性 "scaleLabel"
      関連項目:
        定数フィールド値

    - #### GRID_LINES

          public static final String GRID_LINES

      ﾁｬｰﾄ属性 "gridLines"
      関連項目:
        定数フィールド値

  - ### コンストラクタの詳細

    - #### JsChartData

          public JsChartData()

      デフォルトコンストラクター
      変更履歴:
        6.9.7.0 (2018/05/14) PMD Each class should declare at least one constructor

  - ### メソッドの詳細

    - #### setChartColumn

          public void setChartColumn​(String chartColumn)

      チャートカラムを設定します。
      パラメータ:
        `chartColumn` - チャートカラム

    - #### getChartColumn

          public String getChartColumn()

      JsChartData オブジェクトを作成する時のチャートカラムを取得します。
      戻り値:
        チャートカラム

    - #### setId

          public void setId​(String id)

      ﾃﾞｰﾀﾁｬｰﾄのIDを指定します。 yAxisIDに使用するキーとなるid ( yAxisID=yid+'Ax' )
      パラメータ:
        `id` - 固有の名前
      変更履歴:
        7.0.1.1 (2018/10/22) 属性の追加。

    - #### setUseAxis

          public void setUseAxis​(boolean flag)

      y軸表示を使用するかどうか(true/false)を設定します。 使用するとは、yAxisID属性を、内部的に登録します。
      パラメータ:
        `flag` - true:使用する/false:使用しない

    - #### isUseAxis

          public boolean isUseAxis()

      y軸表示を使用するかどうか(true/false)を設定します。
      戻り値:
        true:使用する/false:使用しない

    - #### setUseTime

          public void setUseTime​(boolean flag)

      x軸の時間表示を使用するかどうか(true/false)を設定します。 使用しない場合は、time バッファーを axis 属性に追加しません。
      パラメータ:
        `flag` - true:使用する/false:使用しない

    - #### addDataset

          public void addDataset​(String key,
                                 String val,
                                 boolean isNum)

      キーと設定値をdatasetに追加します。
      パラメータ:
        `key` - キー
        `val` - 設定値(前後のクオーテーション等は、付いているものとします。)
        `isNum` - 数値項目/boolean項目かどうか(true:数値要素/false:文字または配列要素)

    - #### addAxis

          public void addAxis​(String key,
                              String val,
                              boolean isNum)

      キーと設定値をaxisに追加します。 ※ chartJS上は、Axes(axisの複数形)と、Axis を使い分けていますが、属性は、axis で統一します。
      パラメータ:
        `key` - キー
        `val` - 設定値(前後のクオーテーション等は、付いているものとします。)
        `isNum` - 数値項目かどうか(true:数値要素/false:文字または配列要素)

    - #### addTicks

          public void addTicks​(String key,
                               String val,
                               boolean isNum)

      キーと設定値をaxisのticks に追加します。
      パラメータ:
        `key` - キー
        `val` - 設定値(前後のクオーテーション等は、付いているものとします。)
        `isNum` - 数値項目かどうか(true:数値要素/false:文字または配列要素)

    - #### addTime

          public void addTime​(String key,
                              String val,
                              boolean isNum)

      キーと設定値をaxisのtime に追加します。
      パラメータ:
        `key` - キー
        `val` - 設定値(前後のクオーテーション等は、付いているものとします。)
        `isNum` - 数値項目かどうか(true:数値要素/false:文字または配列要素)

    - #### addOptions

          public void addOptions​(String bufKey,
                                 String val)

      指定のバッファーに、オプション属性を追加します。 オプション属性は、各バッファーの一番最後にまとめて追加します。 key:val の関係ではなく、val だけをそのまま追加していきます。 オプションの追加は、まとめて最後に行いますので、このメソッド上では 最後にカンマは付けません。必要であれば、追加する設定値にカンマをつけてください。
      パラメータ:
        `bufKey` - キー [dataset,axis,ticks,time,scaleLabel,gridLines] が指定可能
        `val` - 設定値

    - #### contains

          public boolean contains​(String bufKey,
                                  String key)

      バッファキー内に、設定キーの値がすでに登録済みかどうか(あればtrue)を判定します。 一般とオプションの両方を検索します。
      パラメータ:
        `bufKey` - チェックするバッファのキー
        `key` - キー
      戻り値:
        すでに登録済みかどうか [true:登録済み/false:未登録]
      変更履歴:
        7.0.1.3 (2018/11/12) バッファキー検索処理追加

    - #### getDataset

          public String getDataset​(char xy)

      JsChartData オブジェクトのdata:datasets: パラメータ情報を取得します。 ここで返す値は、yidが、'y0' とすると、 var y0Ds = { dataset.toString() } ; という文字列を返します。 引数は、'x' か 'y' を指定します。 通常、Y軸表示を行う場合は、'y' を指定しまが、horizontalBar 使用時は、 'x' を指定することになります。 ただし、useAxis=false の場合は、(x,y)AxisID は出力されません。
      パラメータ:
        `xy` - idのｷｰﾜｰﾄﾞ [x,y]
      戻り値:
        ﾊﾟﾗﾒｰﾀ文字列
      変更履歴:
        7.0.1.1 (2018/10/22) data:datasets: パラメータ情報

    - #### getDatasetKey

          public String getDatasetKey()

      JsChartData オブジェクトのdata:datasets: パラメータ情報の変数名を取得します。 ここで返す値は、yidが、'y0' とすると、 "y0Ds" という文字列を返します。
      戻り値:
        ﾊﾟﾗﾒｰﾀ文字列
      変更履歴:
        7.0.1.1 (2018/10/22) data:datasets: パラメータ変数名

    - #### getAxis

          public String getAxis()

      JsChartData オブジェクトのoptions:scales:yAxes: パラメータ情報を取得します。 ここで返す値は、yidが、'y0' とすると、 var y0Ax = { addAxis.toString() } ; という文字列を返します。 ただし、useAxis=false の場合は、ゼロ文字列を返します。
      戻り値:
        ﾊﾟﾗﾒｰﾀ文字列
      変更履歴:
        7.0.1.1 (2018/10/22) options:scales:yAxes: パラメータ情報

    - #### getAxisKey

          public String getAxisKey()

      JsChartData オブジェクトのoptions:scales:yAxes: パラメータ情報の変数名を取得します。 ここで返す値は、yidが、'y0' とすると、 "y0Ax ," という文字列を返します。便宜上、後ろのコロンも追加しています。 その際、useAxis=false の場合は、空文字列を返します。 ※ chartJS上は、Axes(axisの複数形)と、Axis を使い分けていますが、属性は、axis で統一します。
      戻り値:
        ﾊﾟﾗﾒｰﾀ文字列
      変更履歴:
        7.0.1.1 (2018/10/22) options:scales:yAxes:パラメータ情報の変数名

    - #### toString

          public String toString()

      内部バッファを文字列にして返します。
      オーバーライド:
        `toString` クラス内 `Object`
      戻り値:
        内部バッファを文字列にして返します。
      このメソッドは、nullを返しません