com.esri.ags.layers.MapImageLayer

	Property	Defined By
		initialExtent : Extent [override] Initial extent of the layer.	MapImageLayer
		isInScaleRange : Boolean [read-only] Returns true if the current scale of the map is between the maximum and minimum scale of the layer [added in version 1.3].	Layer
		loaded : Boolean [read-only] When the layer is loaded, the value becomes "true" and layer properties can be accessed.	Layer
		loadFault : Fault [read-only] A reference to the fault that is dispatched when the layer throws a loadError event.	Layer
		map : Map [read-only] A reference to the Map this layer is in.	Layer
		mapImageProvider : Object Set of images to be viewed.	MapImageLayer
		maxScale : Number The maximum scale of the layer [added in version 1.3].	Layer
		minScale : Number The minimum scale of the layer [added in version 1.3].	Layer
		spatialReference : SpatialReference [read-only] The spatial reference of the layer.	Layer
		units : String [read-only] The units of the layer.	Layer

	Method	Defined By
		MapImageLayer() Creates a new MapImageLayer	MapImageLayer
		add(mapImage:MapImage):void Add an image to the map.	MapImageLayer
		getImageVisibility(mapImage:MapImage):Boolean Gets the current visibility of the input MapImage.	MapImageLayer
		refresh():void Causes the layer to redraw or reload its content.	Layer
		remove(mapImage:MapImage):void Remove the specified image from the layer.	MapImageLayer
		removeAll():void Remove all images from the layer.	MapImageLayer
		setImageVisibility(mapImage:MapImage, isVisible:Boolean):void Set the visibility for the image.	MapImageLayer

Protected Methods

	Method		Defined By
		addMapListeners():void Adds listeners for ExtentEvent.EXTENT_CHANGE, ZoomEvent.ZOOM_START, ZoomEvent.ZOOM_UPDATE and ZoomEvent.ZOOM_END.	Layer
		extentChangeHandler(event:ExtentEvent):void When an EXTENT_CHANGE event occurs, this calls invalidateLayer();	Layer
		hideHandler(event:FlexEvent):void When the layer is hidden (visible is set to false), this calls removeMapListeners().	Layer
		invalidateLayer():void Subclasses should call this whenever they would like to have updateLayer() called on them.	Layer
		removeAllChildren():void Removes all the layers children.	Layer
		removeMapListeners():void Removes the four event listeners added by addMapListeners();	Layer
		setLoaded(value:Boolean):void Subclasses must call this when they've loaded all their properties and are ready to load their content.	Layer
		showHandler(event:FlexEvent):void When the layer is shown (visible is set to true), this calls addMapListeners() and invalidateLayer().	Layer
		toScreenX(mapX:Number):Number Converts the x-coordinate of map point to a screen point.	Layer
		toScreenY(mapY:Number):Number Converts the y-coordinate of map point to a screen point.	Layer
		updateLayer():void Subclasses must override this method.	Layer
		zoomEndHandler(event:ZoomEvent):void Finishes the zoom animation.	Layer
		zoomStartHandler(event:ZoomEvent):void Prepares the zoom animation by taking a bitmap of the layer.	Layer
		zoomUpdateHandler(event:ZoomEvent):void Redraws the bitmap of the layer.	Layer

Summary	Defined By
isInScaleRangeChange	Fires if the value of isInScaleRange changes.	Layer
load	Fires after layer properties for the layer are successfully populated.	Layer
loadError	Fires if the layer is unable to load.	Layer
updateEnd	Fires when the layer has finished updating its content.	Layer
updateStart	Fires when the layer begins to update its content.	Layer

Property Detail

initialExtent

property

initialExtent:Extent[override]

Initial extent of the layer. Used by the map if it is the first layer in the map and map doesn't have an extent specified.

The default value is new Extent(-180, -90, 180, 90, new SpatialReference(4326)).

Implementation
public function get initialExtent():Extent
public function set initialExtent(value:Extent):void

mapImageProvider

property

mapImageProvider:Object

Set of images to be viewed. This property lets you use either an Array, an ArrayCollection. If you set the mapImageProvider property to an Array, it will be converted to an ArrayCollection. If you set the property to an ArrayCollection, it will be used directly. If you set the property to a single MapImage, it will be wrapped in a new ArrayCollection.

As a consequence of the conversions, when you get the mapImageProvider property, it will always be an ArrayCollection.

The default value is an empty ArrayCollection.

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

Implementation
public function get mapImageProvider():Object
public function set mapImageProvider(value:Object):void

Constructor Detail

MapImageLayer

()

Constructor

public function MapImageLayer()

Creates a new MapImageLayer

Method Detail

add

()

method

public function add(mapImage:MapImage):void

Add an image to the map. The Map Image extent should have the same coordinate system as the map and be within the map's extent.

Parameters

mapImage:MapImage

getImageVisibility

()

method

public function getImageVisibility(mapImage:MapImage):Boolean

Gets the current visibility of the input MapImage.

Parameters

mapImage:MapImage

Returns

Boolean

remove

()

method

public function remove(mapImage:MapImage):void

Remove the specified image from the layer.

Parameters

mapImage:MapImage

removeAll

()

method

public function removeAll():void

Remove all images from the layer.

setImageVisibility

()

method

public function setImageVisibility(mapImage:MapImage, isVisible:Boolean):void

Set the visibility for the image.

Parameters

	`mapImage:MapImage`

	`isVisible:Boolean`

Wed Nov 30 2011, 04:19 PM -08:00

ArcGIS API for Flex 2.5	All Packages \| All Classes \| Index \| Frames No Frames
MapImageLayer	Properties \| Methods \| Events

Package	com.esri.ags.layers
Class	public class MapImageLayer
Inheritance	MapImageLayer Layer mx.core.UIComponent