| Package | ardisia.components.magnifier |
| Class | public class Magnifier |
| Inheritance | Magnifier  DisplacementMapFilterFixed spark.filters.DisplacementMapFilter |
Can zoom in or zoom out of the targeted component via the "displacementScale" property.
Do not add this component to the display list for use. Declare in the declarations tag of an MXML document or in actionscript and call the magnify() method when needed.
View the technical documentation on the Ardisia Labs website for more information.
| Property | Defined By | ||
|---|---|---|---|
| displacementScale : Number
Value to scale the pixels for the displacement filter in the x and y
direction. | Magnifier | ||
| Method | Defined By | ||
|---|---|---|---|
magnify(target:UIComponent, regionWidth:Number, regionHeight:Number, xPosition:Number, yPosition:Number):void
Magnifies the passed target at the passed position and size. | Magnifier | ||
remove():void
Remove the magnifier and the displacement effect from the passed target. | Magnifier | ||
| displacementScale | property |
displacementScale:NumberValue to scale the pixels for the displacement filter in the x and y direction. Positive values will zoom in and negative values will zoom out.
Think of it as a strength indicator for the zoom.
Filter will update and reflect changes to this property the next time magnify() is called.
The default value is 50.
public function get displacementScale():Number public function set displacementScale(value:Number):void| magnify | () | method |
public function magnify(target:UIComponent, regionWidth:Number, regionHeight:Number, xPosition:Number, yPosition:Number):voidMagnifies the passed target at the passed position and size.
Call remove() to remove the zoom effect and the indicator.
Parameters
target:UIComponent — the UIComponent to magnify
| |
regionWidth:Number — the width of the magnified region
| |
regionHeight:Number — the height of the magnified region
| |
xPosition:Number — the x position to center the zoom
| |
yPosition:Number — the y position to center the zoom
|
| remove | () | method |
public function remove():voidRemove the magnifier and the displacement effect from the passed target.