Packagemx.graphics
Classpublic class SolidColorStroke
InheritanceSolidColorStroke Inheritance flash.events.EventDispatcher
Implements IStroke
Subclasses Stroke

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

The SolidColorStroke class defines the properties for a line. You can define a SolidColorStroke object in MXML, but you must attach that SolidColorStroke to another object for it to appear in your application. The following example defines two SolidColorStroke objects and then uses them in the horizontalAxisRenderer of a LineChart control: 
  ...
  <mx:SolidColorStroke id="ticks" color="0xFF0000" weight="1"/>
  <mx:SolidColorStroke 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:SolidColorStroke> tag inherits all the tag attributes of its superclass, and adds the following tag attributes:

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

See also

flash.display.Graphics

Public Properties
 PropertyDefined 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
 MethodDefined By
  
SolidColorStroke(color:uint = 0x000000, weight:Number = 1, alpha:Number = 1.0, pixelHinting:Boolean = false, scaleMode:String = normal, caps:String = round, joints:String = round, miterLimit:Number = 3)
Constructor.
SolidColorStroke
  
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
Property Detail
alphaproperty
alpha:Number

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

The transparency of a line. Possible values are 0.0 (invisible) through 1.0 (opaque).

The default value is 1.0..

This property can be used as the source for data binding.


Implementation
    public function get alpha():Number
    public function set alpha(value:Number):void
capsproperty 
caps:String

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

Specifies the type of caps at the end of lines. Valid values are: CapsStyle.ROUND, CapsStyle.SQUARE, and CapsStyle.NONE.

The default value is CapsStyle.ROUND.

This property can be used as the source for data binding.


Implementation
    public function get caps():String
    public function set caps(value:String):void
colorproperty 
color:uint

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

The line color.

The default value is 0x000000 (black)..

This property can be used as the source for data binding.


Implementation
    public function get color():uint
    public function set color(value:uint):void
jointsproperty 
joints:String

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

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

The default value is JointStyle.ROUND.

This property can be used as the source for data binding.


Implementation
    public function get joints():String
    public function set joints(value:String):void
miterLimitproperty 
miterLimit:Number

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

Indicates the limit at which a miter is cut off. Valid values range from 1 to 255.

The default value is 3.

This property can be used as the source for data binding.


Implementation
    public function get miterLimit():Number
    public function set miterLimit(value:Number):void
pixelHintingproperty 
pixelHinting:Boolean

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

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.

This property can be used as the source for data binding.


Implementation
    public function get pixelHinting():Boolean
    public function set pixelHinting(value:Boolean):void
scaleModeproperty 
scaleMode:String

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

A value from the LineScaleMode class that specifies which scale mode to use. Value valids are:

The default value is LineScaleMode.NORMAL.

This property can be used as the source for data binding.


Implementation
    public function get scaleMode():String
    public function set scaleMode(value:String):void
weightproperty 
weight:Number

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

The line weight, in pixels. For many charts, the default value is 1 pixel.

This property can be used as the source for data binding.


Implementation
    public function get weight():Number
    public function set weight(value:Number):void
Constructor Detail
SolidColorStroke()Constructor
public function SolidColorStroke(color:uint = 0x000000, weight:Number = 1, alpha:Number = 1.0, pixelHinting:Boolean = false, scaleMode:String = normal, caps:String = round, joints:String = round, miterLimit:Number = 3)

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 = 1) — Specifies the line weight, in pixels. The default value is 1.
 
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 = round) — Specifies the type of caps at the end of lines. Valid values are CapsStyle.ROUND, CapsStyle.SQUARE, and CapsStyle.NONE. The default value is CapsStyle.ROUND.
 
joints:String (default = round) — Specifies the type of joint appearance used at angles. Valid values are JointStyle.ROUND, JointStyle.MITER, and JointStyle.BEVEL. The default value is JointStyle.ROUND.
 
miterLimit:Number (default = 3) — Indicates the limit at which a miter is cut off. Valid values range from 1 to 255. The default value is 3.
Method Detail
apply()method
public function apply(graphics:Graphics, targetBounds:Rectangle, targetOrigin:Point):void

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

Applies the properties to the specified Graphics object.

Parameters

graphics:Graphics — The Graphics object to apply the properties to.
 
targetBounds:Rectangle — The bounds of the shape that the stroke is applied to.
 
targetOrigin:Point — The Point that defines the origin (0,0) of the shape in the coordinate system of target.

createGraphicsStroke()method 
public function createGraphicsStroke(targetBounds:Rectangle, targetOrigin:Point):GraphicsStroke

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

Generates a GraphicsStroke object representing this stroke.

Parameters

targetBounds:Rectangle — The stroke's bounding box.
 
targetOrigin:Point — The Point that defines the origin (0,0) of the shape in the coordinate system of target.

Returns
GraphicsStroke — The Drawing API-2 GraphicsStroke object representing this stroke.



The Apache Software Foundation

Wed Nov 15 2017, 09:50 AM +01:00