Packagecom.esri.bacore.domain
Classpublic class PolygonStudyArea
InheritancePolygonStudyArea Inheritance StudyArea Inheritance flash.events.EventDispatcher
Implements IPolygonStudyArea

Since : Business Analyst API for Flex 2.2.

The PolygonStudyArea class is the default implementation of IPolygonStudyArea interface.



Public Properties
 PropertyDefined By
  area : Number
Area of the study area.
PolygonStudyArea
 Inheriteddescription : String
Study area description.
StudyArea
 InheritedfeatureSet : FeatureSet
Feature set associated with this study area.
StudyArea
 Inheritedid : String
Study area ID.
StudyArea
 Inheritedname : String
Study area name.
StudyArea
  type : StudyAreaType
[override] [read-only] Type of the study area.
PolygonStudyArea
  units : Object
The units in which the area parameter is measured.
PolygonStudyArea
Public Methods
 MethodDefined By
  
Creates a new instance of the PolygonStudyArea class.
PolygonStudyArea
  
readExternal(input:IDataInput):void
[override] The class implements this method to decode itself from a data stream by calling the methods of the IDataInput interface.
PolygonStudyArea
 Inherited
toBoundaries(studyArea:IStudyArea, combineGeographyFeatures:Boolean = false):Object
[static] Converts a geography study area to a FeatureSet or StandardLayer instance.
StudyArea
  
writeExternal(output:IDataOutput):void
[override] The class implements this method to encode itself for a data stream by calling the methods of the IDataOutput interface.
PolygonStudyArea
Property Detail
areaproperty
area:Number

Area of the study area.


Implementation
    public function get area():Number
    public function set area(value:Number):void
typeproperty 
type:StudyAreaType  [read-only] [override]

Since : Business Analyst API for Flex 3.0.

Type of the study area.


Implementation
    public function get type():StudyAreaType
unitsproperty 
units:Object

Since : Business Analyst API for Flex 3.0.

The units in which the area parameter is measured.

It is recommended to use constants from the com.esri.ags.Units class.


Implementation
    public function get units():Object
    public function set units(value:Object):void
Constructor Detail
PolygonStudyArea()Constructor
public function PolygonStudyArea()

Creates a new instance of the PolygonStudyArea class.

Method Detail
readExternal()method
override public function readExternal(input:IDataInput):void

The class implements this method to decode itself from a data stream by calling the methods of the IDataInput interface.

Parameters

input:IDataInput

writeExternal()method 
override public function writeExternal(output:IDataOutput):void

The class implements this method to encode itself for a data stream by calling the methods of the IDataOutput interface.

Parameters

output:IDataOutput