mx.graphics.ImageSnapshot - Adobe® Flex® 4 Language Reference (Flex 4)

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

A helper class used to capture a snapshot of any Flash component that implements 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.

Public Properties

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
		prototype : 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

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		ImageSnapshot(width:int = 0, height:int = 0, data:ByteArray = null, contentType:String = null) 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
		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
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		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
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

	Constant		Defined By
		MAX_BITMAP_DIMENSION : int = 2880 [static] The maximum width and height of a Bitmap.	ImageSnapshot

Property Detail

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):void

data

property

data:ByteArray

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The encoded data representing the image snapshot.

Implementation
public function get data():ByteArray
public function set data(value:ByteArray):void

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

height:int

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The image height in pixels.

Implementation
public function get height():int
public function set height(value:int):void

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):void

width

property

width:int

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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)

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Constructor.

Parameters

	`width:int` (default = `0`) — Width of the image.

	`height:int` (default = `0`) — Height of the image.

	`data:ByteArray` (default = `null`) — A byte array to contain the image.

	`contentType:String` (default = `null`) — The encoder format type for the image, either PNGEncoder or JPEGEncoder.

Method Detail

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`) — 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:flash.geom:ColorTransform` (default = `null`) — A ColorTransform object that you use to adjust the color values of the bitmap. If no object is supplied, the bitmap image's colors are not transformed. If you must pass this parameter but you do not want to transform the image, set this parameter to a ColorTransform object created with the default new ColorTransform() constructor.

	`blendMode:String` (default = `null`) — A string value, from the flash.display.BlendMode class, specifying the blend mode to be applied to the resulting bitmap.

	`clipRect:Rectangle` (default = `null`) — A Rectangle object that defines the area of the source object to draw. If you do not supply this value, no clipping occurs and the entire source object is drawn.

	`smoothing:Boolean` (default = `false`) — A Boolean value that determines whether a BitmapData object is smoothed when scaled.

Returns

BitmapData — A BitmapData object representing the captured snapshot.

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`) — 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. The two encoders are PNGEncoder and JPEGEncoder. If an encoder is not provided, the default is PNGEncoder.

	`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

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.

Returns

String — A string representing the base64 encoded snapshot.

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.