com.infragistics.faces.chart.component
Class Scale

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

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

Axis

public class Scale

extends ModelComponent

Scaling information. A scale has all the information required to convert an arbtirary Number value to the normalised range [0, 1]. Values outside the range are reported as negative and positive infinity.

This class is used internally by the charting component as a super class for the Axis class, and should not be instantiated by users.

See Also:

Serialized Form

Constructor Summary

Scale()

Method Summary

float	getBase() Returns the base used for logarithmic axes and automatic tick mark and gridline calculation.
float	getMaximumValue() Returns the maximum value to plot.
float	getMinimumValue() Returns the minimum value to plot.
float	getScaledValue(float value) Applies this scale to the parameter value.
boolean	isLogarithmic() Returns the logarithmic scaling flag.
void	setBase(float base) Sets the base used for logarithmic axes and automatic tick mark and gridline calculation.
void	setLogarithmic(boolean logarithmic) Sets the logarithmic scaling flag.
void	setMaximumValue(float maximumValue) Sets the maximum value to plot.
void	setMinimumValue(float minimumValue) Sets the minimum value to plot.

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

Scale

public Scale()

Method Detail

getBase

public float getBase()

Returns the base used for logarithmic axes and automatic tick mark and gridline calculation.

Returns:

float

isLogarithmic

public boolean isLogarithmic()

Returns the logarithmic scaling flag.

Returns:

boolean

getMaximumValue

public float getMaximumValue()

Returns the maximum value to plot.

Returns:

float

getMinimumValue

public float getMinimumValue()

Returns the minimum value to plot.

Returns:

float

setBase

public void setBase(float base)

Sets the base used for logarithmic axes and automatic tick mark and gridline calculation.

Parameters:

base - float

setLogarithmic

public void setLogarithmic(boolean logarithmic)

Sets the logarithmic scaling flag.

Parameters:

logarithmic - boolean

setMaximumValue

public void setMaximumValue(float maximumValue)

Sets the maximum value to plot.

Parameters:

maximumValue - float

setMinimumValue

public void setMinimumValue(float minimumValue)

Sets the minimum value to plot.

Parameters:

minimumValue - float

getScaledValue

public float getScaledValue(float value)

Applies this scale to the parameter value.

Parameters:

value - float to convert

Returns:

float