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

Package | mx.graphics
Class | public class RadialGradientStroke
Inheritance | RadialGradientStroke GradientStroke GradientBase flash.events.EventDispatcher

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The RadialGradientStroke class lets you specify a gradient filled stroke. You use the RadialGradientStroke class, along with the GradientEntry class, to define a gradient stroke.

Default MXML Property `entries`

See also

mx.graphics.Stroke
mx.graphics.GradientEntry
mx.graphics.RadialGradient
flash.display.Graphics

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | angle : Number Deprecated: Please Use rotation By default, the LinearGradientStroke defines a transition from left to right across the control. | GradientBase
|  | caps : String Specifies the appearance of the ends of lines. | GradientStroke
|  | entries : Array An Array of GradientEntry objects defining the fill patterns for the gradient fill. | GradientBase
|  | focalPointRatio : Number Sets the location of the start of the radial fill. | RadialGradientStroke
|  | interpolationMethod : String A value from the InterpolationMethod class that specifies which interpolation method to use. | GradientBase
|  | joints : String A value from the JointStyle class that specifies the type of joint appearance used at angles. | GradientStroke
|  | matrix : Matrix An array of values used for matrix transformation. | GradientBase
|  | miterLimit : Number A number that indicates the limit at which a miter is cut off. | GradientStroke
|  | pixelHinting : Boolean A Boolean value that specifies whether to hint strokes to full pixels. | GradientStroke
|  | rotation : Number By default, the LinearGradientStroke defines a transition from left to right across the control. | GradientBase
|  | scaleMode : String Specifies which scale mode to use. | GradientStroke
|  | scaleX : Number The horizontal scale of the gradient transform, which defines the width of the (unrotated) gradient | RadialGradientStroke
|  | scaleY : Number The vertical scale of the gradient transform, which defines the height of the (unrotated) gradient | RadialGradientStroke
|  | spreadMethod : String A value from the SpreadMethod class that specifies which spread method to use. | GradientBase
|  | weight : Number The stroke weight, in pixels. | GradientStroke
|  | x : Number The distance by which to translate each point along the x axis. | GradientBase
|  | y : Number The distance by which to translate each point along the y axis. | GradientBase

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | compoundTransform : CompoundTransform Holds the matrix and the convenience transform properties (x, y, and rotation). | GradientBase

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | RadialGradientStroke(weight:Number = 1, pixelHinting:Boolean = false, scaleMode:String = normal, caps:String = round, joints:String = round, miterLimit:Number = 3) Constructor. | RadialGradientStroke
|  | apply(g:Graphics, targetBounds:Rectangle, targetOrigin:Point):void Applies the properties to the specified Graphics object. | GradientStroke
|  | createGraphicsStroke(targetBounds:Rectangle, targetOrigin:Point):GraphicsStroke Generates a GraphicsStroke object representing this stroke. | GradientStroke

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | GRADIENT_DIMENSION : Number = 1638.4 [static] Value of the width and height of the untransformed gradient | GradientBase

Property Detail

focalPointRatio | property

`focalPointRatio:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Sets the location of the start of the radial fill.

Valid values are from `-1.0` to `1.0`. A value of `-1.0` sets the focal point (or, start of the gradient fill) on the left of the bounding Rectangle. A value of `1.0` sets the focal point on the right of the bounding Rectangle.

If you use this property in conjunction with the `angle` property, this value specifies the degree of distance from the center that the focal point occurs. For example, with an angle of 45 and `focalPointRatio` of 0.25, the focal point is slightly lower and to the right of center. If you set `focalPointRatio` to `0`, the focal point is in the middle of the bounding Rectangle.

If you set `focalPointRatio` to `1`, the focal point is all the way to the bottom right corner of the bounding Rectangle.

The default value is `0.0`.

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

Implementation
`public function get focalPointRatio():Number`
`public function set focalPointRatio(value:Number):void`

scaleX | property |

`scaleX:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The horizontal scale of the gradient transform, which defines the width of the (unrotated) gradient

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

Implementation
`public function get scaleX():Number`
`public function set scaleX(value:Number):void`

scaleY | property |

`scaleY:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The vertical scale of the gradient transform, which defines the height of the (unrotated) gradient

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

Implementation
`public function get scaleY():Number`
`public function set scaleY(value:Number):void`
Constructor Detail

RadialGradientStroke | () | Constructor

`public function RadialGradientStroke(weight:Number = 1, 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

| `weight:Number` (default = `1`)`` — Specifies the line weight, in pixels. This parameter is optional, with a default value of `1`.
| `pixelHinting:Boolean` (default = `false`)`` — A Boolean value that specifies whether to hint strokes to full pixels. This affects both the position of anchors of a curve and the line stroke size itself. With `pixelHinting` set to `true`, Flash Player and AIR hint line widths to full pixel widths. With `pixelHinting` set to `false`, disjoints can appear for curves and straight lines. This parameter is optional, with a default value of `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`)`` — A 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`. A `null` value is equivalent to `CapsStyle.ROUND`. This parameter is optional, with a default value of `CapsStyle.ROUND`.
| `joints:String` (default = `round`)`` — A value from the JointStyle class that specifies the type of joint appearance used at angles. Valid values are `JointStyle.BEVEL`, `JointStyle.MITER`, and `JointStyle.ROUND`. A `null` value is equivalent to `JointStyle.ROUND`. This parameter is optional, with a default value of `JointStyle.ROUND`.
| `miterLimit:Number` (default = `3`)`` — A number that indicates 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` property 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. This parameter is optional, with a default value of `3`.

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