BarChart (OpenNMS 19.1.0 API)

java.lang.Object
- org.opennms.netmgt.config.charts.BarChart

All Implemented Interfaces:

Serializable
```
public class BarChart
extends Object
implements Serializable
```
Class BarChart.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

BarChart()

Constructors
Constructor and Description
`BarChart()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addSeriesDef(int index, SeriesDef vSeriesDef)`
`void`	`addSeriesDef(SeriesDef vSeriesDef)`
`void`	`addSubTitle(int index, SubTitle vSubTitle)`
`void`	`addSubTitle(SubTitle vSubTitle)`
`void`	`deleteDrawBarOutline()`
`void`	`deleteShowLegend()`
`void`	`deleteShowToolTips()`
`void`	`deleteShowUrls()`
`Enumeration<SeriesDef>`	`enumerateSeriesDef()` Method enumerateSeriesDef.
`Enumeration<SubTitle>`	`enumerateSubTitle()` Method enumerateSubTitle.
`boolean`	`equals(Object obj)` Overrides the Object.equals method.
`ChartBackgroundColor`	`getChartBackgroundColor()` Returns the value of field 'chartBackgroundColor'.
`String`	`getDomainAxisLabel()` Returns the value of field 'domainAxisLabel'.
`Boolean`	`getDrawBarOutline()` Returns the value of field 'drawBarOutline'.
`GridLines`	`getGridLines()` Returns the value of field 'gridLines'.
`ImageSize`	`getImageSize()` Returns the value of field 'imageSize'.
`String`	`getName()` Returns the value of field 'name'.
`PlotBackgroundColor`	`getPlotBackgroundColor()` Returns the value of field 'plotBackgroundColor'.
`String`	`getPlotOrientation()` Returns the value of field 'plotOrientation'.
`String`	`getRangeAxisLabel()` Returns the value of field 'rangeAxisLabel'.
`String`	`getSeriesColorClass()` Returns the value of field 'seriesColorClass'.
`SeriesDef[]`	`getSeriesDef()` Method getSeriesDef.Returns the contents of the collection in an Array.
`SeriesDef`	`getSeriesDef(int index)` Method getSeriesDef.
`List<SeriesDef>`	`getSeriesDefCollection()` Method getSeriesDefCollection.Returns a reference to 'seriesDefList'.
`int`	`getSeriesDefCount()` Method getSeriesDefCount.
`Boolean`	`getShowLegend()` Returns the value of field 'showLegend'.
`Boolean`	`getShowToolTips()` Returns the value of field 'showToolTips'.
`Boolean`	`getShowUrls()` Returns the value of field 'showUrls'.
`String`	`getSubLabelClass()` Returns the value of field 'subLabelClass'.
`SubTitle[]`	`getSubTitle()` Method getSubTitle.Returns the contents of the collection in an Array.
`SubTitle`	`getSubTitle(int index)` Method getSubTitle.
`List<SubTitle>`	`getSubTitleCollection()` Method getSubTitleCollection.Returns a reference to 'subTitleList'.
`int`	`getSubTitleCount()` Method getSubTitleCount.
`Title`	`getTitle()` Returns the value of field 'title'.
`String`	`getVariation()` Returns the value of field 'variation'.
`boolean`	`hasDrawBarOutline()` Method hasDrawBarOutline.
`int`	`hashCode()` Method hashCode.
`boolean`	`hasShowLegend()` Method hasShowLegend.
`boolean`	`hasShowToolTips()` Method hasShowToolTips.
`boolean`	`hasShowUrls()` Method hasShowUrls.
`Boolean`	`isDrawBarOutline()` Returns the value of field 'drawBarOutline'.
`Boolean`	`isShowLegend()` Returns the value of field 'showLegend'.
`Boolean`	`isShowToolTips()` Returns the value of field 'showToolTips'.
`Boolean`	`isShowUrls()` Returns the value of field 'showUrls'.
`Iterator<SeriesDef>`	`iterateSeriesDef()` Method iterateSeriesDef.
`Iterator<SubTitle>`	`iterateSubTitle()` Method iterateSubTitle.
`void`	`removeAllSeriesDef()`
`void`	`removeAllSubTitle()`
`boolean`	`removeSeriesDef(SeriesDef vSeriesDef)` Method removeSeriesDef.
`SeriesDef`	`removeSeriesDefAt(int index)` Method removeSeriesDefAt.
`boolean`	`removeSubTitle(SubTitle vSubTitle)` Method removeSubTitle.
`SubTitle`	`removeSubTitleAt(int index)` Method removeSubTitleAt.
`void`	`setChartBackgroundColor(ChartBackgroundColor chartBackgroundColor)` Sets the value of field 'chartBackgroundColor'.
`void`	`setDomainAxisLabel(String domainAxisLabel)` Sets the value of field 'domainAxisLabel'.
`void`	`setDrawBarOutline(Boolean drawBarOutline)` Sets the value of field 'drawBarOutline'.
`void`	`setGridLines(GridLines gridLines)` Sets the value of field 'gridLines'.
`void`	`setImageSize(ImageSize imageSize)` Sets the value of field 'imageSize'.
`void`	`setName(String name)` Sets the value of field 'name'.
`void`	`setPlotBackgroundColor(PlotBackgroundColor plotBackgroundColor)` Sets the value of field 'plotBackgroundColor'.
`void`	`setPlotOrientation(String plotOrientation)` Sets the value of field 'plotOrientation'.
`void`	`setRangeAxisLabel(String rangeAxisLabel)` Sets the value of field 'rangeAxisLabel'.
`void`	`setSeriesColorClass(String seriesColorClass)` Sets the value of field 'seriesColorClass'.
`void`	`setSeriesDef(int index, SeriesDef vSeriesDef)`
`void`	`setSeriesDef(List<SeriesDef> vSeriesDefList)` Sets the value of 'seriesDefList' by copying the given Vector.
`void`	`setSeriesDef(SeriesDef[] vSeriesDefArray)`
`void`	`setSeriesDefCollection(List<SeriesDef> seriesDefList)` Deprecated.
`void`	`setShowLegend(Boolean showLegend)` Sets the value of field 'showLegend'.
`void`	`setShowToolTips(Boolean showToolTips)` Sets the value of field 'showToolTips'.
`void`	`setShowUrls(Boolean showUrls)` Sets the value of field 'showUrls'.
`void`	`setSubLabelClass(String subLabelClass)` Sets the value of field 'subLabelClass'.
`void`	`setSubTitle(int index, SubTitle vSubTitle)`
`void`	`setSubTitle(List<SubTitle> vSubTitleList)` Sets the value of 'subTitleList' by copying the given Vector.
`void`	`setSubTitle(SubTitle[] vSubTitleArray)`
`void`	`setSubTitleCollection(List<SubTitle> subTitleList)` Deprecated.
`void`	`setTitle(Title title)` Sets the value of field 'title'.
`void`	`setVariation(String variation)` Sets the value of field 'variation'.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BarChart
```
public BarChart()
```
- Method Detail
  - addSeriesDef
