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

Class ChartType

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap

com.ibm.json.java.JSONObject

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

All Implemented Interfaces:

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

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

Provides an abstraction for the Dojo Chart type. Every Chart requires a Chart Type. By default a Columns (ie, Vertical Bar) chart is used. Since this is a JSON object, additional properties can be set as required for a given chart type.

Author:

sls

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChartType.ChartTypes
static interface	ChartType.Fields

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
ChartType() Creates a new ChartType using default values.

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getGap() Return the Gap for the chart items
java.lang.String	getLabel() Gets the Label for this Chart Type, if nothing is supplied, then the type is used
int	getLabelOffset() Returns the current label offset
java.lang.String	getType() Returns the Chart Type (ie, the Dojo Chart Type)
void	setGap(int i) Set the Gap for the Chart Items
void	setLabel(java.lang.String label) Sets the Label for this ChartType
void	setLabelOffset(int off) Sets the label offset, usually used in Pie charts to move the % outside of the pie
void	setTension(java.lang.String ten) Sets the tension to be one of
void	setType(ChartType.ChartTypes type) Sets the chart type using enum
void	setType(java.lang.String type) Set the Chart Type.

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

ChartType

public ChartType()

Creates a new ChartType using default values.

Method Detail

setGap

public void setGap(int i)

Set the Gap for the Chart Items

Parameters:

i -

getGap

public java.lang.Integer getGap()

Return the Gap for the chart items

Returns:

setType

public void setType(ChartType.ChartTypes type)

Sets the chart type using enum

Parameters:

type -

setType

public void setType(java.lang.String type)

Set the Chart Type. Must be a valid Dojo Chart Type. See the ChartType.ChartTypes for a list of supported types.

Parameters:

type -

getType

public java.lang.String getType()

Returns the Chart Type (ie, the Dojo Chart Type)

Returns:

getLabel

public java.lang.String getLabel()

Gets the Label for this Chart Type, if nothing is supplied, then the type is used

Returns:

setLabel

public void setLabel(java.lang.String label)

Sets the Label for this ChartType

Parameters:

label -

setTension

public void setTension(java.lang.String ten)

Sets the tension to be one of

 X - Cubic bezier lines
 x - Similar to "X" but assumes that the point set is closed (a loop). It can be used when plotting true XY data.
 S - Quadratic bezier lines.
 

Parameters:

ten -

setLabelOffset

public void setLabelOffset(int off)

Sets the label offset, usually used in Pie charts to move the % outside of the pie

Parameters:

off -

getLabelOffset

public int getLabelOffset()

Returns the current label offset

Returns: