Packagecom.esri.aws.awx.map.layers.overlays.style
Classpublic class PolylineStyle
InheritancePolylineStyle Inheritance BaseStyle
ImplementsIStyle

A polylineStyle with all of the parameters of Graphics.lineStyle().

Note: Although styles have public properties (such as color, fill, alpha) they should not be edited after construction.

See also

http://livedocs.adobe.com/flex/201/langref/flash/display/Graphics.html

Public Properties
 PropertyDefined by
  alpha : Number
The alpha value of the color of the line; valid values are 0 to 1.
PolylineStyle
  caps : String
The value from the CapsStyle class that specifies the type of caps at the end of lines.
PolylineStyle
  color : uint
The hexadecimal color value of the line; for example, red is 0xFF0000 and blue is 0x0000FF.
PolylineStyle
  joints : String
The type of joint appearance used at angles.
PolylineStyle
  miterLimit : Number
The limit at which a miter is cut off.
PolylineStyle
  pixelHinting : Boolean
If true, turns on pixel hinting.
PolylineStyle
  scaleMode : String
The value from the LineScaleMode class that specifies which scale mode to use.
PolylineStyle
  thickness : Number
The thickness of the line in points; valid values are 0 to 255.
PolylineStyle
Public Methods
 MethodDefined by
  
PolylineStyle(thickness:Number = 7, color:uint = 0x000BE6, alpha:Number = 0.5, pixelHinting:Boolean = false, scaleMode:String, caps:String = null, joints:String = null, miterLimit:Number = 3)
Creates a new PolylineStyle.
PolylineStyle
 Inherited
cleanUp(overlayObject:OverlayObject):void
Cleans up the OverlayObject to restore it to its original state.
BaseStyle
  
draw(overlayObject:OverlayObject, projectionModel:IProjectionModel):void
Draws the polyline.
PolylineStyle
Property detail
alphaproperty
public var alpha:Number

The alpha value of the color of the line; valid values are 0 to 1. If the value is less than 0, the default is 0. If the value is greater than 1, the default is 1.

The default value is 0.5.

capsproperty 
public var caps:String

The value from the CapsStyle class that specifies the type of caps at the end of lines. Valid values are: CapsStyle.NONE, CapsStyle.ROUND, and CapsStyle.SQUARE.

The default value is CapsStyle.ROUND.

colorproperty 
public var color:uint

The hexadecimal color value of the line; for example, red is 0xFF0000 and blue is 0x0000FF.

The default value is 0x000BE6.

jointsproperty 
public var joints:String

The type of joint appearance used at angles. Valid values are: JointStyle.BEVEL, JointStyle.MITER, and JointStyle.ROUND.

The default value is JointStyle.ROUND.

miterLimitproperty 
public var miterLimit:Number

The limit at which a miter is cut off. Valid values range from 1 to 255 (and values outside of that range are rounded to 1 or 255). This value is only used if the jointStyle is set to "miter". The miterLimit value represents the length that a miter can extend beyond the point at which the lines meet to form a joint. The value expresses a factor of the line thickness. For example, with a miterLimit factor of 2.5 and a thickness of 10 pixels, the miter is cut off at 25 pixels.

pixelHintingproperty 
public var pixelHinting:Boolean

If true, turns on pixel hinting. This affects both the position of anchors of a curve and the line stroke size itself. With pixelHinting set to true, Flash Player hints line widths to full pixel widths. With pixelHinting set to false, disjoints can appear for curves and straight lines.

scaleModeproperty 
public var scaleMode:String

The value from the LineScaleMode class that specifies which scale mode to use.

thicknessproperty 
public var thickness:Number

The thickness of the line in points; valid values are 0 to 255. If a number is not specified, or if the parameter is undefined, a line is not drawn. If a value of less than 0 is passed, the default is 0. The value 0 indicates hairline thickness; the maximum thickness is 255. If a value greater than 255 is passed, the default is 255.

Constructor detail
PolylineStyle()constructor
public function PolylineStyle(thickness:Number = 7, color:uint = 0x000BE6, alpha:Number = 0.5, pixelHinting:Boolean = false, scaleMode:String, caps:String = null, joints:String = null, miterLimit:Number = 3)

Creates a new PolylineStyle.

Parameters
thickness:Number (default = 7) — The thickness of the line in points; valid values are 0 to 255. If a number is not specified, or if the parameter is undefined, a line is not drawn. If a value of less than 0 is passed, the default is 0. The value 0 indicates hairline thickness; the maximum thickness is 255. If a value greater than 255 is passed, the default is 255.
 
color:uint (default = 0x000BE6) — The hexadecimal color value of the line; for example, red is 0xFF0000, blue is 0x0000FF, and so on. If a value is not indicated, the default is 0x000BE6.
 
alpha:Number (default = 0.5) — The alpha value of the color of the line; valid values are 0 to 1. If a value is not indicated, the default is 0.5. If the value is less than 0, the default is 0. If the value is greater than 1, the default is 1.
 
pixelHinting:Boolean (default = false) — If true, turns on pixel hinting. This affects both the position of anchors of a curve and the line stroke size itself. With pixelHinting set to true, Flash Player hints line widths to full pixel widths. With pixelHinting set to false, disjoints can appear for curves and straight lines.
 
scaleMode:String — The value from the LineScaleMode class that specifies which scale mode to use.
 
caps:String (default = null) — The type of caps at the end of lines. Valid values are: CapsStyle.NONE, CapsStyle.ROUND, and CapsStyle.SQUARE. If a value is not indicated, Flash uses round caps.
 
joints:String (default = null) — The type of joint appearance used at angles. Valid values are: JointStyle.BEVEL, JointStyle.MITER, and JointStyle.ROUND. If a value is not indicated, Flash uses round joints.
 
miterLimit:Number (default = 3) — The limit at which a miter is cut off. Valid values range from 1 to 255 (and values outside of that range are rounded to 1 or 255). This value is only used if the jointStyle is set to "miter". The miterLimit value represents the length that a miter can extend beyond the point at which the lines meet to form a joint. The value expresses a factor of the line thickness. For example, with a miterLimit factor of 2.5 and a thickness of 10 pixels, the miter is cut off at 25 pixels.
Method detail
draw()method
public override function draw(overlayObject:OverlayObject, projectionModel:IProjectionModel):void

Draws the polyline.

Parameters
overlayObject:OverlayObject — the overlayObject on which to draw.
 
projectionModel:IProjectionModel — the project model used to calculate the pixel coordinates