|
Chart FX for Java 6.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectSoftwareFX.ChartFX.AxisSection
Provides access to the AxisSection object.
This class is used to customize chart AxisSection objects. By creating axis sections, the supported class members allow the developer to assign visual attributes to the newly created axis sections. By allowing this customization, developers can focus end user's attention on particular values in the chart or display additional detail.
The Axis Section implementation is another analytical feature embedded into Chart FX. Utilizing this object in your charting applications allows end users to quickly identify focus areas of a chart and determine whether values fall into this range. This analytic enhancement makes data driven charts more pleasing to the eye and easily deciphered by users.
Constructor Summary | |
AxisSection()
|
Method Summary | |
java.awt.Color |
getAlternateColor()
Gets or sets the AlternateColor for a selected Axis or AxisSection object. |
java.awt.Color |
getBackColor()
Gets or sets the AxisSection background color. |
int |
getFontStyle()
Gets or sets additional font attributes to the selelcted AxisSection object. |
double |
getFrom()
Gets or sets a value indicating the beginning value of the range for a selected AxisSection object. |
Line |
getGrid()
Returns a Line object used to customize the gridlines for a selected Axis or AxisSection object. |
Link |
getLink()
Gets the Link object for a selected Axis or AxisSection item. |
Line |
getMinorGrid()
Returns a Line object used to customize the minor gridlines. |
int |
getMinorTickMark()
Gets or sets the style for the minor tick marks of an Axis or AxisSection object. |
java.awt.Color |
getTextColor()
Gets or sets the color for text of a selected Axis or AxisSection object. |
int |
getTickMark()
Gets or sets the style for the tick marks of an Axis or AxisSection object. |
double |
getTo()
Gets or sets a value indicating the ending value of the range for a selected AxisSection object. |
boolean |
isGridlines()
Gets or sets a value indicating to show gridlines for the selected Axis or AxisSection object. |
boolean |
isMinorGridlines()
Gets or sets a value indicating whether to show or hide minor gridlines. |
void |
setAlternateColor(java.awt.Color value)
Gets or sets the AlternateColor for a selected Axis or AxisSection object. |
void |
setBackColor(java.awt.Color value)
Gets or sets the AxisSection background color. |
void |
setFontStyle(int value)
Gets or sets additional font attributes to the selelcted AxisSection object. |
void |
setFrom(double value)
Gets or sets a value indicating the beginning value of the range for a selected AxisSection object. |
void |
setGridlines(boolean value)
Gets or sets a value indicating to show gridlines for the selected Axis or AxisSection object. |
void |
setMinorGridlines(boolean value)
Gets or sets a value indicating whether to show or hide minor gridlines. |
void |
setMinorTickMark(int value)
Gets or sets the style for the minor tick marks of an Axis or AxisSection object. |
void |
setTextColor(java.awt.Color value)
Gets or sets the color for text of a selected Axis or AxisSection object. |
void |
setTickMark(int value)
Gets or sets the style for the tick marks of an Axis or AxisSection object. |
void |
setTo(double value)
Gets or sets a value indicating the ending value of the range for a selected AxisSection object. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public AxisSection()
Method Detail |
public java.awt.Color getAlternateColor()
Gets or sets the AlternateColor for a selected Axis or AxisSection object.
The AlternateColor is used when the selected axis is configured as Axis.setInterlaced(boolean)
. The other color is defined by the configured Chart.setInsideColor(java.awt.Color)
.
The setTextColor(java.awt.Color)
property is used to control the color for the text of the selected Axis or AxisSection object.
The Axis.getSections()
member returns an AxisSection object which may be configured using the AxisSection class members.
For more information regarding the Color type, please refer to the Java API Documentation.
Here is an example of an Interlaced Y axis:
Axis.setInterlaced(boolean)
,
setTextColor(java.awt.Color)
,
Axis.getSections()
,
Chart.setInsideColor(java.awt.Color)
,
Axis
,
AxisSection
public java.awt.Color getBackColor()
Gets or sets the AxisSection background color.
The Axis.getSections()
member returns an AxisSection object which may be configured using the AxisSection class members.
The setFrom(double)
member is used to specify the beginning value of the section range for a selected AxisSection
object.
The setTo(double)
member is used to specify the ending value of the section range for a selected AxisSection
object.
Axis.getSections()
,
setFrom(double)
,
setTo(double)
,
Axis
,
AxisSection
public int getFontStyle()
Gets or sets additional font attributes to the selelcted AxisSection object.
FontStyle :
Specifies style information applied to text.Value | Description |
BOLD | Bold text. |
ITALIC | Italic text. |
REGULAR | Regular text. |
STRIKEOUT | Text with a line through the middle. |
UNDERLINE | Underline text. |
The Axis.getSections()
member returns an AxisSection object which may be configured using the AxisSection class members.
The setFrom(double)
member is used to specify the beginning value of the section range for a selected AxisSection
object.
The setTo(double)
member is used to specify the ending value of the section range for a selected AxisSection
object.
Axis.getSections()
,
setFrom(double)
,
setTo(double)
,
AxisSection
public double getFrom()
Gets or sets a value indicating the beginning value of the range for a selected AxisSection
object.
The setTo(double)
property is used to specify the ending value of the section range for a selected AxisSection
object.
The setFontStyle(int)
property is used to configure additional font attributes for the selected axis section.
The Axis.getSections()
member returns an AxisSection object which may be configured using the AxisSection class members.
setTo(double)
,
setFontStyle(int)
public Line getGrid()
Returns a Line object used to customize the gridlines for a selected Axis or AxisSection object.
Please see the Line
class for the supported members exposed by this property.
Use the setGridlines(boolean)
member to show or hide the axis gridlines for the AxisSection object.
The Axis.getSections()
member returns an AxisSection object which may be configured using the AxisSection classs members.
setGridlines(boolean)
,
Axis.getSections()
,
Line
,
Axis
public Link getLink()
Gets the Link object for a selected Axis or AxisSection item.
Developers may obtain the Link object for an axis section item using this property. Using the supported Link class members, developers may configure a URL and Target using the respective members (Link.setUrl(java.lang.String)
and Link.setTarget(java.lang.String)
).
Link.setUrl(java.lang.String)
,
Link.setTarget(java.lang.String)
,
Link
public Line getMinorGrid()
Returns a Line object used to customize the minor gridlines.
Please see the Line
class for the supported members exposed by this property.
Control the Step for the minor grids using the Axis.setMinorStep(double)
member.
Use the setMinorGridlines(boolean)
member to show or hide the axis gridlines for a selected axis object.
The Axis.getSections()
property returns an AxisSection object which may be configured using the AxisSection and AxisSectionBase classs members.
The Axis.getSections()
member returns an AxisSection object which may be configured using the AxisSection class members.
setMinorGridlines(boolean)
,
Axis.getSections()
,
Axis
,
AxisSection
public int getMinorTickMark()
Gets or sets the style for the minor tick marks of an Axis or AxisSection object.
TickMark :
Define the different ways of displaying tick marks at the major and minor gridlines on the selected axis. Value | Description |
NONE | Hides tick marks for the selected axis. |
OUTSIDE | Displays tick marks on the outside of the selected axis. |
INSIDE | Displays tick marks on the inside of the selected axis. |
CROSS | Displays tick marks that cross inside and outside the selected axis. |
This property applies only to the minor gridlines, for the major gridlines please refer to the setTickMark(int)
member.
The tick mark is not the gridline that crosses the entire chart, it is just a reference line that appears on every tick of the minor unit of the axis. If you want to display a gridline that crosses the chart, please refer to the setMinorGridlines(boolean)
member.
The Axis.getSections()
member returns an AxisSection object which may be configured using the AxisSection class members.
setTickMark(int)
,
getMinorGrid()
,
Axis.getSections()
,
Axis
public java.awt.Color getTextColor()
Gets or sets the color for text of a selected Axis or AxisSection object.
The TextColor member is used to set a color for the specified Axis or AxisSection labels. Please refer to the TextColor property of the Title object to customize the color for the axis title.
The Axis.getSections()
member returns an AxisSection object which may be configured using the AxisSection and class members.
For more information regarding the Color type, please refer to your development environment documentation.
Axis.getSections()
,
Axis
,
AxisSection
public int getTickMark()
Gets or sets the style for the tick marks of an Axis or AxisSection object.
TickMark :
Define the different ways of displaying tick marks at the major and minor gridlines on the selected axis. Value | Description |
NONE | Hides tick marks for the selected axis. |
OUTSIDE | Displays tick marks on the outside of the selected axis. |
INSIDE | Displays tick marks on the inside of the selected axis. |
CROSS | Displays tick marks that cross inside and outside the selected axis. |
This property applies only to the major gridlines, for the minor gridlines please refer to the setMinorTickMark(int)
member.
The tick mark is not the gridline that crosses the entire chart, it is just a reference line that appears on every tick of the minor unit of the axis. If you want to display a gridline that crosses the chart, please refer to the setGridlines(boolean)
member.
The Axis.getSections()
member returns an AxisSection object which may be configured using the AxisSection and class members.
The major unit is controlled by the Axis.setStep(double)
member.
setMinorTickMark(int)
,
setGridlines(boolean)
,
Axis.getSections()
,
Axis.setStep(double)
,
Axis
,
AxisSection
public double getTo()
Gets or sets a value indicating the ending value of the range for a selected AxisSection object.
The setFrom(double)
property is used to specify the beginning value of the section range for a selected AxisSection
object.
The setFontStyle(int)
member is used to configure additional font attributes for the selected axis section.
The Axis.getSections()
member returns an AxisSection object which may be configured using the AxisSection class members.
setFrom(double)
,
setFontStyle(int)
public boolean isGridlines()
Gets or sets a value indicating to show gridlines for the selected Axis or AxisSection object.
The getGrid()
member returns a Line object which may be customized using the supported Line class members.
The Axis.getSections()
member returns an AxisSection object which may be configured using the AxisSection class members.
getGrid()
,
Axis.getSections()
,
AxisSection
,
Axis
public boolean isMinorGridlines()
Gets or sets a value indicating whether to show or hide minor gridlines.
The minor interval is controlled by the Axis.setMinorStep(double)
member, which must be set in order to use the MinorGrid. You can control the major interval using the Axis.setStep(double)
member.
The getMinorGrid()
member returns a Line object which may be customized using the supported Line class members.
You can use the setGridlines(boolean)
and getGrid()
members to configure the major grids for a chart.
The Axis.getSections()
member returns an AxisSection object which may be configured using the AxisSection class members.
Below the MinorGrid (LightBlue) has been set to True, and the Axis.setMinorStep(double)
member was set to 1.5:
getMinorGrid()
,
Axis.getSections()
,
Axis
,
AxisSection
public void setAlternateColor(java.awt.Color value)
Gets or sets the AlternateColor for a selected Axis or AxisSection object.
The AlternateColor is used when the selected axis is configured as Axis.setInterlaced(boolean)
. The other color is defined by the configured Chart.setInsideColor(java.awt.Color)
.
The setTextColor(java.awt.Color)
property is used to control the color for the text of the selected Axis or AxisSection object.
The Axis.getSections()
member returns an AxisSection object which may be configured using the AxisSection class members.
For more information regarding the Color type, please refer to the Java API Documentation.
Here is an example of an Interlaced Y axis:
Axis.setInterlaced(boolean)
,
setTextColor(java.awt.Color)
,
Axis.getSections()
,
Chart.setInsideColor(java.awt.Color)
,
Axis
,
AxisSection
public void setBackColor(java.awt.Color value)
Gets or sets the AxisSection background color.
The Axis.getSections()
member returns an AxisSection object which may be configured using the AxisSection class members.
The setFrom(double)
member is used to specify the beginning value of the section range for a selected AxisSection
object.
The setTo(double)
member is used to specify the ending value of the section range for a selected AxisSection
object.
Axis.getSections()
,
setFrom(double)
,
setTo(double)
,
Axis
,
AxisSection
public void setFontStyle(int value)
Gets or sets additional font attributes to the selelcted AxisSection object.
FontStyle :
Specifies style information applied to text.Value | Description |
BOLD | Bold text. |
ITALIC | Italic text. |
REGULAR | Regular text. |
STRIKEOUT | Text with a line through the middle. |
UNDERLINE | Underline text. |
The Axis.getSections()
member returns an AxisSection object which may be configured using the AxisSection class members.
The setFrom(double)
member is used to specify the beginning value of the section range for a selected AxisSection
object.
The setTo(double)
member is used to specify the ending value of the section range for a selected AxisSection
object.
Axis.getSections()
,
setFrom(double)
,
setTo(double)
,
AxisSection
public void setFrom(double value)
Gets or sets a value indicating the beginning value of the range for a selected AxisSection
object.
The setTo(double)
property is used to specify the ending value of the section range for a selected AxisSection
object.
The setFontStyle(int)
property is used to configure additional font attributes for the selected axis section.
The Axis.getSections()
member returns an AxisSection object which may be configured using the AxisSection class members.
setTo(double)
,
setFontStyle(int)
public void setGridlines(boolean value)
Gets or sets a value indicating to show gridlines for the selected Axis or AxisSection object.
The getGrid()
member returns a Line object which may be customized using the supported Line class members.
The Axis.getSections()
member returns an AxisSection object which may be configured using the AxisSection class members.
getGrid()
,
Axis.getSections()
,
AxisSection
,
Axis
public void setMinorGridlines(boolean value)
Gets or sets a value indicating whether to show or hide minor gridlines.
The minor interval is controlled by the Axis.setMinorStep(double)
member, which must be set in order to use the MinorGrid. You can control the major interval using the Axis.setStep(double)
member.
The getMinorGrid()
member returns a Line object which may be customized using the supported Line class members.
You can use the setGridlines(boolean)
and getGrid()
members to configure the major grids for a chart.
The Axis.getSections()
member returns an AxisSection object which may be configured using the AxisSection class members.
Below the MinorGrid (LightBlue) has been set to True, and the Axis.setMinorStep(double)
member was set to 1.5:
getMinorGrid()
,
Axis.getSections()
,
Axis
,
AxisSection
public void setMinorTickMark(int value)
Gets or sets the style for the minor tick marks of an Axis or AxisSection object.
TickMark :
Define the different ways of displaying tick marks at the major and minor gridlines on the selected axis. Value | Description |
NONE | Hides tick marks for the selected axis. |
OUTSIDE | Displays tick marks on the outside of the selected axis. |
INSIDE | Displays tick marks on the inside of the selected axis. |
CROSS | Displays tick marks that cross inside and outside the selected axis. |
This property applies only to the minor gridlines, for the major gridlines please refer to the setTickMark(int)
member.
The tick mark is not the gridline that crosses the entire chart, it is just a reference line that appears on every tick of the minor unit of the axis. If you want to display a gridline that crosses the chart, please refer to the setMinorGridlines(boolean)
member.
The Axis.getSections()
member returns an AxisSection object which may be configured using the AxisSection class members.
setTickMark(int)
,
getMinorGrid()
,
Axis.getSections()
,
Axis
public void setTextColor(java.awt.Color value)
Gets or sets the color for text of a selected Axis or AxisSection object.
The TextColor member is used to set a color for the specified Axis or AxisSection labels. Please refer to the TextColor property of the Title object to customize the color for the axis title.
The Axis.getSections()
member returns an AxisSection object which may be configured using the AxisSection and class members.
For more information regarding the Color type, please refer to your development environment documentation.
Axis.getSections()
,
Axis
,
AxisSection
public void setTickMark(int value)
Gets or sets the style for the tick marks of an Axis or AxisSection object.
TickMark :
Define the different ways of displaying tick marks at the major and minor gridlines on the selected axis. Value | Description |
NONE | Hides tick marks for the selected axis. |
OUTSIDE | Displays tick marks on the outside of the selected axis. |
INSIDE | Displays tick marks on the inside of the selected axis. |
CROSS | Displays tick marks that cross inside and outside the selected axis. |
This property applies only to the major gridlines, for the minor gridlines please refer to the setMinorTickMark(int)
member.
The tick mark is not the gridline that crosses the entire chart, it is just a reference line that appears on every tick of the minor unit of the axis. If you want to display a gridline that crosses the chart, please refer to the setGridlines(boolean)
member.
The Axis.getSections()
member returns an AxisSection object which may be configured using the AxisSection and class members.
The major unit is controlled by the Axis.setStep(double)
member.
setMinorTickMark(int)
,
setGridlines(boolean)
,
Axis.getSections()
,
Axis.setStep(double)
,
Axis
,
AxisSection
public void setTo(double value)
Gets or sets a value indicating the ending value of the range for a selected AxisSection object.
The setFrom(double)
property is used to specify the beginning value of the section range for a selected AxisSection
object.
The setFontStyle(int)
member is used to configure additional font attributes for the selected axis section.
The Axis.getSections()
member returns an AxisSection object which may be configured using the AxisSection class members.
setFrom(double)
,
setFontStyle(int)
|
http://www.softwarefx.com | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |