ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.graphics 

Stroke  - AS3 Flex

Packagemx.graphics
Classpublic class Stroke
InheritanceStroke Inheritance SolidColorStroke Inheritance EventDispatcher Inheritance Object
Deprecated since 4.0: Please Use SolidColorStroke

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The Stroke class defines the properties for a line. You can define a Stroke object in MXML, but you must attach that Stroke to another object for it to appear in your application. The following example defines two Stroke objects and then uses them in the horizontalAxisRenderer of a LineChart control:
  ...
  <mx:Stroke id="ticks" color="0xFF0000" weight="1"/>
  <mx:Stroke id="mticks" color="0x0000FF" weight="1"/>
  
  <mx:LineChart id="mychart" dataProvider="{ndxa}">
      <mx:horizontalAxisRenderer>
          <mx:AxisRenderer placement="bottom" canDropLabels="true">
              <mx:tickStroke>{ticks}</mx:tickStroke>
              <mx:minorTickStroke>{mticks}</mx:minorTickStroke>
          </mx:AxisRenderer>
      </mx:horizontalAxisRenderer>
  </LineChart>
  ...
  

MXML SyntaxexpandedHide MXML Syntax

The <mx:Stroke> tag inherits all the tag attributes of its superclass, and adds the following tag attributes:

  <mx:Stroke
    Properties
    alpha="1.0"
    caps="null|none|round|square"
    color="0x000000"
    joints="null|bevel|miter|round"
    miterLimit="1"
    pixelHinting="false|true"
    scaleMode="normal|none|horizontal|vertical"
    weight="1 (in most cases)"
  />
  

More examples

Related API Elements



Public Properties
 PropertyDefined By
 Inheritedalpha : Number
The transparency of a line.
SolidColorStroke
 Inheritedcaps : String
Specifies the type of caps at the end of lines.
SolidColorStroke
 Inheritedcolor : uint
The line color.
SolidColorStroke
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheritedjoints : String
Specifies the type of joint appearance used at angles.
SolidColorStroke
 InheritedmiterLimit : Number
Indicates the limit at which a miter is cut off.
SolidColorStroke
 InheritedpixelHinting : Boolean
Specifies whether to hint strokes to full pixels.
SolidColorStroke
 InheritedscaleMode : String
A value from the LineScaleMode class that specifies which scale mode to use.
SolidColorStroke
 Inheritedweight : Number
The line weight, in pixels.
SolidColorStroke
Public Methods
 MethodDefined By
  
Stroke(color:uint = 0x000000, weight:Number = 0, alpha:Number = 1.0, pixelHinting:Boolean = false, scaleMode:String = "normal", caps:String = null, joints:String = null, miterLimit:Number = 1)
Constructor.
Stroke
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
EventDispatcher
 Inherited
apply(graphics:Graphics, targetBounds:Rectangle, targetOrigin:Point):void
Applies the properties to the specified Graphics object.
SolidColorStroke
 Inherited
Generates a GraphicsStroke object representing this stroke.
SolidColorStroke
 Inherited
Dispatches an event into the event flow.
EventDispatcher
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
Constructor Detail

Stroke

()Constructor
public function Stroke(color:uint = 0x000000, weight:Number = 0, alpha:Number = 1.0, pixelHinting:Boolean = false, scaleMode:String = "normal", caps:String = null, joints:String = null, miterLimit:Number = 1)

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructor.

Parameters
color:uint (default = 0x000000) — Specifies the line color. The default value is 0x000000 (black).
 
weight:Number (default = 0) — Specifies the line weight, in pixels. The default value is 0.
 
alpha:Number (default = 1.0) — Specifies the alpha value in the range 0.0 to 1.0. The default value is 1.0 (opaque).
 
pixelHinting:Boolean (default = false) — Specifies whether to hint strokes to full pixels. This value affects both the position of anchors of a curve and the line stroke size itself. The default value is false.
 
scaleMode:String (default = "normal") — A value from the LineScaleMode class that specifies which scale mode to use. Valid values are LineScaleMode.HORIZONTAL, LineScaleMode.NONE, LineScaleMode.NORMAL, and LineScaleMode.VERTICAL. This parameter is optional, with a default value of LineScaleMode.NORMAL.
 
caps:String (default = null) — Specifies the type of caps at the end of lines. Valid values are "round", "square", and "none". The default value is null.
 
joints:String (default = null) — Specifies the type of joint appearance used at angles. Valid values are "round", "miter", and "bevel". The default value is null.
 
miterLimit:Number (default = 1) — Indicates the limit at which a miter is cut off. Valid values range from 1 to 255. The default value is 1.