com.softwarefx.chartfx.server

Class AxisSectionHighlightAttributes

java.lang.Object

com.softwarefx.chartfx.server.AxisSectionHighlightAttributes

public final class AxisSectionHighlightAttributes
extends java.lang.Object

Provides access to the AxisSectionHighlightAttributes object.

By accessing this class you can enable/disable AxisSection Highlighting, as well as set the Condition to Highlight. It is accessed in the Axis via the Highlight method.

Constructor Summary

Constructors

Constructor and Description
AxisSectionHighlightAttributes() Constructs a newly allocated AxisSectionHighlightAttributes object

Method Summary

Methods

Modifier and Type	Method and Description
AxisSectionCondition	getCondition() Allows to highlight the Points/Series inside/outside the selected axis section
int	getPoint() Allows you to select on which point the title of the axis section will be highlighted.
boolean	isEnabled() Gets or sets a value indicating whether the Axis Section highlighting feature will be enabled in the chart.
void	resetCondition() Set the property Condition to its default value.
void	resetEnabled() Set the property Enabled to its default value.
void	resetPoint() Set the property Point to its default value.
void	setCondition(AxisSectionCondition value) Allows to highlight the Points/Series inside/outside the selected axis section
void	setEnabled(boolean value) Gets or sets a value indicating whether the Axis Section highlighting feature will be enabled in the chart.
void	setPoint(int value) Allows you to select on which point the title of the axis section will be highlighted.

Methods inherited from class java.lang.Object

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

Constructor Detail

AxisSectionHighlightAttributes

public AxisSectionHighlightAttributes()

Constructs a newly allocated AxisSectionHighlightAttributes object

Method Detail

getCondition

public AxisSectionCondition getCondition()

Allows to highlight the Points/Series inside/outside the selected axis section

You may use this object to manipulate the conditions in which the AxisSectionHighlightAttributes applies

You can control wether you want to Highlight the Point/Series inside the AxisSection or to Highlight the Point/Series outside the AxisSection

To Highlight point/series outside the selected AxisSection:

• Java

• AxisSection sect;
  sect = new AxisSection(((AxisSectionValue)0.0), ((AxisSectionValue)100.0), new java.awt.Color(255,0,0,255));
  sect.getHighlight().setCondition(AxisSectionCondition.Outside);
  chart1.getAxisX().getSections().add(sect);
  

See Also:

resetCondition

setCondition

public void setCondition(AxisSectionCondition value)

Allows to highlight the Points/Series inside/outside the selected axis section

You may use this object to manipulate the conditions in which the AxisSectionHighlightAttributes applies

You can control wether you want to Highlight the Point/Series inside the AxisSection or to Highlight the Point/Series outside the AxisSection

To Highlight point/series outside the selected AxisSection:

• Java

• AxisSection sect;
  sect = new AxisSection(((AxisSectionValue)0.0), ((AxisSectionValue)100.0), new java.awt.Color(255,0,0,255));
  sect.getHighlight().setCondition(AxisSectionCondition.Outside);
  chart1.getAxisX().getSections().add(sect);
  

Parameters:

value -

See Also:

resetCondition

isEnabled

public boolean isEnabled()

Gets or sets a value indicating whether the Axis Section highlighting feature will be enabled in the chart.

Setting this value to false will disable the Axis Section Highlighting feature.

To disable the AxisSectionHighlightAttributes feature:

• Java

• AxisSection sect;
  sect = new AxisSection(((AxisSectionValue)0.0), ((AxisSectionValue)100.0), new java.awt.Color(255,0,0,255));
  sect.getHighlight().setEnabled(false);
  

See Also:

resetEnabled

setEnabled

public void setEnabled(boolean value)

Gets or sets a value indicating whether the Axis Section highlighting feature will be enabled in the chart.

Setting this value to false will disable the Axis Section Highlighting feature.

To disable the AxisSectionHighlightAttributes feature:

• Java

• AxisSection sect;
  sect = new AxisSection(((AxisSectionValue)0.0), ((AxisSectionValue)100.0), new java.awt.Color(255,0,0,255));
  sect.getHighlight().setEnabled(false);
  

Parameters:

value -

See Also:

resetEnabled

getPoint

public int getPoint()

Allows you to select on which point the title of the axis section will be highlighted.

• When hovering on the X-Axis labels, you can select a point in which the Axis Section title will get highlighted.
• Items in X-Axis have zero-based index.

Example

To highlight the Axis Section title when hovering on the point 6 of the X-Axis:

• Java

• AxisSection section;
  section = new AxisSection(((AxisSectionValue)20.0), ((AxisSectionValue)90.0), new java.awt.Color(176,224,230,255));
  section.getTitle().setText("Section Title");
  section.getTitle().setAlignment(StringAlignment.NEAR);
  section.getHighlight().setPoint(5);
  chart1.getAxisY().getSections().add(section);
  

See Also:

resetPoint

setPoint

public void setPoint(int value)

Allows you to select on which point the title of the axis section will be highlighted.

• When hovering on the X-Axis labels, you can select a point in which the Axis Section title will get highlighted.
• Items in X-Axis have zero-based index.

Example

To highlight the Axis Section title when hovering on the point 6 of the X-Axis:

• Java

• AxisSection section;
  section = new AxisSection(((AxisSectionValue)20.0), ((AxisSectionValue)90.0), new java.awt.Color(176,224,230,255));
  section.getTitle().setText("Section Title");
  section.getTitle().setAlignment(StringAlignment.NEAR);
  section.getHighlight().setPoint(5);
  chart1.getAxisY().getSections().add(section);
  

Parameters:

value -

See Also:

resetPoint

resetCondition

public void resetCondition()

Set the property Condition to its default value.

See Also:

setCondition

resetEnabled

public void resetEnabled()

Set the property Enabled to its default value.

See Also:

isEnabled

resetPoint

public void resetPoint()

Set the property Point to its default value.

See Also:

setPoint