Packagemx.graphics
Classpublic dynamic class ImageSnapshot
InheritanceImageSnapshot Inheritance Object


Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  contentType : String
The content type for the image encoding format that was used to capture this snapshot.
ImageSnapshot
  data : ByteArray
The encoded data representing the image snapshot.
ImageSnapshot
  DEFAULT_ENCODER : Class
[static] The default mx.graphics.codec.IImageEncoder implementation used to capture images.
ImageSnapshot
  height : int
The image height in pixels.
ImageSnapshot
  MAX_BITMAP_DIMENSION : int = 2880
[static]
ImageSnapshot
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  width : int
The image width in pixels.
ImageSnapshot
Public Methods
 MethodDefined By
  
ImageSnapshot(width:int = 0, height:int = 0, data:ByteArray = null, contentType:String = null)
Constructor.
ImageSnapshot
  
captureBitmapData(source:*, matrix:Matrix = null, colorTransform:ColorTransform = null, blendMode:String = null, clipRect:Rectangle = null, smoothing:Boolean = false):BitmapData
[static] A utility method to grab a raw snapshot of a UI component as BitmapData.
ImageSnapshot
  
captureImage(source:*, dpi:Number = 0, encoder:IImageEncoder = null, scaleLimited:Boolean = true):ImageSnapshot
[static] A utility method to grab a snapshot of a component, scaled to a specific resolution (in dpi) and encoded into a specific image format.
ImageSnapshot
  
encodeImageAsBase64(snapshot:ImageSnapshot):String
[static] A utility method to convert an ImageSnapshot into a Base-64 encoded String for transmission in text based serialization formats such as XML.
ImageSnapshot
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Property Detail
contentTypeproperty
contentType:String  [read-write]

The content type for the image encoding format that was used to capture this snapshot.


Implementation
    public function get contentType():String
    public function set contentType(value:String):void
dataproperty 
data:ByteArray  [read-write]

The encoded data representing the image snapshot.


Implementation
    public function get data():ByteArray
    public function set data(value:ByteArray):void
DEFAULT_ENCODERproperty 
public static var DEFAULT_ENCODER:Class

The default mx.graphics.codec.IImageEncoder implementation used to capture images. The default encoder uses the PNG format.

heightproperty 
height:int  [read-write]

The image height in pixels.


Implementation
    public function get height():int
    public function set height(value:int):void
MAX_BITMAP_DIMENSIONproperty 
public static var MAX_BITMAP_DIMENSION:int = 2880
widthproperty 
width:int  [read-write]

The image width in pixels.


Implementation
    public function get width():int
    public function set width(value:int):void
Constructor Detail
ImageSnapshot()Constructor
public function ImageSnapshot(width:int = 0, height:int = 0, data:ByteArray = null, contentType:String = null)

Constructor.

Parameters
width:int (default = 0)
 
height:int (default = 0)
 
data:ByteArray (default = null)
 
contentType:String (default = null)
Method Detail
captureBitmapData()method
public static function captureBitmapData(source:*, matrix:Matrix = null, colorTransform:ColorTransform = null, blendMode:String = null, clipRect:Rectangle = null, smoothing:Boolean = false):BitmapData

A utility method to grab a raw snapshot of a UI component as BitmapData.

Parameters

source:* — A UI component that implements flash.display.IBitmapDrawable
 
matrix:Matrix (default = null) — A Matrix object used to scale, rotate, or translate the coordinates of the captured bitmap. If you do not want to apply a matrix transformation to the image, set this parameter to an identity matrix, created with the default new Matrix() constructor, or pass a null value.
 
colorTransform:ColorTransform (default = null)
 
blendMode:String (default = null)
 
clipRect:Rectangle (default = null)
 
smoothing:Boolean (default = false)

Returns
BitmapData — BitmapData representing the captured snapshot.
captureImage()method 
public static function captureImage(source:*, dpi:Number = 0, encoder:IImageEncoder = null, scaleLimited:Boolean = true):ImageSnapshot

A utility method to grab a snapshot of a component, scaled to a specific resolution (in dpi) and encoded into a specific image format.

Parameters

source:* — A UI component that implements flash.display.IBitmapDrawable
 
dpi:Number (default = 0) — The resolution in dots per inch. If a resolution is not provided the current on-screen resolution is used by default.
 
encoder:IImageEncoder (default = null) — The image format used to encode the raw bitmap. If an encoder is not provided, a default PNGEncoder is used.
 
scaleLimited:Boolean (default = true) — The maximum width or height of a bitmap in Flash is 2880 pixels - if scaleLimited is set to true the resolution will be reduced proportionately to fit within 2880 pixels, otherwise, if scaleLimited is false, smaller snapshot windows will be taken and stitched together to capture a larger image. The default is true.

Returns
ImageSnapshot — An ImageSnapshot holding an encoded captured snapshot and associated image metadata.
encodeImageAsBase64()method 
public static function encodeImageAsBase64(snapshot:ImageSnapshot):String

A utility method to convert an ImageSnapshot into a Base-64 encoded String for transmission in text based serialization formats such as XML.

Parameters

snapshot:ImageSnapshot — An image captured as a mx.graphics.ImageSnapshot

Returns
String

See also

captureImage



© 2004-2007 Adobe Systems Incorporated. All rights reserved.
Sun Sep 23 2007, 10:15 PM GMT-07:00

 

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

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/common/langref/mx/graphics/ImageSnapshot.html