```
public void addSeriesDef(SeriesDef vSeriesDef)
                  throws IndexOutOfBoundsException
```
    Parameters:
    
    vSeriesDef -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addSeriesDef
```
public void addSeriesDef(int index,
                         SeriesDef vSeriesDef)
                  throws IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vSeriesDef -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addSubTitle
```
public void addSubTitle(SubTitle vSubTitle)
                 throws IndexOutOfBoundsException
```
    Parameters:
    
    vSubTitle -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addSubTitle
```
public void addSubTitle(int index,
                        SubTitle vSubTitle)
                 throws IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vSubTitle -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - deleteDrawBarOutline
```
public void deleteDrawBarOutline()
```
  - deleteShowLegend
```
public void deleteShowLegend()
```
  - deleteShowToolTips
```
public void deleteShowToolTips()
```
  - deleteShowUrls
```
public void deleteShowUrls()
```
  - enumerateSeriesDef
```
public Enumeration<SeriesDef> enumerateSeriesDef()
```
    Method enumerateSeriesDef.
    
    Returns:
    
    an Enumeration over all possible elements of this collection
  - enumerateSubTitle
```
public Enumeration<SubTitle> enumerateSubTitle()
```
    Method enumerateSubTitle.
    
    Returns:
    
    an Enumeration over all possible elements of this collection
  - equals
```
public boolean equals(Object obj)
```
    Overrides the Object.equals method.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj -
    
    Returns:
    
    true if the objects are equal.
  - getChartBackgroundColor
```
public ChartBackgroundColor getChartBackgroundColor()
```
    Returns the value of field 'chartBackgroundColor'.
    
    Returns:
    
    the value of field 'ChartBackgroundColor'.
  - getDomainAxisLabel
```
public String getDomainAxisLabel()
```
    Returns the value of field 'domainAxisLabel'.
    
    Returns:
    
    the value of field 'DomainAxisLabel'.
  - getDrawBarOutline
```
public Boolean getDrawBarOutline()
```
    Returns the value of field 'drawBarOutline'.
    
    Returns:
    
    the value of field 'DrawBarOutline'.
  - getGridLines
