OFC Charts 3.1


com.oxymel.ofc.charts
Class VerticalBarChart

java.lang.Object
  |
  +--com.oxymel.ofc.charts.Chart
        |
        +--com.oxymel.ofc.charts.ChartWithAxisXY
              |
              +--com.oxymel.ofc.charts.BarChart
                    |
                    +--com.oxymel.ofc.charts.VerticalBarChart
Direct Known Subclasses:
VerticalAreaChart, VerticalLineChart, VerticalStackedBarChart

public class VerticalBarChart
extends com.oxymel.ofc.charts.BarChart

This class manages vertical bar charts, it has subclasses allowing to customize the representation of the bar charts.


Fields inherited from class com.oxymel.ofc.charts.Chart
ROTATE_180_DEGREE, ROTATE_270_DEGREE, ROTATE_90_DEGREE, ROTATE_NONE
 
Constructor Summary
VerticalBarChart(int chartWidth, int chartHeight, HorizontalCategoryAxis axisX, VerticalNumberAxis axisY, CategoryValueSeriesContainer categoryValueSeriesContainer)
          Constructor
 
Method Summary
 CategoryValueSeriesContainer getCategoryValueSeriesContainer()
          Gets the series container defining the input data.
 void moveDataBack(double newValueAddAtEnd)
          Replaces the first data series by the one given as argument and then provides a backward circular translation of data series.
 void moveDataBackCircular()
          Provides a backward circular translation of data.
 void moveDataForward(double newValueAddAtStart)
          Replaces the last data series by the one given as argument and then provides a forward circular translation of data series.
 void moveDataForwardCircular()
          Provides a forward circular translation of data.
 void setCategoryValueSeriesContainer(CategoryValueSeriesContainer categoryValueSeriesContainer)
          Replaces the data series used to draw the chart.
 void setLegendDisplayMode(int legendDisplayMode)
          Sets the legend display mode.
 void setPercentageBarWidthMax(int percentageBarWidthMax)
          Customizes the bar width by giving a maximum size.
 void setPercentageBarWidthMin(int percentageBarWidthMin)
          Customizes the bar width by giving a minimum size.
 void setPercentageBetweenEachBarHisto(int percentageBetweenEachBarHisto)
          Sets the free space beetween two bars.
 void setPercentageFreeAfterSeries(int percentageFreeAfterSeries)
          Sets the free space after the last bar within a category.
 void setPercentageFreeBeforeSeries(int percentageFreeBeforeSeries)
          Sets the free space before the first bar within a category.
 
Methods inherited from class com.oxymel.ofc.charts.ChartWithAxisXY
setGraphicVisible, setIGOriginAxisColor, setInternalGridVisible
 
Methods inherited from class com.oxymel.ofc.charts.Chart
drawAnimateSVG, drawAnimateSVG, drawAnimateSVG, drawAnimateSVG, drawAnimateSVG, drawJPEG, drawJPEG, drawPNG, drawPNG, drawSVG, drawSVG, drawSVG, drawSVG, drawSVG, drawSVG, get3dEffectValue, getAllSeriesOrderByDisplayNumber, getBufferedImage, set3dEffectValue, setBackgroundColorVisible, setColorPalette, setGraphicBackgroundColor, setImageBackgroundColor, setLegendAlignMode, setLegendFontSize, setNbPixelFreeArroundImageForPresentation, setRotateValue
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

VerticalBarChart

public VerticalBarChart(int chartWidth,
                        int chartHeight,
                        HorizontalCategoryAxis axisX,
                        VerticalNumberAxis axisY,
                        CategoryValueSeriesContainer categoryValueSeriesContainer)
Constructor
Parameters:
chartWidth - Width of vertical bar chart
chartHeight - Height of vertical bar chart
axisX - Horizontal axis to display categories
axisY - Vertical number axis
categoryValueSeriesContainer - All series of couple category-value
Method Detail

moveDataBackCircular

