Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
BitmapImage

Package | spark.primitives
Class | public class BitmapImage
Inheritance | BitmapImage GraphicElement flash.events.EventDispatcher
Subclasses | MobileGridBitmapCellRenderer

Language Version : | ActionScript 3.0

Product Version : | Flex 4.0

Runtime Versions : | Flash Player 10, AIR 2.0

A BitmapImage element defines a rectangular region in its parent element's coordinate space, filled with bitmap data drawn from a source file or source URL.

View the examples

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | alpha : Number The level of transparency of the graphic element. | GraphicElement
|  | alwaysCreateDisplayObject : Boolean Specifies that this GraphicElement is to be associated with and be rendered to its own DisplayObject. | GraphicElement
|  | baseline : Object The vertical distance in pixels from the anchor target to the control's baseline position. | GraphicElement
|  | baselinePosition : Number [read-only] The y-coordinate of the baseline of the first line of text of the component. | GraphicElement
|  | bitmapData : BitmapData [read-only] Returns a copy of the BitmapData object representing the currently loaded image content (unscaled). | BitmapImage
|  | blendMode : String A value from the BlendMode class that specifies which blend mode to use. | GraphicElement
|  | bottom : Object The vertical distance in pixels from the bottom edge of the component to the anchor target's bottom edge. | GraphicElement
|  | bytesLoaded : Number [read-only] The number of bytes of the image already loaded. | BitmapImage
|  | bytesTotal : Number [read-only] The total image data in bytes loaded or pending load. | BitmapImage
|  | clearOnLoad : Boolean Denotes whether or not to clear previous image content prior to loading new content. | BitmapImage
|  | contentLoader : IContentLoader Optional custom image loader (e.g. | BitmapImage
|  | contentLoaderGrouping : String Optional content grouping identifier to pass to the an associated IContentLoader instance's load() method. | BitmapImage
|  | depth : Number Determines the order in which items inside of containers are rendered. | GraphicElement
|  | designLayer : DesignLayer Specifies the optional DesignLayer instance associated with this visual element. | GraphicElement
|  | displayObject : DisplayObject [read-only] The shared DisplayObject where this IGraphicElement is drawn. | GraphicElement
|  | displayObjectSharingMode : String Indicates the association between this IGraphicElement and its display objects. | GraphicElement
|  | explicitHeight : Number Number that specifies the explicit height of the component, in pixels, in the component's coordinates. | GraphicElement
|  | explicitMaxHeight : Number The maximum recommended height of the component to be considered by the parent during layout. | GraphicElement
|  | explicitMaxWidth : Number The maximum recommended width of the component to be considered by the parent during layout. | GraphicElement
|  | explicitMinHeight : Number The minimum recommended height of the component to be considered by the parent during layout. | GraphicElement
|  | explicitMinWidth : Number The minimum recommended width of the component to be considered by the parent during layout. | GraphicElement
|  | explicitWidth : Number Number that specifies the explicit width of the component, in pixels, in the component's coordinates. | GraphicElement
|  | fillMode : String Determines how the bitmap fills in the dimensions. | BitmapImage
|  | filters : Array An indexed array that contains each filter object currently associated with the graphic element. | GraphicElement
|  | hasLayoutMatrix3D : Boolean [read-only] Contains true if the element has 3D Matrix. | GraphicElement
|  | height : Number The height of the graphic element. | GraphicElement
|  | horizontalAlign : String The horizontal alignment of the content when it does not have a one-to-one aspect ratio and scaleMode is set to mx.graphics.BitmapScaleMode.LETTERBOX. | BitmapImage
|  | horizontalCenter : Object The horizontal distance in pixels from the center of the component to the center of the anchor target's content area. | GraphicElement
|  | id : String The identity of the component. | GraphicElement
|  | imageDecodingPolicy : String = onDemand The image decoding policy, set to ON_DEMAND or ON_LOAD. | BitmapImage
|  | includeInLayout : Boolean Specifies whether this element is included in the layout of the parent. | GraphicElement
|  | is3D : Boolean [read-only] Contains true when the element is in 3D. | GraphicElement
|  | layoutDirection : String Specifies the desired layout direction for an element: one of LayoutDirection.LTR (left to right), LayoutDirection.RTL (right to left), or null (inherit). | GraphicElement
|  | left : Object The horizontal distance in pixels from the left edge of the component to the anchor target's left edge. | GraphicElement
|  | luminosityClip : Boolean A property that controls whether the luminosity mask clips the masked content. | GraphicElement
|  | luminosityInvert : Boolean A property that controls the calculation of the RGB color value of a graphic element being masked by a luminosity mask. | GraphicElement
|  | mask : DisplayObject The calling display object is masked by the specified mask object. | GraphicElement
|  | maskType : String Defines how the mask is applied to the GraphicElement. The possible values are MaskType.CLIP, MaskType.ALPHA, and MaskType.LUMINOSITY. Clip Masking When masking in clip mode, a clipping masks is reduced to 1-bit. | GraphicElement
|  | maxHeight : Number The maximum recommended height of the component to be considered by the parent during layout. | GraphicElement
|  | maxWidth : Number The maximum recommended width of the component to be considered by the parent during layout. | GraphicElement
|  | measuredHeight : Number The default height of the component, in pixels. | GraphicElement
|  | measuredWidth : Number The default width of the component, in pixels. | GraphicElement
|  | measuredX : Number The default measured bounds top-left corner relative to the origin of the element. | GraphicElement
|  | measuredY : Number The default measured bounds top-left corner relative to the origin of the element. | GraphicElement
|  | minHeight : Number The minimum recommended height of the component to be considered by the parent during layout. | GraphicElement
|  | minWidth : Number The minimum recommended width of the component to be considered by the parent during layout. | GraphicElement
|  | MXMLDescriptor : Array [read-only] | GraphicElement
|  | MXMLProperties : Array [read-only] | GraphicElement
|  | owner : DisplayObjectContainer The owner of this IVisualElement object. | GraphicElement
|  | parent : DisplayObjectContainer [read-only] The parent container or component for this component. | GraphicElement
|  | percentHeight : Number Specifies the height of a component as a percentage of its parent's size. | GraphicElement
|  | percentWidth : Number Specifies the width of a component as a percentage of its parent's size. | GraphicElement
|  | postLayoutTransformOffsets : TransformOffsets Defines a set of adjustments that can be applied to the object's transform in a way that is invisible to its parent's layout. | GraphicElement
|  | preliminaryHeight : Number Provides an estimate to use for height when the "measured" bounds of the image is requested by layout, but the image data has yet to complete loading. | BitmapImage
|  | preliminaryWidth : Number Provides an estimate to use for width when the "measured" bounds of the image is requested by layout, but the image data has yet to complete loading. | BitmapImage
|  | right : Object The horizontal distance in pixels from the right edge of the component to the anchor target's right edge. | GraphicElement
|  | rotation : Number Indicates the rotation of the element, in degrees, from the transform point. | GraphicElement
|  | rotationX : Number Indicates the x-axis rotation of the element instance, in degrees, from its original orientation relative to the 3D parent container. | GraphicElement
|  | rotationY : Number Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | GraphicElement
|  | rotationZ : Number Indicates the rotation of the element, in degrees, from the transform point. | GraphicElement
|  | scaleMode : String Determines how the image is scaled when fillMode is set to mx.graphics.BitmapFillMode.SCALE. | BitmapImage
|  | scaleX : Number The horizontal scale (percentage) of the element as applied from the transform point. | GraphicElement
|  | scaleY : Number The vertical scale (percentage) of the element as applied from the transform point. | GraphicElement
|  | scaleZ : Number The z scale (percentage) of the element as applied from the transform point. | GraphicElement
|  | smooth : Boolean | BitmapImage
|  | smoothingQuality : String Determines how the image is down-scaled. | BitmapImage
|  | source : Object The source used for the bitmap fill. | BitmapImage
|  | sourceHeight : Number [read-only] Provides the unscaled height of the original image data. | BitmapImage
|  | sourceWidth : Number [read-only] Provides the unscaled width of the original image data. | BitmapImage
|  | top : Object The vertical distance in pixels from the top edge of the component to the anchor target's top edge. | GraphicElement
|  | transform : Transform | GraphicElement
|  | transformX : Number The x position transform point of the element. | GraphicElement
|  | transformY : Number The y position transform point of the element. | GraphicElement
|  | transformZ : Number The z position transform point of the element. | GraphicElement
|  | trustedSource : Boolean [read-only] A read-only flag denoting whether the currently loaded content is considered loaded form a source whose security policy allows for cross domain image access. | BitmapImage
|  | verticalAlign : String The vertical alignment of the content when it does not have a one-to-one aspect ratio and scaleMode is set to mx.graphics.BitmapScaleMode.LETTERBOX. | BitmapImage
|  | verticalCenter : Object The vertical distance in pixels from the center of the component to the center of the anchor target's content area. | GraphicElement
|  | visible : Boolean Controls the visibility of this visual element. | GraphicElement
|  | width : Number The width of the graphic element. | GraphicElement
|  | x : Number The x position of the graphic element. | GraphicElement
|  | y : Number The y position of the graphic element. | GraphicElement
|  | z : Number The z position of the graphic element. | GraphicElement

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | drawnDisplayObject : DisplayObject [read-only] The actual DisplayObject that is drawn into by the GraphicElement. | GraphicElement
|  | drawX : Number [read-only] The x position where the element should be drawn. | GraphicElement
|  | drawY : Number [read-only] The y position where the element should be drawn. | GraphicElement
|  | hasComplexLayoutMatrix : Boolean [read-only] Returns true if the GraphicElement has any non-translation (x,y) transform properties | GraphicElement
|  | layoutFeatures : AdvancedLayoutFeatures Contain all of the implementation details of how the GraphicElement implements transform and layering support. | GraphicElement
|  | needsDisplayObject : Boolean [read-only] True if the element requires an exclusive DisplayObject. | GraphicElement

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | BitmapImage() Constructor. | BitmapImage
|  | canShareWithNext(element:IGraphicElement):Boolean Returns true if this IGraphicElement is compatible and can share display objects with the next IGraphicElement in the sequence. | GraphicElement
|  | canShareWithPrevious(element:IGraphicElement):Boolean Returns true if this IGraphicElement is compatible and can share display objects with the previous IGraphicElement in the sequence. | GraphicElement
|  | createDisplayObject():DisplayObject Creates a new DisplayObject where this IGraphicElement is drawn. | GraphicElement
|  | generateMXMLArray(document:Object, data:Array, recursive:Boolean = true):Array | GraphicElement
|  | generateMXMLVector(document:Object, data:Array, recursive:Boolean = true):* | GraphicElement
|  | getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the x coordinate of the element's bounds at the specified element size. | GraphicElement
|  | getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the y coordinate of the element's bounds at the specified element size. | GraphicElement
|  | getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's layout height. | GraphicElement
|  | getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's layout width. | GraphicElement
|  | getLayoutBoundsX(postLayoutTransform:Boolean = true):Number Returns the x coordinate that the element uses to draw on screen. | GraphicElement
|  | getLayoutBoundsY(postLayoutTransform:Boolean = true):Number Returns the y coordinate that the element uses to draw on screen. | GraphicElement
|  | getLayoutMatrix():Matrix Returns the transform matrix that is used to calculate the component's layout relative to its siblings. | GraphicElement
|  | getLayoutMatrix3D():Matrix3D Returns the layout transform Matrix3D for this element. | GraphicElement
|  | getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's maximum height. | GraphicElement
|  | getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's maximum width. | GraphicElement
|  | getMinBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's minimum height. | GraphicElement
|  | getMinBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's minimum width. | GraphicElement
|  | getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's preferred height. | GraphicElement
|  | getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's preferred width. | GraphicElement
|  | initialized(document:Object, id:String):void Called automatically by the MXML compiler when the GraphicElement is created using an MXML tag. | GraphicElement
|  | invalidateDisplayList():void Calling this method results in a call to the elements's validateDisplayList() method before the display list is rendered. | GraphicElement
|  | invalidateLayoutDirection():void An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes. | GraphicElement
|  | invalidateProperties():void Calling this method results in a call to the elements's validateProperties() method before the display list is rendered. | GraphicElement
|  | invalidateSize():void Calling this method results in a call to the elements's validateSize() method before the display list is rendered. | GraphicElement
|  | localToGlobal(point:Point):Point Converts the point object from the object's (local) coordinates to the Stage (global) coordinates. | GraphicElement
|  | parentChanged(value:IGraphicElementContainer):void Called by IGraphicElementContainer when an IGraphicElement is added to or removed from the host component. | GraphicElement
|  | setLayoutBoundsPosition(newBoundsX:Number, newBoundsY:Number, postLayoutTransform:Boolean = true):void Sets the coordinates that the element uses to draw on screen. | GraphicElement
|  | setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void Sets the layout size of the element. | GraphicElement
|  | setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void Sets the transform Matrix that is used to calculate the component's layout size and position relative to its siblings. | GraphicElement
|  | setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void Sets the transform Matrix3D that is used to calculate the component's layout size and position relative to its siblings. | GraphicElement
|  | setMXMLDescriptor(value:Array):void | GraphicElement
|  | setMXMLProperties(value:Array):void | GraphicElement
|  | setSharedDisplayObject(sharedDisplayObject:DisplayObject):Boolean Determines whether this element can draw itself to the sharedDisplayObject of the sequence. | GraphicElement
|  | transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void A utility method to update the rotation, scale, and translation of the transform while keeping a particular point, specified in the component's own coordinate space, fixed in the parent's coordinate space. | GraphicElement
|  | transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void A utility method to transform a point specified in the local coordinates of this object to its location in the object's parent's coordinates. | GraphicElement
|  | validateDisplayList():void Called by the IGraphicElementContainer to redraw this element in its displayObject property. | GraphicElement
|  | validateNow():void Validates and updates the properties and layout of this object by immediately calling validateProperties(), validateSize(), and validateDisplayList(), if necessary. | GraphicElement
|  | validateProperties():void Used by layout logic to validate the properties of a component by calling the commitProperties() method. | GraphicElement
|  | validateSize():void Called by the IGraphicElementContainer to validate the size of this element. | GraphicElement

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | canSkipMeasurement():Boolean Determines if the call to the measure() method can be skipped. | GraphicElement
|  | commitProperties():void [override] Processes the properties set on the element. | BitmapImage
|  | generateMXMLAttributes(data:Array):void | GraphicElement
|  | generateMXMLInstances(document:Object, data:Array, recursive:Boolean = true):void | GraphicElement
|  | generateMXMLObject(document:Object, data:Array):Object | GraphicElement
|  | getStrokeExtents(postLayoutTransform:Boolean = true):Rectangle Returns the amount of pixels occupied by the stroke on each side of the element's bounds. | GraphicElement
|  | invalidateDisplayObjectSharing():void Utility method that notifies the host that this element has changed and needs its layer to be updated. | GraphicElement
|  | invalidateParentSizeAndDisplayList():void Helper method to invalidate parent size and display list if this object affects its layout (includeInLayout is true). | GraphicElement
|  | measure():void [override] Calculates the default size of the element. | BitmapImage
|  | preferredHeightPreTransform():Number Used for the implementation of the ILayoutElement interface, returns the explicit measured height pre-transform. | GraphicElement
|  | preferredWidthPreTransform():Number Used for the implementation of the ILayoutElement interface, returns the explicit of measured width pre-transform. | GraphicElement
|  | transformHeightForLayout(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Transform the element's size. | GraphicElement
|  | transformWidthForLayout(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Transform the element's size. | GraphicElement
|  | updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void [override] Draws the element and/or sizes and positions its content. | BitmapImage

Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | complete | Dispatched when content loading is complete. | BitmapImage
|  | httpStatus | Dispatched when a network request is made over HTTP and Flash Player or AIR can detect the HTTP status code. | BitmapImage
|  | ioError | Dispatched when an input/output error occurs. | BitmapImage
|  | progress | Dispatched when content is loading. | BitmapImage
|  | ready | Dispatched when content loading is complete. | BitmapImage
|  | securityError | Dispatched when a security error occurs. | BitmapImage

Public Constants

| Constant | Defined By
--- | --- | ---
|  | ON_DEMAND : String = onDemand [static] Specifies that the image being loaded will be decoded when needed. | BitmapImage
|  | ON_LOAD : String = onLoad [static] Specifies that the image being loaded will be decoded on load. | BitmapImage

Property Detail

bitmapData | property

`bitmapData:BitmapData` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.0

Returns a copy of the BitmapData object representing the currently loaded image content (unscaled). This property is `null` for untrusted cross domain content.

The default value is `null`.

Implementation
`public function get bitmapData():BitmapData`

bytesLoaded | property |

`bytesLoaded:Number` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.0

The number of bytes of the image already loaded. Only relevant for images loaded by request URL.

The default value is `NaN`.

Implementation
`public function get bytesLoaded():Number`

bytesTotal | property |

`bytesTotal:Number` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.0

The total image data in bytes loaded or pending load. Only relevant for images loaded by request URL.

The default value is `NaN`.

Implementation
`public function get bytesTotal():Number`

clearOnLoad | property |

`clearOnLoad:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.0

Denotes whether or not to clear previous image content prior to loading new content.

The default value is `true`.

Implementation
`public function get clearOnLoad():Boolean`
`public function set clearOnLoad(value:Boolean):void`

contentLoader | property |

`contentLoader:IContentLoader`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 1.5

Optional custom image loader (e.g. image cache or queue) to associate with content loader client.

The default value is `null`.

Implementation
`public function get contentLoader():IContentLoader`
`public function set contentLoader(value:IContentLoader):void`

contentLoaderGrouping | property |

`contentLoaderGrouping:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 1.5

Optional content grouping identifier to pass to the an associated IContentLoader instance's load() method. This property is only considered when a valid contentLoader is assigned.

Implementation
`public function get contentLoaderGrouping():String`
`public function set contentLoaderGrouping(value:String):void`

fillMode | property |

`fillMode:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Determines how the bitmap fills in the dimensions. If you set the value of this property in a tag, use the string (such as "repeat"). If you set the value of this property in ActionScript, use the constant (such as `mx.graphics.BitmapFillMode.CLIP`).

When set to `BitmapFillMode.CLIP` ("clip"), the bitmap ends at the edge of the region.

When set to `BitmapFillMode.REPEAT` ("repeat"), the bitmap repeats to fill the region.

When set to `BitmapFillMode.SCALE` ("scale"), the bitmap stretches to fill the region.

The default value is ``BitmapFillMode.SCALE``.

Implementation
`public function get fillMode():String`
`public function set fillMode(value:String):void`

See also

mx.graphics.BitmapFillMode

horizontalAlign | property |

`horizontalAlign:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The horizontal alignment of the content when it does not have a one-to-one aspect ratio and `scaleMode` is set to `mx.graphics.BitmapScaleMode.LETTERBOX`.

Can be one of `HorizontalAlign.LEFT` ("left"), `HorizontalAlign.RIGHT` ("right"), or `HorizontalAlign.CENTER` ("center").

This property is only applicable when `fillMode` is set to to `mx.graphics.BitmapFillMode.SCALE` ("scale").

The default value is ``HorizontalAlign.CENTER``.

Implementation
`public function get horizontalAlign():String`
`public function set horizontalAlign(value:String):void`

See also

mx.graphics.BitmapFillMode
mx.graphics.BitmapScaleMode

imageDecodingPolicy | property |

`public var imageDecodingPolicy:String = onDemand`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.11

Runtime Versions : | AIR 2.6

The image decoding policy, set to ON_DEMAND or ON_LOAD. The default is ON_DEMAND. ImageDecodingPolicy also defined ON_DEMAND and ON_LOAD but these are only available under AIR 2.6 and above. Setting to asynchronously decode and load the bitmap images for large image may improve your application’s perceived performance.

preliminaryHeight | property |

`preliminaryHeight:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 1.5

Provides an estimate to use for height when the "measured" bounds of the image is requested by layout, but the image data has yet to complete loading. When NaN the measured height is 0 until the image has finished loading.

The default value is `NaN`.

Implementation
`public function get preliminaryHeight():Number`
`public function set preliminaryHeight(value:Number):void`

preliminaryWidth | property |

`preliminaryWidth:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 1.5

Provides an estimate to use for width when the "measured" bounds of the image is requested by layout, but the image data has yet to complete loading. When NaN the measured width is 0 until the image has finished loading.

The default value is `NaN`.

Implementation
`public function get preliminaryWidth():Number`
`public function set preliminaryWidth(value:Number):void`

scaleMode | property |

`scaleMode:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.0

Determines how the image is scaled when `fillMode` is set to `mx.graphics.BitmapFillMode.SCALE`.

When set to `mx.graphics.BitmapScaleMode.STRETCH` ("stretch"), the image is stretched to fit.

When set to `BitmapScaleMode.LETTERBOX` ("letterbox"), the image is scaled with respect to the original unscaled image's aspect ratio.

When set to `BitmapScaleMode.ZOOM` ("zoom"), the image is scaled to fit with respect to the original unscaled image's aspect ratio. This results in cropping on one axis.

The default value is ``BitmapScaleMode.STRETCH``.

Implementation
`public function get scaleMode():String`
`public function set scaleMode(value:String):void`

See also

mx.graphics.BitmapFillMode
mx.graphics.BitmapScaleMode

smooth | property |

`smooth:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The default value is `false`.

Implementation
`public function get smooth():Boolean`
`public function set smooth(value:Boolean):void`

smoothingQuality | property |

`smoothingQuality:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 1.5

Determines how the image is down-scaled. When set to `BitmapSmoothingQuality.HIGH`, the image is resampled (if data is from a trusted source) to achieve a higher quality result. If set to `BitmapSmoothingQuality.DEFAULT`, the default stage quality for scaled bitmap fills is used.

The default value is ``BitmapSmoothingQuality.DEFAULT``.

Implementation
`public function get smoothingQuality():String`
`public function set smoothingQuality(value:String):void`

source | property |

`source:Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The source used for the bitmap fill. The fill can render from various graphical sources, including the following:

- A Bitmap or BitmapData instance.
- A class representing a subclass of DisplayObject. The BitmapFill instantiates the class and creates a bitmap rendering of it.
- An instance of a DisplayObject. The BitmapFill copies it into a Bitmap for filling.
- The name of an external image file.

If you use an image file for the source, it can be of type PNG, GIF, or JPG.

To specify an embedded image source, you can use the @Embed directive, as the following example shows:

          source="@Embed('<i>image_location</i>')"

The image location can be specified via a URL, URLRequest, or file reference. If it is a file reference, its location is relative to the location of the file that is being compiled.

The BitmapImage class is designed to work with embedded images or images that are loaded at run time.

If the source is a Bitmap or BitmapData instance or is an external image file, it is the responsibility of the caller to dispose of the source once it is no longer needed. If ImageLoader created the BitmapData instance, then it will dispose of the BitmapData once the source has changed.

This property can be used as the source for data binding.

Implementation
`public function get source():Object`
`public function set source(value:Object):void`

See also

flash.display.Bitmap
flash.display.BitmapData
mx.graphics.BitmapFill

sourceHeight | property |

`sourceHeight:Number` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 1.5

Provides the unscaled height of the original image data.

The default value is `NaN`.

Implementation
`public function get sourceHeight():Number`

sourceWidth | property |

`sourceWidth:Number` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 1.5

Provides the unscaled width of the original image data.

The default value is `NaN`.

Implementation
`public function get sourceWidth():Number`

trustedSource | property |

`trustedSource:Boolean` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 9, AIR 1.5

A read-only flag denoting whether the currently loaded content is considered loaded form a source whose security policy allows for cross domain image access. When `false`, advanced bitmap operations such as high quality scaling, and tiling are not permitted. This flag is set once an image has been fully loaded.

The default value is `true`.

Implementation
`public function get trustedSource():Boolean`

verticalAlign | property |

`verticalAlign:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 1.5

The vertical alignment of the content when it does not have a one-to-one aspect ratio and scaleMode is set to `mx.graphics.BitmapScaleMode.LETTERBOX`.

Can be one of `VerticalAlign.TOP` ("top"), `VerticalAlign.BOTTOM` ("bottom"), or `VerticalAlign.MIDDLE` ("middle").

This property is only applicable when scaleMode is set to to `BitmapFillMode.SCALE` ("scale").

The default value is ``VerticalAlign.MIDDLE``.

Implementation
`public function get verticalAlign():String`
`public function set verticalAlign(value:String):void`

See also

mx.graphics.BitmapFillMode
mx.graphics.BitmapScaleMode
Constructor Detail

BitmapImage | () | Constructor

`public function BitmapImage()`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Constructor.

Method Detail

commitProperties | () | method

`override protected function commitProperties():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Processes the properties set on the element. This is an advanced method that you might override when creating a subclass.

You do not call this method directly. Flex calls the `commitProperties()` method when you use the `addElement()` method to add an element to an `IGraphicElementContainer` container such as Group, or when you call the `invalidateProperties()` method of the element. Calls to the `commitProperties()` method occur before calls to the `measure()` method. This lets you set property values that might be used by the `measure()` method.

Some elements have properties that interact with each other. It is often best at startup time to process all of these properties at one time to avoid duplicating work.

measure | () | method |

`override protected function measure():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Calculates the default size of the element. This is an advanced method that you might override when creating a subclass of GraphicElement.

You do not call this method directly. Flex calls the `measure()` method when the element is added to an `IGraphicElementContainer` container such as Group using the `addElement()` method, and when the element's `invalidateSize()` method is called.

By default you set both explicit height and explicit width of an element, Flex does not call the `measure()` method, even if you explicitly call the `invalidateSize()` method. To override this behavior, override `skipMeasure()` method.

In your override of this method, you must set the `measuredWidth` and `measuredHeight` properties to define the default size. You can optionally set the `measuredX` and `measuredY` properties to define the default measured bounds top-left corner relative to the origin of the element.

The conceptual point of `measure()` is for the element to provide its own natural or intrinsic bounds as a default. Therefore, the `measuredWidth` and `measuredHeight` properties should be determined by factors such as:

- The amount of text the component needs to display.
- The size of a JPEG image that the component displays.

In some cases, there is no intrinsic way to determine default values. For example, a simple GreenCircle element might simply set measuredWidth = 100 and measuredHeight = 100 in its `measure()` method to provide a reasonable default size. In other cases, such as a TextArea, an appropriate computation (such as finding the right width and height that would just display all the text and have the aspect ratio of a Golden Rectangle) might be too time-consuming to be worthwhile.

The default implementation of `measure()` sets the values of the `measuredWidth`, `measuredHeight`, `measuredX`, and `measuredY` properties to `0`.

updateDisplayList | () | method |

`override protected function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Draws the element and/or sizes and positions its content. This is an advanced method that you might override when creating a subclass of GraphicElement.

You do not call this method directly. Flex calls the `updateDisplayList()` method when the component is added to an `IGraphicElementContainer` container such as Group using the `addElement()` method, and when the element's `invalidateDisplayList()` method is called.

This method is where you would do programmatic drawing using methods on the elements's displayObject such as `graphics.drawRect()`.

Parameters

| `unscaledWidth:Number` — Specifies the width of the component, in pixels, in the component's coordinates, regardless of the value of the `scaleX` property of the component.
| `unscaledHeight:Number` — Specifies the height of the component, in pixels, in the component's coordinates, regardless of the value of the `scaleY` property of the component.

Event Detail

complete | Event

Event Object Type: `flash.events.Event`
Event.type property = `flash.events.Event.COMPLETE`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.0

Dispatched when content loading is complete. This event is only dispatched for url and ByteArray based sources (those sources requiring a Loader).

Note that for content loaded via Loader, both `ready` and `complete` events are dispatched.

For other source types such as embeds, only `ready` is dispatched.

httpStatus | Event |

Event Object Type: `flash.events.HTTPStatusEvent`
HTTPStatusEvent.type property = `flash.events.HTTPStatusEvent.HTTP_STATUS`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.0

Dispatched when a network request is made over HTTP and Flash Player or AIR can detect the HTTP status code.

ioError | Event |

Event Object Type: `flash.events.IOErrorEvent`
IOErrorEvent.type property = `flash.events.IOErrorEvent.IO_ERROR`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.0

Dispatched when an input/output error occurs.

See also

flash.events.IOErrorEvent

progress | Event |

Event Object Type: `flash.events.ProgressEvent`
ProgressEvent.type property = `flash.events.ProgressEvent.PROGRESS`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.0

Dispatched when content is loading.

Note: The `progress` event is not guaranteed to be dispatched. The `complete` event may be received, without any `progress` events being dispatched. This can happen when the loaded content is a local file.

ready | Event |

Event Object Type: `mx.events.FlexEvent`
FlexEvent.type property = `mx.events.FlexEvent.READY`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.0

Dispatched when content loading is complete. Unlike the `complete` event, this event is dispatched for all source types.

Note that for content loaded via Loader, both `ready` and `complete` events are dispatched.

For other source types such as embeds, only `ready` is dispatched. The `FlexEvent.READY` constant defines the value of the `type` property of the event object for a `ready` event. This event is dispatched by the BitmapImage and spark Image classes to denote that the assigned image source has fully loaded.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`returnValue` | null
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myImage.addEventListener()` to register an event listener, myImage is the value of the `currentTarget`.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`Type` | FlexEvent.READY

securityError | Event |

Event Object Type: `flash.events.SecurityErrorEvent`
SecurityErrorEvent.type property = `flash.events.SecurityErrorEvent.SECURITY_ERROR`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.0

Dispatched when a security error occurs.

See also

flash.events.SecurityErrorEvent
Constant Detail

ON_DEMAND | Constant

`public static const ON_DEMAND:String = onDemand`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.11

Runtime Versions : | Flash Player 10, AIR 1.5

Specifies that the image being loaded will be decoded when needed.

See also

flash.system.ImageDecodingPolicy

ON_LOAD | Constant |

`public static const ON_LOAD:String = onLoad`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.11

Runtime Versions : | Flash Player 10, AIR 1.5

Specifies that the image being loaded will be decoded on load.

See also

flash.system.ImageDecodingPolicy
Examples
BitmapImageExample.mxml

    <?xml version="1.0" encoding="utf-8"?>
    <!--

      Licensed to the Apache Software Foundation (ASF) under one or more
      contributor license agreements.  See the NOTICE file distributed with
      this work for additional information regarding copyright ownership.
      The ASF licenses this file to You under the Apache License, Version 2.0
      (the "License"); you may not use this file except in compliance with
      the License.  You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      See the License for the specific language governing permissions and
      limitations under the License.

    -->
    <!-- BitmapGraphicExample.mxml -->
    <s:Application xmlns:fx="http://ns.adobe.com/mxml/2009" xmlns:s="library://ns.adobe.com/flex/spark">

        <s:Panel title="Bitmap Graphic Example"
                width="75%" height="75%"
                horizontalCenter="0" verticalCenter="0">
            <s:Group left="10" right="10" top="10" bottom="10">
                <!-- Single image, not resized, not repeated. -->
                <s:Graphic x="0" y="0">
                    <s:BitmapImage id="bg1" source="@Embed('assets/Icon12x12.gif')" fillMode="clip"/>
                </s:Graphic>

                <!-- Single image, scaled to fit specified dimensions. -->
                <s:Graphic x="150" y="0">
                    <s:BitmapImage id="bg2" source="@Embed('assets/Icon12x12.gif')" width="60" height="60" fillMode="scale"/>
                </s:Graphic>

                <!-- Repeated image to fit specified dimensions. -->
                <s:Graphic x="300" y="0">
                    <s:BitmapImage id="bg3" source="@Embed('assets/Icon12x12.gif')" width="120" height="120" fillMode="repeat"/>
                </s:Graphic>
            </s:Group>
        </s:Panel>

    </s:Application>

Wed Nov 15 2017, 09:50 AM +01:00