SoftwareFX.ChartFX.Map
Class MapRegion

java.lang.Object
  SoftwareFX.ChartFX.Map.MapRegion

public abstract class MapRegion
extends java.lang.Object

Provides access to the MapRegion object.

The supported members of the MapRegion class allow you to read the attributes for a selected map region. Use the FindMapRegion method of the Map class to return a MapRegion object, which will then expose the properties and methods of this class. These members are also utilized within the mouse events (MouseUp, MouseDown, etc.).

Constructor Summary

MapRegion()

Method Summary

void	drillDownTo() Used to instruct the map to drill down to a selected MapRegion.
AnnotationObject	getBoundary() Returns the AnnotationObject of the selected MapRegion from the AnnotationObjectsList for the map.
java.lang.String	getDataText() Gets the DataText attribute of the MapRegion object.
java.lang.String	getDisplayText() Gets the DisplayText attribute of the MapRegion object.
java.awt.Font	getFont() Gets the Font.
int	getLevel() Gets the current DetailLevel which the MapRegion object exists.
int	getPoint() Gets the point index of the MapRegion object.
PointAttributes	getPointAttributes() Gets the PointAttributes object for the selected map region.
java.lang.String	getSvgText() Gets the SvgText attribute of the MapRegion object.
AnnotationObject	getText() Returns the Text/Label part of the selected MapRegion from the map.
RuleDataObj	getValues() Returns a selected item of the data array for the MapRegion object.
int	getWinnerSeries() Gets the WinnerSeries for the MapRegion.
void	setFont(java.awt.Font value) Gets or sets the Font for the selected MapRegion object.
void	zoomTo() Used to zoom the map to the selected MapRegion object.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapRegion

public MapRegion()

Method Detail

drillDownTo

public void drillDownTo()

Used to instruct the map to drill down to a selected MapRegion.

Remarks:

When the the DrillDownTo method is used, only the selected MapRegion is displayed in the map window, along with a corresponding region title.

The Map.cancelDrillDown() method may be used to return a drill down to the orignial view.

The zoomTo() method is ued to fill the available map area with the selected MapRegion object. Surrounding MapRegions may be clipped by the edge of the visible map area.

The Zoom and DrillDown features are also available via the runtime UI controls supported by Chart FX Maps.

The Map.findMapRegion(java.lang.String) method of the Map object is used to return a MapRegion object.

See Also:

Map.setDetailLevel(int), zoomTo(), Map.findMapRegion(java.lang.String), Map.cancelDrillDown(), Map

getBoundary

public AnnotationObject getBoundary()

Returns the AnnotationObject of the selected MapRegion from the AnnotationObjectsList for the map.

Remarks:

This is a read only property.

Once you have selected a MapRegion using the Map.findMapRegion(java.lang.String) method of the Map class, using this property you can obtain the AnnotationObject that region contained in the Map.getAnnotationObjectsList(int).

MapRegion mr = map.findMapRegion("CA",LabelLinkSearchTypes.FROM_DISPLAY);
AnnotationObject annObj = mr.getBoundary();
annObj.setColor(java.awt.Color.BLUE);


This could also be very useful if you wish to add an Annotation object to the map. For example, if you wanted to create an AnnotationArrow that points to a selected region:

MapRegion mr = map.findMapRegion("CA",LabelLinkSearchTypes.FROM_DISPLAY);
AnnotationArrow arrow = new AnnotationArrow();
arrow.setColor(java.awt.Color.RED);
arrow.setHeight(30);
arrow.setWidth(30);
arrow.set(mr.getBoundary().getTop());
arrow.setLeft(mr.getBoundary().getLef()-10);
arrow.getBorder().setColor(java.awt.Color.RED);


map.getAnnotationObjectsList().add(arrow);


See Also:

Map.getAnnotationObjectsList(int), Map.findMapRegion(java.lang.String), Map

getDataText

public java.lang.String getDataText()

Gets the DataText attribute of the MapRegion object.

