SoftwareFX.ChartFX.Map
Class Map

java.lang.Object
  SoftwareFX.ChartFX.ChartCore
      SoftwareFX.ChartFX.Chart
          SoftwareFX.ChartFX.Map.Map

Direct Known Subclasses:

MapServer

public final class Map
extends Chart

Provides access to the Map object.

The Map class is derived form the Chart class of Chart FX for Java . 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.

Field Summary

Fields inherited from class SoftwareFX.ChartFX.Chart

HIDDEN

Constructor Summary

Map()

Method Summary

void	addMapCancelledDrillDownListener(MapCancelledDrillDownListener value) Adds a MapCancelledDrillDownListener to the listener list.
void	addMapCancellingDrillDownListener(MapCancellingDrillDownListener value) Adds a MapCancellingDrillDownListener to the listener list.
void	addMapDetailLevelChangedListener(MapDetailLevelChangedListener value) Adds a MapDetailLevelChangedListener to the listener list.
void	addMapDrilledDownListener(MapDrilledDownListener value) Adds a MapDrilledDownListener to the listener list.
void	addMapDrillingDownListener(MapDrillingDownListener value) Adds a MapDrillingDownListener 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	clearData(int cdf) Clears some or all data in the map based on type setting.
void	exportMap(java.io.OutputStream stream) Used to export the configured map (SVG) to a stream.
MapRegion	findMapRegion(java.lang.String descriptor) Returns a MapRegion object of based on the descriptor and search criteria specified.
MapRegion	findMapRegion(java.lang.String descriptor, int labelLinkSearch) Returns a MapRegion object of based on the descriptor and search criteria specified.
java.awt.Color	getAlternateTextColor() Gets the AlternateTextColor.
AnnotationList	getAnnotationObjectsList() Returns the collection of annotation objects contained in the map extension.
AnnotationObject	getAnnotationObjectsList(int n) Deprecated. You should use getAnnotationObjectsList(int) instead.
SoftwareFX.ChartFX.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.
MapRegion	getDrillDownMapRegion() Returns the MapRegion object of a DrillDown.
int	getDrillDownMode() Gets the DrillDownMode.
int	getGallery() Gets the Gallery.
IGalleryType	getGalleryObj() Gets the GalleryObj.
int	getHeight() Gets the Height.
PointAttributes	getItem(java.lang.String displaytext) Used to return the PointAttributes object for a map region.
LabelLink	getLabelLink(int i) Deprecated. You should use getLabelLinks() instead.
java.lang.String	getLabelLinkFile() Gets the LabelLinkFile.
LabelLinkCollection	getLabelLinks() Used to access a selected LabelLink item based on the specified index value.
int	getLabelStyles() Gets the LabelStyles.
LabelStylesSettings	getLabelStylesSettings() Used to access the LabelStylesSettings object for the map.
MapCancelledDrillDownListener[]	getMapCancelledDrillDownListeners() Returns an array of all the MapCancelledDrillDownListeners added to this class with addMapCancelledDrillDownListeners().
MapCancellingDrillDownListener[]	getMapCancellingDrillDownListeners() Returns an array of all the MapCancellingDrillDownListeners added to this class with addMapCancellingDrillDownListeners().
MapDataObj	getMapData() Used to return an MapDataObj from a Map.
double	getMapData(int series, int point) Deprecated. You should use getMapData() instead.
MapDetailLevelChangedListener[]	getMapDetailLevelChangedListeners() Returns an array of all the MapDetailLevelChangedListeners added to this class with addMapDetailLevelChangedListeners().
MapDrilledDownListener[]	getMapDrilledDownListeners() Returns an array of all the MapDrilledDownListeners added to this class with addMapDrilledDownListeners().
MapDrillingDownListener[]	getMapDrillingDownListeners() Returns an array of all the MapDrillingDownListeners added to this class with addMapDrillingDownListeners().
java.lang.String	getMapSource() Gets the MapSource.
int	getMaxDetailLevel() Returns the highest detail level supported in a configured map.
java.lang.String	getPalette() Gets the Palette.
java.awt.Font	getTitleFont() Gets the TitleFont.
java.lang.String	getTitleSeparator() Gets the TitleSeparator.
VisibleMapRegions	getVisibleMapRegions() Returns the VisibleMapRegion Collection.
int	getWidth() Gets the Width.
WinnerCallbackListener[]	getWinnerCallbackListeners() Returns an array of all the WinnerCallbackListeners added to this class with addWinnerCallbackListeners().
int	getWinnerSeriesType() Gets the WinnerSeriesType.
void	importMap(java.io.InputStream stream) Used to import a map (SVG) exported prior using the ExportMap method.
boolean	isShowRegionBorders() Gets the ShowRegionBorders.
void	recalculate() Used to instruct Chart FX to re-apply the configured conditional attributes to the map.
void	removeMapCancelledDrillDownListener(MapCancelledDrillDownListener value) Removes a MapCancelledDrillDownListener from the listener list.
void	removeMapCancellingDrillDownListener(MapCancellingDrillDownListener value) Removes a MapCancellingDrillDownListener from the listener list.
void	removeMapDetailLevelChangedListener(MapDetailLevelChangedListener value) Removes a MapDetailLevelChangedListener from the listener list.
void	removeMapDrilledDownListener(MapDrilledDownListener value) Removes a MapDrilledDownListener from the listener list.
void	removeMapDrillingDownListener(MapDrillingDownListener value) Removes a MapDrillingDownListener from the listener list.
void	removeWinnerCallbackListener(WinnerCallbackListener value) Removes a WinnerCallbackListener from the listener list.
void	setAlternateTextColor(java.awt.Color value) Gets or sets the color used for all complex labels in a map.
void	setDetailLevel(int value) Gets or sets the detail level used to display the map.
void	setDrillDownMode(int value) Gets or sets the DrillDown mode for a map.
void	setGallery(int value) Gets or sets the chart type.
void	setGalleryObj(IGalleryType value) Gets or sets the Map GalleryObj.
void	setHeight(int value) Gets or sets the height of the map object.
void	setLabelLink(int i, LabelLink value) Deprecated. You should use getLabelLinks() instead.
void	setLabelLinkFile(java.lang.String value) Gets or sets a path for an XML file of the LabelLink attributes.
void	setLabelStyles(int value) Flag property that allows setting attributes for map labels contained in the map extension.
void	setMapSource(java.lang.String value) Gets or sets the SVG to be used for the Map object.
void	setPalette(java.lang.String value) Gets or sets a Chart FX pre-defined palette for the map.
void	setShowRegionBorders(boolean value) Gets or sets a value indicating whether to display the region borders.
void	setTitleFont(java.awt.Font value) Used to assign a new font object for double DrillDown titles.
void	setTitleSeparator(java.lang.String value) Gets or sets the string used to separate titles.
void	setWidth(int value) Gets or sets the width of the map object.
void	setWinnerSeriesType(int value) Gets or sets the mode which the winning series is determined.

