com.afcomponents.umap.overlays.Polygon

	Property	Defined by
		asDisplayObject : DisplayObject Returns reference to the object as a DisplayObject instance.	MapObject
		autoCloseInfo : Boolean Gets or sets the autCloseInfo flag, which indicates whether to close info window automatically when user clicks somewhere on the map.	Overlay
		autoInfo : Boolean Gets or sets the autInfo flag, which indicates whether to open info window automatically upon mouse click.	Overlay
		clipping : Boolean	Polygon
		core : UMap Returns reference to the core UMap object.	MapObject
		data : * Gets or sets the data parameter of the Overlay.	Overlay
		description : String Gets or sets the description text of the Overlay.	Overlay
		draggable : Boolean Gets or sets Overlay's draggable property.	Overlay
		dragging : Boolean Indicates whether Overlay is being dragged at the moment.	Overlay
		id : uint Gets or sets the ID of the object.	MapObject
		info : IInfoWindow Return referens to opened InfoWindow	Overlay
		infoParam : Object Gets or sets the info window param object.	Overlay
		infoStyle : Object Gets or sets the info window style object associated with the Overlay.	Overlay
		name : String Gets or sets the name of the object.	Overlay
		owner : IMapObjectContainer Returns reference to the owner container object.	MapObject
		point : Point Returns the position of the Overlay in bitmap coordinates.	Overlay
		points : Array	Polygon
		position : LatLng Gets or set the geographical position of the Overlay.	Overlay
		smartPosition : Boolean Gets or sets the smartPosition flag, which indicates whether to use smart positioning with the Overlay.	Overlay
		smartPositionOffset : Number	Overlay
		visible : Boolean Gets or sets the Overlay's visibility.	Overlay
		zIndexAuto : Boolean Gets or sets zIndexAuto property which indicates wheter Overlay should be brought to front on mouse over event.	Overlay

	Method	Defined by
		Polygon(param:Object = null, style:Object = null)	Polygon
		addEventListeners(target:InteractiveObject = null):void Adds a built-in listener for MouseEvents fired by an InteractiveObject contained in the Overlay.	Overlay
		bringToFront():void Brings target Overlay to the top of the parent's display list.	Overlay
		clone():IOverlay Creates an exact copy of this Overlay and returns it to the user.	Overlay
		closeInfoWindow():void Closes info window that is currently opened.	Overlay
		dispose():void Releases all the resources accuired by the object.	Polygon
		dragStart():void Starts Overlay dragging.	Overlay
		dragStop():void Stops Overlay dragging.	Overlay
		fromXML(xml:XML, param:Object = null, style:Object = null, classObject:Class = null):Polygon [static] Creates new Polygon from XML object in KML 2.1 format.	Polygon
		getBoundsLatLng():LatLngBounds Retruns Overlay bounds in geographical coordinates.	Polygon
		getBoundsXY(zoom:Number = 0):Bounds Retruns Overlay bounds in bitmap coordinates.	Polygon
		getStyle():Object Returns a copy of the style object.	Polygon
		getVertex(index:uint, lineIndex:uint = 0):LatLng	Polygon
		getVertexCount(lineIndex:uint = 0):uint	Polygon
		hide():void Hides overlay.	Overlay
		invalidate():void Schedules the Overlay for invalidation in 1 frame after this call.	Overlay
		openInfoWindow(param:Object = null, style:Object = null):IInfoWindow Opens new info window with the specified parameters & style.	Overlay
		redraw():void Redraws the overlay.	Polygon
		refresh(full:Boolean = false):void Refreshes overlay position on the map.	Polygon
		remove():void Removes the object from the owner container object.	MapObject
		removeEventListeners(target:InteractiveObject = null):void Removes a built-in listener for MouseEvents fired by an InteractiveObject contained in the Overlay.	Overlay
		setOwner(owner:IMapObjectContainer):void Adds the object to the specified IMapObjectContainer.	MapObject
		setStyle(style:Object):void Sets the style for this Overlay from an Object or another Style.	Polygon
		show():void Shows overlay.	Overlay
		toString():String Returns a textual representation of the object.	MapObject
		toXML(full:Boolean = true, afcTags:Boolean = false):XML Builds an XML object in KML 2.1 format that describes the Overlay & it's style.	Polygon
		updateMapType(mapType:IMapType):void Invoked when map type has been changed.	Overlay
		updatePosition(latlng:LatLng):void Invoked when map center has been updated.	Overlay
		updateZoom(zoom:Number):void Invoked when map zoom has been updated.	Overlay

Events

	Summary	Defined by
infoWindowClosed	Dispatched when the InfoWindow has been closed with the `Overlay`	Overlay
infoWindowOpened	Dispatched when the InfoWindow has been opened with the `Overlay`	Overlay
overlaBeforeyRefresh	Dispatched when an `Overlay` position is about to be refreshed.	Overlay
overlayAdded	Dispatched when overlay has been added to a MapObjectContainer, e.g.	Overlay
overlayBeforeRedraw	Dispatched when an `Overlay` is about to be invalidated.	Overlay
overlayChanged	Dispatched when an `Overlay` has been changed.	Overlay
overlayDrag	Dispatched when user drags an `Overlay`.	Overlay
overlayDragStart	Dispatched when user starts dragging an `Overlay`.	Overlay
overlayDragStop	Dispatched when user stops dragging an `Overlay`.	Overlay
overlayHide	Dispatched when an `Overlay` has become invisible.	Overlay
overlayMouseDown	Dispatched when user presses a mouse button over an `Overlay`.	Overlay
overlayMouseMove	Dispatched when user moves the mouse over an `Overlay`.	Overlay
overlayMouseUp	Dispatched when user releases a mouse button over an `Overlay`.	Overlay
overlayReady	Dispatched when an `Overlay` enters ready state.	Overlay
overlayRedraw	Dispatched when an `Overlay` has been invalidated.	Overlay
overlayRefresh	Dispatched when an `Overlay` position has been refreshed.	Overlay
overlayRollOUt	Dispatched when user rolls out an `Overlay`.	Overlay
overlayRollOver	Dispatched when user rolls over an `Overlay`.	Overlay
overlayShow	Dispatched when an `Overlay` has become visible.	Overlay