public void moveDataBackCircular()
Provides a backward circular translation of data. After the operation the first data series becomes the last one, and the second one becomes the first and so on. This feature may be used when managing animated graphics for instance.

moveDataBack

public void moveDataBack(double newValueAddAtEnd)
Replaces the first data series by the one given as argument and then provides a backward circular translation of data series. After the operation the first data series does not exist anymore and the other series are translated from their original position to the previous one. The new last series is the one given as parameter.
Parameters:
newValueAddAtEnd - the new last data series in the container.

moveDataForwardCircular

public void moveDataForwardCircular()
Provides a forward circular translation of data. After the operation the first data series becomes the second one,.., and the last one becomes the first and so on. This feature may be used when managing animated graphics for instance.

moveDataForward

public void moveDataForward(double newValueAddAtStart)
Replaces the last data series by the one given as argument and then provides a forward circular translation of data series. After the operation the last data series does not exist anymore and the other series are translated from their original position to the next one. The new first series is the one given as parameter.
Parameters:
newValueAddAtStart - the new first data series in the container.

setLegendDisplayMode

public void setLegendDisplayMode(int legendDisplayMode)
Sets the legend display mode. The legend may look like a table.
Overrides:
setLegendDisplayMode in class Chart
Parameters:
legendDisplayMode - The legend display mode to be set.
See Also:
Legend

setCategoryValueSeriesContainer

public void setCategoryValueSeriesContainer(CategoryValueSeriesContainer categoryValueSeriesContainer)
Replaces the data series used to draw the chart. It can be used to draw several graphics with the same characteristics but different input data.
Parameters:
categoryValueSeriesContainer - All series defining the couples category-value, they are grouped within a series container.

getCategoryValueSeriesContainer

public CategoryValueSeriesContainer getCategoryValueSeriesContainer()
Gets the series container defining the input data.
Returns:
CategoryValueSeriesContainer currently used to draw chart

setPercentageBetweenEachBarHisto

public void setPercentageBetweenEachBarHisto(int percentageBetweenEachBarHisto)
Sets the free space beetween two bars. The space is given on a percentage basis, assuming that 100% corresponds to the whole space required to display one information category. Setting this information is not mandatory and furthermore the OFC-Chart kernel used it only if it provides a consistent resulting graphic.
Parameters:
percentageBetweenEachBarHisto - the free space percentage beetween two bars

setPercentageFreeBeforeSeries

public void setPercentageFreeBeforeSeries(int percentageFreeBeforeSeries)
Sets the free space before the first bar within a category. The space is given on a percentage basis, assuming that 100% corresponds to the whole space required to display one information category. The acceptance of this percentage by the OFC-Chart kernel depends on the resulting graphic consistency.
Parameters:
percentageFreeBeforeSeries - the free space percentage before the first bar

setPercentageFreeAfterSeries

public void setPercentageFreeAfterSeries(int percentageFreeAfterSeries)
Sets the free space after the last bar within a category. The space is given on a percentage basis, assuming that 100% corresponds to the whole space required to display one information category. The acceptance of this percentage by the OFC-Chart kernel depends on the resulting graphic consistency.
Parameters:
percentageFreeAfterSeries - the free space percentage after the last bar

setPercentageBarWidthMax

public void setPercentageBarWidthMax(int percentageBarWidthMax)
Customizes the bar width by giving a maximum size. The maximum width is given on a percentage basis, assuming that 100% corresponds to the whole space required to display one information category. This information is taken into account only if it provides a consistent resulting graphic.
Parameters:
percentageBarWidthMax - the percentage of bar width max

setPercentageBarWidthMin

public void setPercentageBarWidthMin(int percentageBarWidthMin)
Customizes the bar width by giving a minimum size. The maximum width is given on a percentage basis, assuming that 100% corresponds to the whole space required to display one information category. This information is taken into account only if it provides a consistent resulting graphic.
Parameters:
percentageBarWidthMin - the percentage of bar width min

OFC Charts 3.1


Copyright © 2005 Oxymel SA All Rights Reserved.