Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
BaseDimensionFilter

Package | mx.filters
Class | public class BaseDimensionFilter
Inheritance | BaseDimensionFilter BaseFilter flash.events.EventDispatcher
Subclasses | BevelFilter, DropShadowFilter, GlowFilter, GradientFilter

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Base class for some Spark filters.

Public Properties

| Property | Defined By
--- | --- | ---
|  | blurX : Number The amount of horizontal blur. | BaseDimensionFilter
|  | blurY : Number The amount of vertical blur. | BaseDimensionFilter
|  | knockout : Boolean Specifies whether the object has a knockout effect. | BaseDimensionFilter
|  | quality : int The number of times to apply the filter. | BaseDimensionFilter
|  | strength : Number The strength of the imprint or spread. | BaseDimensionFilter

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | BaseDimensionFilter() Constructor. | BaseDimensionFilter
|  | notifyFilterChanged():void Propagates a change event when the filter has changed. | BaseFilter

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | CHANGE : String = change [static] The string "change". | BaseFilter

Property Detail

blurX | property

`blurX:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The amount of horizontal blur. Valid values are 0 to 255. A blur of 1 or less means that the original image is copied as is. The default value is 4. Values that are a power of 2 (such as 2, 4, 8, 16, and 32) are optimized to render more quickly than other values.

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

blurY | property |

`blurY:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The amount of vertical blur. Valid values are 0 to 255. A blur of 1 or less means that the original image is copied as is. The default value is 4. Values that are a power of 2 (such as 2, 4, 8, 16, and 32) are optimized to render more quickly than other values.

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

knockout | property |

`knockout:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Specifies whether the object has a knockout effect. A knockout effect makes the object's fill transparent and reveals the background color of the document. The value true specifies a knockout effect; the default value is false (no knockout effect).

Implementation
`public function get knockout():Boolean`
`public function set knockout(value:Boolean):void`

quality | property |

`quality:int`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The number of times to apply the filter. The default value is BitmapFilterQuality.LOW, which is equivalent to applying the filter once. The value BitmapFilterQuality.MEDIUM applies the filter twice; the value BitmapFilterQuality.HIGH applies it three times. Filters with lower values are rendered more quickly. For most applications, a quality value of low, medium, or high is sufficient. Although you can use additional numeric values up to 15 to achieve different effects, higher values are rendered more slowly. Instead of increasing the value of quality, you can often get a similar effect, and with faster rendering, by simply increasing the values of the blurX and blurY properties.

Implementation
`public function get quality():int`
`public function set quality(value:int):void`

strength | property |

`strength:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The strength of the imprint or spread. The higher the value, the more color is imprinted and the stronger the contrast between the glow and the background. Valid values are 0 to 255. A value of 0 means that the filter is not applied. The default value is 1.

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

BaseDimensionFilter | () | Constructor

`public function BaseDimensionFilter()`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Constructor.

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