パッケージ org.opengion.hayabusa.io
クラス JsChartData
java.lang.Object
org.opengion.hayabusa.io.JsChartData
JsChartData は、JsChartData の個別属性を管理しているデータ管理クラスです。
内部には、data:datasets: の 要素の属性と、options:scales:[x/y]: の 要素の属性を管理します。
chartColumn、useAxis 属性は別管理で、ticks と、grid:属性 は、関連する属性を無効化します。
datasetOptions と、yAxesOptions は、直接追加されますので、既存の属性をセットしている場合は、
動作保障できません。
8.0.0.0 (2021/08/31) V2 → V3 対応
scaleLabel → title
gridLines → grid
options 追加
plugins 追加(options:plugins:)
annotations 追加(plugins:annotation:annotations:)
- 変更履歴:
- 5.9.17.2 (2017/02/08) 新規作成, 7.0.1.1 (2018/10/22) 大幅見直し, 8.0.0.0 (2021/08/31) Ver3対応 大幅見直し
- 導入されたバージョン:
- JDK11.0
-
フィールドの概要
フィールド修飾子とタイプフィールド説明static final String
チャート属性 "annotations"static final String
チャート属性 "axis"static final String
チャート属性 "dataset"static final String
チャート属性 "grid"static final String
チャート属性 "options"static final String
チャート属性 "plugins"static final String
チャート属性 "ticks"static final String
チャート属性 "time"static final String
チャート属性 "title" -
コンストラクタの概要
コンストラクタ -
メソッドの概要
修飾子とタイプメソッド説明void
addAnnotations
(String key, String val, boolean isNum) キーと設定値をannotations に追加します。void
設定値をaxisに追加します。void
キーと設定値をaxisに追加します。void
addDataset
(String key, String val, boolean isNum) キーと設定値をdatasetに追加します。void
addPlugins
(String key, String val, boolean isNum) キーと設定値をplugins に追加します。void
キーと設定値をaxisのticks に追加します。void
キーと設定値をaxisのtime に追加します。boolean
バッファキー内に、設定キーの値がすでに登録済みかどうか(あればtrue)を判定します。getAxis()
JsChartData オブジェクトのoptions:scales:yAxes: パラメータ情報を取得します。JsChartData オブジェクトのoptions:scales:yAxes: パラメータ情報の変数名を取得します。JsChartData オブジェクトを作成する時のチャートカラムを取得します。getDataset
(char xy) JsChartData オブジェクトのdata:datasets: パラメータ情報を取得します。JsChartData オブジェクトのdata:datasets: パラメータ情報の変数名を取得します。エラーメッセージを返します。boolean
y軸表示を使用するかどうか(true/false)を設定します。void
setChartColumn
(String chartColumn) チャートカラムを設定します。void
データチャートのIDを指定します。void
setUseAxis
(boolean flag) y軸表示を使用するかどうか(true/false)を設定します。void
setUseTime
(boolean flag) x軸の時間表示を使用するかどうか(true/false)を設定します。toString()
内部バッファを文字列にして返します。
-
フィールド詳細
-
DATASET
チャート属性 "dataset"- 関連項目:
-
AXIS
チャート属性 "axis"- 関連項目:
-
TICKS
チャート属性 "ticks"- 関連項目:
-
TIME
チャート属性 "time"- 関連項目:
-
TITLE
チャート属性 "title"- 関連項目:
-
GRID
チャート属性 "grid"- 関連項目:
-
OPTIONS
チャート属性 "options"- 関連項目:
-
PLUGINS
チャート属性 "plugins"- 関連項目:
-
ANNOTATIONS
チャート属性 "annotations"- 関連項目:
-
-
コンストラクタの詳細
-
JsChartData
public JsChartData()デフォルトコンストラクター- 変更履歴:
- 6.9.7.0 (2018/05/14) PMD Each class should declare at least one constructor
-
-
メソッドの詳細
-
setChartColumn
チャートカラムを設定します。- パラメータ:
chartColumn
- チャートカラム
-
getChartColumn
JsChartData オブジェクトを作成する時のチャートカラムを取得します。- 戻り値:
- チャートカラム
-
setId
データチャートのIDを指定します。 yAxisIDに使用するキーとなるid ( yAxisID=yid+'Ax' )- パラメータ:
id
- 固有の名前- 変更履歴:
- 7.0.1.1 (2018/10/22) 属性の追加。
-
setUseAxis
y軸表示を使用するかどうか(true/false)を設定します。 使用するとは、yAxisID属性を、内部的に登録します。- パラメータ:
flag
- true:使用する/false:使用しない
-
isUseAxis
y軸表示を使用するかどうか(true/false)を設定します。- 戻り値:
- true:使用する/false:使用しない
-
setUseTime
x軸の時間表示を使用するかどうか(true/false)を設定します。 使用しない場合は、time バッファーを axis 属性に追加しません。- パラメータ:
flag
- true:使用する/false:使用しない
-
addDataset
キーと設定値をdatasetに追加します。- パラメータ:
key
- キーval
- 設定値isNum
- 数値項目/boolean項目かどうか(true:数値要素/false:文字または配列要素)
-
addAxis
キーと設定値をaxisに追加します。 ※ chartJS上は、Axes(axisの複数形)と、Axis を使い分けていますが、属性は、axis で統一します。- パラメータ:
key
- キーval
- 設定値isNum
- 数値項目かどうか(true:数値要素/false:文字または配列要素)
-
addAxis
設定値をaxisに追加します。 これは、chartsバッファに、bufKey 毎のバッファに、引数をそのまま追加します。- パラメータ:
bufKey
- 追加するバッファのキーval
- 設定値- 変更履歴:
- 8.0.0.0 (2021/08/31) 新規作成
-
addTicks
キーと設定値をaxisのticks に追加します。- パラメータ:
key
- キーval
- 設定値isNum
- 数値項目かどうか(true:数値要素/false:文字または配列要素)
-
addTime
キーと設定値をaxisのtime に追加します。- パラメータ:
key
- キーval
- 設定値isNum
- 数値項目かどうか(true:数値要素/false:文字または配列要素)
-
addPlugins
キーと設定値をplugins に追加します。- パラメータ:
key
- キーval
- 設定値isNum
- 数値項目かどうか(true:数値要素/false:文字または配列要素)- 変更履歴:
- 8.0.0.0 (2021/08/31) 新規作成
-
addAnnotations
キーと設定値をannotations に追加します。- パラメータ:
key
- キーval
- 設定値isNum
- 数値項目かどうか(true:数値要素/false:文字または配列要素)- 変更履歴:
- 8.0.0.0 (2021/08/31) 新規作成
-
contains
バッファキー内に、設定キーの値がすでに登録済みかどうか(あればtrue)を判定します。 一般とオプションの両方を検索します。- パラメータ:
bufKey
- チェックするバッファのキーkey
- キー- 戻り値:
- すでに登録済みかどうか [true:登録済み/false:未登録]
- 変更履歴:
- 7.0.1.3 (2018/11/12) バッファキー検索処理追加
-
getDataset
JsChartData オブジェクトのdata:datasets: パラメータ情報を取得します。 ここで返す値は、yidが、'y0' とすると、 const 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
JsChartData オブジェクトのdata:datasets: パラメータ情報の変数名を取得します。 ここで返す値は、yidが、'y0' とすると、 "y0Ds" という文字列を返します。- 戻り値:
- パラメータ文字列
- 変更履歴:
- 7.0.1.1 (2018/10/22) data:datasets: パラメータ変数名
-
getAxis
JsChartData オブジェクトのoptions:scales:yAxes: パラメータ情報を取得します。 ここで返す値は、yidが、'y0' とすると、 const y0Ax = { addAxis.toString() } ; という文字列を返します。 ただし、useAxis=false の場合は、ゼロ文字列を返します。- 戻り値:
- パラメータ文字列
- 変更履歴:
- 7.0.1.1 (2018/10/22) options:scales:yAxes: パラメータ情報
-
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:パラメータ情報の変数名
-
getErrorMessage
エラーメッセージを返します。 エラーが存在しなかった場合は、長さゼロの文字列になります。- 戻り値:
- エラーメッセージの内部バッファを文字列にして返します。
- 変更履歴:
- 8.0.0.0 (2021/08/31) 新規作成
- このメソッドは、nullを返しません
-
toString
内部バッファを文字列にして返します。
-