| Package | com.esri.ags.symbols |
| Class | public class CartographicLineSymbol |
| Inheritance | CartographicLineSymbol  SimpleLineSymbol LineSymbol Symbol flash.events.EventDispatcher |
See also
| Property | Defined By | ||
|---|---|---|---|
 | alpha : Number
Line symbol alpha (transparency). | LineSymbol | |
| cap : String
The type of caps at the end of lines. | CartographicLineSymbol | ||
| color : uint
Line symbol color. | LineSymbol | |
| join : String
The type of joint appearance used at angles. | CartographicLineSymbol | ||
| miterLimit : Number
The limit at which a miter is cut off. | CartographicLineSymbol | ||
| style : String
The line style. | SimpleLineSymbol | |
| width : Number
Line symbol width in pixels. | LineSymbol | |
| Method | Defined By | ||
|---|---|---|---|
CartographicLineSymbol(style:String = solid, color:Number = 0x000000, alpha:Number = 1, width:Number = 1, cap:String = butt, join:String = miter, miterLimit:Number = 10)
Creates a new CartographicLineSymbol. | CartographicLineSymbol | ||
| clear(sprite:Sprite):void
Clears the graphics that were drawn to the sprite object. | Symbol | |
| createSwatch(width:Number = 50, height:Number = 50):UIComponent
Creates a swatch for a symbol which can be used in a legend. | Symbol | |
| destroy(sprite:Sprite):void
Removes all the graphics that were drawn to the sprite object and resets its properties. | Symbol | |
|
Draw the graphics on the sprite object. | Symbol | |
|
Initialize the sprite. | Symbol | |
| Method | Defined By | ||
|---|---|---|---|
| dispatchEventChange():void
Helper function to dispatch a change event. | Symbol | |
| removeAllChildren(sprite:Sprite):void
Removes all children from the sprite object. | Symbol | |
setLineStyle(graphics:Graphics):void [override]
Overrides the setLineStyle method. | CartographicLineSymbol | ||
|
Converts the x-coordinate of map point to a screen point. | Symbol | |
|
Converts the y-coordinate of map point to a screen point. | Symbol | |
| Constant | Defined By | ||
|---|---|---|---|
| CAP_BUTT : String = butt [static]
Line ends square at the end point. | CartographicLineSymbol | ||
| CAP_ROUND : String = round [static]
Line is rounded just beyond the end point. | CartographicLineSymbol | ||
| CAP_SQUARE : String = square [static]
Line is squared just beyond the end point. | CartographicLineSymbol | ||
| JOIN_BEVEL : String = bevel [static]
The joined lines are beveled
| CartographicLineSymbol | ||
| JOIN_MITER : String = miter [static]
The joined lines are not rounded or beveled. | CartographicLineSymbol | ||
| JOIN_ROUND : String = round [static]
The joined lines are rounded. | CartographicLineSymbol | ||
| STYLE_DASH : String = dash [static]
The line is made of dashes. | SimpleLineSymbol | |
| STYLE_DASHDOT : String = dashdot [static]
The line is made of a dash-dot pattern. | SimpleLineSymbol | |
| STYLE_DASHDOTDOT : String = dashdotdot [static]
The line is made of a dash-dot-dot pattern. | SimpleLineSymbol | |
| STYLE_DOT : String = dot [static]
The line is made of dots. | SimpleLineSymbol | |
| STYLE_NULL : String = none [static]
The line has no symbol. | SimpleLineSymbol | |
| STYLE_SOLID : String = solid [static]
The line is solid. | SimpleLineSymbol | |
| cap | property |
Hide Inherited Public Properties
Show Inherited Public Propertiescap:StringThe type of caps at the end of lines.
Note: as of version 1.1, CartographicLineSymbol.CAP_BUTT now correctly ends a line with square end points.
The default value is CAP_BUTT.
public function get cap():String public function set cap(value:String):void| join | property |
join:StringThe type of joint appearance used at angles.
The default value is JOIN_MITER.
public function get join():String public function set join(value:String):void| miterLimit | property |
miterLimit:NumberThe limit at which a miter is cut off.
The default value is 10.
public function get miterLimit():Number public function set miterLimit(value:Number):void| CartographicLineSymbol | () | Constructor |
public function CartographicLineSymbol(style:String = solid, color:Number = 0x000000, alpha:Number = 1, width:Number = 1, cap:String = butt, join:String = miter, miterLimit:Number = 10)Creates a new CartographicLineSymbol.
Parametersstyle:String (default = solid) | |
color:Number (default = 0x000000) | |
alpha:Number (default = 1) | |
width:Number (default = 1) | |
cap:String (default = butt) | |
join:String (default = miter) | |
miterLimit:Number (default = 10) |
| setLineStyle | () | method |
override protected function setLineStyle(graphics:Graphics):voidOverrides the setLineStyle method.
Parameters
graphics:Graphics |
| CAP_BUTT | Constant |
public static const CAP_BUTT:String = buttLine ends square at the end point.
| CAP_ROUND | Constant |
public static const CAP_ROUND:String = roundLine is rounded just beyond the end point.
| CAP_SQUARE | Constant |
public static const CAP_SQUARE:String = squareLine is squared just beyond the end point.
| JOIN_BEVEL | Constant |
public static const JOIN_BEVEL:String = bevelThe joined lines are beveled
| JOIN_MITER | Constant |
public static const JOIN_MITER:String = miterThe joined lines are not rounded or beveled.
| JOIN_ROUND | Constant |
public static const JOIN_ROUND:String = roundThe joined lines are rounded.
<esri:CartographicLineSymbol id="cls" cap="round" join="round"/>