ImageSnapshot

Package	mx.graphics
Classe	public dynamic class ImageSnapshot
Héritage	ImageSnapshot Object

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Classe d’aide utilisée pour capturer un instantané des composants Flash qui implémentent flash.display.IBitmapDrawable, y compris les composants UIComponents Flex.

Une instance de cette classe peut être envoyée sous la forme d’un composant RemoteObject à Adobe LiveCycle Data Services afin de générer un fichier PDF d’une image côté client. Si vous devez spécifier d’autres propriétés de l’image au-delà de ses propriétés contentType, width et height, vous devez définir des paires nom/valeur pour l’objet properties.

Dans les versions antérieures de Flex, ces propriétés supplémentaires étaient définies sur l’instance ImageSnapshot. Cette classe reste dynamique afin de permettre cette action, mais elle ne le sera peut être plus dans une version ultérieure de Flex.

Propriétés publiques

Masquer les propriétés publiques héritées

Afficher les propriétés publiques héritées

	Propriété		Défini par
		constructor : Object Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.	Object
		contentType : String Type de contenu MIME pour format de codage d’image utilisé pour capturer cet instantané.	ImageSnapshot
		data : ByteArray Données codées représentant l’instantané de l’image.	ImageSnapshot
		defaultEncoder : Class [statique] Implémentation mx.graphics.codec.IImageEncoder par défaut utilisée pour la capture d’images.	ImageSnapshot
		height : int Hauteur de l’image, en pixels.	ImageSnapshot
		properties : Object Objet contenant des paires nom/valeur spécifiant des propriétés supplémentaires de l’image.	ImageSnapshot
		width : int Largeur de l’image, en pixels.	ImageSnapshot

Méthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		ImageSnapshot(width:int = 0, height:int = 0, data:ByteArray = null, contentType:String = null) Constructeur.	ImageSnapshot
		captureBitmapData(source:IBitmapDrawable, matrix:Matrix = null, colorTransform:flash.geom:ColorTransform = null, blendMode:String = null, clipRect:Rectangle = null, smoothing:Boolean = false):BitmapData [statique] Méthode d’utilitaire permettant de saisir un instantané brut d’un composant de l’interface utilisateur sous la forme d’un objet BitmapData.	ImageSnapshot
		captureImage(source:IBitmapDrawable, dpi:Number = 0, encoder:IImageEncoder = null, scaleLimited:Boolean = true):ImageSnapshot [statique] Méthode d’utilitaire permettant de saisir un instantané d’un composant, mis à l’échelle à une résolution spécifique (en ppp) et codé dans un format d’image spécifique.	ImageSnapshot
		encodeImageAsBase64(snapshot:ImageSnapshot):String [statique] Méthode d’utilitaire permettant de convertir un instantané ImageSnapshot en chaîne codée au format base-64 à des fins de transmission dans un format de sérialisation basé sur du texte, tel que le XML.	ImageSnapshot
		hasOwnProperty(name:String):Boolean Indique si la propriété spécifiée d’un objet est définie.	Object
		isPrototypeOf(theClass:Object):Boolean Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre.	Object
		propertyIsEnumerable(name:String):Boolean Indique si la propriété spécifiée existe et est énumérable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.	Object
		toLocaleString():String Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.	Object
		toString():String Renvoie la représentation sous forme de chaîne de l’objet spécifié.	Object
		valueOf():Object Renvoie la valeur primitive de l’objet spécifié.	Object

Constantes publiques

	Constante		Défini par
		MAX_BITMAP_DIMENSION : int = 2880 [statique] Largeur et hauteur maximales d’un bitmap.	ImageSnapshot

Détails de la propriété

contentType

propriété

contentType:String

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Type de contenu MIME pour format de codage d’image utilisé pour capturer cet instantané. Pour les images au format PNG, le type MIME est « image/png ». Pour les images au format JPG ou JPEG, le type MIME est « image/jpeg »

Implémentation
public function get contentType():String
public function set contentType(value:String):void

data

propriété

data:ByteArray

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Données codées représentant l’instantané de l’image.

Implémentation
public function get data():ByteArray
public function set data(value:ByteArray):void

defaultEncoder

propriété

public static var defaultEncoder:Class

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Implémentation mx.graphics.codec.IImageEncoder par défaut utilisée pour la capture d’images. Les deux implémentations sont PNGEncoder et JPEGEncoder. L’encodeur par défaut utilise le format PNG.

height

propriété

height:int

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Hauteur de l’image, en pixels.

Implémentation
public function get height():int
public function set height(value:int):void

properties

propriété

properties:Object

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Objet contenant des paires nom/valeur spécifiant des propriétés supplémentaires de l’image.

En règle générale, vous devez fournir de telles informations lors de l’envoi d’une instance ImageSnapshot à Adobe LiveCycle Data Services en vue de générer un fichier PDF. Vous pouvez définir l’ensemble de l’objet ou définir des paires nom/valeur individuelles pour l’objet vide préexistant.

La valeur par défaut est {}.

Implémentation
public function get properties():Object
public function set properties(value:Object):void

width

propriété

width:int

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Largeur de l’image, en pixels.

Implémentation
public function get width():int
public function set width(value:int):void

