ElegantJCharts Java API Specification v2.0

com.elegantj.graphx
Class AxisDetail

java.lang.Object
  |
  +--com.elegantj.graphx.AxisDetail
All Implemented Interfaces:
java.lang.Cloneable, java.io.Externalizable, java.io.Serializable
Direct Known Subclasses:
GraphXAxisDetail, GraphYAxisDetail, GraphZAxisDetail

public class AxisDetail
extends java.lang.Object
implements java.io.Externalizable, java.lang.Cloneable

Axis Detail is a super class that provides detailed description about the axis like name Color, name Font, label Color, label Font etc. You can change the description values to suit your customization.

See Also:
Serialized Form

Constructor Summary
AxisDetail()
           
 
Method Summary
 java.lang.Object clone()
          Clones an Object
 java.util.Vector getAxisDisplayMap()
          This method helps to map the values displayed by axis label data
 java.awt.Color getAxisGridLineColor()
          This method allows you to select the Axis Grid Line Color
 int getAxisGridLineStyle()
          This method allows you to select Axis Grid Line Style
 boolean getAxisGridLineVisible()
          This method lets you choose if you want to have Axis Grid Line visible on Major Line
 int getAxisGridLineWidth()
          You can adjust Axis Grid Line Width using this method
 java.awt.Color getAxisGridStripColor()
          Color of the Axis Grid Line can be selected using this method
 boolean getAxisGridStripVisible()
          get Axis Grid Strip visible on Major Line
 int getAxisLabelAlign()
          Axis Label alignment can be chosen using this method.
 int getAxisLabelAlignAngle()
          Axis Label Alignment Angle can be set using this method
 java.awt.Color getAxisLabelBackground()
          Background Color of the axis label can be selected using this method
 boolean getAxisLabelBackgroundVisible()
          You can choose if you want to have Axis label Background visible by this method
 boolean getAxisLabelDrillDownEnable()
          Axis label DrillDown can be enabled or disabled using this method
 java.awt.Font getAxisLabelFont()
          Font of the Axis Label can be selected using this method
 java.awt.Color getAxisLabelForeground()
          You can select the font color of the axis using this method
 java.lang.String getAxisLabelFormat()
          Axis Label Formatting can be done using this method
 int getAxisLabelGap()
          The label gap can be adjusted using the get Axis Label gap method
 java.lang.String getAxisLabelTooltipText()
          Using this method you can choose to have tool tip text for an axis label
 boolean getAxisLabelVisible()
          To display the Axis Label you can use this method
 java.awt.Color getAxisLineColor()
          Axis Major Line Color can be selected using this method
 int getAxisLineWidth()
          Axis Major Line Width can be selected using this method
 java.lang.String getAxisName()
          To assign a name to the Axis you can use this method
 int getAxisNameAlign()
          Axis Name Alignment can be set using this method
 java.awt.Color getAxisNameBackground()
          Background Color of the Axis Name can be selected using this method
 boolean getAxisNameBackgroundVisible()
          To display the background of the axis name, you can use this method
 java.awt.Color getAxisNameBorderColor()
          Use this method to select the Axis Name Border Color
 int getAxisNameBorderStyle()
          Axis Name Border style can be selected with this method
 int getAxisNameBorderWidth()
          The width of the border of the Axis Name can be adjusted with this method
 java.awt.Font getAxisNameFont()
          Select the font for the axis Name using this method
 java.awt.Color getAxisNameForeground()
          Axis Font Color can be selected using this method
 int getAxisNameMaxLine()
          Maximum number of lines in which the Axis Name must be displayed can be set with this method
 java.awt.Color getAxisNameShadowColor()
          Axis Name Shadow Color can be selected with this method
 int getAxisNameShadowStyle()
          Shadow style of the Axis Name can be selected with this method
 int getAxisNameShadowWidth()
          Shadow width of the Axis Name can be adjusted with this method
 boolean getAxisNameVisible()
          You can display the Axis Name using this method
 java.awt.Color getAxisTickLineColor()
          Color of the Axis Tick Line can be assigned using this method
 int getAxisTickLineHeight()
          Axis Tick Line Height can be adjusted using this method
 int getAxisTickLinePosition()
          the Position of the Axis Tick Line can be set using this method
 boolean getAxisTickLineVisible()
          Use this method toget Axis Tick Line visible on Major Line
 int getAxisTickLineWidth()
          Axis Tick Line Width can be adjusted using this method
 int getMaximumFractionDigit()
          Maximum Number of Fraction digit after decimal can be set for the axis label value with this method
 int getNegativeValueRep()
          Negative Value Representation for Axis labels can be assigned using this method
 boolean getOverLapAxisLabelEnable()
          Axis label Overlapping can be enabled or disabled with this method
 boolean getUnitPosition()
          Axis Label unit at suffix to value
 java.lang.String getUnitText()
          Axis Label Unit Text can be assigned with this method
 boolean isCommaFormatted()
          Axis Label as comma Formatted can be displayed using this method
 void readExternal(java.io.ObjectInput in)
          This method retrieves the state of the bean
 void setAxisDisplayMap(java.util.Vector map)
          set Axis Label Data-Display value mapping
 void setAxisGridLineColor(java.awt.Color linecolor)
          set Axis Grid Line Color
 void setAxisGridLineStyle(int style)
          set Axis Grid Line Style
 void setAxisGridLineVisible(boolean visible)
          set Axis Grid Line visible on Major Line
 void setAxisGridLineWidth(int width)
          set Axis Grid Line Width
 void setAxisGridStripColor(java.awt.Color linecolor)
          set Axis Grid Strip Color
 void setAxisGridStripVisible(boolean visible)
          set Axis Grid Strip visible on Major Line
 void setAxisLabelAlign(int align)
          set Axis Label alignment
 void setAxisLabelAlignAngle(int angle)
          set Axis Name Alignment Angle
 void setAxisLabelBackground(java.awt.Color Backgroundcolor)
          set Axis label Background Color
 void setAxisLabelBackgroundVisible(boolean visible)
          set Axis label Background visible
 void setAxisLabelDrillDownEnable(boolean enable)
          set Axis label DrillDown Enable
 void setAxisLabelFont(java.awt.Font labelfont)
          set Axis Label Font
 void setAxisLabelForeground(java.awt.Color foreground)
          set Axis Label Font Color
 void setAxisLabelFormat(java.lang.String formatStr)
          set Axis Label Format string
 void setAxisLabelGap(int gap)
          set Axis Label gap
 void setAxisLabelTooltipText(java.lang.String tooltip)
          set Axis Label Tooltip text
 void setAxisLabelVisible(boolean visible)
          set Axis Label visible
 void setAxisLineColor(java.awt.Color linecolor)
          set Axis Major Line Color
 void setAxisLineWidth(int width)
          set Axis Major Line Width
 void setAxisName(java.lang.String name)
          set Axis Name
 void setAxisNameAlign(int align)
          set Axis Name Alignment
 void setAxisNameBackground(java.awt.Color bgColor)
          set Axis Name Background Color
 void setAxisNameBackgroundVisible(boolean visible)
          set Axis Name Background visible
 void setAxisNameBorderColor(java.awt.Color inColor)
          set Axis Name Border Color
 void setAxisNameBorderStyle(int style)
          set Axis Name Border style
 void setAxisNameBorderWidth(int width)
          set Axis Name Border Width
 void setAxisNameFont(java.awt.Font namefont)
          set Axis Name Font
 void setAxisNameForeground(java.awt.Color foreground)
          set Axis Name Font Color
 void setAxisNameMaxLine(int max)
          set Axis Name Maximum number of lines
 void setAxisNameShadowColor(java.awt.Color inColor)
          set Axis Name Shadow Color
 void setAxisNameShadowStyle(int style)
          set Axis Name Shadow style
 void setAxisNameShadowWidth(int width)
          set Axis Name Shadow Width
 void setAxisNameVisible(boolean visible)
          set Axis Name visible
 void setAxisTickLineColor(java.awt.Color linecolor)
          set Axis Tick Line Color
 void setAxisTickLineHeight(int height)
          set Axis Tick Line Height
 void setAxisTickLinePosition(int position)
          set Axis Tick Line Position
 void setAxisTickLineVisible(boolean visible)
          set Axis Tick Line visible on Major Line
 void setAxisTickLineWidth(int width)
          set Axis Tick Line Width
 void setCommaFormatted(boolean isComma)
          set Axis Label as comma Formatted
 void setMaximumFractionDigit(int no)
          set Axis Label Maximum Number of Fraction digit after decimal
 void setNegativeValueRep(int value)
          Set -ve Value Representation for Axis labels
 void setOverLapAxisLabelEnable(boolean visible)
          set Axis label OverLap enable
 void setUnitPosition(boolean isSuffix)
          set Axis Label unit at suffix to value
 void setUnitText(java.lang.String text)
          set Axis Label Unit Text
 void writeExternal(java.io.ObjectOutput out)
          This method saves the state of the bean
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AxisDetail

