| Package | com.esri.bacore.domain |
| Class | public class GeographyStudyArea |
| Inheritance | GeographyStudyArea  StudyArea flash.events.EventDispatcher |
| Implements | IGeographyStudyArea |
| Since : | Community Analyst API for Flex 2.2. |
| Property | Defined By | ||
|---|---|---|---|
 | description : String
Study area description. | StudyArea | |
| featureSet : FeatureSet
Feature set associated with this study area. | StudyArea | |
| geographies : IList
List of geography features consisting of IGeographyFeature items. | GeographyStudyArea | ||
| id : String
Study area ID. | StudyArea | |
| name : String
Study area name. | StudyArea | |
| Method | Defined By | ||
|---|---|---|---|
Creates a new instance of the GeographyStudyArea class. | GeographyStudyArea | ||
| readExternal(input:IDataInput):void
The class implements this method to decode itself from a data stream by calling the methods of the IDataInput interface. | StudyArea | |
| toBoundaries(studyArea:IStudyArea, combineGeographyFeatures:Boolean = false):Object [static]
Converts a geography study area to a FeatureSet or StandardLayer instance. | StudyArea | |
[static]
Converts a geography study area to a new instance of the standard layer. | GeographyStudyArea | ||
| writeExternal(output:IDataOutput):void
The class implements this method to encode itself for a data stream by calling the methods of the IDataOutput interface. | StudyArea | |
| geographies | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesgeographies:IList
List of geography features consisting of IGeographyFeature items.
The list of geographies implemented in this class is an instance of the ArrayCollection class. When another collection is set as this property value, this collection is cleared and members of another collection are added to this collection.
public function get geographies():IList public function set geographies(value:IList):voidSee also
| GeographyStudyArea | () | Constructor |
public function GeographyStudyArea()Creates a new instance of the GeographyStudyArea class.
| toStandardLayer | () | method |
public static function toStandardLayer(studyArea:IGeographyStudyArea, combineFeatures:Boolean = false):StandardLayerConverts a geography study area to a new instance of the standard layer.
The method tests that at least one geography feature has the specified level ID and there are no different level IDs in the geography features. If testing fails, the BARequestError error is thrown. If the studyArea is null or its list of geography features is empty, null value is returned.
Parameters
studyArea:IGeographyStudyArea — Geography study area to be converted.
| |
combineFeatures:Boolean (default = false) |
StandardLayer — A new standard layer or null.
|