com.softwarefx.chartfx.server.maps
Class Map

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

All Implemented Interfaces:

IExtension

public class Map
extends Object
implements IExtension

Provides access to the Map object

The Map class is derived form the Chart class of Chart FX for .NET. All the supported members of the core chart class are supported, as well as newly added members specifically intented to allow the Map Extension to function.

Constructor Summary

Map()

Method Summary

void	addCancelledDrillDownListener(MapCancelledDrillDownListener value) Adds a CancelledDrillDownListener to the listener list.
void	addCancellingDrillDownListener(MapCancellingDrillDownListener value) Adds a CancellingDrillDownListener to the listener list.
void	addDetailLevelChangedListener(MapDetailLevelChangedListener value) Adds a DetailLevelChangedListener to the listener list.
void	addDrilledDownListener(MapDrilledDownListener value) Adds a DrilledDownListener to the listener list.
void	addDrillingDownListener(MapDrillingDownListener value) Adds a DrillingDownListener to the listener list.
void	addWinnerCallbackListener(WinnerCallbackListener value) Adds a WinnerCallbackListener to the listener list.
void	cancelDrillDown() Aborts a DrillDown action to the previous view.
void	cancelZoom() Error: Member Map.cancelZoom member not found
Point[]	convertPointsToScale(Point[] points) Converts an array of Points to the scaled size of the map image.
Point	convertPointToScale(Point pt) Converts a Point to the relative drawing Point of the map image based on the map's size.
boolean	exportMap(com.softwarefx.sfxnet.System.IO.Stream stream) Used to export the configured map (SVG) to a stream.
MapRegion	findMapRegion(String descriptor) Returns a MapRegion object of based on the descriptor and search criteria specified.
MapRegion	findMapRegion(String descriptor, EnumSet<LabelLinkSearchTypes> labelLinkSearch) Returns a MapRegion object of based on the descriptor and search criteria specified.
PointAttributes	get(String displaytext) Returns the element at the specified position in the Map.
AnnotationList	getAnnotationObjectsList() Returns the collection of annotation objects contained in the map extension.
MapCancelledDrillDownListener[]	getCancelledDrillDownListeners() Returns an array of all the CancelledDrillDownListeners added to this class with addCancelledDrillDownListeners().
MapCancellingDrillDownListener[]	getCancellingDrillDownListeners() Returns an array of all the CancellingDrillDownListeners added to this class with addCancellingDrillDownListeners().
Chart	getChart() Gets the Chart.
Locale	getCulture() Gets the Culture.
MapDataObj	getData() Used to return an MapDataObj from a Map.
ValueFormat	getDataFormat() Gets the ValueFormat object for the Map.
DefaultAttributes	getDefaultAttributes() Returns the DefaultAttributes object for the map.
PointAttributes	getDefaultHighlightAttributes() Returns a PointAttributes object used for assigning highlight attributes for the map.
int	getDetailLevel() Gets the DetailLevel.
MapDetailLevelChangedListener[]	getDetailLevelChangedListeners() Returns an array of all the DetailLevelChangedListeners added to this class with addDetailLevelChangedListeners().
MapRegion	getDrillDownMapRegion() Returns the MapRegion object of a DrillDown.
DrillDownMode	getDrillDownMode() Gets the DrillDownMode.
MapDrilledDownListener[]	getDrilledDownListeners() Returns an array of all the DrilledDownListeners added to this class with addDrilledDownListeners().
MapDrillingDownListener[]	getDrillingDownListeners() Returns an array of all the DrillingDownListeners added to this class with addDrillingDownListeners().
com.softwarefx.sfxnet.System.Xml.XmlDocument	getDummyLabelLinkFile() Provides a means to store the label link file.
String	getLabelLinkFile() Gets the LabelLinkFile.
LabelLinkCollection	getLabelLinks() Used to access a selected LabelLink item based on the specified index value.
EnumSet<LabelStyles>	getLabelStyles() Gets the LabelStyles.
LabelStylesSettings	getLabelStylesSettings() Used to access the LabelStylesSettings object for the map.
int	getMapCommandID(com.softwarefx.chartfx.server.maps.MapCommandId id) Error: Member Map.MapCommandID member not found
MapDataObj	getMapData() Error: Deprecated member Map.MapData member not found
String	getMapSource() Gets the MapSource.
int	getMaxDetailLevel() Returns the highest detail level supported in a configured map.
Color	getRegionAlternateTextColor() Gets the RegionAlternateTextColor.
Font	getTitleFont() Gets the TitleFont.
String	getTitleSeparator() Gets the TitleSeparator.
VisibleMapRegions	getVisibleMapRegions() Used to access a MapRegion objects currently visible in a map.
WinnerCallbackListener[]	getWinnerCallbackListeners() Returns an array of all the WinnerCallbackListeners added to this class with addWinnerCallbackListeners().
EnumSet<WinnerSeriesType>	getWinnerSeriesType() Gets the WinnerSeriesType.
void	importMap(com.softwarefx.sfxnet.System.IO.Stream stream) Used to import a map (SVG) that was previously exported using the ExportMap method.
boolean	isCurrentGallery() Gets the CurrentGallery.
boolean	isEnableViewState() Error: Member Map.EnableViewState member not found
void	recalculate() Used to instruct Chart FX to re-apply the configured conditional attributes to the map.
void	removeCancelledDrillDownListener(MapCancelledDrillDownListener value) Removes a CancelledDrillDownListener from the listener list.
void	removeCancellingDrillDownListener(MapCancellingDrillDownListener value) Removes a CancellingDrillDownListener from the listener list.
void	removeDetailLevelChangedListener(MapDetailLevelChangedListener value) Removes a DetailLevelChangedListener from the listener list.
void	removeDrilledDownListener(MapDrilledDownListener value) Removes a DrilledDownListener from the listener list.
void	removeDrillingDownListener(MapDrillingDownListener value) Removes a DrillingDownListener from the listener list.
void	removeWinnerCallbackListener(WinnerCallbackListener value) Removes a WinnerCallbackListener from the listener list.
void	setChart(Chart value) Get or set the associated Chart object.
void	setCulture(Locale value) Get or set the CultureInfo object.
void	setCurrentGallery(boolean value) Get or set the value indicating whether the Map is the current Chart gallery.
void	setDetailLevel(int value) Sets the detail level used to display the map.
void	setDrillDownMode(DrillDownMode value) Sets the DrillDown mode for a map.
void	setEnableViewState(boolean value) Error: Member Map.EnableViewState member not found
void	setLabelLinkFile(String value) Sets a path for an XML file of the LabelLink attributes.
void	setLabelStyles(EnumSet<LabelStyles> value) Flag property that allows setting attributes for map labels contained in the map extension.
void	setMapSource(String value) Sets the SVG to be used for the Map object.
void	setRegionAlternateTextColor(Color value) Get or set the color used for all complex labels in a map.
void	setTitleFont(Font value) Used to assign a new font object for double DrillDown titles.
void	setTitleSeparator(String value) Sets the string used to separate titles.
void	setWinnerSeriesType(EnumSet<WinnerSeriesType> value) Sets the mode which the winning series is determined.

