Packagecom.esri.ags.components
Classpublic class InfoWindow
InheritanceInfoWindow Inheritance InfoContainer Inheritance mx.core.Container

InfoWindow is used to display custom content on the map or the attributes of a graphic based on its infoWindowRenderer property.
Default infowindowrenderer Custom CSS infowindowrenderer Orange infowindow without close button Custom InfoWindow with image
Standard InfoWindow(see sample)Styled InfoWindow(see sample)Styled InfoWindow(see Concepts)    Custom InfoWindow(see sample)
Table 1: Examples of InfoWindows components.

See also

com.esri.ags.Map.infoWindow
Live sample - Using infoWindow on rollover
Live sample - Show Geoprocessing result in InfoWindow
Live sample - Show FeatureLayer feature in InfoWindow
Live sample - Show Locator result in InfoWindow
Live sample - Styling InfoWindow with CSS

Public Properties
 PropertyDefined By
 InheritedanchorX : Number
The anchor X location in pixels.
InfoContainer
 InheritedanchorY : Number
The anchor Y location in pixels.
InfoContainer
  closeButtonVisible : Boolean
Whether to display the close button in the upper right corner.
InfoWindow
  content : UIComponent
The info window content.
InfoWindow
  contentOwner : Object
The content owner.
InfoWindow
  labelVisible : Boolean
Whether to display the label in the upper left corner.
InfoWindow
 Inheritedmap : Map
[read-only] Get a reference the Map instance.
InfoContainer
Public Methods
 MethodDefined By
  
hide():void
Hide the info window.
InfoWindow
  
show(mapPoint:MapPoint):void
Shows the info window at a specific location.
InfoWindow
Events
 Event Summary Defined By
  
close
Fires when an InfoWindow is closed.InfoWindow
Styles
 Style Description Defined By
 Inherited
borderAlpha
Type: Number CSS Inheritance: no
The alpha transparency of the border [added in version 1.3].		InfoContainer
 Inherited
borderColor
Type: uint Format: Color CSS Inheritance: no
The color of the border [added in version 1.		InfoContainer
 Inherited
borderSkin
Type: Class CSS Inheritance: no
The border skin class of the component.		InfoContainer
 Inherited
borderThickness
Type: Number Format: Length CSS Inheritance: no
Thickness of the border [added in version 1.		InfoContainer
 Inherited
infoOffsetW
Type: Number Format: Length CSS Inheritance: no
Number of pixels of the tail base.		InfoContainer
 Inherited
infoOffsetX
Type: Number Format: Length CSS Inheritance: no
Number of pixels in the horizontal direction to offset the info tail.		InfoContainer
 Inherited
infoOffsetY
Type: Number Format: Length CSS Inheritance: no
Number of pixels in the vertical direction to offset the info tail.		InfoContainer
 Inherited
infoPlacement
Type: String CSS Inheritance: no
The placement of the info container relative to its anchor point.		InfoContainer
 Inherited
infoPlacementMode
Type: String CSS Inheritance: no
The placement mode of the info container relative to its anchor point.		InfoContainer
 Inherited
lowerLeftRadius
Type: Number Format: Length CSS Inheritance: no
Radius of the lower left corner.		InfoContainer
 Inherited
lowerRightRadius
Type: Number Format: Length CSS Inheritance: no
Radius of the lower right corner.		InfoContainer
 Inherited
shadowAlpha
Type: Number CSS Inheritance: no
The alpha transparency value for the shadow color.		InfoContainer
 Inherited
shadowAngle
Type: Number CSS Inheritance: no
The angle of the shadow.		InfoContainer
 Inherited
shadowColor
Type: uint Format: Color CSS Inheritance: yes
The color of the shadow.		InfoContainer
 Inherited
shadowDistance
Type: Number CSS Inheritance: no
The offset distance for the shadow, in pixels.		InfoContainer
 Inherited
upperLeftRadius
Type: Number Format: Length CSS Inheritance: no
Radius of the upper left corner.		InfoContainer
 Inherited
upperRightRadius
Type: Number Format: Length CSS Inheritance: no
Radius of the upper right corner.		InfoContainer
Property Detail
closeButtonVisibleproperty
closeButtonVisible:Boolean

Whether to display the close button in the upper right corner.

The default value is true.


Implementation
    public function get closeButtonVisible():Boolean
    public function set closeButtonVisible(value:Boolean):void
contentproperty 
content:UIComponent

The info window content. Developers can hide the header label and close button using the labelVisible and closeButtonVisible properties. A component in the content can hide the info window by making content dispatch a CLOSE event.

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


Implementation
    public function get content():UIComponent
    public function set content(value:UIComponent):void
contentOwnerproperty 
public var contentOwner:Object

The content owner. Most of the time, the content owner is an instance of Graphic.

labelVisibleproperty 
labelVisible:Boolean

Whether to display the label in the upper left corner. This label is can be styled using InfoWindowLabel

The default value is true.


Implementation
    public function get labelVisible():Boolean
    public function set labelVisible(value:Boolean):void

See also

com.esri.ags.components.supportClasses.InfoWindowLabel
Method Detail
hide()method
public function hide():void

Hide the info window. This will dispatch an Event.CLOSE event.

show()method 
public function show(mapPoint:MapPoint):void

Shows the info window at a specific location.

Parameters

mapPoint:MapPoint — The location of the info window in map coordinates.

See also

com.esri.ags.components.supportClasses.InfoPlacement
Event Detail
close Event
Event Object Type: flash.events.Event
Event.type property = flash.events.Event.CLOSE

Fires when an InfoWindow is closed.




© 2008-2010 ESRI, Inc. All rights reserved.

Fri Jan 7 2011, 11:30 AM -08:00