Détails du constructeur

()

Constructeur

public function ImageSnapshot(width:int = 0, height:int = 0, data:ByteArray = null, contentType:String = null)

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Constructeur.

Paramètres

	`width:int` (default = `0`) — Largeur de l’image.

	`height:int` (default = `0`) — Hauteur de l’image.

	`data:ByteArray` (default = `null`) — Tableau d’octets contenant l’image.

	`contentType:String` (default = `null`) — Type de format de l’encodeur de l’image, PNGEncoder ou JPEGEncoder.

Détails de la méthode

captureBitmapData

()

méthode

 public static function captureBitmapData(source:IBitmapDrawable, matrix:Matrix = null, colorTransform:flash.geom:ColorTransform = null, blendMode:String = null, clipRect:Rectangle = null, smoothing:Boolean = false):BitmapData

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Méthode d’utilitaire permettant de saisir un instantané brut d’un composant de l’interface utilisateur sous la forme d’un objet BitmapData.

Paramètres

	`source:IBitmapDrawable` — Objet qui implémente l’interface `flash.display.IBitmapDrawable`.

	`matrix:Matrix` (default = `null`) — Objet Matrix utilisé pour redimensionner, faire pivoter ou traduire les coordonnées du bitmap capturé. Si vous ne souhaitez pas appliquer une matrice de transformation à l’image, réglez ce paramètre sur une matrice d’identité, créée à l’aide du constructeur new Matrix() par défaut, ou transmettez une valeur null.

	`colorTransform:flash.geom:ColorTransform` (default = `null`) — Objet ColorTransform utilisé pour définir les valeurs de couleur du bitmap. Si aucun objet n’est fourni, les couleurs de l’image bitmap ne sont pas transformées. Si ce paramètre doit être transmis, alors que vous ne souhaitez pas transformer l’image, réglez-le sur un objet ColorTransform créé à l’aide du constructeur new ColorTransform() par défaut.

	`blendMode:String` (default = `null`) — Chaîne extraite de la classe flash.display.BlendMode, qui spécifie le mode de fondu à appliquer au bitmap générée par l’opération.

	`clipRect:Rectangle` (default = `null`) — Objet Rectangle qui définit la zone de l’image source à dessiner. Si cette valeur n’est pas fournie, aucun découpage n’est effectué et l’objet source est dessiné dans sa totalité.

	`smoothing:Boolean` (default = `false`) — Valeur booléenne indiquant si un objet BitmapData doit être lissé lorsqu’il est redimensionné.

Valeur renvoyée

BitmapData — Objet BitmapData représentant l’instantané capturé ou null si la source n’a aucune limite visible.

captureImage

()

méthode

 public static function captureImage(source:IBitmapDrawable, dpi:Number = 0, encoder:IImageEncoder = null, scaleLimited:Boolean = true):ImageSnapshot

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Méthode d’utilitaire permettant de saisir un instantané d’un composant, mis à l’échelle à une résolution spécifique (en ppp) et codé dans un format d’image spécifique.

Paramètres

	`source:IBitmapDrawable` — Objet qui implémente l’interface `flash.display.IBitmapDrawable`.

	`dpi:Number` (default = `0`) — Résolution en points par pouce. En l’absence de résolution, la résolution à l’écran est utilisée par défaut.

	`encoder:IImageEncoder` (default = `null`) — Le format d’image utilise pour coder le bitmap brut. Les deux encodeurs sont PNGEncoder et JPEGEncoder. Si aucun encodeur n’est fourni, celui par défaut est PNGEncoder.

	`scaleLimited:Boolean` (default = `true`) — La largeur ou la hauteur maximale d’une image bitmap dans Flash est de 2880 pixels. Si la valeur scaleLimited est définie sur true la résolution est réduite proportionnellement pour rester dans la limite de 2880 pixels. Dans le cas contraire, si la valeur scaleLimited est définie sur false, des fenêtres d’instantané de taille inférieure seront prises et assemblées afin de capturer une image plus grande. La valeur par défaut est true.

Valeur renvoyée

ImageSnapshot — Une instance ImageSnapshot contenant un instantané capturé codé et les métadonnées d’image associées.

encodeImageAsBase64

()

méthode

public static function encodeImageAsBase64(snapshot:ImageSnapshot):String

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Méthode d’utilitaire permettant de convertir un instantané ImageSnapshot en chaîne codée au format Base-64 à des fins de transmission dans un format de sérialisation basé sur du texte, tel que le XML.

Paramètres

snapshot:ImageSnapshot — Image capturée en tant qu’instantané mx.graphics.ImageSnapshot.

Valeur renvoyée

String — Chaîne représentant l’instantané codé au format Base64.

Eléments de l’API associés

captureImage

Détails de la constante

MAX_BITMAP_DIMENSION

Constante

public static const MAX_BITMAP_DIMENSION:int = 2880

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Largeur et hauteur maximales d’un bitmap.

Informations juridiques | Politique de confidentialité en ligne

ImageSnapshot - AS3 Flex

Classes x

contentType

data

defaultEncoder

height

properties

width

ImageSnapshot

captureBitmapData

captureImage

encodeImageAsBase64

MAX_BITMAP_DIMENSION