Methods inherited from class java.lang.Object

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

Constructor Detail

Map

public Map()

Method Detail

addCancelledDrillDownListener

public void addCancelledDrillDownListener(MapCancelledDrillDownListener value)

Adds a CancelledDrillDownListener to the listener list.

Parameters:

value - The CancelledDrillDownListener to be added.

addCancellingDrillDownListener

public void addCancellingDrillDownListener(MapCancellingDrillDownListener value)

Adds a CancellingDrillDownListener to the listener list.

Parameters:

value - The CancellingDrillDownListener to be added.

addDetailLevelChangedListener

public void addDetailLevelChangedListener(MapDetailLevelChangedListener value)

Adds a DetailLevelChangedListener to the listener list.

Parameters:

value - The DetailLevelChangedListener to be added.

addDrilledDownListener

public void addDrilledDownListener(MapDrilledDownListener value)

Adds a DrilledDownListener to the listener list.

Parameters:

value - The DrilledDownListener to be added.

addDrillingDownListener

public void addDrillingDownListener(MapDrillingDownListener value)

Adds a DrillingDownListener to the listener list.

Parameters:

value - The DrillingDownListener to be added.

addWinnerCallbackListener

public void addWinnerCallbackListener(WinnerCallbackListener value)

Adds a WinnerCallbackListener to the listener list.

