com.softwarefx.chartfx.server
Class PointLabelOrganizer

java.lang.Object
  com.softwarefx.chartfx.server.PointLabelOrganizer

public class PointLabelOrganizer
extends 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

PointLabelOrganizer()

Method Summary

double	getMaximumCollisions() Gets the MaximumCollisions.
int	getMaximumTime() Gets the MaximumTime.
boolean	isAutoArrange() Gets the AutoArrange.
boolean	isCache() Gets the Cache.
boolean	isEnabled() Gets the Enabled.
void	setAutoArrange(boolean value) Sets a value specifying to use internal alogrithms to arrange point labels.
void	setCache(boolean value) Sets a value specifying to save PointLabels in memory.
void	setEnabled(boolean value) Sets a value specifying if the PointLabelOrganizer feature is enabled.
void	setMaximumCollisions(double value) Sets a acceptable percentage rate of collisions (clipped or overlapping labels).
void	setMaximumTime(int value) 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()

Method Detail

getMaximumCollisions

public double getMaximumCollisions()

Gets the MaximumCollisions. For more detail see setMaximumCollisions(double).

getMaximumTime

public int getMaximumTime()

Gets the MaximumTime. For more detail see setMaximumTime(int).

isAutoArrange

public boolean isAutoArrange()

Gets the AutoArrange. For more detail see setAutoArrange(boolean).

isCache

public boolean isCache()

Gets the Cache. For more detail see setCache(boolean).

isEnabled

public boolean isEnabled()

Gets the Enabled. For more detail see setEnabled(boolean).

setAutoArrange

public void setAutoArrange(boolean value)

Sets a value specifying to use internal alogrithms to arrange point labels.

Remarks:

The AutoArrange property 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 GlobalAttributes.getPointLabelOrganizer() property (GlobalAttributes) is used to access the PointLabelOrganizer object of a chart.

The setEnabled(boolean) property 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 property 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 setMaximumCollisions(double) property 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(int) property is used to configure the maximum amount of time to be used for PointLabel organization features. This time is measured in milliseconds.

The setCache(boolean) property 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 property to true increases memory usage but makes charts more efficient.

See Also:

setEnabled(boolean), setCache(boolean), setMaximumCollisions(double), setMaximumTime(int), GlobalAttributes.getPointLabelOrganizer(), GlobalAttributes

setCache

public void setCache(boolean value)

Sets a value specifying to save PointLabels in memory.

Remarks:

The Cache property 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 property to true increases memory usage but makes charts more efficient.

The setAutoArrange(boolean) property 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 GlobalAttributes.getPointLabelOrganizer() property (GlobalAttributes) is used to access the PointLabelOrganizer object of a chart.

The setEnabled(boolean) property 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 property 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 setMaximumCollisions(double) property 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(int) property is used to configure the maximum amount of time to be used for PointLabel organization features. This time is measured in milliseconds.

See Also:

setAutoArrange(boolean), setEnabled(boolean), setMaximumCollisions(double), setMaximumTime(int), GlobalAttributes.getPointLabelOrganizer(), GlobalAttributes

setEnabled

public void setEnabled(boolean value)

Sets a value specifying if the PointLabelOrganizer feature is enabled.

Remarks:

The GlobalAttributes.getPointLabelOrganizer() property (GlobalAttributes) is used to access the PointLabelOrganizer object of a chart.

The Enabled property 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 property 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 setAutoArrange(boolean) property 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 setCache(boolean) property 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 property to true increases memory usage but makes charts more efficient.

The setMaximumCollisions(double) property 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(int) property is used to configure the maximum amount of time to be used for PointLabel organization features. This time is measured in milliseconds.

See Also:

setAutoArrange(boolean), setCache(boolean), setMaximumCollisions(double), setMaximumTime(int), GlobalAttributes.getPointLabelOrganizer(), GlobalAttributes

setMaximumCollisions

public void setMaximumCollisions(double value)

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

Remarks:

The setAutoArrange(boolean) property 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 properties to be realized, AutoArrange must be set to true.

The setMaximumCollisions(double) property 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(int) property is used to configure the maximum amount of time to be used for PointLabel organization features. This time is measured in milliseconds.

The GlobalAttributes.getPointLabelOrganizer() property (GlobalAttributes) is used to access the PointLabelOrganizer object of a chart.

The setEnabled(boolean) property 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 property 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 setCache(boolean) property 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 property to true increases memory usage but makes charts more efficient.

See Also:

setAutoArrange(boolean), setEnabled(boolean), setCache(boolean), setMaximumTime(int), GlobalAttributes.getPointLabelOrganizer(), GlobalAttributes

setMaximumTime

public void setMaximumTime(int value)

Sets a value specifying the maximum time limit used to arrange point labels.

Remarks:

The MaximumTime property is used to configure the maximum amount of time to be used for the AutoArrange feature. This time is measured in milliseconds.

The setAutoArrange(boolean) property 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 MaximumCollissions and MaximumTime properties to be realized, AutoArrange must be set to true.

The setMaximumCollisions(double) property 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 GlobalAttributes.getPointLabelOrganizer() property (GlobalAttributes) is used to access the PointLabelOrganizer object of a chart.

The setEnabled(boolean) property 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 property 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 setCache(boolean) property 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 property to true increases memory usage but makes charts more efficient.

See Also:

setAutoArrange(boolean), setEnabled(boolean), setCache(boolean), setMaximumCollisions(double), GlobalAttributes.getPointLabelOrganizer(), GlobalAttributes