BBjBUIDialChart

```
public class BBjBUIDialChart
```
BBjBUIDialChart In BBj 20.00 and higher, the BBjBUIDialChart is a BBj Custom Class to help build dial charts more easily by acting as a proxy between a BBj program that wants to use a dial chart and the underlying JFreeChart.

See Also:
[ The source file for a small sample program at the beginning of the file]
Since:
BBj 20.00

Constructor Summary

Constructors
Constructor and Description
`BBjBUIDialChart()` BBjBUIDialChart constructor that creates the object with default values
`BBjBUIDialChart(BBjString p_backgroundImage$)` BBjBUIDialChart constructor that creates the object with a custom background image
`BBjBUIDialChart(BBjColor p_borderColor!, BBjNumber p_dialVisible)` BBjBUIDialChart constructor that creates the object with a custom background image and a number indicating whether the dial should be initially visible
`BBjBUIDialChart(BBjString p_title$, BBjNumber p_value)` BBjBUIDialChart constructor that creates the object with a custom title string and value
`BBjBUIDialChart(BBjString p_title$, BBjNumber p_value, BBjColor p_bgColor!, BBjColor p_fgColor!, BBjFont p_font!)` BBjBUIDialChart constructor that creates the object with all available parameters

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addDataset(BBjNumber datasetNumber, BBjNumber initialValue, BBjNumber pointerType, BBjNumber pointerRadius)`
`void`	`addDataset(BBjNumber datasetNumber, BBjNumber initialValue, BBjNumber pointerType, BBjNumber pointerRadius, Color needleColor!, Color pointerFillColor!, Color pointerOutlineColor!)`
`BBjImage`	`getChartImage(BBjNumber p_width, BBjNumber p_height)` Method to get a screenshot of the chart in the form of a BBjImage sized to the provided width and height parameters
`Color`	`getColor(BBjColor color!)`
`Color`	`getColorWithAlpha(BBjColor color!, BBjNumber alpha)`
`org.jfree.data.general.DefaultValueDataset`	`getDataset(BBjNumber datsetNumber)`
`Font`	`getFont(BBjFont p_font!)`
`org.jfree.chart.JFreeChart`	`getJFreeChart()` Method to get the underlying JFreeChart so that it can be further manipulated if desired
`BBjNumber`	`getValue(BBjNumber p_datasetNumber)` Method to get the value of the dial chart
`void`	`setAnnotation(BBjString p_title$, BBjFont p_font!, BBjColor color!, BBjNumber radius, BBjNumber angle)`
`BBjNumber`	`setBackgroundImage(BBjString imageFile$)`
`BBjNumber`	`setBackgroundImageResized(BBjString imageFile$, BBjNumber p_width, BBjNumber p_height)`
`void`	`setChartBackgroundColor(BBjNumber red, BBjNumber green, BBjNumber blue, BBjNumber alpha)`
`void`	`setDialBackgroundColor(BBjNumber red, BBjNumber green, BBjNumber blue, BBjNumber alpha)`
`void`	`setDialCap(BBjNumber dialCapSize, BBjColor outlineColor!, BBjColor fillColor!)`
`void`	`setDialSize(BBjNumber p_sizePercentage)`
`void`	`setDialSize(BBjNumber p_sizePercentageWidth, BBjNumber p_sizePercentageHeight)`
`void`	`setGradient(BBjColor color1!, BBjColor color2!, BBjNumber verticalOrientation)`
`void`	`setGradientWithAlpha(BBjColor color1!, BBjNumber alpha1, BBjColor color2!, BBjNumber alpha2, BBjNumber verticalOrientation)`
`void`	`setScale(BBjNumber scaleNumber, BBjNumber rangeBottom, BBjNumber rangeTop, BBjNumber majorTickIncrement, BBjNumber scaleStartDegrees, BBjNumber scaleRangeDegrees, BBjNumber scaleRadius, BBjNumber scaleLength, BBjFont p_font!, BBjNumber labelOffset, BBjColor tickColor!, BBjNumber minorTickCount)`
`void`	`setTitle(BBjString p_title$)`
`void`	`setValue(BBjNumber p_datasetNumber, BBjNumber p_value)` Method to set the value of the dial chart
`void`	`setValueIndicator(BBjNumber datasetNumber, BBjFont p_font!, BBjColor p_fgColor!, BBjColor p_bgColor!, BBjColor outlineColor!, BBjNumber radius, BBjNumber angle)`
`void`	`setView(BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height)`

Constructor Detail
- BBjBUIDialChart
```
public BBjBUIDialChart()
```
  BBjBUIDialChart constructor that creates the object with default values
- BBjBUIDialChart
```
public BBjBUIDialChart(BBjString p_backgroundImage$)
```
  BBjBUIDialChart constructor that creates the object with a custom background image
  
  Parameters:
  p_backgroundImage$ A BBjString with the fully-qualified path to an image file that will be used as the chart's background
- BBjBUIDialChart
```
public BBjBUIDialChart(BBjColor p_borderColor!, BBjNumber p_dialVisible)
```
  BBjBUIDialChart constructor that creates the object with a custom background image and a number indicating whether the dial should be initially visible
  
  Parameters:
  p_borderColor! A BBjColor that will be used for the foreground and background color of the dial frame
  dialVisible A BBjNumber acting as a boolean that determines whether the dial should be visible where 0=not visible and 1=visible
- BBjBUIDialChart
```
public BBjBUIDialChart(BBjString p_title$, BBjNumber p_value)
```
  BBjBUIDialChart constructor that creates the object with a custom title string and value
  
  Parameters:
  p_title$ A BBjString that will be used for the chart's title
  p_value A BBjNumber that sets the dial's initial value
- BBjBUIDialChart
```
public BBjBUIDialChart(BBjString p_title$, BBjNumber p_value, BBjColor p_bgColor!, BBjColor p_fgColor!, BBjFont p_font!)
```
  BBjBUIDialChart constructor that creates the object with all available parameters
  
  Parameters:
  p_title$ A BBjString that will be used for the chart's title
  p_value A BBjNumber that sets the dial's initial value
  p_bgColor! A BBjColor that will be used for the chart's background color
  p_fgColor! A BBjColor that will be used for the chart's foreground color
  p_font! A BBjFont that will be used for the chart's title

Method Detail

addDataset

public void addDataset(BBjNumber datasetNumber, BBjNumber initialValue, BBjNumber pointerType, BBjNumber pointerRadius)

addDataset

public void addDataset(BBjNumber datasetNumber, BBjNumber initialValue, BBjNumber pointerType, BBjNumber pointerRadius, Color needleColor!, Color pointerFillColor!, Color pointerOutlineColor!)

getChartImage
```
public BBjImage getChartImage(BBjNumber p_width, BBjNumber p_height)
```
Method to get a screenshot of the chart in the form of a BBjImage sized to the provided width and height parameters

Parameters:
p_width A BBjNumber that sets the width of the returned BBjImage
p_height A BBjNumber that sets the height of the returned BBjImage
Returns:
A BBjImage that's a screenshot of the chart sized to the specified width and height

getColor
```
public Color getColor(BBjColor color!)
```

getColorWithAlpha

public Color getColorWithAlpha(BBjColor color!, BBjNumber alpha)

getDataset

public org.jfree.data.general.DefaultValueDataset getDataset(BBjNumber datsetNumber)

getFont
```
public Font getFont(BBjFont p_font!)
```

getJFreeChart
```
public org.jfree.chart.JFreeChart getJFreeChart()
```
Method to get the underlying JFreeChart so that it can be further manipulated if desired

Returns:
The underlying JFreeChart

getValue
```
public BBjNumber getValue(BBjNumber p_datasetNumber)
```
Method to get the value of the dial chart

Parameters:
p_datasetNumber A BBjNumber specifying the dataset index to query
Returns:
A BBjNumber specifying the value for the dial in the specified dataset

setAnnotation

public void setAnnotation(BBjString p_title$, BBjFont p_font!, BBjColor color!, BBjNumber radius, BBjNumber angle)

setBackgroundImage

public BBjNumber setBackgroundImage(BBjString imageFile$)

setBackgroundImageResized

public BBjNumber setBackgroundImageResized(BBjString imageFile$, BBjNumber p_width, BBjNumber p_height)

setChartBackgroundColor

public void setChartBackgroundColor(BBjNumber red, BBjNumber green, BBjNumber blue, BBjNumber alpha)

setDialBackgroundColor

public void setDialBackgroundColor(BBjNumber red, BBjNumber green, BBjNumber blue, BBjNumber alpha)

setDialCap

public void setDialCap(BBjNumber dialCapSize, BBjColor outlineColor!, BBjColor fillColor!)

setDialSize

public void setDialSize(BBjNumber p_sizePercentage)

setDialSize

public void setDialSize(BBjNumber p_sizePercentageWidth, BBjNumber p_sizePercentageHeight)

setGradient

public void setGradient(BBjColor color1!, BBjColor color2!, BBjNumber verticalOrientation)

setGradientWithAlpha

public void setGradientWithAlpha(BBjColor color1!, BBjNumber alpha1, BBjColor color2!, BBjNumber alpha2, BBjNumber verticalOrientation)

setScale

public void setScale(BBjNumber scaleNumber, BBjNumber rangeBottom, BBjNumber rangeTop, BBjNumber majorTickIncrement, BBjNumber scaleStartDegrees, BBjNumber scaleRangeDegrees, BBjNumber scaleRadius, BBjNumber scaleLength, BBjFont p_font!, BBjNumber labelOffset, BBjColor tickColor!, BBjNumber minorTickCount)

setTitle

public void setTitle(BBjString p_title$)

setValue
```
public void setValue(BBjNumber p_datasetNumber, BBjNumber p_value)
```
Method to set the value of the dial chart

Parameters:
p_datasetNumber A BBjNumber specifying the dataset index to modify
p_value A BBjNumber specifying the value for the dial

setValueIndicator

public void setValueIndicator(BBjNumber datasetNumber, BBjFont p_font!, BBjColor p_fgColor!, BBjColor p_bgColor!, BBjColor outlineColor!, BBjNumber radius, BBjNumber angle)

setView

public void setView(BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height)

Class BBjBUIDialChart

Constructor Summary

Method Summary

Constructor Detail

BBjBUIDialChart

BBjBUIDialChart

BBjBUIDialChart

BBjBUIDialChart

BBjBUIDialChart

Method Detail

addDataset

addDataset

getChartImage

getColor

getColorWithAlpha

getDataset

getFont

getJFreeChart

getValue

setAnnotation

setBackgroundImage

setBackgroundImageResized

setChartBackgroundColor

setDialBackgroundColor

setDialCap

setDialSize

setDialSize

setGradient

setGradientWithAlpha

setScale

setTitle

setValue

setValueIndicator

setView