Parameters:

value - The WinnerCallbackListener to be added.

cancelDrillDown

public void cancelDrillDown()

Aborts a DrillDown action to the previous view.

Remarks:

When this method is called, all concurrent DrillDowns are canceled. Therefore, if you DrillDown on a DrillDown and then use this method, the result will be the original view before the initial DrillDown.

The #DrillDownTo method is used to DrillDown to a selected region in the map.

See Also:

#setDrillDownTo, MapRegion

cancelZoom

public void cancelZoom()

Error: Member Map.cancelZoom member not found

ERROR: Doc member not found

convertPointToScale

public Point convertPointToScale(Point pt)

Converts a Point to the relative drawing Point of the map image based on the map's size.

Remarks:

This method is useful if your Map image is not displayed at 100% of its size. If a developer wanted to place an annotation at Point(100,100) of the full-size image, this method will convert that point to the current scale of the image.

Parameters:

pt - The Point on the map when at full-size.

convertPointsToScale

public Point[] convertPointsToScale(Point[] points)

Converts an array of Points to the scaled size of the map image.

Remarks:

This method works in the same way as convertPointToScale(java.awt.Point), but allows for an array of Points to be converted with one method call.

Parameters:

points - An array of full-size map drawing points.

See Also:

convertPointToScale(java.awt.Point)

exportMap

public boolean exportMap(com.softwarefx.sfxnet.System.IO.Stream stream)

Used to export the configured map (SVG) to a stream.

Remarks:

The ImportMap method may be used to import a map previously exported.

Parameters:

stream - Stream to export SVG map.

See Also:

importMap(com.softwarefx.sfxnet.System.IO.Stream)

findMapRegion

public MapRegion findMapRegion(String descriptor)

Returns a MapRegion object of based on the descriptor and search criteria specified.

Remarks:

This method returns the desired MapRegion object within a map. Therefore, when using this method you may equate the call to a MapRegion object or directly access the MapRegion attrbutes:

MapRegion mr = map1.FindMapRegion("Florida", LabelLinkSearchTypes.FromDisplay);

mr.RuleAttributes.Color = Color.Red;

or

map1.FindMapRegion("Florida", LabelLinkSearchTypes.FromDisplay).RuleAttributes.Color = Color.Red;

Note: When modifying the RuleAttributes, the actual RuleAttributes object is modified affecting all regions the rule is applied.

If you search for a region that does not exist on the current level, this method will return the parent level (at current level) which the desired region resides. If nothing is found that matches the search criteria, null is returned.

This method is overloaded, if you do not specify a labelLinkSearch parameter the DataText LabelLink attribute will be used.

Please see the MapRegion class for all the supported members exposed by this object.

Parameters:

descriptor - LabelLink string of the region to return.

See Also:

MapRegion

findMapRegion

public MapRegion findMapRegion(String descriptor,
                               EnumSet<LabelLinkSearchTypes> labelLinkSearch)

Returns a MapRegion object of based on the descriptor and search criteria specified.

Remarks:

This method returns the desired MapRegion object within a map. Therefore, when using this method you may equate the call to a MapRegion object or directly access the MapRegion attrbutes:

MapRegion mr = map1.FindMapRegion("Florida", LabelLinkSearchTypes.FromDisplay);

mr.RuleAttributes.Color = Color.Red;

or

map1.FindMapRegion("Florida", LabelLinkSearchTypes.FromDisplay).RuleAttributes.Color = Color.Red;

Note: When modifying the RuleAttributes, the actual RuleAttributes object is modified affecting all regions the rule is applied.

If you search for a region that does not exist on the current level, this method will return the parent level (at current level) which the desired region resides. If nothing is found that matches the search criteria, null is returned.

This method is overloaded, if you do not specify a labelLinkSearch parameter the DataText LabelLink attribute will be used.

Please see the MapRegion class for all the supported members exposed by this object.

Parameters:

descriptor - LabelLink string of the region to return.

labelLinkSearch - LabelLink type to seach for descriptor.

See Also:

MapRegion

get

public PointAttributes get(String displaytext)