Methods inherited from class SoftwareFX.ChartFX.Chart

dateToNumber, dateToNumber, getFont, getHtmlData, getHtmlDataEx, getHtmlTag, getHtmlTag, getHtmlTag, getHtmlTag, getID, getImgHeight, getImgMap, getImgQuality, getImgTags, getImgWidth, getOutputWriter, getProxyUri, getURL, getURLOptions, getURLParamMask, getURLTarget, isEmbeddedData, isImgSizeable, isMainClient, loadDefault, setConfigPath, setEmbeddedData, setFont, setHtmlTag, setID, setImgHeight, setImgMap, setImgQuality, setImgSizeable, setImgTags, setImgWidth, setMainClient, setOutputWriter, setProxyUri, setURL, setURLOptions, setURLParamMask, setURLTarget

Methods inherited from class SoftwareFX.ChartFX.ChartCore

closeData, exportChart, exportChart, getAngleX, getAngleY, getAxesStyle, getAxis, getAxis, getAxisX, getAxisY, getAxisY2, getBackColor, getBackgroundImage, getBackObject, getBorderColor, getBorderEffect, getBorderObject, getBottomGap, getChartStyle, getCommand, getCommands, getConditionalAttribute, getConditionalAttributes, getConstantLine, getConstantLines, getCulture, getCylSides, getDataEditorObj, getDataSource, getDataSourceSettings, getDataStyle, getDataType, getDataType, getDesignTimeData, getExtension, getExtensions, getFileMask, getGaps, getGrid, getHighlight, getImageMode, getInfoString, getIniValue, getIniValue, getInsideBackObject, getInsideColor, getKeyLeg, getKeyLeg, getLeftGap, getLegend, getLegend, getLegendBoxObj, getLineStyle, getLineWidth, getLink, getMarkerShape, getMarkerSize, getMarkerStep, getMenuBarObj, getMenuBarObj, getMessageText, getNSeries, getNValues, getPageColor, getPane, getPanes, getPersonalizedFlags, getPersonalizedName, getPerspective, getPoint, getPoint, getPoint, getPointFont, getPointLabelAlign, getPointLabelAngle, getPointLabelColor, getPointLabelFont, getPointLabelMask, getPointLabelOffset, getPrinter, getRightGap, getScheme, getSeries, getSeries, getSerKey, getSerKey, getSerLeg, getSerLeg, getSerLegBoxObj, getSmoothFlags, getStacked, getStripe, getStripes, getStyleEx, getTemplateMask, getTipMask, getTitle, getTitles, getToolBarObj, getToolBarObj, getTopGap, getTypeEx, getTypeMask, getUserLegendBoxObj, getValue, getValue, getView3DDepth, getView3DLight, getVolume, getWallWidth, getXValue, getXValue, getYLeg, getYLeg, importChart, importChart, isAllowDrag, isAllowEdit, isBorder, isChart3D, isCluster, isContextMenus, isCrossHairs, isDataEditor, isDirty, isLegendBox, isMenuBar, isMultipleColors, isPointLabels, isScrollable, isSerLegBox, isShowTips, isToolBar, isUserLegendBox, isView3D, isZoom, markerToPixel, openData, paint, recalcScale, setAllowDrag, setAllowEdit, setAngleX, setAngleY, setAxesStyle, setBackColor, setBackgroundImage, setBackObject, setBorder, setBorderColor, setBorderEffect, setBorderObject, setBottomGap, setChart3D, setChartStyle, setCluster, setContextMenus, setCrossHairs, setCulture, setCylSides, setDataEditor, setDataSource, setDataStyle, setDataType, setDesignTimeData, setDirty, setFileMask, setGaps, setGrid, setImageMode, setIniValue, setInsideBackObject, setInsideColor, setKeyLeg, setLeftGap, setLegend, setLegendBox, setLineStyle, setLineWidth, setMarkerShape, setMarkerSize, setMarkerStep, setMenuBar, setMenuBarObj, setMessageText, setMultipleColors, setNSeries, setNValues, setPageColor, setPersonalizedFlags, setPersonalizedName, setPerspective, setPoint, setPoint, setPointFont, setPointLabelAlign, setPointLabelAngle, setPointLabelColor, setPointLabelFont, setPointLabelMask, setPointLabelOffset, setPointLabels, setRightGap, setScheme, setScrollable, setSerKey, setSerLeg, setSerLegBox, setShowTips, setSmoothFlags, setStacked, setStyleEx, setTemplateMask, setTipMask, setToolBar, setToolBarObj, setTopGap, setTypeEx, setTypeMask, setUserLegendBox, setValue, setView3D, setView3DDepth, setView3DLight, setVolume, setWallWidth, setXValue, setYLeg, setZoom

