com.softwarefx.chartfx.server

Class PointLabelOrganizer

java.lang.Object

com.softwarefx.chartfx.server.PointLabelOrganizer

public class PointLabelOrganizer
extends java.lang.Object

Provides access to the PointLabelOrganizer object.

The PointLabelOrganizer object supports members to enable developers with built-in features to try and display point labels in the most visual appealing manner. By default, point labels are painted in the same order in which the series/points they are associated. This can cause overlapping and unreadable point labels.

The PointLabelOrganizer class supports members not only to bring all labels to the front to avoid this issue, but also internal algorithms used to reposition and even hide offending point labels. Additionally, members have been implemented to allow the developer control over acceptable point label collisions, time limits used for organizing and even caching features.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
double	getMaximumCollisions() Gets or sets a acceptable percentage rate of collisions (clipped or overlapping labels).
int	getMaximumTime() Gets or sets a value specifying the maximum time limit used to arrange point labels.
boolean	isAutoArrange() Gets or sets a value specifying to use internal alogrithms to arrange point labels.
boolean	isCache() Gets or sets a value specifying to save PointLabels in memory.
boolean	isEnabled() Gets or sets a value specifying if the PointLabelOrganizer feature is enabled.
void	resetAutoArrange() Set the property AutoArrange to its default value.
void	resetCache() Set the property Cache to its default value.
void	resetEnabled() Set the property Enabled to its default value.
void	resetMaximumCollisions() Set the property MaximumCollisions to its default value.
void	resetMaximumTime() Set the property MaximumTime to its default value.
void	setAutoArrange(boolean value) Gets or sets a value specifying to use internal alogrithms to arrange point labels.
void	setCache(boolean value) Gets or sets a value specifying to save PointLabels in memory.
void	setEnabled(boolean value) Gets or sets a value specifying if the PointLabelOrganizer feature is enabled.
void	setMaximumCollisions(double value) Gets or sets a acceptable percentage rate of collisions (clipped or overlapping labels).
void	setMaximumTime(int value) Gets or sets a value specifying the maximum time limit used to arrange point labels.

Methods inherited from class java.lang.Object

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

Constructor Detail

PointLabelOrganizer

public PointLabelOrganizer()

Constructs a newly allocated PointLabelOrganizer object

Method Detail

isAutoArrange

public boolean isAutoArrange()

Gets or sets a value specifying to use internal alogrithms to arrange point labels.

• Java

• PointLabelOrganizer pntLblOrganizer;
  pntLblOrganizer = chart1.getAllSeries().getPointLabelOrganizer();
  pntLblOrganizer.setEnabled(true);
  pntLblOrganizer.setAutoArrange(true);
  

See Also:

resetAutoArrange

setAutoArrange

public void setAutoArrange(boolean value)

Gets or sets a value specifying to use internal alogrithms to arrange point labels.

• Java

• PointLabelOrganizer pntLblOrganizer;
  pntLblOrganizer = chart1.getAllSeries().getPointLabelOrganizer();
  pntLblOrganizer.setEnabled(true);
  pntLblOrganizer.setAutoArrange(true);
  

Parameters:

value -

See Also:

resetAutoArrange

isCache

public boolean isCache()

Gets or sets a value specifying to save PointLabels in memory.

• Java

• PointLabelOrganizer pntLblOrganizer;
  pntLblOrganizer = chart1.getAllSeries().getPointLabelOrganizer();
  pntLblOrganizer.setEnabled(true);
  pntLblOrganizer.setCache(true);
  

See Also:

resetCache

setCache

public void setCache(boolean value)

Gets or sets a value specifying to save PointLabels in memory.

• Java

• PointLabelOrganizer pntLblOrganizer;
  pntLblOrganizer = chart1.getAllSeries().getPointLabelOrganizer();
  pntLblOrganizer.setEnabled(true);
  pntLblOrganizer.setCache(true);
  

Parameters:

value -

See Also:

resetCache

isEnabled

public boolean isEnabled()

Gets or sets a value specifying if the PointLabelOrganizer feature is enabled.

