com.steema.teechart.styles
Class Map.Polygon

java.lang.Object
  com.steema.teechart.TeeBase
      com.steema.teechart.styles.Map.Polygon

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

Map

public final class Map.Polygon
extends TeeBase

See Also:

Serialized Form

Field Summary

Map	parentSeries

Fields inherited from class com.steema.teechart.TeeBase

chart

Constructor Summary

Map.Polygon(IBaseChart chart)

Map.Polygon(Map.PolygonList collection, IBaseChart chart)

Method Summary

int	add(double x, double y) Adds a boundary coordinate to the polygon.
int	add(Point p) Adds a boundary coordinate to the polygon.
void	draw(IGraphics3D g, int valueIndex)
Rectangle	getBounds() Returns the rectangle in pixels that corresponds to the maximum space used by the polygon.
ChartBrush	getBrush() Determines the kind of brush used to fill the polygon interior.
boolean	getClosed() When true, the polygon is displayed and filled using the polygon Pen and Brush methods.
Color	getColor(int index) The Color used to fill the polygon.
Gradient	getGradient() Determines the kind of polygon's interior gradient effect.
int	getIndex()
boolean	getParentBrush() The polygon uses the same Brush as its parentseries (Map Series) when true.
boolean	getParentPen() The polygon uses the same Pen as its Parentseries, when true.
ChartPen	getPen() Specifies the Pen used to draw the border of the polygon.
Map.PolygonSeries	getPoints() Accesses the co-ordinates PointList which determine the boundary of the polygon.
Point[]	getPolygonPoints() The coordinates of all Points of the Polygon.
java.lang.String	getText() Specifies the text string that labels the polygon
int	getTransparency() Amount of opacity used to fill the polygon interior.
double	getZ() Specifies the position on the Z-axis of the 3D Map Series.
void	setClosed(boolean value) When true, the polygon is displayed and filled using the polygon Pen and Brush methods.
void	setColor(Color value) Sets Color used to fill the polygon.
void	setIndex(int value)
void	setParentBrush(boolean value) The polygon uses the same Brush as its parentseries (Map Series) when true.
void	setParentPen(boolean value) The polygon uses the same Pen as its Parentseries, when true.
void	setPoints(Map.PolygonSeries value) Accesses the co-ordinates PointList which determine the boundary of the polygon.
void	setText(java.lang.String value) Specifies the text string that labels the polygon
void	setTransparency(int value) Amount of opacity used to fill the polygon interior.
void	setZ(double value) Specifies the position on the Z-axis of the 3D Map Series.
boolean	visible() Returns true if the polygon fits inside the available Chart ChartRect rectangle.

Methods inherited from class com.steema.teechart.TeeBase

getChart, invalidate, setBooleanProperty, setChart, setColorProperty, setDoubleProperty, setIntegerProperty, setStringProperty

Methods inherited from class java.lang.Object

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

Field Detail

parentSeries

public Map parentSeries

Constructor Detail

Map.Polygon

public Map.Polygon(IBaseChart chart)

Map.Polygon

public Map.Polygon(Map.PolygonList collection,
                   IBaseChart chart)

Method Detail

getIndex

public int getIndex()

setIndex

public void setIndex(int value)

visible

public boolean visible()

Returns true if the polygon fits inside the available Chart ChartRect rectangle.

Returns:

boolean

draw

public void draw(IGraphics3D g,
                 int valueIndex)

getBounds

public Rectangle getBounds()

Returns the rectangle in pixels that corresponds to the maximum space used by the polygon.

Returns:

Rectangle

getPoints

public Map.PolygonSeries getPoints()

Accesses the co-ordinates PointList which determine the boundary of the polygon.

Returns:

PolygonSeries

setPoints

public void setPoints(Map.PolygonSeries value)

Accesses the co-ordinates PointList which determine the boundary of the polygon.

Parameters:

value - PolygonSeries

getPolygonPoints

public Point[] getPolygonPoints()

The coordinates of all Points of the Polygon.

Returns:

Point[]

getBrush

public ChartBrush getBrush()

Determines the kind of brush used to fill the polygon interior.

Returns:

ChartBrush

getClosed

public boolean getClosed()

When true, the polygon is displayed and filled using the polygon Pen and Brush methods. When false, a poly-line is displayed using the Pen method.

Returns:

boolean

setClosed

public void setClosed(boolean value)

When true, the polygon is displayed and filled using the polygon Pen and Brush methods.

Parameters:

value - boolean

getParentPen

public boolean getParentPen()

The polygon uses the same Pen as its Parentseries, when true.
If false, the polygon uses its own Pen.

Returns:

boolean

setParentPen

public void setParentPen(boolean value)

The polygon uses the same Pen as its Parentseries, when true.
If false, the polygon uses its own Pen.

Parameters:

value - boolean

getColor

public Color getColor(int index)

The Color used to fill the polygon.
Or that used to draw the Brush pattern.

Parameters:

index - int

Returns:

Color

setColor

public void setColor(Color value)

Sets Color used to fill the polygon.
Or that used to draw the Brush pattern.

Parameters:

value - Color

getGradient

public Gradient getGradient()

Determines the kind of polygon's interior gradient effect.

Returns:

Gradient

getParentBrush

public boolean getParentBrush()

The polygon uses the same Brush as its parentseries (Map Series) when true.
If false, the polygon uses its own Brush property.

Returns:

boolean

setParentBrush

public void setParentBrush(boolean value)

The polygon uses the same Brush as its parentseries (Map Series) when true.

Parameters:

value - boolean

getZ

public double getZ()

Specifies the position on the Z-axis of the 3D Map Series.
In Chart terms, this will set a Z plane position, a lower value of Z will be drawn in front of a higher Z value.
Map Series is intended to be viewed in 2D and the Z value is provided to be used as a value for a Polygon (ie. for demographic maps). If colour Palette is used then the Z value will set the Polygon colour.

Returns:

double

setZ

public void setZ(double value)

Specifies the position on the Z-axis of the 3D Map Series.

Parameters:

value - double

add

public int add(Point p)

Adds a boundary coordinate to the polygon.
The polygon will be drawn in sequential order of the coordinates. (ie. from point 1 (X0,Y0) to point 2 (X1,Y1) to point 3 (X2,Y2), ...)

Parameters:

p - Point

Returns:

int

add

public int add(double x,
               double y)

Adds a boundary coordinate to the polygon.
The polygon will be drawn in sequential order of the coordinates. (ie. from point 1 (X0,Y0) to point 2 (X1,Y1) to point 3 (X2,Y2), ...)

Parameters:

x - double

y - double

Returns:

int

getText

public java.lang.String getText()

Specifies the text string that labels the polygon

Returns:

String

setText

public void setText(java.lang.String value)

Specifies the text string that labels the polygon

Parameters:

value - String

getPen

public ChartPen getPen()

Specifies the Pen used to draw the border of the polygon.

Returns:

ChartPen

getTransparency

public int getTransparency()

Amount of opacity used to fill the polygon interior.
100 means fully transparent, 0 means fully opaque.

Returns:

int

setTransparency

public void setTransparency(int value)

Amount of opacity used to fill the polygon interior.
100 means fully transparent, 0 means fully opaque.

Parameters:

value - int