Methods inherited from class java.lang.Object

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

Constructor Detail

Map

public Map()

Method Detail

addMapCancelledDrillDownListener

public void addMapCancelledDrillDownListener(MapCancelledDrillDownListener value)

Adds a MapCancelledDrillDownListener to the listener list.

Parameters:

value - The MapCancelledDrillDownListener to be added.

addMapCancellingDrillDownListener

public void addMapCancellingDrillDownListener(MapCancellingDrillDownListener value)

Adds a MapCancellingDrillDownListener to the listener list.

Parameters:

value - The MapCancellingDrillDownListener to be added.

addMapDetailLevelChangedListener

public void addMapDetailLevelChangedListener(MapDetailLevelChangedListener value)

Adds a MapDetailLevelChangedListener to the listener list.

Parameters:

value - The MapDetailLevelChangedListener to be added.

addMapDrilledDownListener

public void addMapDrilledDownListener(MapDrilledDownListener value)

Adds a MapDrilledDownListener to the listener list.

Parameters:

value - The MapDrilledDownListener to be added.

addMapDrillingDownListener

public void addMapDrillingDownListener(MapDrillingDownListener value)

Adds a MapDrillingDownListener to the listener list.

Parameters:

value - The MapDrillingDownListener 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 MapRegion.drillDownTo()MapRegion.drillDownTo() method is used to DrillDown to a selected region in the map.

See Also:

