| Package | com.esri.bacore.domain |
| Class | public class StudyArea |
| Inheritance | StudyArea  flash.events.EventDispatcher |
| Implements | IStudyArea |
| Subclasses | GeographyStudyArea, LocationStudyArea, PolygonStudyArea |
| Since : | Business 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 | ||
| id : String
Study area ID. | StudyArea | ||
| name : String
Study area name. | StudyArea | ||
| type : StudyAreaType [read-only]
Type of the study area. | StudyArea | ||
| Method | Defined By | ||
|---|---|---|---|
Creates a new instance of the StudyArea class. | StudyArea | ||
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 | ||
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 | ||
| description | property |
description:StringStudy area description.
public function get description():String public function set description(value:String):void| featureSet | property |
featureSet:FeatureSetFeature set associated with this study area.
The feature set is required for a polygon study area. For a geography study area, a feature set is optional. In the case of a location study area, a feature set is required when such study area is used in report components.
public function get featureSet():FeatureSet public function set featureSet(value:FeatureSet):void| id | property |
id:StringStudy area ID.
By default study area IDs are enumerated from zero.
public function get id():String public function set id(value:String):void| name | property |
name:StringStudy area name.
public function get name():String public function set name(value:String):void| type | property |
type:StudyAreaType [read-only] | Since : | Business Analyst API for Flex 3.0. |
Type of the study area.
public function get type():StudyAreaType| StudyArea | () | Constructor |
public function StudyArea()Creates a new instance of the StudyArea class.
| readExternal | () | method |
public function readExternal(input:IDataInput):voidThe class implements this method to decode itself from a data stream by calling the methods of the IDataInput interface.
Parameters
input:IDataInput |
| toBoundaries | () | method |
public static function toBoundaries(studyArea:IStudyArea, combineGeographyFeatures:Boolean = false):ObjectConverts a geography study area to a FeatureSet or StandardLayer instance.
If the input study area is IGeographyStudyArea, it is converted to
a new instance of the StandardLayer class using the
GeographyStudyArea.toStandardLayer method. In other cases, the feature set of
the study area is tested to have the polygon geometry type and is returned.
If something wrong, the BARequestError error is thrown. If study area is null or empty
(its feature set has no features or its list of geography features is empty), null is returned.
Parameters
studyArea:IStudyArea — A study area to be converted.
| |
combineGeographyFeatures:Boolean (default = false) |
Object — An instance of FeatureSet or StandardLayer or null.
|
See also
| writeExternal | () | method |
public function writeExternal(output:IDataOutput):voidThe class implements this method to encode itself for a data stream by calling the methods of the IDataOutput interface.
Parameters
output:IDataOutput |