public AxisDetail()
Method Detail

setAxisNameVisible

public void setAxisNameVisible(boolean visible)
set Axis Name visible

Parameters:
visible - if true then Axis name is display otherwise not drawn

getAxisNameVisible

public boolean getAxisNameVisible()
You can display the Axis Name using this method

Returns:
boolean true if Axis name is display otherwise false

setAxisName

public void setAxisName(java.lang.String name)
set Axis Name

Parameters:
name - String representing Axis name

getAxisName

public java.lang.String getAxisName()
To assign a name to the Axis you can use this method

Returns:
String String Object representing Axis name

setAxisNameMaxLine

public void setAxisNameMaxLine(int max)
set Axis Name Maximum number of lines

Parameters:
max - Maximum number of Axis name lines

getAxisNameMaxLine

public int getAxisNameMaxLine()
Maximum number of lines in which the Axis Name must be displayed can be set with this method

Returns:
int Maximum number of Axis name lines

setAxisNameFont

public void setAxisNameFont(java.awt.Font namefont)
set Axis Name Font

Parameters:
namefont - font style for Axis name

getAxisNameFont

public java.awt.Font getAxisNameFont()
Select the font for the axis Name using this method

Returns:
Font Specifies Axis name Font Style

setAxisNameForeground

public void setAxisNameForeground(java.awt.Color foreground)
set Axis Name Font Color

