org.faceless.graph
Class AxesGraph

java.lang.Object
  extended by org.faceless.graph.Graph
      extended by org.faceless.graph.AxesGraph
Direct Known Subclasses:
AbstractBarGraph, AbstractLineGraph

public abstract class AxesGraph
extends Graph

An Axes Graph covers every Graph that is plotted against an Axes. Currently this is everything but the PieGraph.


Field Summary
 
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 optionAxisStyle(Style val)
          What style to draw the principal axes for the graph in.
 void optionBoxColor(Color val)
          What color, if any, to draw the box around the content of the graph (excluding the values on the axes).
 void optionFloorStyle(Style val)
          What style, if any, to draw the grid on the floor of the graph (either where y=0 or y=min(y) - see optionXAxisAtZero).
 void optionMaxY(double val)
          The maximum value to plot on the Y axis.
 void optionMinY(double val)
          The minimum value to plot on the Y axis.
 void optionXAxisAtZero(boolean val)
          If the Y-axis values go from -ve to +ve, whether to draw the X-Axis where y=0 or where y=min(y) Default: false except for the subclass LineGraph, which is true
 void optionXAxisLabel(String val)
          The label to give the X-Axis Default: <none>
 void optionXAxisLabelStyle(Style val)
          Set the style to write the label for the X-Axis Default: Black 12pt Helvetica
 void optionXAxisStyle(Style val)
          What Style to write the values on the X-Axis Default: Black 8pt Helvetica
 void optionXAxisTextRotation(double val)
          Whether to rotate the values on the Y-Axis.
 void optionXFormatter(Formatter val)
          Which {link org.faceless.graph.formatter.Formatter} to use to format the values on the X axis.
 void optionXStretchToZero(boolean val)
          Whether to always stretch the X axis to include zero.
 void optionYAxisAtZero(boolean val)
          If the X-axis values go from -ve to +ve, whether to draw the Y-Axis where x=0 or where x=min(x) Default: false except for the subclass LineGraph, which is true
 void optionYAxisLabel(String val)
          The label to give the Y-Axis Default: <none>
 void optionYAxisLabelStyle(Style val)
          Set the style to write the label for the Y-Axis Default: Black 12pt Helvetica
 void optionYAxisStyle(Style val)
          What Style to write the values on the Y-Axis Default: Black 8pt Helvetica
 void optionYAxisTextRotation(double val)
          Whether to rotate the values on the X-Axis.
 void optionYFormatter(Formatter val)
          Which {link org.faceless.graph.formatter.Formatter} to use to format the values on the Y axis.
 void optionYStretchToZero(boolean val)
          Whether to always stretch the Y axis to include zero.
 void optionYWallStyle(Style val)
          What style, if any, to draw the grid on the Y-Wall of the graph (either where x=0 or x=min(x) - see optionYAxisAtZero).
 void optionZAxisStyle(Style val)
          What Style to write the values on the Z-Axis Default: Black 8pt Helvetica
 void optionZFormatter(Formatter val)
          Which {link org.faceless.graph.formatter.Formatter} to use to format the values on the Z axis.
 void optionZWallStyle(Style val)
          What style, if any, to draw the grid on the back or Z-Wall of the graph.
 
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
 

Method Detail

optionXAxisLabel

public void optionXAxisLabel(String val)
The label to give the X-Axis

Default: <none>


optionYAxisLabel

public void optionYAxisLabel(String val)
The label to give the Y-Axis

Default: <none>


optionXAxisLabelStyle

public void optionXAxisLabelStyle(Style val)
Set the style to write the label for the X-Axis

Default: Black 12pt Helvetica


optionYAxisLabelStyle

public void optionYAxisLabelStyle(Style val)
Set the style to write the label for the Y-Axis

Default: Black 12pt Helvetica


optionXAxisAtZero

public void optionXAxisAtZero(boolean val)
If the Y-axis values go from -ve to +ve, whether to draw the X-Axis where y=0 or where y=min(y)

Default: false except for the subclass LineGraph, which is true


optionYAxisAtZero

public void optionYAxisAtZero(boolean val)
If the X-axis values go from -ve to +ve, whether to draw the Y-Axis where x=0 or where x=min(x)

