| Package | mx.graphics |
| Class | public dynamic class ImageSnapshot |
| Inheritance | ImageSnapshot  Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
flash.display.IBitmapDrawable,
including Flex UIComponents.
An instance of this class can be sent as a RemoteObject
to Adobe's LiveCycle Data Services to generate
a PDF file of a client-side image.
If you need to specify additional properties of the image
beyond its contentType, width,
and height properties, you should set name/value pairs
on the properties object.
In earlier versions of Flex, you set these additional properties on the ImageSnapshot instance itself. This class is still dynamic in order to allow that, but in a future version of Flex it might no longer be dynamic.
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| contentType : String
The MIME 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 | ||
| defaultEncoder : Class [static]
The default mx.graphics.codec.IImageEncoder implementation
used to capture images. | ImageSnapshot | ||
| height : int
The image height in pixels. | ImageSnapshot | ||
| properties : Object
An Object containing name/value pairs
specifying additional properties of the image. | ImageSnapshot | ||
| width : int
The image width in pixels. | ImageSnapshot | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor. | ImageSnapshot | ||
captureBitmapData(source:IBitmapDrawable, matrix:Matrix = null, colorTransform:flash.geom: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:IBitmapDrawable, 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 | ||
[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 | ||
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
| Constant | Defined By | ||
|---|---|---|---|
| MAX_BITMAP_DIMENSION : int = 2880 [static]
The maximum width and height of a Bitmap. | ImageSnapshot | ||
contentType | property |
contentType:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The MIME content type for the image encoding format that was used to capture this snapshot. For PNG format images, the MIME type is "image/png". For JPG or JPEG images, the MIME type is "image/jpeg"
Implementation
public function get contentType():String public function set contentType(value:String):voiddata | property |
defaultEncoder | property |
public static var defaultEncoder:Class| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The default mx.graphics.codec.IImageEncoder implementation
used to capture images. The two implementations are PNGEncoder and
JPEGEncoder. The default encoder uses the PNG format.
height | property |
properties | property |
properties:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
An Object containing name/value pairs specifying additional properties of the image.
You generally supply such information only when sending an ImageSnapshot instance to Adobe's LiveCycle Data Services in order to generate a PDF file. You can either set the entire object or set individual name/value pairs on the pre-existing empty Object.
The default value is {}.
Implementation
public function get properties():Object public function set properties(value:Object):voidwidth | property |
ImageSnapshot | () | Constructor |
public function ImageSnapshot(width:int = 0, height:int = 0, data:ByteArray = null, contentType:String = null)| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor.
Parameterswidth:int (default = 0) | |
height:int (default = 0) | |
data:ByteArray (default = null) | |
contentType:String (default = null) |
captureBitmapData | () | method |
public static function captureBitmapData(source:IBitmapDrawable, matrix:Matrix = null, colorTransform:flash.geom:ColorTransform = null, blendMode:String = null, clipRect:Rectangle = null, smoothing:Boolean = false):BitmapData| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A utility method to grab a raw snapshot of a UI component as BitmapData.
Parameters
source:IBitmapDrawable — An object that implements the
flash.display.IBitmapDrawable interface.
| |
matrix:Matrix (default = null) | |
colorTransform:flash.geom:ColorTransform (default = null) | |
blendMode:String (default = null) | |
clipRect:Rectangle (default = null) | |
smoothing:Boolean (default = false) |
BitmapData — A BitmapData object representing the captured snapshot or null if
the source has no visible bounds.
|
captureImage | () | method |
public static function captureImage(source:IBitmapDrawable, dpi:Number = 0, encoder:IImageEncoder = null, scaleLimited:Boolean = true):ImageSnapshot| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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:IBitmapDrawable — An object that implements the
flash.display.IBitmapDrawable interface.
| |
dpi:Number (default = 0) | |
encoder:IImageEncoder (default = null) | |
scaleLimited:Boolean (default = true) |
ImageSnapshot — An ImageSnapshot holding an encoded captured snapshot
and associated image metadata.
|
encodeImageAsBase64 | () | method |
public static function encodeImageAsBase64(snapshot:ImageSnapshot):String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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 an
mx.graphics.ImageSnapshot.
|
String — A string representing the base64 encoded snapshot.
|
Related API Elements
MAX_BITMAP_DIMENSION | Constant |
public static const MAX_BITMAP_DIMENSION:int = 2880| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The maximum width and height of a Bitmap.
Mon Apr 10 2017, 12:28 PM -07:00