MapRegion.drillDownTo(), MapRegion

clearData

public void clearData(int cdf)

Clears some or all data in the map based on type setting.

Remarks:

This method can be called with multiple constants using bitwise operators. For example if you want to remove both Labels and Values, you may invoke the ClearData call combining both ClearDataFlags.

The getMapData(int, int) property of the Map object is used to return the MapDataObj; the data array for a map.

Overrides:

clearData in class ChartCore

Parameters:

cdf - A ClearDataFlag specifying what type of data you want to remove form the chart.

See Also:

ChartCore.setDataSource(SoftwareFX.ChartFX.IDataProvider), getMapData(int, int), Map

exportMap

public void exportMap(java.io.OutputStream 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(java.io.InputStream)

findMapRegion

public MapRegion findMapRegion(java.lang.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.FROM_DISPLAY);
mr.getPointAttributes().setColor(java.awt.Color.red);

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(java.lang.String descriptor,
                               int 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.FROM_DISPLAY);
mr.getPointAttributes().setColor(java.awt.Color.red);

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.

Parameter Values:
The available values for labelLinkSearch are:

Value	Description
LabelLinkSearchTypes.FROM_DATA	Search for string in LabelLinks DataText.
LabelLinkSearchTypes.FROM_SVG	Search for string in LabelLinks SvgText.
LabelLinkSearchTypes.FROM_DISPLAY	Search for string in LabelLinks DisplayText.

See Also:

MapRegion

getAlternateTextColor

public java.awt.Color getAlternateTextColor()

Gets the AlternateTextColor. For more detail see setAlternateTextColor(java.awt.Color).

getAnnotationObjectsList

public AnnotationObject getAnnotationObjectsList(int n)

Deprecated. You should use getAnnotationObjectsList(int) instead.

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.

getDefaultAttributes

public SoftwareFX.ChartFX.Map.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(), MapRegion.drillDownTo(), 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).

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 MapRegion.drillDownTo() method of the MapRegion class is used to perform a DrillDown programmatically. Users may also DrillDown using the map context menu when Active .Net component charts are used.

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

See Also:

MapRegion.drillDownTo(), cancelDrillDown(), MapRegion

getDrillDownMode

public int getDrillDownMode()

Gets the DrillDownMode. For more detail see setDrillDownMode(int).

getGallery

public int getGallery()

Gets the Gallery. For more detail see setGallery(int).

Overrides:

getGallery in class ChartCore

getGalleryObj

public IGalleryType getGalleryObj()

Gets the GalleryObj. For more detail see setGalleryObj(SoftwareFX.ChartFX.IGalleryType).

Overrides:

getGalleryObj in class ChartCore

getHeight

public int getHeight()

Gets the Height. For more detail see setHeight(int).

Overrides:

getHeight in class Chart

getItem

public PointAttributes getItem(java.lang.String displaytext)

Used to return the PointAttributes object for a map region.

Remarks:

This property may be used to return the PointAttributes object for a selected MapRegion. It is important to remember if this point object is utilized for any other region, that region will also be modified.

getLabelLink

public LabelLink getLabelLink(int i)

Deprecated. You should use getLabelLinks() instead.

getLabelLinkFile

public java.lang.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 int getLabelStyles()

Gets the LabelStyles. For more detail see setLabelStyles(int).

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(int) property allows you to set these same attributes as flags using bitwise operators.

See Also:

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

getMapCancelledDrillDownListeners

public MapCancelledDrillDownListener[] getMapCancelledDrillDownListeners()

Returns an array of all the MapCancelledDrillDownListeners added to this class with addMapCancelledDrillDownListeners().

getMapCancellingDrillDownListeners

public MapCancellingDrillDownListener[] getMapCancellingDrillDownListeners()

Returns an array of all the MapCancellingDrillDownListeners added to this class with addMapCancellingDrillDownListeners().

getMapData

public double getMapData(int series,
                         int point)

Deprecated. You should use getMapData() instead.

See Also:

MapDataObj

getMapData

public MapDataObj getMapData()

Used to return an MapDataObj from a Map.

Remarks:

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

See Also:

Map

getMapDetailLevelChangedListeners

public MapDetailLevelChangedListener[] getMapDetailLevelChangedListeners()

Returns an array of all the MapDetailLevelChangedListeners added to this class with addMapDetailLevelChangedListeners().

getMapDrilledDownListeners

