com.f1j.chart
Interface DataLabelFormat


public interface DataLabelFormat
extends FormatBase

The Data Label Format interface.


Inner Class Summary
static class DataLabelFormat.EPosition
          Data label position enumeration
static class DataLabelFormat.EProperty
          Data label format property enumeration
 
Field Summary
static short eDataLabelPercentageMask
          Data label displays the value of the data point as a percent.
static short eDataLabelSeriesNameMask
          Data label displays the series name.
static short eDataLabelSizeValueMask
          Data label displays the value of the bubble size.
static short eDataLabelXValueMask
          Data label displays the X value, or category name.
static short eDataLabelYValueMask
          Data label displays the Y value.
static short eNone
          Data label is not displayed.
static DataLabelFormat.EProperty ePosition
          Data Label Position attribute.
static DataLabelFormat.EPosition ePositionAbove
          Data label position above.
static DataLabelFormat.EPosition ePositionAuto
          Data label position automatic.
static DataLabelFormat.EPosition ePositionAxis
          Data label position axis.
static DataLabelFormat.EPosition ePositionBelow
          Data label position below.
static DataLabelFormat.EPosition ePositionCenter
          Data label position center.
static DataLabelFormat.EPosition ePositionDefault
          Use default data label positioning.
static DataLabelFormat.EPosition ePositionInside
          Data label position inside.
static DataLabelFormat.EPosition ePositionLeft
          Data label position left.
static DataLabelFormat.EPosition ePositionOutside
          Data label position outside.
static DataLabelFormat.EPosition ePositionRight
          Data label position right.
static DataLabelFormat.EProperty eSeparator
          Data Label Separator attribute.
static DataLabelFormat.EProperty eType
          Data label type attribute.
 
Method Summary
 DataLabelFormat.EPosition getPosition()
          Gets the data label position.
 java.lang.String getSeparator()
          Returns the data label separator value.
 int getType()
          Gets the data label type.
 void setPosition(DataLabelFormat.EPosition position)
          Sets the data label position.
 void setSeparator(java.lang.String separator)
          Sets the data label separator.
 void setType(int type)
          Sets the data label type.
 
Methods inherited from interface com.f1j.util.FormatBase
isUndefined, isUndefined, isUsed, setUndefined, undefineAll, useAll
 

Field Detail

eType

public static final DataLabelFormat.EProperty eType
Data label type attribute.

ePosition

public static final DataLabelFormat.EProperty ePosition
Data Label Position attribute.

eSeparator

public static final DataLabelFormat.EProperty eSeparator
Data Label Separator attribute.

ePositionDefault

public static final DataLabelFormat.EPosition ePositionDefault
Use default data label positioning.

ePositionOutside

public static final DataLabelFormat.EPosition ePositionOutside
Data label position outside.

ePositionInside

public static final DataLabelFormat.EPosition ePositionInside
Data label position inside.

ePositionCenter

public static final DataLabelFormat.EPosition ePositionCenter
Data label position center.

ePositionAxis

public static final DataLabelFormat.EPosition ePositionAxis
Data label position axis.

ePositionAbove

public static final DataLabelFormat.EPosition ePositionAbove
Data label position above.

ePositionBelow

public static final DataLabelFormat.EPosition ePositionBelow
Data label position below.

ePositionLeft

public static final DataLabelFormat.EPosition ePositionLeft
Data label position left.

ePositionRight

public static final DataLabelFormat.EPosition ePositionRight
Data label position right.

ePositionAuto

public static final DataLabelFormat.EPosition ePositionAuto
Data label position automatic.

eNone

public static final short eNone
Data label is not displayed.

eDataLabelSeriesNameMask

public static final short eDataLabelSeriesNameMask
Data label displays the series name.

eDataLabelXValueMask

public static final short eDataLabelXValueMask
Data label displays the X value, or category name.

eDataLabelYValueMask

public static final short eDataLabelYValueMask
Data label displays the Y value.

eDataLabelPercentageMask

public static final short eDataLabelPercentageMask
Data label displays the value of the data point as a percent.

eDataLabelSizeValueMask

public static final short eDataLabelSizeValueMask
Data label displays the value of the bubble size.
Method Detail

getPosition

public DataLabelFormat.EPosition getPosition()
Gets the data label position.
Returns:
the data label position.

getSeparator

public java.lang.String getSeparator()
Returns the data label separator value.

Returns:
a String representing the separator
See Also:
setSeparator(String)

getType

public int getType()
Gets the data label type.
Returns:
the data label type.

setPosition

public void setPosition(DataLabelFormat.EPosition position)
Sets the data label position.
Parameters:
position - The position.

setSeparator

public void setSeparator(java.lang.String separator)
Sets the data label separator.
Parameters:
separator - The separator.

setType

public void setType(int type)
             throws InvalidArgumentException
Sets the data label type.
Parameters:
type - The type.