com.teamdev.jxmaps

Class Symbol

java.lang.Object

com.teamdev.jxmaps.MapObject

com.teamdev.jxmaps.Symbol

All Implemented Interfaces:

java.lang.Cloneable

public class Symbol
extends MapObject

Represents symbol. Contains set of properties for symbol object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Symbol.Property

Constructor Summary

Constructors

Constructor and Description
Symbol() Creates new Symbol object
Symbol(Map map) Deprecated.

Method Summary

Modifier and Type	Method and Description
Point	getAnchor() Returns value of anchor property.
java.lang.String	getFillColor() Returns value of fillColor property.
double	getFillOpacity() Returns value of fillOpacity property.
Point	getLabelOrigin() Returns value of labelOrigin property.
java.lang.String	getPath() Returns value of path property.
double	getRotation() Returns value of rotation property.
double	getScale() Returns value of scale property.
java.lang.String	getStrokeColor() Returns value of strokeColor property.
double	getStrokeOpacity() Returns value of strokeOpacity property.
double	getStrokeWeight() Returns value of strokeWeight property.
void	setAnchor(Point value) Sets new value for anchor property.
void	setFillColor(java.lang.String value) Sets new value for fillColor property.
void	setFillOpacity(double value) Sets new value for fillOpacity property.
void	setLabelOrigin(Point value) Sets new value for labelOrigin property.
void	setPath(StandardSymbol value) Sets new value for path property.
void	setPath(java.lang.String value) Sets new value for path property.
void	setRotation(double value) Sets new value for rotation property.
void	setScale(double value) Sets new value for scale property.
void	setStrokeColor(java.lang.String value) Sets new value for strokeColor property.
void	setStrokeOpacity(double value) Sets new value for strokeOpacity property.
void	setStrokeWeight(double value) Sets new value for strokeWeight property.

Methods inherited from class com.teamdev.jxmaps.MapObject

addEventListener, attachObject, cacheProperties, cacheProperties, clone, createJSValue, dispose, fromJSValue, getJSObject, getMap, getProperties, invokeMethod, propertyChanged, removeEventListener, updateProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

Symbol

public Symbol()

Creates new Symbol object

Symbol

@Deprecated
public Symbol(Map map)

Deprecated.

Creates new Symbol object

Parameters:

map - owner Map object

Method Detail

getAnchor

public Point getAnchor()

Returns value of anchor property.

Contains the position of the symbol relative to the marker or polyline. The coordinates of the symbol's path are translated left and up by the anchor's x and y coordinates respectively. By default, a symbol is anchored at (0, 0). The position is expressed in the same coordinate system as the symbol's path.

Returns:

property value

See Also:

setAnchor(com.teamdev.jxmaps.Point)

setAnchor

public void setAnchor(Point value)

Sets new value for anchor property.

Parameters:

value - new property value

See Also:

getAnchor()

getLabelOrigin

public Point getLabelOrigin()

Returns value of labelOrigin property.

Contains the origin of the label relative to the origin of the path, if label is supplied by the marker. By default, the origin is located at (0, 0). The origin is expressed in the same coordinate system as the symbol's path. This property is unused for symbols on polylines.

Returns:

property value

See Also:

setLabelOrigin(com.teamdev.jxmaps.Point)

setLabelOrigin

public void setLabelOrigin(Point value)

Sets new value for labelOrigin property.

Parameters:

value - new property value

See Also:

getLabelOrigin()

getFillColor

public java.lang.String getFillColor()

Returns value of fillColor property.

Contains the symbol's fill color. All CSS3 colors are supported except for extended named colors. For symbol markers, this defaults to 'black'. For symbols on polylines, this defaults to the stroke color of the corresponding polyline.

Returns:

property value

See Also:

setFillColor(java.lang.String)

setFillColor

public void setFillColor(java.lang.String value)

Sets new value for fillColor property.

Parameters:

value - new property value

See Also:

getFillColor()

getStrokeColor

public java.lang.String getStrokeColor()

Returns value of strokeColor property.

Contains the symbol's stroke color. All CSS3 colors are supported except for extended named colors. For symbol markers, this defaults to 'black'. For symbols on a polyline, this defaults to the stroke color of the polyline.

Returns:

property value

See Also:

setStrokeColor(java.lang.String)

setStrokeColor

public void setStrokeColor(java.lang.String value)

Sets new value for strokeColor property.

Parameters:

value - new property value

See Also:

getStrokeColor()

getPath

public java.lang.String getPath()

Returns value of path property.

Contains the symbol's path, which is a built-in symbol path, or a custom path expressed using SVG path notation. Required.

Returns:

property value

See Also:

setPath(java.lang.String)

setPath

public void setPath(java.lang.String value)

Sets new value for path property.

Parameters:

value - new property value

See Also:

getPath()

setPath

public void setPath(StandardSymbol value)

Sets new value for path property.

Parameters:

value - new property value

See Also:

getPath()

getFillOpacity

public double getFillOpacity()

Returns value of fillOpacity property.

Contains the symbol's fill opacity. Defaults to 0.

Returns:

property value

See Also:

setFillOpacity(double)

setFillOpacity

public void setFillOpacity(double value)

Sets new value for fillOpacity property.

Parameters:

value - new property value

See Also:

getFillOpacity()

getRotation

public double getRotation()

Returns value of rotation property.

Contains the angle by which to rotate the symbol, expressed clockwise in degrees. Defaults to 0. A symbol in an IconSequence where fixedRotation is false is rotated relative to the angle of the edge on which it lies.

Returns:

property value

See Also:

setRotation(double)

setRotation

public void setRotation(double value)

Sets new value for rotation property.

Parameters:

value - new property value

See Also:

getRotation()

getScale

public double getScale()

Returns value of scale property.

Contains the amount by which the symbol is scaled in size. For symbol markers, this defaults to 1; after scaling, the symbol may be of any size. For symbols on a polyline, this defaults to the stroke weight of the polyline; after scaling, the symbol must lie inside a square 22 pixels in size centered at the symbol's anchor.

Returns:

property value

See Also:

setScale(double)

setScale

public void setScale(double value)

Sets new value for scale property.

Parameters:

value - new property value

See Also:

getScale()

getStrokeOpacity

public double getStrokeOpacity()

Returns value of strokeOpacity property.

Contains the symbol's stroke opacity. For symbol markers, this defaults to 1. For symbols on a polyline, this defaults to the stroke opacity of the polyline.

Returns:

property value

See Also:

setStrokeOpacity(double)

setStrokeOpacity

public void setStrokeOpacity(double value)

Sets new value for strokeOpacity property.

Parameters:

value - new property value

See Also:

getStrokeOpacity()

getStrokeWeight

public double getStrokeWeight()

Returns value of strokeWeight property.

Contains the symbol's stroke weight. Defaults to the scale of the symbol.

Returns:

property value

See Also:

setStrokeWeight(double)

setStrokeWeight

public void setStrokeWeight(double value)

Sets new value for strokeWeight property.

Parameters:

value - new property value

See Also:

getStrokeWeight()