The setPointLabelOrganizer method (GlobalAttributes) is used to access the PointLabelOrganizer object of a chart.

The isEnabled method is a boolean used to enable the PointLabelOrganizer feature. When enabled, all point labels are brought to the front of the chart (painted last). If this method is disabled, PointLabels will be painted at the same time as each corresponding point marker. This can cause point labels of initial series to be overwritten and clipped by markers and labels of following series.

The isAutoArrange method may be used to instruct Chart FX to use internal alogrithms to calculate the best locations for PointLabels and even hide some labels if they become intrusive to the chart's display.

The isCache method may be used to instruct the chart that point labels will be saved in memory rather than refreshed each time the chart is redrawn. Setting this method to true increases memory usage but makes charts more efficient.

The setMaximumCollisions method is used to specify a percentage of collisions (clipped or overlapping labels) acceptable by the developer. Once the internal alogrithm has reached this benchmark, violating point labels are hidden and the chart is displayed.

The setMaximumTime method is used to configure the maximum amount of time to be used for PointLabel organization features. This time is measured in milliseconds.

To enable the PointLabelOrganizer:

• Java

• PointLabelOrganizer pntLblOrganizer;
  pntLblOrganizer = chart1.getAllSeries().getPointLabelOrganizer();
  pntLblOrganizer.setEnabled(true);
  

See Also:

resetEnabled

setEnabled

public void setEnabled(boolean value)

Gets or sets a value specifying if the PointLabelOrganizer feature is enabled.

The setPointLabelOrganizer method (GlobalAttributes) is used to access the PointLabelOrganizer object of a chart.

The isEnabled method is a boolean used to enable the PointLabelOrganizer feature. When enabled, all point labels are brought to the front of the chart (painted last). If this method is disabled, PointLabels will be painted at the same time as each corresponding point marker. This can cause point labels of initial series to be overwritten and clipped by markers and labels of following series.

The isAutoArrange method may be used to instruct Chart FX to use internal alogrithms to calculate the best locations for PointLabels and even hide some labels if they become intrusive to the chart's display.

The isCache method may be used to instruct the chart that point labels will be saved in memory rather than refreshed each time the chart is redrawn. Setting this method to true increases memory usage but makes charts more efficient.

The setMaximumCollisions method is used to specify a percentage of collisions (clipped or overlapping labels) acceptable by the developer. Once the internal alogrithm has reached this benchmark, violating point labels are hidden and the chart is displayed.

The setMaximumTime method is used to configure the maximum amount of time to be used for PointLabel organization features. This time is measured in milliseconds.

To enable the PointLabelOrganizer:

• Java

• PointLabelOrganizer pntLblOrganizer;
  pntLblOrganizer = chart1.getAllSeries().getPointLabelOrganizer();
  pntLblOrganizer.setEnabled(true);
  

Parameters:

value -

See Also:

resetEnabled

getMaximumCollisions

public double getMaximumCollisions()

Gets or sets a acceptable percentage rate of collisions (clipped or overlapping labels).

The isAutoArrange method may be used to instruct Chart FX to use internal alogrithms to calculate the best locations for PointLabels and even hide some labels if they become intrusive to the chart's display. In order for the MaximumCollisions and MaximumTime methods to be realized, AutoArrange must be set to true.

The setMaximumCollisions method is used to specify a percentage of collisions (clipped or overlapping labels) acceptable by the developer. Once the internal alogrithm has reached this benchmark, violating point labels are hidden and the chart is displayed.

The setMaximumTime method is used to configure the maximum amount of time to be used for PointLabel organization features. This time is measured in milliseconds.

The setPointLabelOrganizer method (GlobalAttributes) is used to access the PointLabelOrganizer object of a chart.

The isEnabled method is a boolean used to enable the PointLabelOrganizer feature. When enabled, all point labels are brought to the front of the chart (painted last). If this method is disabled, PointLabels will be painted at the same time as each corresponding point marker. This can cause point labels of initial series to be overwritten and clipped by markers and labels of following series.