public MapDrilledDownListener[] getMapDrilledDownListeners()

Returns an array of all the MapDrilledDownListeners added to this class with addMapDrilledDownListeners().

getMapDrillingDownListeners

public MapDrillingDownListener[] getMapDrillingDownListeners()

Returns an array of all the MapDrillingDownListeners added to this class with addMapDrillingDownListeners().

getMapSource

public java.lang.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)

getPalette

public java.lang.String getPalette()

Gets the Palette. For more detail see setPalette(java.lang.String).

Overrides:

getPalette in class ChartCore

getTitleFont

public java.awt.Font getTitleFont()

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

getTitleSeparator

public java.lang.String getTitleSeparator()

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

getVisibleMapRegions

public VisibleMapRegions getVisibleMapRegions()

Returns the VisibleMapRegion Collection.

Remarks:

This property exposes the supported members of the VisibleMapRegions class.

It could be used to access a specific VisibleMapRegion 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 VisibleMapRegion.





map1.getVisibleMapRegions().getItem(0).setFont(new java.awt.Font("Arial",java.awt.Font.PLAIN,15));
or
VisibleMapRegions vmrc = map1.getVisibleMapRegions();


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

getWidth

public int getWidth()

Gets the Width. For more detail see setWidth(int).

Overrides:

getWidth in class Chart

getWinnerCallbackListeners

public WinnerCallbackListener[] getWinnerCallbackListeners()

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

getWinnerSeriesType

public int getWinnerSeriesType()

Gets the WinnerSeriesType. For more detail see setWinnerSeriesType(int).

importMap

public void importMap(java.io.InputStream stream)

Used to import a map (SVG) exported prior 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(java.io.InputStream)

isShowRegionBorders

public boolean isShowRegionBorders()

Gets the ShowRegionBorders. For more detail see setShowRegionBorders(boolean).

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.

removeMapCancelledDrillDownListener

public void removeMapCancelledDrillDownListener(MapCancelledDrillDownListener value)

Removes a MapCancelledDrillDownListener from the listener list.

Parameters:

value - The MapCancelledDrillDownListener to be removed.

removeMapCancellingDrillDownListener

public void removeMapCancellingDrillDownListener(MapCancellingDrillDownListener value)

Removes a MapCancellingDrillDownListener from the listener list.

Parameters:

value - The MapCancellingDrillDownListener to be removed.

removeMapDetailLevelChangedListener

public void removeMapDetailLevelChangedListener(MapDetailLevelChangedListener value)

Removes a MapDetailLevelChangedListener from the listener list.

Parameters:

value - The MapDetailLevelChangedListener to be removed.

removeMapDrilledDownListener

public void removeMapDrilledDownListener(MapDrilledDownListener value)

Removes a MapDrilledDownListener from the listener list.

Parameters:

value - The MapDrilledDownListener to be removed.

removeMapDrillingDownListener

public void removeMapDrillingDownListener(MapDrillingDownListener value)

Removes a MapDrillingDownListener from the listener list.

Parameters:

value - The MapDrillingDownListener to be removed.

removeWinnerCallbackListener

public void removeWinnerCallbackListener(WinnerCallbackListener value)

Removes a WinnerCallbackListener from the listener list.

Parameters:

value - The WinnerCallbackListener to be removed.

setAlternateTextColor

public void setAlternateTextColor(java.awt.Color value)

Gets or sets 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.

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

See Also:

Map

setDetailLevel

public void setDetailLevel(int value)

Gets or 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.

End users have access to modify the DetailLevel using the Right-click context menu of the map at run-time if the chart is configured as an Active .Net component.

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(int value)

Gets or sets the DrillDown mode for a map.

Values:

DrillDownMode : DrillDownMode

Value	Description
DrillDownMode.HIDE	Hide all regions not in the DrillDown.
DrillDownMode.SHOW_DEFAULT	Display surrounding regions of the DrillDown region with the DefaultRuleAttribute applied.

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()

setGallery

public void setGallery(int value)

Gets or sets the chart type.

Remarks:

This property was included in the Maps documentation for compatibility reasons. For a full description, please see the Chart FX Help.

Overrides:

setGallery in class ChartCore

See Also:

SeriesAttributes.setGallery(int), ChartCore.setGalleryObj(SoftwareFX.ChartFX.IGalleryType), SeriesAttributes, Pie, Radar

setGalleryObj

public void setGalleryObj(IGalleryType value)