Returns the element at the specified position in the Map.

Parameters:

displaytext -

getAnnotationObjectsList

public AnnotationList getAnnotationObjectsList()

Returns the collection of annotation objects contained in the map extension.

Remarks:

When a map is generated, each item in the map is created using an Annotation Polygon object. This property allows you to access a selected item in that collection using an index value.

This property exposes the supported members of the AnnotationList class. Please see the Annotation extension documentation for more information regarding this class.

getCancelledDrillDownListeners

public MapCancelledDrillDownListener[] getCancelledDrillDownListeners()

Returns an array of all the CancelledDrillDownListeners added to this class with addCancelledDrillDownListeners().

getCancellingDrillDownListeners

public MapCancellingDrillDownListener[] getCancellingDrillDownListeners()

Returns an array of all the CancellingDrillDownListeners added to this class with addCancellingDrillDownListeners().

getChart

public Chart getChart()

Gets the Chart. For more detail see setChart(com.softwarefx.chartfx.server.Chart).

getCulture

public Locale getCulture()

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

getData

public MapDataObj getData()

Used to return an MapDataObj from a Map.

Remarks:

This property is used to access the MapDataObj for the chart.

See Also:

Map

getDataFormat

public ValueFormat getDataFormat()

Gets the ValueFormat object for the Map.

Remarks:

The properties of the ValueFormat are modifiable, but you cannot assign a new object to the DataFormat property.

getDefaultAttributes

public DefaultAttributes getDefaultAttributes()

Returns the DefaultAttributes object for the map.

Remarks:

The DefaultAttributes object derives from the chart's PointAttributes object.

The DefaultAttributes object is applied to map regions which no conditional attributes or default series attributes were assigned. The only time DefaultAttributes are applied is when a map region has no configured data value or if a DrillDown occurs (applied to non focus regions). If data has been configured for a region, then the default SeriesAttributes for the series object are applied.

The getDefaultHighlightAttributes() property may be used to configure default highlighting attributes for the chart.

See Also:

getDefaultHighlightAttributes(), #setDrillDownTo, MapRegion

getDefaultHighlightAttributes

public PointAttributes getDefaultHighlightAttributes()

Returns a PointAttributes object used for assigning highlight attributes for the map.

Remarks:

The DefaultHighlightAttributes object derives from the chart's PointAttributes object.

This allows you to configure the default highlight attributes for a map. It is important to mention that the highlight attributes inherited from the chart are overridden and will have no effect on a map. Developers should use this property to configure highlight attributes when using Chart FX Maps.

Therefore, setting Highlight attributes like this WILL BE IGNORED by Chart FX Maps:

See Also:

getDefaultAttributes()

getDetailLevel

public int getDetailLevel()

Gets the DetailLevel. For more detail see setDetailLevel(int).

getDetailLevelChangedListeners

public MapDetailLevelChangedListener[] getDetailLevelChangedListeners()

Returns an array of all the DetailLevelChangedListeners added to this class with addDetailLevelChangedListeners().

getDrillDownMapRegion

public MapRegion getDrillDownMapRegion()

Returns the MapRegion object of a DrillDown.

Remarks:

This property returns a MapRegion object of a DrillDown action. You can use the supported members of the MapRegion class on the returned object.

The #DrillDownTo method of the MapRegion class is used to perform a DrillDown programmatically.

The cancelDrillDown() method is used to cancel a DrillDown action.

See Also:

#setDrillDownTo, cancelDrillDown(), MapRegion

getDrillDownMode

public DrillDownMode getDrillDownMode()

Gets the DrillDownMode. For more detail see setDrillDownMode(com.softwarefx.chartfx.server.maps.DrillDownMode).

getDrilledDownListeners

public MapDrilledDownListener[] getDrilledDownListeners()

Returns an array of all the DrilledDownListeners added to this class with addDrilledDownListeners().

getDrillingDownListeners

public MapDrillingDownListener[] getDrillingDownListeners()

Returns an array of all the DrillingDownListeners added to this class with addDrillingDownListeners().

getDummyLabelLinkFile

public com.softwarefx.sfxnet.System.Xml.XmlDocument getDummyLabelLinkFile()

Provides a means to store the label link file.

