Apache Flex 4.16.1 API Reference All Packages | All Classes | Index | Frames
GradientFilter
 
Packagespark.filters
Classpublic class GradientFilter
InheritanceGradientFilter Inheritance BaseDimensionFilter Inheritance BaseFilter Inheritance flash.events.EventDispatcher
Subclasses GradientBevelFilter, GradientGlowFilter

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

The base class for filters that provide gradient visual effects.

MXML SyntaxexpandedHide MXML Syntax

The <s:GradientFilter> tag inherits all of the tag attributes of its superclass and adds the following tag attributes:

  <s:GradientFilter
    Properties
    angle="45"
    distance="4.0"
    entries="[]"
    type="inner"
  />

Default MXML Propertyentries

See also

spark.filters.GradientGlowFilter
spark.filters.GradientBevelFilter

Public Properties
 PropertyDefined By
  angle : Number
The angle, in degrees.
GradientFilter
 InheritedblurX : Number
The amount of horizontal blur.
BaseDimensionFilter
 InheritedblurY : Number
The amount of vertical blur.
BaseDimensionFilter
  distance : Number
The offset distance of the glow.
GradientFilter
  entries : Array
An Array of GradientEntry objects defining the fill patterns for the gradient fill.
GradientFilter
 Inheritedknockout : Boolean
Specifies whether the object has a knockout effect.
BaseDimensionFilter
 Inheritedquality : int
The number of times to apply the filter.
BaseDimensionFilter
 Inheritedstrength : Number
The strength of the imprint or spread.
BaseDimensionFilter
  type : String
The placement of the filter effect.
GradientFilter
Public Methods
 MethodDefined By
  
GradientFilter(colors:Array = null, alphas:Array = null, ratios:Array = null)
Constructor.
GradientFilter
 Inherited
notifyFilterChanged():void
Propagates a change event when the filter has changed.
BaseFilter
Public Constants
 ConstantDefined By
 InheritedCHANGE : String = change
[static] The string "change".
BaseFilter
Property Detail
angleproperty
angle:Number

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

The angle, in degrees. Valid values are 0 to 360. The angle value represents the angle of the theoretical light source falling on the object and determines the placement of the effect relative to the object. If distance is set to 0, the effect is not offset from the object, and therefore the angle property has no effect.

The default value is 45.


Implementation
    public function get angle():Number
    public function set angle(value:Number):void
distanceproperty 
distance:Number

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

The offset distance of the glow.

The default value is 4.0.


Implementation
    public function get distance():Number
    public function set distance(value:Number):void
entriesproperty 
entries:Array

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

An Array of GradientEntry objects defining the fill patterns for the gradient fill.

The default value is [].

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


Implementation
    public function get entries():Array
    public function set entries(value:Array):void
typeproperty 
type:String

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

The placement of the filter effect. Possible values are flash.filters.BitmapFilterType constants:

The default value is BitmapFilterType.INNER.


Implementation
    public function get type():String
    public function set type(value:String):void

See also

flash.filters.BitmapFilterType
Constructor Detail
GradientFilter()Constructor
public function GradientFilter(colors:Array = null, alphas:Array = null, ratios:Array = null)

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Constructor.

Parameters
colors:Array (default = null) — An array of RGB hexadecimal color values to use in the gradient. For example, red is 0xFF0000, blue is 0x0000FF, and so on.
 
alphas:Array (default = null) — An array of alpha transparency values for the corresponding colors in the colors array. Valid values for each element in the array are 0 to 1. For example, .25 sets a transparency value of 25%.
 
ratios:Array (default = null) — An array of color distribution ratios; valid values are 0 to 255.



The Apache Software Foundation

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