Parameters:
foreground - Foregound Color for Axis name

getAxisNameForeground

public java.awt.Color getAxisNameForeground()
Axis Font Color can be selected using this method

Returns:
Color Foreground Color of Axis name

setAxisNameBackgroundVisible

public void setAxisNameBackgroundVisible(boolean visible)
set Axis Name Background visible

Parameters:
visible - if true then Axis name Backgound is drawn otherwise not

getAxisNameBackgroundVisible

public boolean getAxisNameBackgroundVisible()
To display the background of the axis name, you can use this method

Returns:
boolean true if Axis name Background is Drawn otherwise false

setAxisNameBackground

public void setAxisNameBackground(java.awt.Color bgColor)
set Axis Name Background Color

Parameters:
bgColor - Background Color for Axis name

getAxisNameBackground

public java.awt.Color getAxisNameBackground()
Background Color of the Axis Name can be selected using this method

Returns:
Color Background Color of Axis name

setAxisNameBorderStyle

public void setAxisNameBorderStyle(int style)
set Axis Name Border style

Parameters:
style - Axis name Border style

getAxisNameBorderStyle

public int getAxisNameBorderStyle()
Axis Name Border style can be selected with this method

Returns:
int Axis name Border style

setAxisNameBorderWidth

public void setAxisNameBorderWidth(int width)
set Axis Name Border Width

Parameters:
width - Axis name Border width

getAxisNameBorderWidth

public int getAxisNameBorderWidth()
The width of the border of the Axis Name can be adjusted with this method

Returns:
int Axis name Border width

setAxisNameBorderColor

public void setAxisNameBorderColor(java.awt.Color inColor)
set Axis Name Border Color

Parameters:
inColor - Axis name Border color

getAxisNameBorderColor

