com.ibm.tivoli.maximo.skd.control.chart

Class Series

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap

com.ibm.json.java.JSONObject

com.ibm.tivoli.maximo.skd.control.chart.Series

All Implemented Interfaces:

com.ibm.json.java.JSONArtifact, java.io.Serializable, java.lang.Cloneable, java.util.Map

public class Series
extends com.ibm.json.java.JSONObject

A Series represets the Name and Data points for chart data. The "name" will also be used in the Legend if the legend is enabled.

Author:

sls

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Series.Fields Fields referenced by the Series

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Series() Creats a new Series with an empty name
Series(java.lang.String name) Creates a new Series with a given name.

Method Summary

Modifier and Type	Method and Description
com.ibm.json.java.JSONObject	addPiePoint(java.lang.Number y, java.lang.String label, java.lang.String legend) Adds a new Pie Point to the series, with mouse over tooltip and legend display label NOTE: Only use this if you are building a Pie Chart.
com.ibm.json.java.JSONObject	addPoint(java.lang.Number x, java.lang.Number y) Adds a new Point to the series.
com.ibm.json.java.JSONObject	addPoint(java.lang.Number x, java.lang.String xlabel, java.lang.Number y, java.lang.String ylabel) Adds a new Point to the series, specifying the X and Y labels
com.ibm.json.java.JSONArray	getData() Get the Data for this series as a JSONArray of JSONObject objects
java.lang.String	getName() Gets the name for the series.
com.ibm.json.java.JSONObject	getOptions() Gets the Options for this Series
com.ibm.json.java.JSONArray	getXLabels() Returns the X labels, if they are defined, or an empty array, there there are no X Labels defined.
com.ibm.json.java.JSONArray	getYLabels() Returns the Y labels, if they are defined, or an empty array, there there are no Y Labels defined.
void	normalizeSequence() Normalizes the Series data, such that the x,y pairs are sequential along the X axis, which means that we replace the X value with a sequence, and we store the original X value in the X_REAL field (in case we need to reference the real value later).
void	setData(com.ibm.json.java.JSONArray data) Explicitly set the Data for this series.
void	setName(java.lang.String name) Sets the name for the series.
void	setOptions(com.ibm.json.java.JSONObject options) Set any additional options for this series.

Methods inherited from class com.ibm.json.java.JSONObject

isValidObject, isValidType, parse, parse, parse, put, serialize, serialize, serialize, serialize, serialize, serialize, toString

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

Series

public Series()

Creats a new Series with an empty name

Series

public Series(java.lang.String name)

Creates a new Series with a given name.

Parameters:

name -

Method Detail

getName

public java.lang.String getName()

Gets the name for the series.

Returns:

setName

public void setName(java.lang.String name)

Sets the name for the series. This name will uniquely identify the series, and it will shown on the legend, if the legend is visible.

Parameters:

name -

getData

public com.ibm.json.java.JSONArray getData()

Get the Data for this series as a JSONArray of JSONObject objects

Returns:

setData

public void setData(com.ibm.json.java.JSONArray data)

Explicitly set the Data for this series.

Parameters:

data -

setOptions

public void setOptions(com.ibm.json.java.JSONObject options)

Set any additional options for this series.

Parameters:

options -

getOptions

public com.ibm.json.java.JSONObject getOptions()

Gets the Options for this Series

Returns:

addPoint

public com.ibm.json.java.JSONObject addPoint(java.lang.Number x,
                                             java.lang.Number y)

Adds a new Point to the series.

Parameters:

x -

y -

Returns:

addPoint

public com.ibm.json.java.JSONObject addPoint(java.lang.Number x,
                                             java.lang.String xlabel,
                                             java.lang.Number y,
                                             java.lang.String ylabel)

Adds a new Point to the series, specifying the X and Y labels

Parameters:

x -

xlabel -

y -

ylabel -

Returns:

addPiePoint

public com.ibm.json.java.JSONObject addPiePoint(java.lang.Number y,
                                                java.lang.String label,
                                                java.lang.String legend)

Adds a new Pie Point to the series, with mouse over tooltip and legend display label NOTE: Only use this if you are building a Pie Chart. This is a convenience method for adding Pie Points.

Parameters:

y - Pie data value

label - Pie mouse over label

legend - Pie label to show in the legend

Returns:

normalizeSequence

public void normalizeSequence()

Normalizes the Series data, such that the x,y pairs are sequential along the X axis, which means that we replace the X value with a sequence, and we store the original X value in the X_REAL field (in case we need to reference the real value later). This is a requirement when using Column charts.

getXLabels

public com.ibm.json.java.JSONArray getXLabels()

Returns the X labels, if they are defined, or an empty array, there there are no X Labels defined.

Returns:

getYLabels

public com.ibm.json.java.JSONArray getYLabels()

Returns the Y labels, if they are defined, or an empty array, there there are no Y Labels defined.

Returns: