Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
Stroke

Package | mx.graphics
Class | public class Stroke
Inheritance | Stroke SolidColorStroke flash.events.EventDispatcher

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 Syntax Show MXML Syntax
Hide 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)"
      />

See also

flash.display.Graphics

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | alpha : Number The transparency of a line. | SolidColorStroke
|  | caps : String Specifies the type of caps at the end of lines. | SolidColorStroke
|  | color : uint The line color. | SolidColorStroke
|  | joints : String Specifies the type of joint appearance used at angles. | SolidColorStroke
|  | miterLimit : Number Indicates the limit at which a miter is cut off. | SolidColorStroke
|  | pixelHinting : Boolean Specifies whether to hint strokes to full pixels. | SolidColorStroke
|  | scaleMode : String A value from the LineScaleMode class that specifies which scale mode to use. | SolidColorStroke
|  | weight : Number The line weight, in pixels. | SolidColorStroke

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined 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
|  | apply(graphics:Graphics, targetBounds:Rectangle, targetOrigin:Point):void Applies the properties to the specified Graphics object. | SolidColorStroke
|  | createGraphicsStroke(targetBounds:Rectangle, targetOrigin:Point):GraphicsStroke Generates a GraphicsStroke object representing this stroke. | SolidColorStroke

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.

Sun Mar 5 2017, 03:42 PM +11:00