Remarks:

This property allows the developer to store the label link within the Map object for reference or modification.

getLabelLinkFile

public String getLabelLinkFile()

Gets the LabelLinkFile. For more detail see setLabelLinkFile(java.lang.String).

getLabelLinks

public LabelLinkCollection getLabelLinks()

Used to access a selected LabelLink item based on the specified index value.

Remarks:

By default, Chart FX Maps assumes that labels passed with chart data match the text labels that exist in the configured SVG 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: LabelLink.setDataText(java.lang.String), LabelLink.setDisplayText(java.lang.String) and LabelLink.setSvgText(java.lang.String).

This property allows you to access LabelLink.setDataText(java.lang.String), LabelLink.setDisplayText(java.lang.String) and LabelLink.setSvgText(java.lang.String) properties of the LabelLink class.

The setLabelLinkFile(java.lang.String) property may be used to configure an XML file used the LabelLink settings.

See Also:

setLabelLinkFile(java.lang.String), LabelLink.setDataText(java.lang.String), LabelLink.setDisplayText(java.lang.String), LabelLink.setSvgText(java.lang.String), LabelLink

getLabelStyles

public EnumSet<LabelStyles> getLabelStyles()

Gets the LabelStyles. For more detail see setLabelStyles(java.util.EnumSet).

getLabelStylesSettings

public LabelStylesSettings getLabelStylesSettings()

Used to access the LabelStylesSettings object for the map.

Remarks:

This property returns the LabelStylesSettings object for the chart which exposes proerties which allow you to control the style in which labels are displayed for chart regions.

The members supported by the LabelStylesSettings class include LabelStylesSettings.setDontShowParentLevels(boolean), LabelStylesSettings.setShowNothing(boolean) and LabelStylesSettings.setShowThisLevelOnly(boolean).

The setLabelStyles(java.util.EnumSet) property allows you to set these same attributes as flags using bitwise operators.

See Also:

setLabelStyles(java.util.EnumSet), LabelStylesSettings.setDontShowParentLevels(boolean), LabelStylesSettings.setShowNothing(boolean), LabelStylesSettings.setShowThisLevelOnly(boolean), LabelStylesSettings

getMapCommandID

public int getMapCommandID(com.softwarefx.chartfx.server.maps.MapCommandId id)

Error: Member Map.MapCommandID member not found

ERROR: Doc member not found

getMapData

public MapDataObj getMapData()

Error: Deprecated member Map.MapData member not found

getMapSource

public String getMapSource()

Gets the MapSource. For more detail see setMapSource(java.lang.String).

getMaxDetailLevel

public int getMaxDetailLevel()

Returns the highest detail level supported in a configured map.

Remarks:

You may configure the current detail level for a map using the setDetailLevel(int) property.

See Also:

setDetailLevel(int)

getRegionAlternateTextColor

public Color getRegionAlternateTextColor()

Gets the RegionAlternateTextColor. For more detail see setRegionAlternateTextColor(java.awt.Color).

getTitleFont

public Font getTitleFont()

Gets the TitleFont. For more detail see setTitleFont(java.awt.Font).

getTitleSeparator

public String getTitleSeparator()

Gets the TitleSeparator. For more detail see setTitleSeparator(java.lang.String).

getVisibleMapRegions

public VisibleMapRegions getVisibleMapRegions()

Used to access a MapRegion objects currently visible in a map.

Remarks:

This property exposes the supported members of the MapRegion class. It could be used to access a selected MapRegion using an index value or may be used to obtain the entire VisibleMapRegions collection. Once you have obtained the collection, you could loop through to find a specific MapRegion.

map1.VisibleMapRegions[0].Font = new Font("Arial",15);
or
VisibleMapRegions vmrc = map1.VisibleMapRegions;


The findMapRegion(java.lang.String) method allows you to search for a region within the entire MapRegion collection.

See Also:

findMapRegion(java.lang.String), MapRegion

getWinnerCallbackListeners

public WinnerCallbackListener[] getWinnerCallbackListeners()

Returns an array of all the WinnerCallbackListeners added to this class with addWinnerCallbackListeners().

getWinnerSeriesType

public EnumSet<WinnerSeriesType> getWinnerSeriesType()

