View comments | RSS feed
Packagemx.graphics
Classpublic class RadialGradient
ImplementsIFill

The RadialGradient class lets you specify a gradual color transition in the fill color. A radial gradient defines a fill pattern that radiates out from the center of a graphical element. You add a series of GradientEntry classes to the RadialGradient object's entries Array to define the colors that make up the gradient fill.

In MXML, you define a LinearGradient by adding a series of GradientEntry objects, as the following example shows:

  <mx:fill>
   <mx:RadialGradient>
    <mx:entries>
     <mx:GradientEntry color="0xC5C551" ratio="0" alpha=".5"/>
     <mx:GradientEntry color="0xFEFE24" ratio=".33" alpha=".5"/>
     <mx:GradientEntry color="0xECEC21" ratio=".66" alpha=".5"/>
    </mx:entries>
   </mx:RadialGradient>
  </mx:fill>
  

You can also define a LinearGradient as a fill for any graphic element in ActionScript, as the following example shows:

  
  <?xml version="1.0"?>
  <mx:Application xmlns:mx="http://www.adobe.com/2006/mxml" creationComplete="init()">
   <mx:Script>
   import flash.display.Graphics;
   import flash.geom.Rectangle;
   import mx.graphics.GradientEntry;
   import mx.graphics.RadialGradient;
  
   private function init():void {
    var w:Number = 200;
    var h:Number = 200;
  
    var s:Sprite = new Sprite();
    // Add the new Sprite to the display list.
    rawChildren.addChild(s); 
  
    var g:Graphics = s.graphics;
    g.lineStyle(1,0x33CCFF,1.0);
  
    var fill:RadialGradient = new RadialGradient();
    
    var g1:GradientEntry = new GradientEntry(0xFFCC66,0,.5);
    var g2:GradientEntry = new GradientEntry(0x000000,.33,.5);
    var g3:GradientEntry = new GradientEntry(0x99FF33,.66,.5);
      
     fill.entries = [g1,g2,g3];
  
    // Set focal point to upper left corner.
    fill.angle = 45;
    fill.focalPointRatio = -.8;
  
     // Draw a box and fill it with the LinearGradient.
    g.moveTo(0,0);
    fill.begin(g,new Rectangle(0,0,w,h));
    g.lineTo(w,0);
    g.lineTo(w,h);
    g.lineTo(0,h);
    g.lineTo(0,0);  
    fill.end(g);
   }
   </mx:Script>
  </mx:Application>
  

MXML Syntaxexpanded Hide MXML Syntax

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

  <mx:RadialGradient
    Properties
    angle="0"
    foculPointRatio="0"
  />
  

See also

mx.graphics.GradientEntry
mx.graphics.LinearGradient
mx.graphics.IFill
Using a gradient fill with chart controls


Public Properties
 PropertyDefined by
  angle : Number
Sets the location of the start of the radial fill.
RadialGradient
  focalPointRatio : Number = 0
Sets the location of the start of the radial fill.
RadialGradient
Public Methods
 MethodDefined by
  
Constructor.
RadialGradient
  
Starts the fill.
RadialGradient
  
end(target:Graphics):void
Ends the fill.
RadialGradient
Property detail
angleproperty
angle:Number  [read-write]

Sets the location of the start of the radial fill. Use the focalPointRatio property in conjunction with this property to adjust the location and distance from the center point of the bounding Rectangle to the focal point. Valid values are from 0 to 360.

The default value is 0.

Implementation
    public function get angle():Number
    public function set angle(value:Number):void
focalPointRatioproperty 
public var focalPointRatio:Number = 0

Sets the location of the start of the radial fill. Valid values are from -1 to 1. A value of -1 sets the focal point (or, start of the gradient fill) on the left of the bounding Rectangle. A value of 1 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 .25, the focal point is slightly lower and to the right of center. 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, which sets the focal point in the middle of the bounding Rectangle.

Constructor detail
RadialGradient()constructor
public function RadialGradient()

Constructor.

Method detail
begin()method
public function begin(target:Graphics, rc:Rectangle):void

Starts the fill.

Parameters
target:Graphics — The target Graphics object that is being filled.
 
rc:Rectangle — The Rectangle object that defines the size of the fill inside the target. If the dimensions of the Rectangle are larger than the dimensions of the target, the fill is clipped. If the dimensions of the Rectangle are smaller than the dimensions of the target, the fill expands to fill the entire target.
end()method 
public function end(target:Graphics):void

Ends the fill.

Parameters
target:Graphics — The Graphics object that is being filled.




Comments


apichery said on Dec 3, 2007 at 1:17 AM :
Typo in MXML syntax: "foculPointRatio" should read "focalPointRatio".

 

RSS feed | Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/flex/2/langref/mx/graphics/RadialGradient.html