Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.faceless.graph
Class AbstractBarGraph

    java.lang.Object
      org.faceless.graph.Graph
          org.faceless.graph.AxesGraph
              org.faceless.graph.AbstractBarGraph

Direct Known Subclasses:
  BarGraph, DepthBarGraph, FloatingBarGraph, MultiBarGraph, TowerBarGraph

    public abstract class AbstractBarGraph

extends AxesGraph

An abstract superclass for all Bar Graphs. Takes care of some of the work to do with laying out bars. Subclasses of this class need to implement the `plotBar` method

Field Summary
`static int` | `DISPLAYVALUE_INSIDETOP` Value to `optionDisplayValue(int)` to display the value at the end, but just inside the bar
`static int` | `DISPLAYVALUE_MIDDLE` Value to `optionDisplayValue(int)` to display the value in the middle of the bar
`static int` | `DISPLAYVALUE_NONE` Value to `optionDisplayValue(int)` to not display the value on the bar (the default)
`static int` | `DISPLAYVALUE_TOP` Value to `optionDisplayValue(int)` to display the value above the bar

Fields inherited from class org.faceless.graph.Graph
`KEY_BOXED_BOTTOM, KEY_BOXED_LEFT, KEY_BOXED_RIGHT, KEY_BOXED_TOP, KEY_NONE`

Method Summary
`void` | `optionBarDepth(double val)` How deep to make each bar, as a proportion of the square it rests on Default: 1.0
`void` | `optionBarWidth(double val)` How wide to make each bar, as a proportion of the square it rests on Default: 1.0
`void` | `optionDisplayValue(int pos)` Whether to display the value for the bar directly on the graph.
`void` | `optionRoundBars(boolean round)` Whether to draw the bars in the graph as cylinders instead of the default rectangles.
`void` | `optionXStretchToZero(boolean val)` Cannot be set by the user for this class and it's subclasses.
`void` | `optionYStretchToZero(boolean val)` Cannot be set by the user for this class and it's subclasses.

Methods inherited from class org.faceless.graph.AxesGraph
`optionAxisStyle, optionBoxColor, optionFloorStyle, optionMaxY, optionMinY, optionXAxisAtZero, optionXAxisLabel, optionXAxisLabelStyle, optionXAxisStyle, optionXAxisTextRotation, optionXFormatter, optionYAxisAtZero, optionYAxisLabel, optionYAxisLabelStyle, optionYAxisStyle, optionYAxisTextRotation, optionYFormatter, optionYWallStyle, optionZAxisStyle, optionZFormatter, optionZWallStyle`

Methods inherited from class org.faceless.graph.Graph
`getDefaultBorderColor, getFontScale, optionDisplayKey, optionFixedAspectRatio, optionKeyBoxStyle, optionKeyStyle, optionSubTitle, optionSubTitleStyle, optionTitle, optionTitleStyle, optionXRotation, optionYRotation, optionZRotation, setDefaultBorderColor, setDefaultColors, setDefaultLineThickness, setFontScale, setLicenseKey, setLightLevel, setLightVector, setPieEdgeDegrees, toCanvas`

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

Field Detail

### DISPLAYVALUE_NONE

    public static final int DISPLAYVALUE_NONE

  Value to `optionDisplayValue(int)` to not display the value on the bar (the default)

  See Also:
    Constant Field Values

### DISPLAYVALUE_MIDDLE

    public static final int DISPLAYVALUE_MIDDLE

  Value to `optionDisplayValue(int)` to display the value in the middle of the bar

  See Also:
    Constant Field Values

### DISPLAYVALUE_TOP

    public static final int DISPLAYVALUE_TOP

  Value to `optionDisplayValue(int)` to display the value above the bar

  See Also:
    Constant Field Values

### DISPLAYVALUE_INSIDETOP

    public static final int DISPLAYVALUE_INSIDETOP

  Value to `optionDisplayValue(int)` to display the value at the end, but just inside the bar

  Since:
    1.1
  See Also:
    Constant Field Values

Method Detail

### optionBarWidth

    public void optionBarWidth(double val)

  How wide to make each bar, as a proportion of the square it rests on

  Default: 1.0

### optionBarDepth

    public void optionBarDepth(double val)

  How deep to make each bar, as a proportion of the square it rests on

  Default: 1.0

### optionDisplayValue

    public void optionDisplayValue(int pos)

  Whether to display the value for the bar directly on the graph. One of `DISPLAYVALUE_NONE` to not display the value, `DISPLAYVALUE_MIDDLE` to display the value in the middle of the bar, `DISPLAYVALUE_TOP` to display the value above the bar, or `DISPLAYVALUE_INSIDETOP` to display the value at the end of but just inside the bar.

  Default: DISPLAYVALUE_NONE

  Since:
    1.0.7

### optionRoundBars

    public void optionRoundBars(boolean round)

  Whether to draw the bars in the graph as cylinders instead of the default rectangles. The diameter of the cylinder is the average of the bar-depth and the bar-width. This value may be ignored by some subclasses (currently only MultiBarGraph).

  Drawing cylinders is considerably slower than drawing rectangles. This can be sped up by reducing the number of flat edges used to draw the cylinder, by passing a higher value to the `Graph.setPieEdgeDegrees(double)` method. The default for Bar Graphs is 10.

  Since:
    1.0.10

### optionXStretchToZero

    public void optionXStretchToZero(boolean val)

  Cannot be set by the user for this class and it's subclasses. Will always throw an exception.

  Overrides:
    `optionXStretchToZero` in class `AxesGraph`
  Throws:
    `UnsupportedOperationException`

### optionYStretchToZero

    public void optionYStretchToZero(boolean val)

  Cannot be set by the user for this class and it's subclasses. Will always throw an exception.

  Overrides:
    `optionYStretchToZero` in class `AxesGraph`
  Throws:
    `UnsupportedOperationException`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2001-2012 Big Faceless Organization