Chart (Apache Chukwa 0.8.0 API)

java.lang.Object
- org.apache.hadoop.chukwa.hicc.bean.Chart

```
public class Chart
extends Object
```

Constructor Summary

Constructors
Constructor and Description

Chart(String id)

Constructors
Constructor and Description
`Chart(String id)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Chart`	`createChart(String id, String title, String[] metrics, String source, String yunitType)` Create a chart object.
`static Chart`	`createCircle(String id, String title, String[] metrics, String source, String suffixLabel, String direction)` Create a chart in HBase by specifying parameters.
`static Chart`	`createTile(String id, String title, String bannerText, String suffixLabel, String[] metrics, String source, String icon)` Create a tile in HBase by specifying parameters.
`String`	`getBannerText()`
`int`	`getHeight()`
`String`	`getIcon()`
`String`	`getId()`
`boolean`	`getLegend()`
`List<SeriesMetaData>`	`getSeries()`
`String`	`getSuffixText()`
`String`	`getThreshold()`
`String`	`getTitle()`
`ChartType`	`getType()`
`boolean`	`getUserDefinedMax()`
`boolean`	`getUserDefinedMin()`
`int`	`getWidth()`
`String`	`getXAxisLabel()`
`List<String>`	`getXLabelsRange()`
`String`	`getYAxisLabel()`
`String`	`getYAxisRightLabel()`
`double`	`getYMax()`
`double`	`getYMin()`
`String`	`getYUnitType()`
`boolean`	`isXAxisLabelsOn()`
`boolean`	`isYAxisLabelsOn()`
`boolean`	`isYAxisRightLabelsOn()`
`void`	`setBannerText(String bannerText)`
`void`	`setIcon(String icon)`
`void`	`setId(String id)`
`void`	`setLegend(boolean toggle)`
`void`	`setSeries(List<SeriesMetaData> series)`
`void`	`setSize(int width, int height)`
`void`	`setSuffixText(String suffixText)`
`void`	`setThreshold(String direction)`
`void`	`setTitle(String title)`
`void`	`setType(ChartType type)`
`void`	`setXAxisLabel(String label)`
`void`	`setXAxisLabelsOn(boolean toggle)`
`void`	`setXLabelsRange(List<String> range)`
`void`	`setYAxisLabel(String label)`
`void`	`setYAxisLabels(boolean toggle)`
`void`	`setYAxisRightLabel(String label)`
`void`	`setYAxisRightLabels(boolean toggle)`
`void`	`setYMax(double max)`
`void`	`setYMin(double min)`
`void`	`setYUnitType(String yUnitType)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- Chart
```
public Chart(String id)
```

Method Detail

getType
```
public ChartType getType()
```

setType
```
public void setType(ChartType type)
```

setYMax
```
public void setYMax(double max)
```

getYMax
```
public double getYMax()
```

getUserDefinedMax
```
public boolean getUserDefinedMax()
```

setYMin
```
public void setYMin(double min)
```

getYMin
```
public double getYMin()
```

getUserDefinedMin
```
public boolean getUserDefinedMin()
```

setSize

public void setSize(int width,
                    int height)

getWidth
```
public int getWidth()
```

getHeight
```
public int getHeight()
```

setTitle
```
public void setTitle(String title)
```

getTitle
```
public String getTitle()
```

setId
```
public void setId(String id)
```

getId
```
public String getId()
```

setSeries

public void setSeries(List<SeriesMetaData> series)

getSeries

public List<SeriesMetaData> getSeries()

setXAxisLabelsOn

public void setXAxisLabelsOn(boolean toggle)

isXAxisLabelsOn
```
public boolean isXAxisLabelsOn()
```

setYAxisLabels

public void setYAxisLabels(boolean toggle)

isYAxisLabelsOn
```
public boolean isYAxisLabelsOn()
```

setYAxisRightLabels

public void setYAxisRightLabels(boolean toggle)

isYAxisRightLabelsOn
```
public boolean isYAxisRightLabelsOn()
```

setXAxisLabel

public void setXAxisLabel(String label)

getXAxisLabel
```
public String getXAxisLabel()
```

setYAxisLabel

public void setYAxisLabel(String label)

getYAxisLabel
```
public String getYAxisLabel()
```

setYAxisRightLabel

public void setYAxisRightLabel(String label)

getYAxisRightLabel
```
public String getYAxisRightLabel()
```

setXLabelsRange

public void setXLabelsRange(List<String> range)

getXLabelsRange
```
public List<String> getXLabelsRange()
```

setLegend

public void setLegend(boolean toggle)

getLegend
```
public boolean getLegend()
```

setYUnitType

public void setYUnitType(String yUnitType)

getYUnitType
```
public String getYUnitType()
```

setIcon
```
public void setIcon(String icon)
```

getIcon
```
public String getIcon()
```

setBannerText

public void setBannerText(String bannerText)

getBannerText
```
public String getBannerText()
```

setSuffixText

public void setSuffixText(String suffixText)

getSuffixText
```
public String getSuffixText()
```

setThreshold

public void setThreshold(String direction)

getThreshold
```
public String getThreshold()
```

createChart

public static Chart createChart(String id,
                                String title,
                                String[] metrics,
                                String source,
                                String yunitType)
                         throws URISyntaxException

Create a chart object.

Parameters:: id - is unique chart identifier; title - is searchable name of the chart; metrics - is list of metric names to render chart; source - is data source name; yunitType - is y axis unit type
Returns:: Chart object
Throws:: URISyntaxException - if metrics name can not compose valid URL syntax

createCircle

public static Chart createCircle(String id,
                                 String title,
                                 String[] metrics,
                                 String source,
                                 String suffixLabel,
                                 String direction)
                          throws URISyntaxException

Create a chart in HBase by specifying parameters.

Parameters:: id - is unique chart identifier; title - is searchable name of the chart; metrics - is list of metric names to render ring chart; source - is data source name; suffixLabel - is text label to append to metric values; direction - sets the threshold to have either upper limit or lower limit
Returns:: Chart object
Throws:: URISyntaxException - if metrics name can not compose valid URL syntax

createTile

public static Chart createTile(String id,
                               String title,
                               String bannerText,
                               String suffixLabel,
                               String[] metrics,
                               String source,
                               String icon)
                        throws URISyntaxException

Create a tile in HBase by specifying parameters.

Parameters:: id - is unique tile identifier; title - is searchable name of the tile widget; bannerText - is description of the tile widget; suffixLabel - is text label to append to metric values; metrics - is list of metric names to render tile widget; source - is data source name; icon - is emoji symbol to render beside tile widget
Returns:: Chart object
Throws:: URISyntaxException - if metrics name can not compose valid URL syntax

Class Chart

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Chart

Method Detail

getType

setType

setYMax

getYMax

getUserDefinedMax

setYMin

getYMin

getUserDefinedMin

setSize

getWidth

getHeight

setTitle

getTitle

setId

getId

setSeries

getSeries

setXAxisLabelsOn

isXAxisLabelsOn

setYAxisLabels

isYAxisLabelsOn

setYAxisRightLabels

isYAxisRightLabelsOn

setXAxisLabel

getXAxisLabel

setYAxisLabel

getYAxisLabel

setYAxisRightLabel

getYAxisRightLabel

setXLabelsRange

getXLabelsRange

setLegend

getLegend

setYUnitType

getYUnitType

setIcon

getIcon

setBannerText

getBannerText

setSuffixText

getSuffixText

setThreshold

getThreshold

createChart

createCircle

createTile