Property detail

clipping

property

clipping:Boolean [read-write]

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

points

property

points:Array [read-write]

Implementation
public function get points():Array
public function set points(value:Array):void

Constructor detail

Polygon

()

constructor

public function Polygon(param:Object = null, style:Object = null)

Parameters

	`param:Object` (default = `null`)

	`style:Object` (default = `null`)

Method detail

dispose

()

method

public override function dispose():void

Releases all the resources accuired by the object.

fromXML

()

method

public static function fromXML(xml:XML, param:Object = null, style:Object = null, classObject:Class = null):Polygon

Creates new Polygon from XML object in KML 2.1 format.

Parameters

	`xml:XML` — XML object with root `<Container>` node which contains `Style` nodes and a single `<Placemark>` node.

	`param:Object` (default = `null`) — Default parameter object that will be passed to the object's constructor.

	`style:Object` (default = `null`) — Default style object that will be passed to the object's constructor.

	`classObject:Class` (default = `null`) — Custom class object that will be instantiated instead of the default one.

Returns

Polygon — New Polygon object.

Example
Here is a sample KML structure:

  <!-- Container id="ID" -->               <!-- Document,Folder -->
    <Style id="ID">
      <LineStyle id="ID">
        <!-- inherited from ColorStyle -->
        <color>ffffffff</color>            <!-- kml:color -->
        <colorMode>normal</colorMode>      <!-- colorModeEnum: normal or random -->
        <!-- specific to LineStyle -->
        <width>1</width>                   <!-- float -->
      </LineStyle> 
      <PolyStyle id="ID">
        <!-- inherited from ColorStyle -->
        <color>ffffffff</color>            <!-- kml:color -->
        <colorMode>normal</colorMode>      <!-- kml:colorModeEnum: normal or random -->
        <!-- specific to PolyStyle -->
        <fill>1</fill>                     <!-- boolean -->
        <outline>1</outline>               <!-- boolean -->
      </PolyStyle>
    </Style>
    <Placemark>
         <Polygon id="ID">
           <!-- specific to Polygon -->
           <outerBoundaryIs>
             <LinearRing>
               <coordinates>...</coordinates>         <!-- lon,lat[,alt] -->
             </LinearRing>
           </outerBoundaryIs>
           <innerBoundaryIs>
             <LinearRing>
               <coordinates>...</coordinates>         <!-- lon,lat[,alt] -->
             </LinearRing>
           </innerBoundaryIs>
         </Polygon>
       </Placemark>
  <-- /Container -->

getBoundsLatLng

()

method

public override function getBoundsLatLng():LatLngBounds

Retruns Overlay bounds in geographical coordinates.

Returns

LatLngBounds — Overlay bounding rectangle in geographical coordinates.

getBoundsXY

()

method

public override function getBoundsXY(zoom:Number = 0):Bounds

Retruns Overlay bounds in bitmap coordinates. Use zoom parameter to specify zoom level for bounds conversion.

Parameters

zoom:Number (default = 0) — Defines the zoom level at which to perform bounds conversion; if omitted, current zoom level will be used.

Returns

Bounds — Overlay bounding rectangle in bitmap coordinates.

getStyle

()

method

public override function getStyle():Object

Returns a copy of the style object.

Returns

Object — A clone of the current style object.

getVertex

()

method

public function getVertex(index:uint, lineIndex:uint = 0):LatLng

Parameters

	`index:uint`

	`lineIndex:uint` (default = `0`)

Returns

LatLng

getVertexCount

()

method

public function getVertexCount(lineIndex:uint = 0):uint

Parameters

lineIndex:uint (default = 0)

Returns

uint

redraw

()

method

public override function redraw():void

Redraws the overlay.

Override this method in your subclass and call super.redraw() immediately before actual redraw so that OverlayEvent.BEFORE_REDRAW event will be automatically fired. At the end of your drawing don't forget to manually fire OverlayEvent.REDRAW event.

refresh

()

method

public override function refresh(full:Boolean = false):void

Refreshes overlay position on the map. If the full paramter is set to true then bitmap coordinates for this overlay should be recalculated.

Parameters

full:Boolean (default = false) — Indicates whether to recalculate bitmap coordinats.

setStyle

()

method

public override function setStyle(style:Object):void

Sets the style for this Overlay from an Object or another Style. After setting the style, Overlay will be invalidated.

Parameters

style:Object — which contains style properties you wish to overwrite.

toXML

()

method

public override function toXML(full:Boolean = true, afcTags:Boolean = false):XML

Builds an XML object in KML 2.1 format that describes the Overlay & it's style. Flag full indicates whether to build a complete KML data or just a container.

Parameters

	`full:Boolean` (default = `true`) — A value of `true` if you want to return a full KML file with header; `false` if you want to get only a container with style and placemark nodes.

	`afcTags:Boolean` (default = `false`) — Flag that determines whether to generate KML data with extended AFC tags.

Returns

XML — XML object in KML 2.1 format.

UMap 1.4.3 - API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class Polygon	Properties \| Methods \| Events

Package	com.afcomponents.umap.overlays
Class	public class Polygon
Inheritance	Polygon Overlay MapObject flash.display.Sprite
Subclasses	Circle