Gets the WinnerSeriesType. For more detail see setWinnerSeriesType(java.util.EnumSet).

importMap

public void importMap(com.softwarefx.sfxnet.System.IO.Stream stream)

Used to import a map (SVG) that was previously exported using the ExportMap method.

Remarks:

The ExportMap property is used to export the configured SVG map to a stream.

Parameters:

stream - Stream containing the SVG map.

See Also:

importMap(com.softwarefx.sfxnet.System.IO.Stream)

isCurrentGallery

public boolean isCurrentGallery()

Gets the CurrentGallery. For more detail see setCurrentGallery(boolean).

isEnableViewState

public boolean isEnableViewState()

Error: Member Map.EnableViewState member not found

ERROR: Doc member not found

recalculate

public void recalculate()

Used to instruct Chart FX to re-apply the configured conditional attributes to the map.

Remarks:

When data values are modified, the configured conditional attributes are automatically applied to the map. However, if the values of the Conditional Attributes themselves are modified, this method must be called to re-apply the attributes with new settings to the map.

removeCancelledDrillDownListener

public void removeCancelledDrillDownListener(MapCancelledDrillDownListener value)

Removes a CancelledDrillDownListener from the listener list.

Parameters:

value - The CancelledDrillDownListener to be removed.

removeCancellingDrillDownListener

public void removeCancellingDrillDownListener(MapCancellingDrillDownListener value)

Removes a CancellingDrillDownListener from the listener list.

Parameters:

value - The CancellingDrillDownListener to be removed.

removeDetailLevelChangedListener

public void removeDetailLevelChangedListener(MapDetailLevelChangedListener value)

Removes a DetailLevelChangedListener from the listener list.

Parameters:

value - The DetailLevelChangedListener to be removed.

removeDrilledDownListener

public void removeDrilledDownListener(MapDrilledDownListener value)

Removes a DrilledDownListener from the listener list.

Parameters:

value - The DrilledDownListener to be removed.

removeDrillingDownListener

public void removeDrillingDownListener(MapDrillingDownListener value)

Removes a DrillingDownListener from the listener list.

Parameters:

value - The DrillingDownListener to be removed.

removeWinnerCallbackListener

public void removeWinnerCallbackListener(WinnerCallbackListener value)

Removes a WinnerCallbackListener from the listener list.

Parameters:

value - The WinnerCallbackListener to be removed.

setChart

public void setChart(Chart value)

Get or set the associated Chart object.

Remarks:

To create a Map the developer must first drop a Chart object into the design space, then assign the Map extension to the chart.

setCulture

public void setCulture(Locale value)

Get or set the CultureInfo object.

Remarks:

For more information on Culture settings refer to Java API documention.

setCurrentGallery

public void setCurrentGallery(boolean value)

Get or set the value indicating whether the Map is the current Chart gallery.

Remarks:

If this property is set to false, then the Map data will attempt to load onto a default chart.

setDetailLevel

public void setDetailLevel(int value)

Sets the detail level used to display the map.

Remarks:

The DetailLevel of a map refers to the grouping scheme of the SVG MapSource. By creating groups in the SVG map, developers create parent groups which individual map regions may be a part. Chart FX Maps will automatically calculate a total for all the map regions which are grouped together when the DetailLevel changes.

An example of this grouping can be seen in the US Regional map. All the US states are grouped together per region, i.e. SouthEast, NorthWest, etc.

This grouping must be configured in the SVG map used by Chart FX Maps.

The getMaxDetailLevel() property may be used to return the maximum DetailLevel for the configured SVG setMapSource(java.lang.String).

See Also:

getMaxDetailLevel(), setMapSource(java.lang.String)

setDrillDownMode

public void setDrillDownMode(DrillDownMode value)

Sets the DrillDown mode for a map.

Remarks:

Setting this property to Hide, will only display the DrillDown region in the map.

Setting this property to ShowDefault will show all surrounding regions in the Map when a DrillDown occurs, however, all the regions not part of the selected DrillDown MapRegion will have the getDefaultAttributes() applied.

See Also:

getDefaultAttributes()

setEnableViewState

public void setEnableViewState(boolean value)

Error: Member Map.EnableViewState member not found

