com.infragistics.faces.chart.component
Class Axis

java.lang.Object
  com.infragistics.faces.shared.component.ModelComponent
      com.infragistics.faces.chart.component.Scale
          com.infragistics.faces.chart.component.Axis

All Implemented Interfaces:

java.io.Serializable

public class Axis

extends Scale

Axes define the scale for a series as well as attributes for the visible axis and associate grid lines. A chart, seriesgroup or series can embed one or more axis tags, which will define an axis to be used for that object and (in the case of charts and series groups) all nested series.

Most series require two axes (pie and donut charts do not require axes), three dimensional charts also require a Z axis to give depth to the chart. The chart component will create any or all of these if they are required but missing from the chart.

Axis components defines four collections of marks which are used as tickmarks, axis strips, gridlines and gridstrips whenever the axis is used.

Axis components can be configured to automatically generate tickmarks and grid lines and to automatically choose and/or snap appropriate minimum and maximum values.

See Also:

Serialized Form

Constructor Summary

Axis()

Method Summary

Axis	getCrossingXAxis() Returns the x-crossing reference axis.
float	getCrossingXValue() Returns the x-crossing reference value.
Axis	getCrossingYAxis() Returns the y-crossing reference axis.
float	getCrossingYValue() Returns the y-crossing reference value.
Axis	getCrossingZAxis() Returns the z-crossing reference axis.
float	getCrossingZValue() Returns the z-crossing reference value.
java.util.List	getGridLines() Returns the collection of marks defining the grid lines for this axis.
java.lang.String	getGridLineStyleClass() Returns the default CSS style applied when gridlines are rendered.
java.util.List	getGridStrips() Returns the collection of marks defining the grid strips for this axis.
java.lang.String	getGridStripStyleClass() Returns the default CSS style applied when gridstrips are rendered.
java.lang.String	getStyleClass() Returns the CSS style applied when this axis is rendered.
java.lang.String	getTickCaption() Returns the default formatting mask used to generate mark and value labels.
java.util.List	getTickMarks() Returns the collection of marks defining the tick marks for this axis.
java.lang.String	getTickMarkStyleClass() Returns the default CSS style applied when tick marks are rendered.
java.lang.String	getType() Returns the type (X, Y or Z) of this axis.
boolean	hasCrossingXValue() Returns true if the axis has a defined x crossing value
boolean	hasCrossingYValue() Returns true if the axis has a defined y crossing value
boolean	hasCrossingZValue() Returns true if the axis has a defined z crossing value
boolean	isAutoGridLines() Returns the automatic gridline generation flag.
boolean	isAutoRange() Returns the automatic minimum and maximum value calculation flag.
boolean	isAutoRangeSnap() Returns the automatic minimum and maximum value snap flag.
boolean	isAutoTickMarks() Returns the automatic tick mark generation flag.
void	setAutoGridLines(boolean autoGridLines) Sets the automatic gridline generation flag.
void	setAutoRange(boolean autoRange) Sets the automatic minimum and maximum value calculation flag.
void	setAutoRangeSnap(boolean autoRangeSnap) Sets the automatic minimum and maximum value snap flag.
void	setAutoTickMarks(boolean autoTickMarks) Sets the automatic tick mark generation flag.
void	setCrossingXAxis(Axis crossingXAxis) Sets the x-crossing reference axis.
void	setCrossingXValue(float crossingXValue) Sets the x-crossing reference value.
void	setCrossingYAxis(Axis crossingYAxis) Sets the y-crossing reference axis.
void	setCrossingYValue(float crossingYValue) Sets the y-crossing reference value.
void	setCrossingZAxis(Axis crossingZAxis) Sets the z-crossing reference axis.
void	setCrossingZValue(float crossingZValue) Sets the z-crossing reference value.
void	setGridLines(java.util.List gridLines) Sets the collection of marks defining the grid lines for this axis.
void	setGridLineStyleClass(java.lang.String gridLineStyleClass) Sets the default CSS style applied when gridlines are rendered.
void	setGridStrips(java.util.List gridStrips) Sets the collection of marks defining the grid strips for this axis.
void	setGridStripStyleClass(java.lang.String gridStripStyleClass) Sets the default CSS style applied when gridstrips are rendered.
void	setStyleClass(java.lang.String styleClass) Sets the CSS style applied when this axis is rendered.
void	setTickCaption(java.lang.String tickCaption) Sets the default formatting mask used to generate mark and value labels.
void	setTickMarks(java.util.List tickMarks) Sets the collection of marks defining the tick marks for this axis.
void	setTickMarkStyleClass(java.lang.String tickMarkStyleClass) Sets the default CSS style applied when tick marks are rendered.
void	setType(java.lang.String type) Sets the type (X, Y or Z) of this axis.

Methods inherited from class com.infragistics.faces.chart.component.Scale

getBase, getMaximumValue, getMinimumValue, getScaledValue, isLogarithmic, setBase, setLogarithmic, setMaximumValue, setMinimumValue

Methods inherited from class com.infragistics.faces.shared.component.ModelComponent

getParent, getValueBinding, setParent, setValueBinding

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Axis

public Axis()

Method Detail

isAutoGridLines

public boolean isAutoGridLines()

Returns the automatic gridline generation flag.

Returns:

boolean

setAutoGridLines

public void setAutoGridLines(boolean autoGridLines)

Sets the automatic gridline generation flag.

Parameters:

autoGridLines - boolean

isAutoRange

public boolean isAutoRange()

Returns the automatic minimum and maximum value calculation flag.

Returns:

boolean

setAutoRange

public void setAutoRange(boolean autoRange)

Sets the automatic minimum and maximum value calculation flag.

Parameters:

autoRange - boolean