```
public GridLines getGridLines()
```
    Returns the value of field 'gridLines'.
    
    Returns:
    
    the value of field 'GridLines'.
  - getImageSize
```
public ImageSize getImageSize()
```
    Returns the value of field 'imageSize'.
    
    Returns:
    
    the value of field 'ImageSize'.
  - getName
```
public String getName()
```
    Returns the value of field 'name'.
    
    Returns:
    
    the value of field 'Name'.
  - getPlotBackgroundColor
```
public PlotBackgroundColor getPlotBackgroundColor()
```
    Returns the value of field 'plotBackgroundColor'.
    
    Returns:
    
    the value of field 'PlotBackgroundColor'.
  - getPlotOrientation
```
public String getPlotOrientation()
```
    Returns the value of field 'plotOrientation'.
    
    Returns:
    
    the value of field 'PlotOrientation'.
  - getRangeAxisLabel
```
public String getRangeAxisLabel()
```
    Returns the value of field 'rangeAxisLabel'.
    
    Returns:
    
    the value of field 'RangeAxisLabel'.
  - getSeriesColorClass
```
public String getSeriesColorClass()
```
    Returns the value of field 'seriesColorClass'.
    
    Returns:
    
    the value of field 'SeriesColorClass'.
  - getSeriesDef
```
public SeriesDef getSeriesDef(int index)
                       throws IndexOutOfBoundsException
```
    Method getSeriesDef.
    
    Parameters:
    
    index -
    
    Returns:
    
    the value of the SeriesDef at the given index
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - getSeriesDef
```
public SeriesDef[] getSeriesDef()
```
    Method getSeriesDef.Returns the contents of the collection in an Array.
    Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.
    
    Returns:
    
    this collection as an Array
  - getSeriesDefCollection
```
public List<SeriesDef> getSeriesDefCollection()
```
    Method getSeriesDefCollection.Returns a reference to 'seriesDefList'. No type checking is performed on any modifications to the Vector.
    
    Returns:
    
    a reference to the Vector backing this class
  - getSeriesDefCount
```
public int getSeriesDefCount()
```
    Method getSeriesDefCount.
    
    Returns:
    
    the size of this collection
  - getShowLegend
```
public Boolean getShowLegend()
```
    Returns the value of field 'showLegend'.
    
    Returns:
    
    the value of field 'ShowLegend'.
  - getShowToolTips
```
public Boolean getShowToolTips()
```
    Returns the value of field 'showToolTips'.
    
    Returns:
    
    the value of field 'ShowToolTips'.
  - getShowUrls
```
public Boolean getShowUrls()
```
    Returns the value of field 'showUrls'.
    
    Returns:
    
    the value of field 'ShowUrls'.
  - getSubLabelClass
```
public String getSubLabelClass()
```
    Returns the value of field 'subLabelClass'.
    
    Returns:
    
    the value of field 'SubLabelClass'.
  - getSubTitle
```
public SubTitle getSubTitle(int index)
                     throws IndexOutOfBoundsException
```
    Method getSubTitle.
    
    Parameters:
    
    index -
    
    Returns:
    
    the value of the SubTitle at the given index
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - getSubTitle
```
public SubTitle[] getSubTitle()
```
    Method getSubTitle.Returns the contents of the collection in an Array.
    Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.
    
    Returns:
    
    this collection as an Array
  - getSubTitleCollection
```
public List<SubTitle> getSubTitleCollection()
```
    Method getSubTitleCollection.Returns a reference to 'subTitleList'. No type checking is performed on any modifications to the Vector.
    
    Returns:
    
    a reference to the Vector backing this class
  - getSubTitleCount
```
public int getSubTitleCount()
```
    Method getSubTitleCount.
    
    Returns:
    
    the size of this collection
  - getTitle
```
public Title getTitle()
```
    Returns the value of field 'title'.
    
    Returns:
    
    the value of field 'Title'.
  - getVariation
```
public String getVariation()
```
    Returns the value of field 'variation'.
    
    Returns:
    
    the value of field 'Variation'.
  - hasDrawBarOutline
```
public boolean hasDrawBarOutline()
```
    Method hasDrawBarOutline.
    
    Returns:
    
    true if at least one DrawBarOutline has been added
  - hasShowLegend
```
public boolean hasShowLegend()
```
    Method hasShowLegend.
    
    Returns:
    
    true if at least one ShowLegend has been added
  - hasShowToolTips
```
public boolean hasShowToolTips()
```
    Method hasShowToolTips.
    
    Returns:
    
    true if at least one ShowToolTips has been added
  - hasShowUrls
