com.softwarefx.chartfx.server.maps
Class LabelLink

java.lang.Object
  com.softwarefx.chartfx.server.maps.LabelLink

public class LabelLink
extends Object

Provides access to the LabelLink Object

The LabelLink class members are used to configure the LabelLink attributes for the map extension. These LabelLink attributes are used to link map data to regions contained in the SVG file configured for the extension.

The DataText attribute is required when populating the map. If no other LabelLink attributes are configured, it is assumed that all other supported attributes of the LabelLink object are the same:

DataText = DisplayText = SvgText

Constructor Summary

LabelLink()

LabelLink(Locale cultInfo)

LabelLink(String svgText)

LabelLink(String svgText, Locale cultInfo)

LabelLink(String dataText, String svgText)

LabelLink(String dataText, String svgText, Locale cultInfo)

LabelLink(String dataText, String svgText, String displayText)

LabelLink(String dataText, String svgText, String displayText, Locale cultInfo)

Method Summary

Locale	getCulture() Gets the Culture.
String	getDataText() Gets the DataText.
String	getDisplayText() Gets the DisplayText.
String	getSvgText() Gets the SvgText.
void	setCulture(Locale value) Allows you to localize a LabelLink object for a specific language and region.
void	setDataText(String value) Sets the text string associated with the map data.
void	setDisplayText(String value) Sets the text label to be displayed for a region in a map.
void	setSvgText(String value) Sets the text label associated with the regions configured in the SVG map file.

Methods inherited from class java.lang.Object

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

Constructor Detail

LabelLink

public LabelLink()

LabelLink

public LabelLink(String svgText)

LabelLink

public LabelLink(Locale cultInfo)

LabelLink

public LabelLink(String dataText,
                 String svgText)

LabelLink

public LabelLink(String svgText,
                 Locale cultInfo)

LabelLink

public LabelLink(String dataText,
                 String svgText,
                 String displayText)

LabelLink

public LabelLink(String dataText,
                 String svgText,
                 Locale cultInfo)

LabelLink

public LabelLink(String dataText,
                 String svgText,
                 String displayText,
                 Locale cultInfo)

Method Detail

getCulture

public Locale getCulture()

Gets the Culture. For more detail see setCulture(java.util.Locale).

getDataText

public String getDataText()

Gets the DataText. For more detail see setDataText(java.lang.String).

getDisplayText

public String getDisplayText()

Gets the DisplayText. For more detail see setDisplayText(java.lang.String).

getSvgText

public String getSvgText()

Gets the SvgText. For more detail see setSvgText(java.lang.String).

setCulture

public void setCulture(Locale value)

Allows you to localize a LabelLink object for a specific language and region.

Remarks:

If no attributes are set using this property or the Chart Class Chart.setCulture(java.util.Locale) property, then Chart FX inherits the system culture.

When setting this property, you may need the Language Code and/or Country Code constants for the desired culture. For more information, please refer to the java.util.Locale documentation.

See Also:

Map.setCulture(java.util.Locale), LabelLinkCollection.setCulture(java.util.Locale), Map, LabelLinkCollection

setDataText

public void setDataText(String value)

Sets the text string associated with the map data.

Remarks:

By default, Chart FX Maps assumes that labels passed with chart data match the text labels that exist in the configured SVG Map.setMapSource(java.lang.String). For instances when these labels do not correspond, a conversion table is used to connect the data labels to SVG labels. This table is referred to as the LabelLinks collection. Each LabelLinks object includes 3 vital attributes: DataText, setDisplayText(java.lang.String) and setSvgText(java.lang.String).

Using this property, developers may set the DataText attribute for a LabelLink Object.

If there is only a small number of LabelLink objects that need to be added to this conversion table, it may be better to add them using the API. However, developers also have the option of creating an XML file with all the needed label links and using the Map.setLabelLinkFile(java.lang.String) property to configure them for the map.

The Map.getLabelLinks() property of the Map class is used to access the LabelLinksCollection class.

See Also:

setDisplayText(java.lang.String), setSvgText(java.lang.String), Map.setLabelLinkFile(java.lang.String), Map.getLabelLinks(), Map

setDisplayText

public void setDisplayText(String value)

Sets the text label to be displayed for a region in a map.

Remarks:

By default, Chart FX Maps assumes that labels passed with chart data match the text labels that exist in the configured SVG Map.setMapSource(java.lang.String). For instances when these labels do not correspond, a conversion table is used to connect the data labels to SVG labels. This table is referred to as the LabelLinks collection. Each LabelLinks object includes 3 vital attributes: setDataText(java.lang.String), DisplayText and setSvgText(java.lang.String).

Using this property, developers may set the DisplayText attribute for a LabelLink Object.

If there is only a small number of LabelLink objects that need to be added to this conversion table, it may be better to add them using the API. However, developers also have the option of creating an XML file with all the needed label links and using the Map.setLabelLinkFile(java.lang.String) property to configure them for the map.

The Map.getLabelLinks() property of the Map class is used to access the LabelLinksCollection class.

See Also:

setDataText(java.lang.String), #setDataSvg, Map.getLabelLinks(), Map

setSvgText

public void setSvgText(String value)

Sets the text label associated with the regions configured in the SVG map file.

Remarks:

By default, Chart FX Maps assumes that labels passed with chart data match the text labels that exist in the configured SVG Map.setMapSource(java.lang.String). For instances when these labels do not correspond, a conversion table is used to connect the data labels to SVG labels. This table is referred to as the LabelLinks collection. Each LabelLinks object includes 3 vital attributes: setDataText(java.lang.String), setDisplayText(java.lang.String) and SvgText.

Using this property, developers may set the SvgText attribute for a LabelLink Object.

If there is only a small number of LabelLink objects that need to be added to this conversion table, it may be better to add them using the API. However, developers also have the option of creating an XML file with all the needed label links and using the Map.setLabelLinkFile(java.lang.String) property to configure them for the map.

The Map.getLabelLinks() property of the Map class is used to access the LabelLinksCollection class.

See Also:

setDataText(java.lang.String), setDisplayText(java.lang.String), Map.setLabelLinkFile(java.lang.String), Map.getLabelLinks(), Map.setMapSource(java.lang.String), Map