Remarks:

This is a read-only property.

The Map.findMapRegion(java.lang.String) method of the Map class returns a desired MapRegion object.

See Also:

Map.findMapRegion(java.lang.String), Map

getDisplayText

public java.lang.String getDisplayText()

Gets the DisplayText attribute of the MapRegion object.

Remarks:

This is a read-only property.

The Map.findMapRegion(java.lang.String) method of the Map class returns a selected MapRegion object.

See Also:

Map.findMapRegion(java.lang.String), Map

getFont

public java.awt.Font getFont()

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

getLevel

public int getLevel()

Gets the current DetailLevel which the MapRegion object exists.

Remarks:

This is a read-only property.

The Map.findMapRegion(java.lang.String) method of the Map class returns a selected MapRegion object.

See Also:

Map.setDetailLevel(int), Map.findMapRegion(java.lang.String), Map

getPoint

public int getPoint()

Gets the point index of the MapRegion object.

Remarks:

This is a read-only property.

The Map.findMapRegion(java.lang.String) method of the Map class returns a selected MapRegion object.

See Also:

Map.findMapRegion(java.lang.String), Map

getPointAttributes

public PointAttributes getPointAttributes()

Gets the PointAttributes object for the selected 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.

See Also:

getBoundary()

getSvgText

public java.lang.String getSvgText()

Gets the SvgText attribute of the MapRegion object.

Remarks:

This is a read-only property.

The Map.findMapRegion(java.lang.String) method of the Map class returns a selected MapRegion object.

See Also:

Map.findMapRegion(java.lang.String), Map

getText

public AnnotationObject getText()

Returns the Text/Label part of the selected MapRegion from the map.

Remarks:

This is a read only property.

Once you have selected a MapRegion using the Map.findMapRegion(java.lang.String) methodMap, using this property you can obtain the text/label object for that region. The Map.getAnnotationObjectsList(int) is a collection of all the annotation objects used to create the map.

See Also:

Map.getAnnotationObjectsList(int), Map.findMapRegion(java.lang.String), Map

getValues

public RuleDataObj getValues()

Returns a selected item of the data array for the MapRegion object.

Remarks:

This is a read-only property.

This property returns an array of values for a specific MapRegion. Using the index, you can return a specific value in that array consistent with the series value at that RuleDataObj point.

The Map.findMapRegion(java.lang.String) method of the Map class returns a selected MapRegion object.

The WinnerDelegateEvent class also supports a WinnerDelegateEvent.getValues() property which may be accessed during the WinnerCallback event.

See Also:

WinnerDelegateEvent.getValues(), Map.findMapRegion(java.lang.String), Map, WinnerDelegateEvent

getWinnerSeries

public int getWinnerSeries()

Gets the WinnerSeries for the MapRegion.

Remarks:

This is a read only property used to obtain the WinnerSeries for the selected MapRegion object.

See Also:

MapRegion

setFont

public void setFont(java.awt.Font value)

Gets or sets the Font for the selected MapRegion object.

Remarks:

The Map class also supports a Font property which may be used to set a Font object for the entire map.

The Map.findMapRegion(java.lang.String) method is used to obtain a selected map region based on the DataText, DisplayText or SvgText of a map region.

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

See Also:

Map.findMapRegion(java.lang.String), Map

zoomTo

public void zoomTo()

Used to zoom the map to the selected MapRegion object.

Remarks:

The zoom feature will fill the available map area with the selected MapRegion object. Surrounding MapRegions may be clipped by the edge of the visible map area.

When the the drillDownTo() method is used, only the selected MapRegion is displayed in the map window, along with a corresponding region title.

The Zoom and DrillDown features are also available via the runtime UI controls supported by Chart FX Maps.

The Map.findMapRegion(java.lang.String) method of the Map object is used to return a MapRegion object.

See Also:

Map.setDetailLevel(int), drillDownTo(), Map.findMapRegion(java.lang.String), Map