```
public boolean hasShowUrls()
```
    Method hasShowUrls.
    
    Returns:
    
    true if at least one ShowUrls has been added
  - hashCode
```
public int hashCode()
```
    Method hashCode.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a hash code value for the object.
  - isDrawBarOutline
```
public Boolean isDrawBarOutline()
```
    Returns the value of field 'drawBarOutline'.
    
    Returns:
    
    the value of field 'DrawBarOutline'.
  - isShowLegend
```
public Boolean isShowLegend()
```
    Returns the value of field 'showLegend'.
    
    Returns:
    
    the value of field 'ShowLegend'.
  - isShowToolTips
```
public Boolean isShowToolTips()
```
    Returns the value of field 'showToolTips'.
    
    Returns:
    
    the value of field 'ShowToolTips'.
  - isShowUrls
```
public Boolean isShowUrls()
```
    Returns the value of field 'showUrls'.
    
    Returns:
    
    the value of field 'ShowUrls'.
  - iterateSeriesDef
```
public Iterator<SeriesDef> iterateSeriesDef()
```
    Method iterateSeriesDef.
    
    Returns:
    
    an Iterator over all possible elements in this collection
  - iterateSubTitle
```
public Iterator<SubTitle> iterateSubTitle()
```
    Method iterateSubTitle.
    
    Returns:
    
    an Iterator over all possible elements in this collection
  - removeAllSeriesDef
```
public void removeAllSeriesDef()
```
  - removeAllSubTitle
```
public void removeAllSubTitle()
```
  - removeSeriesDef
```
public boolean removeSeriesDef(SeriesDef vSeriesDef)
```
    Method removeSeriesDef.
    
    Parameters:
    
    vSeriesDef -
    
    Returns:
    
    true if the object was removed from the collection.
  - removeSeriesDefAt
```
public SeriesDef removeSeriesDefAt(int index)
```
    Method removeSeriesDefAt.
    
    Parameters:
    
    index -
    
    Returns:
    
    the element removed from the collection
  - removeSubTitle
```
public boolean removeSubTitle(SubTitle vSubTitle)
```
    Method removeSubTitle.
    
    Parameters:
    
    vSubTitle -
    
    Returns:
    
    true if the object was removed from the collection.
  - removeSubTitleAt
```
public SubTitle removeSubTitleAt(int index)
```
    Method removeSubTitleAt.
    
    Parameters:
    
    index -
    
    Returns:
    
    the element removed from the collection
  - setChartBackgroundColor
```
public void setChartBackgroundColor(ChartBackgroundColor chartBackgroundColor)
```
    Sets the value of field 'chartBackgroundColor'.
    
    Parameters:
    
    chartBackgroundColor - the value of field 'chartBackgroundColor'.
  - setDomainAxisLabel
```
public void setDomainAxisLabel(String domainAxisLabel)
```
    Sets the value of field 'domainAxisLabel'.
    
    Parameters:
    
    domainAxisLabel - the value of field 'domainAxisLabel'.
  - setDrawBarOutline
```
public void setDrawBarOutline(Boolean drawBarOutline)
```
    Sets the value of field 'drawBarOutline'.
    
    Parameters:
    
    drawBarOutline - the value of field 'drawBarOutline'.
  - setGridLines
```
public void setGridLines(GridLines gridLines)
```
    Sets the value of field 'gridLines'.
    
    Parameters:
    
    gridLines - the value of field 'gridLines'.
  - setImageSize
```
public void setImageSize(ImageSize imageSize)
```
    Sets the value of field 'imageSize'.
    
    Parameters:
    
    imageSize - the value of field 'imageSize'.
  - setName
```
public void setName(String name)
```
    Sets the value of field 'name'.
    
    Parameters:
    
    name - the value of field 'name'.
  - setPlotBackgroundColor
```
public void setPlotBackgroundColor(PlotBackgroundColor plotBackgroundColor)
```
    Sets the value of field 'plotBackgroundColor'.
    
    Parameters:
    
    plotBackgroundColor - the value of field 'plotBackgroundColor'.
  - setPlotOrientation
```
public void setPlotOrientation(String plotOrientation)
```
    Sets the value of field 'plotOrientation'.
    
    Parameters:
    
    plotOrientation - the value of field 'plotOrientation'.
  - setRangeAxisLabel
```
public void setRangeAxisLabel(String rangeAxisLabel)
```
    Sets the value of field 'rangeAxisLabel'.
    
    Parameters:
    
    rangeAxisLabel - the value of field 'rangeAxisLabel'.
  - setSeriesColorClass