The isCache method may be used to instruct the chart that point labels will be saved in memory rather than refreshed each time the chart is redrawn. Setting this method to true increases memory usage but makes charts more efficient.

To set the MaximumCollisions to 50%:

• Java

• PointLabelOrganizer pntLblOrganizer;
  pntLblOrganizer = chart1.getAllSeries().getPointLabelOrganizer();
  pntLblOrganizer.setEnabled(true);
  pntLblOrganizer.setAutoArrange(true);
  pntLblOrganizer.setMaximumCollisions(50);
  pntLblOrganizer.setMaximumTime(1000);
  

See Also:

resetMaximumCollisions

setMaximumCollisions

public void setMaximumCollisions(double value)

Gets or sets a acceptable percentage rate of collisions (clipped or overlapping labels).

The isAutoArrange method may be used to instruct Chart FX to use internal alogrithms to calculate the best locations for PointLabels and even hide some labels if they become intrusive to the chart's display. In order for the MaximumCollisions and MaximumTime methods to be realized, AutoArrange must be set to true.

The setMaximumCollisions method is used to specify a percentage of collisions (clipped or overlapping labels) acceptable by the developer. Once the internal alogrithm has reached this benchmark, violating point labels are hidden and the chart is displayed.

The setMaximumTime method is used to configure the maximum amount of time to be used for PointLabel organization features. This time is measured in milliseconds.

The setPointLabelOrganizer method (GlobalAttributes) is used to access the PointLabelOrganizer object of a chart.

The isEnabled method is a boolean used to enable the PointLabelOrganizer feature. When enabled, all point labels are brought to the front of the chart (painted last). If this method is disabled, PointLabels will be painted at the same time as each corresponding point marker. This can cause point labels of initial series to be overwritten and clipped by markers and labels of following series.

The isCache method may be used to instruct the chart that point labels will be saved in memory rather than refreshed each time the chart is redrawn. Setting this method to true increases memory usage but makes charts more efficient.

To set the MaximumCollisions to 50%:

• Java

• PointLabelOrganizer pntLblOrganizer;
  pntLblOrganizer = chart1.getAllSeries().getPointLabelOrganizer();
  pntLblOrganizer.setEnabled(true);
  pntLblOrganizer.setAutoArrange(true);
  pntLblOrganizer.setMaximumCollisions(50);
  pntLblOrganizer.setMaximumTime(1000);
  

Parameters:

value -

See Also:

resetMaximumCollisions

getMaximumTime

public int getMaximumTime()

Gets or sets a value specifying the maximum time limit used to arrange point labels.

• Java

• PointLabelOrganizer pntLblOrganizer;
  pntLblOrganizer = chart1.getAllSeries().getPointLabelOrganizer();
  pntLblOrganizer.setEnabled(true);
  pntLblOrganizer.setAutoArrange(true);
  pntLblOrganizer.setMaximumCollisions(50);
  pntLblOrganizer.setMaximumTime(3000);
  

See Also:

resetMaximumTime

setMaximumTime

public void setMaximumTime(int value)

Gets or sets a value specifying the maximum time limit used to arrange point labels.

• Java

• PointLabelOrganizer pntLblOrganizer;
  pntLblOrganizer = chart1.getAllSeries().getPointLabelOrganizer();
  pntLblOrganizer.setEnabled(true);
  pntLblOrganizer.setAutoArrange(true);
  pntLblOrganizer.setMaximumCollisions(50);
  pntLblOrganizer.setMaximumTime(3000);
  

Parameters:

value -

See Also:

resetMaximumTime

resetAutoArrange

public void resetAutoArrange()

Set the property AutoArrange to its default value.

See Also:

isAutoArrange

resetCache

public void resetCache()

Set the property Cache to its default value.

See Also:

isCache

resetEnabled

public void resetEnabled()

Set the property Enabled to its default value.

See Also:

isEnabled

resetMaximumCollisions

public void resetMaximumCollisions()

Set the property MaximumCollisions to its default value.

See Also:

setMaximumCollisions

resetMaximumTime

public void resetMaximumTime()

Set the property MaximumTime to its default value.

See Also:

setMaximumTime