Gets or sets the Map GalleryObj.

Remarks:

This property was included in the Maps documentation for compatibility reasons. For a full description, please see the Chart FX Help.

Overrides:

setGalleryObj in class ChartCore

See Also:

ChartCore.setGallery(int), Pie, Radar

setHeight

public void setHeight(int value)

Gets or sets the height of the map object.

Remarks:

This property may be used to configure or retrieve the height of the map object. The setWidth(int) property may be used to get or set the width for the map.

Use the Location property to set the Top Left coordinate for the map on the form.

Overrides:

setHeight in class Chart

See Also:

setWidth(int)

setLabelLink

public void setLabelLink(int i,
                         LabelLink value)

Deprecated. You should use getLabelLinks() instead.

setLabelLinkFile

public void setLabelLinkFile(java.lang.String value)

Gets or 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(int value)

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

Values:

LabelStyles : LabelStyles

Value	Description
LabelStyles.SHOW_NOTHING	Hide all labels in the map.
LabelStyles.SHOW_OBJECT_NAME	Not yet implemented.
LabelStyles.SHOW_VALUE	Not yet implemented.
LabelStyles.SHOW_THIS_LEVEL_ONLY	Display labels for the current RuleLevel only.
LabelStyles.DONT_SHOW_PARENT_LEVELS	Do not display labels for parent levels, current level and below only.
LabelStyles.SHOW_REGION_BORDERS	Displays the region borders.
LabelStyles.SHOW_LEGEND_ALWAYS	Displays the UserLegend with tbe UserLegendText for all configured RuleAttributes.

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(java.lang.String value)

Gets or 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)

setPalette

public void setPalette(java.lang.String value)

Gets or sets a Chart FX pre-defined palette for the map.

Remarks:

When changing the palette, all the properties related to changing colors in the chart will also be affected as Chart FX will change the windows palette for the chart window. So if you previously set a color using any of the Chart FX supported properties (Color, BackColor, etc) this color may not be part of the applied palette and therefore will be replaced by a color in the selected palette.

Below is a list of Chart FX palettes:


Default.Alternate
Default.ChartFX6
Default.EarthTones
Default.ModernBusiness
Default.Windows
DarkPastels.Pastels
DarkPastels.AltPastels
HighContrast.HighContrast
Nature.Sky
Nature.Adventure
Mesa
Vivid
ChartFX5.ChartFX5


Overrides:

setPalette in class ChartCore

See Also:

ChartCore.setScheme(int), SeriesAttributes

setShowRegionBorders

public void setShowRegionBorders(boolean value)

Gets or sets a value indicating whether to display the region borders.

Remarks:

See Also:

setPalette(java.lang.String)

setTitleFont

public void setTitleFont(java.awt.Font value)

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

Remarks:

The TitleFont property is used to apply a new font object for DrillDown titles, but only when a double DrillDown has occured. Otherwise, the region font from the SVG is used.

The setTitleSeparator(java.lang.String) property is used to specify the character used to separate DrillDown titles in the map.

For more information regarding the Font type, please refer to the Java API Documentation.

See Also:

setTitleSeparator(java.lang.String)

setTitleSeparator

public void setTitleSeparator(java.lang.String value)

Gets or 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 MapRegion.drillDownTo() method of the MapRegion class is used to perform a DrillDown action programmatically.

See Also:

setTitleFont(java.awt.Font), MapRegion.drillDownTo(), MapRegion

setWidth

public void setWidth(int value)

Gets or sets the width of the map object.

Remarks:

This property may be used to configure or retrieve the width of the map object. The setHeight(int) property may be used to get or set the height for the map.

Use the Location property to set the Top Left coordinate for the map on the form.

Overrides:

setWidth in class Chart

See Also:

setHeight(int)

setWinnerSeriesType

public void setWinnerSeriesType(int value)

Gets or sets the mode which the winning series is determined.

Values:

WinnerSeriesType : WinnerSeriesType

Value	Description
WinnerSeriesType.MIN	Winner series will have minimum value.
WinnerSeriesType.MAX	Winner series will have maximum value.

Remarks:

The WinnerDelegateEvent class exposes the WinnerDelegateEvent.setWinnerSeries(int) property. This member may be used to get or set the winning series when the WinnerCallBack event is handled.

See Also:

WinnerDelegateEvent.setWinnerSeries(int), WinnerDelegateEvent