public java.awt.Color getAxisNameBorderColor()
Use this method to select the Axis Name Border Color

Returns:
Color Axis name Border Color

setAxisNameShadowStyle

public void setAxisNameShadowStyle(int style)
set Axis Name Shadow style

Parameters:
style - Axis name Shadow style

getAxisNameShadowStyle

public int getAxisNameShadowStyle()
Shadow style of the Axis Name can be selected with this method

Returns:
int Axis name Shadow style

setAxisNameShadowWidth

public void setAxisNameShadowWidth(int width)
set Axis Name Shadow Width

Parameters:
width - Axis name Shadow width

getAxisNameShadowWidth

public int getAxisNameShadowWidth()
Shadow width of the Axis Name can be adjusted with this method

Returns:
int Axis name Shadow width

setAxisNameShadowColor

public void setAxisNameShadowColor(java.awt.Color inColor)
set Axis Name Shadow Color

Parameters:
inColor - Axis name Shadow color

getAxisNameShadowColor

public java.awt.Color getAxisNameShadowColor()
Axis Name Shadow Color can be selected with this method

Returns:
Color Axis name Shadow Color

setAxisNameAlign

public void setAxisNameAlign(int align)
set Axis Name Alignment

Parameters:
align - Alignment of Axis name

getAxisNameAlign

public int getAxisNameAlign()
Axis Name Alignment can be set using this method

Returns:
int Alignment of Axis name

setAxisLabelVisible

public void setAxisLabelVisible(boolean visible)
set Axis Label visible

Parameters:
visible - if true then Axis labels are display otherwise not drawn

getAxisLabelVisible

public boolean getAxisLabelVisible()
To display the Axis Label you can use this method

Returns:
boolean true if Axis Labels are display otherwise false

setAxisLabelAlign

public void setAxisLabelAlign(int align)
set Axis Label alignment


getAxisLabelAlign

public int getAxisLabelAlign()
Axis Label alignment can be chosen using this method.

Returns:
Alignment of Axis Label

setAxisLabelGap

public void setAxisLabelGap(int gap)
set Axis Label gap


getAxisLabelGap

public int getAxisLabelGap()
The label gap can be adjusted using the get Axis Label gap method

Returns:
Axis Label gap

setAxisLabelFont

public void setAxisLabelFont(java.awt.Font labelfont)
set Axis Label Font


getAxisLabelFont

public java.awt.Font getAxisLabelFont()
Font of the Axis Label can be selected using this method

Returns:
Font Specifies Axis Label Font Style

setAxisLabelForeground

public void setAxisLabelForeground(java.awt.Color foreground)
set Axis Label Font Color

Parameters:
foreground - Foreground Color for Axis label

getAxisLabelForeground

public java.awt.Color getAxisLabelForeground()
You can select the font color of the axis using this method

Returns:
Color Foreground Color of Axis label

setAxisLabelBackgroundVisible

public void setAxisLabelBackgroundVisible(boolean visible)
set Axis label Background visible

Parameters:
visible - if true then Axis label Backgound is drawn otherwise not

getAxisLabelBackgroundVisible

public boolean getAxisLabelBackgroundVisible()
You can choose if you want to have Axis label Background visible by this method

Returns:
boolean true if Axis label Background is Drawn otherwise false

setAxisLabelBackground

public void setAxisLabelBackground(java.awt.Color Backgroundcolor)
set Axis label Background Color


getAxisLabelBackground

public java.awt.Color getAxisLabelBackground()
Background Color of the axis label can be selected using this method

Returns:
Color Background Color of Axis label

setAxisLabelAlignAngle

public void setAxisLabelAlignAngle(int angle)
set Axis Name Alignment Angle


getAxisLabelAlignAngle

public int getAxisLabelAlignAngle()
Axis Label Alignment Angle can be set using this method

Returns:
int Alignment Angle of Axis Label

setOverLapAxisLabelEnable

public void setOverLapAxisLabelEnable(boolean visible)
set Axis label OverLap enable

Parameters:
visible - if true then Over lap Axis label is drawn otherwise not

getOverLapAxisLabelEnable