```
public void setSeriesColorClass(String seriesColorClass)
```
    Sets the value of field 'seriesColorClass'.
    
    Parameters:
    
    seriesColorClass - the value of field 'seriesColorClass'.
  - setSeriesDef
```
public void setSeriesDef(int index,
                         SeriesDef vSeriesDef)
                  throws IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vSeriesDef -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - setSeriesDef
```
public void setSeriesDef(SeriesDef[] vSeriesDefArray)
```
    Parameters:
    
    vSeriesDefArray -
  - setSeriesDef
```
public void setSeriesDef(List<SeriesDef> vSeriesDefList)
```
    Sets the value of 'seriesDefList' by copying the given Vector. All elements will be checked for type safety.
    
    Parameters:
    
    vSeriesDefList - the Vector to copy.
  - setSeriesDefCollection
```
public void setSeriesDefCollection(List<SeriesDef> seriesDefList)
```
    Deprecated.
    
    Sets the value of 'seriesDefList' by setting it to the given Vector. No type checking is performed.
    
    Parameters:
    
    seriesDefList - the Vector to set.
  - setShowLegend
```
public void setShowLegend(Boolean showLegend)
```
    Sets the value of field 'showLegend'.
    
    Parameters:
    
    showLegend - the value of field 'showLegend'.
  - setShowToolTips
```
public void setShowToolTips(Boolean showToolTips)
```
    Sets the value of field 'showToolTips'.
    
    Parameters:
    
    showToolTips - the value of field 'showToolTips'.
  - setShowUrls
```
public void setShowUrls(Boolean showUrls)
```
    Sets the value of field 'showUrls'.
    
    Parameters:
    
    showUrls - the value of field 'showUrls'.
  - setSubLabelClass
```
public void setSubLabelClass(String subLabelClass)
```
    Sets the value of field 'subLabelClass'.
    
    Parameters:
    
    subLabelClass - the value of field 'subLabelClass'.
  - setSubTitle
```
public void setSubTitle(int index,
                        SubTitle vSubTitle)
                 throws IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vSubTitle -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - setSubTitle
```
public void setSubTitle(SubTitle[] vSubTitleArray)
```
    Parameters:
    
    vSubTitleArray -
  - setSubTitle
```
public void setSubTitle(List<SubTitle> vSubTitleList)
```
    Sets the value of 'subTitleList' by copying the given Vector. All elements will be checked for type safety.
    
    Parameters:
    
    vSubTitleList - the Vector to copy.
  - setSubTitleCollection
```
public void setSubTitleCollection(List<SubTitle> subTitleList)
```
    Deprecated.
    
    Sets the value of 'subTitleList' by setting it to the given Vector. No type checking is performed.
    
    Parameters:
    
    subTitleList - the Vector to set.
  - setTitle
```
public void setTitle(Title title)
```
    Sets the value of field 'title'.
    
    Parameters:
    
    title - the value of field 'title'.
  - setVariation
```
public void setVariation(String variation)
```
    Sets the value of field 'variation'.
    
    Parameters:
    
    variation - the value of field 'variation'.

Class BarChart

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BarChart

Method Detail

addSeriesDef

addSeriesDef

addSubTitle

addSubTitle

deleteDrawBarOutline

deleteShowLegend

deleteShowToolTips

deleteShowUrls

enumerateSeriesDef

enumerateSubTitle

equals

getChartBackgroundColor

getDomainAxisLabel

getDrawBarOutline

getGridLines

getImageSize

getName

getPlotBackgroundColor

getPlotOrientation

getRangeAxisLabel

getSeriesColorClass

getSeriesDef

getSeriesDef

getSeriesDefCollection

getSeriesDefCount

getShowLegend

getShowToolTips

getShowUrls

getSubLabelClass

getSubTitle

getSubTitle

getSubTitleCollection

getSubTitleCount

getTitle

getVariation

hasDrawBarOutline

hasShowLegend

hasShowToolTips

hasShowUrls

hashCode

isDrawBarOutline

isShowLegend

isShowToolTips

isShowUrls

iterateSeriesDef

iterateSubTitle

removeAllSeriesDef

removeAllSubTitle

removeSeriesDef

removeSeriesDefAt

removeSubTitle

removeSubTitleAt

setChartBackgroundColor

setDomainAxisLabel

setDrawBarOutline

setGridLines

setImageSize

setName

setPlotBackgroundColor

setPlotOrientation

setRangeAxisLabel

setSeriesColorClass

setSeriesDef

setSeriesDef

setSeriesDef

setSeriesDefCollection

setShowLegend

setShowToolTips

setShowUrls

setSubLabelClass

setSubTitle

setSubTitle

setSubTitle