Default: false except for the subclass LineGraph, which is true


optionXStretchToZero

public void optionXStretchToZero(boolean val)
Whether to always stretch the X axis to include zero. Some subclasses (e.g. AbstractBarGraph) may not allow you to set this value.

Default: usually false, but depends on subclass


optionYStretchToZero

public void optionYStretchToZero(boolean val)
Whether to always stretch the Y axis to include zero. Some subclasses (e.g. AbstractBarGraph) may not allow you to set this value.

Default: usually false, but depends on subclass


optionFloorStyle

public void optionFloorStyle(Style val)
What style, if any, to draw the grid on the floor of the graph (either where y=0 or y=min(y) - see optionXAxisAtZero). You can set the color and border color, or just set the border color for a grid on an otherwise transparent wall.

Default: null


optionYWallStyle

public void optionYWallStyle(Style val)
What style, if any, to draw the grid on the Y-Wall of the graph (either where x=0 or x=min(x) - see optionYAxisAtZero). You can set the color and border color, or just set the border color for a grid on an otherwise transparent wall.

Default: null


optionZWallStyle

public void optionZWallStyle(Style val)
What style, if any, to draw the grid on the back or Z-Wall of the graph. You can set the color and border color, or just set the border color for a grid on an otherwise transparent wall.

Default: null


optionXAxisStyle

public void optionXAxisStyle(Style val)
What Style to write the values on the X-Axis

Default: Black 8pt Helvetica


optionYAxisStyle

public void optionYAxisStyle(Style val)
What Style to write the values on the Y-Axis

Default: Black 8pt Helvetica


optionZAxisStyle

public void optionZAxisStyle(Style val)
What Style to write the values on the Z-Axis

Default: Black 8pt Helvetica


optionYAxisTextRotation

public void optionYAxisTextRotation(double val)
Whether to rotate the values on the X-Axis. Likely values are 0 (horizontal), 90 (vertical) or anything inbetween. This can also be set directly in the style passed to optionXAxisStyle

Default: 0


optionXAxisTextRotation

public void optionXAxisTextRotation(double val)
Whether to rotate the values on the Y-Axis. Likely values are 0 (horizontal), 90 (vertical) or anything inbetween. This can also be set directly in the style passed to optionYAxisStyle

Default: 0


optionXFormatter

public void optionXFormatter(Formatter val)
Which {link org.faceless.graph.formatter.Formatter} to use to format the values on the X axis. The default depends on the subclass and the data. To turn off the display of this axis, set to new NullFormatter

Default: data and class dependent


optionYFormatter

public void optionYFormatter(Formatter val)
Which {link org.faceless.graph.formatter.Formatter} to use to format the values on the Y axis. The default depends on the subclass and the data. To turn off the display of this axis, set to new NullFormatter

Default: data and class dependent


optionZFormatter

public void optionZFormatter(Formatter val)
Which {link org.faceless.graph.formatter.Formatter} to use to format the values on the Z axis. The default depends on the subclass and the data. To turn off the display of this axis, set to new NullFormatter

Default: data and class dependent


optionAxisStyle

public void optionAxisStyle(Style val)
What style to draw the principal axes for the graph in.

Default: Style.getDefaultBorderColor()


optionBoxColor

public void optionBoxColor(Color val)
What color, if any, to draw the box around the content of the graph (excluding the values on the axes). Set to null for no box.

Default: null


optionMinY

public void optionMinY(double val)
The minimum value to plot on the Y axis. Set this to plot useful values for curves like tangents, that give infinite values at certain points, or to just plot the tops of Bar Graphs or Area Graphs.

Note that if a data sample falls outside this value, that value will take precedence.

Default: -Infinity for Line Graphs, zero for Bar Graphs and Area Graphs

Since:
1.0.5 for BarGraphs

optionMaxY

public void optionMaxY(double val)
The maximum value to plot on the Y axis. Set this to plot useful values for curves like tangents, that give infinite values at certain points, or extend the top of the graph beyond the maximum value of the data.

Note that if a data sample falls outside this value, that value will take precedence.

Default: +Infinity

Since:
1.0.5 for BarGraphs


Copyright © 2001-2012 Big Faceless Organization