isAutoRangeSnap

public boolean isAutoRangeSnap()

Returns the automatic minimum and maximum value snap flag.

Returns:

boolean

setAutoRangeSnap

public void setAutoRangeSnap(boolean autoRangeSnap)

Sets the automatic minimum and maximum value snap flag.

Parameters:

autoRangeSnap - boolean

isAutoTickMarks

public boolean isAutoTickMarks()

Returns the automatic tick mark generation flag.

Returns:

boolean

setAutoTickMarks

public void setAutoTickMarks(boolean autoTickMarks)

Sets the automatic tick mark generation flag.

Parameters:

autoTickMarks - boolean

getCrossingXAxis

public Axis getCrossingXAxis()

Returns the x-crossing reference axis.

Returns:

com.infragistics.faces.chart.component.Axis

setCrossingXAxis

public void setCrossingXAxis(Axis crossingXAxis)

Sets the x-crossing reference axis.

Parameters:

crossingXAxis - Axis

getCrossingXValue

public float getCrossingXValue()

Returns the x-crossing reference value.

Returns:

float

hasCrossingXValue

public boolean hasCrossingXValue()

Returns true if the axis has a defined x crossing value

Returns:

boolean

setCrossingXValue

public void setCrossingXValue(float crossingXValue)

Sets the x-crossing reference value.

Parameters:

crossingXValue - float

getCrossingYAxis

public Axis getCrossingYAxis()

Returns the y-crossing reference axis.

Returns:

com.infragistics.faces.chart.component.Axis

setCrossingYAxis

public void setCrossingYAxis(Axis crossingYAxis)

Sets the y-crossing reference axis.

Parameters:

crossingYAxis - Axis

hasCrossingYValue

public boolean hasCrossingYValue()

Returns true if the axis has a defined y crossing value

Returns:

boolean

getCrossingYValue

public float getCrossingYValue()

Returns the y-crossing reference value.

Returns:

float

setCrossingYValue

public void setCrossingYValue(float crossingYValue)

Sets the y-crossing reference value.

Parameters:

crossingYValue - float

getCrossingZAxis

public Axis getCrossingZAxis()

Returns the z-crossing reference axis.

Returns:

com.infragistics.faces.chart.component.Axis

setCrossingZAxis

public void setCrossingZAxis(Axis crossingZAxis)

Sets the z-crossing reference axis.

Parameters:

crossingZAxis - Axis

hasCrossingZValue

public boolean hasCrossingZValue()

Returns true if the axis has a defined z crossing value

Returns:

boolean

getCrossingZValue

public float getCrossingZValue()

Returns the z-crossing reference value.

Returns:

float

setCrossingZValue

public void setCrossingZValue(float crossingZValue)

Sets the z-crossing reference value.

Parameters:

crossingZValue - float

getGridLines

public java.util.List getGridLines()

Returns the collection of marks defining the grid lines for this axis.

Returns:

com.infragistics.faces.chart.component.Mark

setGridLines

public void setGridLines(java.util.List gridLines)

Sets the collection of marks defining the grid lines for this axis.

Parameters:

gridLines - java.util.List

getGridLineStyleClass

public java.lang.String getGridLineStyleClass()

Returns the default CSS style applied when gridlines are rendered.

Returns:

java.lang.String

setGridLineStyleClass

public void setGridLineStyleClass(java.lang.String gridLineStyleClass)

Sets the default CSS style applied when gridlines are rendered.

Parameters:

gridLineStyleClass - String

getGridStrips

public java.util.List getGridStrips()

Returns the collection of marks defining the grid strips for this axis.

Returns:

com.infragistics.faces.chart.component.Mark

setGridStrips

public void setGridStrips(java.util.List gridStrips)

Sets the collection of marks defining the grid strips for this axis.

Parameters:

gridStrips - java.util.List

getGridStripStyleClass

public java.lang.String getGridStripStyleClass()

Returns the default CSS style applied when gridstrips are rendered.

Returns:

java.lang.String

setGridStripStyleClass

public void setGridStripStyleClass(java.lang.String gridStripStyleClass)

Sets the default CSS style applied when gridstrips are rendered.

Parameters:

gridStripStyleClass - String

getStyleClass

public java.lang.String getStyleClass()

Returns the CSS style applied when this axis is rendered.

Returns:

java.lang.String

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Sets the CSS style applied when this axis is rendered.

Parameters:

styleClass - String

getTickCaption

public java.lang.String getTickCaption()

Returns the default formatting mask used to generate mark and value labels.

Returns:

java.lang.String

setTickCaption

public void setTickCaption(java.lang.String tickCaption)

Sets the default formatting mask used to generate mark and value labels.

Parameters:

tickCaption - String

getTickMarks

public java.util.List getTickMarks()

Returns the collection of marks defining the tick marks for this axis.

Returns:

com.infragistics.faces.chart.component.Mark

setTickMarks

public void setTickMarks(java.util.List tickMarks)

Sets the collection of marks defining the tick marks for this axis.

Parameters:

tickMarks - java.util.List

getTickMarkStyleClass

public java.lang.String getTickMarkStyleClass()

Returns the default CSS style applied when tick marks are rendered.

Returns:

java.lang.String

setTickMarkStyleClass

public void setTickMarkStyleClass(java.lang.String tickMarkStyleClass)

Sets the default CSS style applied when tick marks are rendered.

Parameters:

tickMarkStyleClass - String

getType

public java.lang.String getType()

Returns the type (X, Y or Z) of this axis.

Returns:

com.infragistics.faces.chart.enumeration.AxisType (x, y, z)

setType

public void setType(java.lang.String type)

Sets the type (X, Y or Z) of this axis.

Parameters:

type - String (x, y, z)