ERROR: Doc member not found

setLabelLinkFile

public void setLabelLinkFile(String value)

Sets a path for an XML file of the LabelLink attributes.

Remarks:

By default, Chart FX Maps assumes that labels passed with chart data match the text labels that exist in the configured SVG 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: LabelLink.setDataText(java.lang.String), LabelLink.setDisplayText(java.lang.String) and LabelLink.setSvgText(java.lang.String).

The LabelLinks conversion table may be created by adding individual LabelLink objects to the LabelLinkCollection for each required conversion.

If you have a large number of required conversions, you may set this property to an valid XML file containing the necessary attributes. Below is the supported format for the XML:

<LabelLinks>
<LabelLink>
<DataText>ALABAMA</DataText>
<SvgText>AL</SvgText>
<DisplayText>Alabama</DisplayText>
</LabelLink>
</LabelLinks>


See Also:

getLabelLinks(), LabelLink.setDataText(java.lang.String), LabelLink.setDisplayText(java.lang.String), LabelLink.setSvgText(java.lang.String), setMapSource(java.lang.String), LabelLink

setLabelStyles

public void setLabelStyles(EnumSet<LabelStyles> value)

Flag property that allows setting attributes for map labels contained in the map extension.

Remarks:

You set this property using the bitwise operators (And, Or, Not, Xor) provided by your development tool.

For example, the correct way to turn on the 'ShowNothing' setting:

map1.LabelStyles = map1.LabelStyles Or LabelStyles.ShowNothing


The following code is WRONG (it will erase all other settings in the property causing an erratic behavior of the library and an incorrect setting of the individual properties which also control these flags.):

map1.LabelStyles = LabelStyles.ShowNothing


Many of the flags available with this property may also be set using individual Boolean properties of the LabelStylesSettings class. These included: LabelStylesSettings.setDontShowParentLevels(boolean), LabelStylesSettings.setShowNothing(boolean) and LabelStylesSettings.setShowThisLevelOnly(boolean).

See Also:

LabelStylesSettings.setDontShowParentLevels(boolean), LabelStylesSettings.setShowNothing(boolean), LabelStylesSettings.setShowThisLevelOnly(boolean), LabelStylesSettings

setMapSource

public void setMapSource(String value)

Sets the SVG to be used for the Map object.

Remarks:

The file specified as the MapSource must be SVG format.

By default, Chart FX Maps assumes that labels passed with chart data match the text labels that exist in the configured SVG MapSource. 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: LabelLink.setDataText(java.lang.String), LabelLink.setDisplayText(java.lang.String) and LabelLink.setSvgText(java.lang.String).

The setLabelLinkFile(java.lang.String) property is used to configure an XML file consisting of the LabelLink object attributes.

See Also:

setLabelLinkFile(java.lang.String)

setRegionAlternateTextColor

public void setRegionAlternateTextColor(Color value)

Get or set the color used for all complex labels in a map.

Remarks:

A complex label is defined as a label with a path or multiple paths (a line with a label that points to a region). A complex label is usually required when a region is smaller than the text label configured.

This scope of this setting is global for the entire map object.

setTitleFont

public void setTitleFont(Font value)

Used to assign a new font object for double DrillDown titles.

Remarks:

For more information regarding the Font type, please refer to the java.awt.Font Documentation.

See Also:

setTitleSeparator(java.lang.String)

setTitleSeparator

public void setTitleSeparator(String value)

Sets the string used to separate titles.

Remarks:

The only time a TitleSeparator is visible is when a double DrillDown has occured. The setTitleFont(java.awt.Font) is also only used when a double drilldown has occured.

This property accepts a string to be used as the separator for titles in the map extension.

The #DrillDownTo method of the MapRegion class is used to perform a DrillDown action programmatically.

See Also:

setTitleFont(java.awt.Font), #setDrillDownTo, MapRegion

setWinnerSeriesType

public void setWinnerSeriesType(EnumSet<WinnerSeriesType> value)

Sets the mode which the winning series is determined.

Remarks:

The WinnerDelegateEventArgs class exposes the #WnnerSeries property. This member may be used to get or set the winning series when the WinnerCallBack event is handled.

See Also:

#setWinnerSeries