public boolean getOverLapAxisLabelEnable()
Axis label Overlapping can be enabled or disabled with this method

Returns:
boolean true if OverLap Axis label is Drawn otherwise false

setAxisDisplayMap

public void setAxisDisplayMap(java.util.Vector map)
set Axis Label Data-Display value mapping

Parameters:
map - Vector representing Data-Display value mapping

getAxisDisplayMap

public java.util.Vector getAxisDisplayMap()
This method helps to map the values displayed by axis label data

Returns:
Vector Vector representing Data-Display value mapping

setAxisLabelFormat

public void setAxisLabelFormat(java.lang.String formatStr)
set Axis Label Format string

Parameters:
formatStr - String representing Axis Label Format

getAxisLabelFormat

public java.lang.String getAxisLabelFormat()
Axis Label Formatting can be done using this method

Returns:
String String Object representing Axis Label Format

setMaximumFractionDigit

public void setMaximumFractionDigit(int no)
set Axis Label Maximum Number of Fraction digit after decimal

Parameters:
no - Maximum Number of Fraction digit after decimal

getMaximumFractionDigit

public int getMaximumFractionDigit()
Maximum Number of Fraction digit after decimal can be set for the axis label value with this method

Returns:
int Maximum Number of Fraction digit after decimal

setCommaFormatted

public void setCommaFormatted(boolean isComma)
set Axis Label as comma Formatted

Parameters:
isComma - boolean specifies Value as comma Formatted

isCommaFormatted

public boolean isCommaFormatted()
Axis Label as comma Formatted can be displayed using this method

Returns:
boolean boolean specifies Value as comma Formatted

setUnitText

public void setUnitText(java.lang.String text)
set Axis Label Unit Text

Parameters:
text - string specifies Unit Text

getUnitText

public java.lang.String getUnitText()
Axis Label Unit Text can be assigned with this method

Returns:
String string specifies Unit Text

setUnitPosition

public void setUnitPosition(boolean isSuffix)
set Axis Label unit at suffix to value

Parameters:
isSuffix - true - suffix, false - prefix

getUnitPosition

public boolean getUnitPosition()
Axis Label unit at suffix to value

Returns:
boolean true - suffix, false - prefix

setNegativeValueRep

public void setNegativeValueRep(int value)
Set -ve Value Representation for Axis labels

Parameters:
value - This value specifies the -ve Value Representation for Axis labels

getNegativeValueRep

public int getNegativeValueRep()
Negative Value Representation for Axis labels can be assigned using this method

Returns:
value This value specifies the -ve Value Representation for Axis labels

setAxisLabelDrillDownEnable

public void setAxisLabelDrillDownEnable(boolean enable)
set Axis label DrillDown Enable


getAxisLabelDrillDownEnable

public boolean getAxisLabelDrillDownEnable()
Axis label DrillDown can be enabled or disabled using this method

Returns:
boolean true if Axis label DrillDown Enable otherwise false

setAxisLabelTooltipText

public void setAxisLabelTooltipText(java.lang.String tooltip)
set Axis Label Tooltip text

Parameters:
tooltip - String representing Axis Label tooltip text

getAxisLabelTooltipText

public java.lang.String getAxisLabelTooltipText()
Using this method you can choose to have tool tip text for an axis label

Returns:
String String Object representing Axis Label Tooltip Text

setAxisLineColor

public void setAxisLineColor(java.awt.Color linecolor)
set Axis Major Line Color

Parameters:
linecolor - Color of Major Axis line

getAxisLineColor

public java.awt.Color getAxisLineColor()
Axis Major Line Color can be selected using this method

Returns:
Color Major axis line Color

setAxisLineWidth

public void setAxisLineWidth(int width)
set Axis Major Line Width


getAxisLineWidth

public int getAxisLineWidth()
Axis Major Line Width can be selected using this method

Returns:
int line Width of Major axis

setAxisTickLineVisible

public void setAxisTickLineVisible(boolean visible)
set Axis Tick Line visible on Major Line

Parameters:
visible - if true then Axis Tick line is drawn otherwise not

getAxisTickLineVisible

public boolean getAxisTickLineVisible()
Use this method toget Axis Tick Line visible on Major Line

Returns:
boolean true if Axis Tick line is drawn otherwise false

setAxisTickLineColor

public void setAxisTickLineColor(java.awt.Color linecolor)
set Axis Tick Line Color


getAxisTickLineColor

public java.awt.Color getAxisTickLineColor()
Color of the Axis Tick Line can be assigned using this method

Returns:
Color Tick Line Color

setAxisTickLineWidth

public void setAxisTickLineWidth(int width)
set Axis Tick Line Width


getAxisTickLineWidth

public int getAxisTickLineWidth()
Axis Tick Line Width can be adjusted using this method

Returns:
int Width of Axis Tick Line

setAxisTickLineHeight

public void setAxisTickLineHeight(int height)
set Axis Tick Line Height

Parameters:
height - Height of Axis Tick line

getAxisTickLineHeight

public int getAxisTickLineHeight()
Axis Tick Line Height can be adjusted using this method

Returns:
int Height of Axis Tick Line

setAxisTickLinePosition

public void setAxisTickLinePosition(int position)
set Axis Tick Line Position

Parameters:
position - Position of Axis Tick line

getAxisTickLinePosition

public int getAxisTickLinePosition()
the Position of the Axis Tick Line can be set using this method

Returns:
int Position of Axis Tick Line

setAxisGridLineVisible

public void setAxisGridLineVisible(boolean visible)
set Axis Grid Line visible on Major Line

Parameters:
visible - if true then Axis Grid line is drawn otherwise not

getAxisGridLineVisible

public boolean getAxisGridLineVisible()
This method lets you choose if you want to have Axis Grid Line visible on Major Line

Returns:
boolean true if Axis Grid line is drawn otherwise false

setAxisGridLineColor

public void setAxisGridLineColor(java.awt.Color linecolor)
set Axis Grid Line Color


getAxisGridLineColor

public java.awt.Color getAxisGridLineColor()
This method allows you to select the Axis Grid Line Color

Returns:
Color Grid Line Color

setAxisGridLineWidth

public void setAxisGridLineWidth(int width)
set Axis Grid Line Width


getAxisGridLineWidth

public int getAxisGridLineWidth()
You can adjust Axis Grid Line Width using this method

Returns:
int Width of Axis Grid Line

setAxisGridLineStyle

public void setAxisGridLineStyle(int style)
set Axis Grid Line Style

Parameters:
style - Style of Axis Grid line

getAxisGridLineStyle

public int getAxisGridLineStyle()
This method allows you to select Axis Grid Line Style

Returns:
int Style of Axis Grid Line

setAxisGridStripVisible

public void setAxisGridStripVisible(boolean visible)
set Axis Grid Strip visible on Major Line

Parameters:
visible - if true then Axis Grid Strip is drawn otherwise not

getAxisGridStripVisible

public boolean getAxisGridStripVisible()
get Axis Grid Strip visible on Major Line

Returns:
boolean true if Axis Grid Strip is drawn otherwise false

setAxisGridStripColor

public void setAxisGridStripColor(java.awt.Color linecolor)
set Axis Grid Strip Color


getAxisGridStripColor

public java.awt.Color getAxisGridStripColor()
Color of the Axis Grid Line can be selected using this method

Returns:
Color Grid Line Color

clone

public java.lang.Object clone()
Clones an Object

Overrides:
clone in class java.lang.Object

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.lang.ClassNotFoundException,
                         java.io.IOException
This method retrieves the state of the bean

Specified by:
readExternal in interface java.io.Externalizable
java.lang.ClassNotFoundException
java.io.IOException

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
This method saves the state of the bean

Specified by:
writeExternal in interface java.io.Externalizable
java.io.IOException

ElegantJCharts Java API Specification v2.0

For any feedback, suggestion, or query, please revert back to support@elegantcharts.com

Copyright(c)
Elegant Microweb Technologies Pvt. Ltd.
www.elegantmicroweb.com
www.elegantjcharts.com
All Rights Reserved.