Package | com.esri.bacore.domain |
Class | public class LocationStudyArea |
Inheritance | LocationStudyArea StudyArea flash.events.EventDispatcher |
Implements | ILocationStudyArea |
Since : | Community Analyst API for Flex 2.2. |
Property | Defined By | ||
---|---|---|---|
address : Object
Address of the location point. | LocationStudyArea | ||
description : String
Study area description. | StudyArea | ||
donut : Boolean
Whether non-overlapping donut-style area bands are created
instead of overlapping areas that all originate from the same location. | LocationStudyArea | ||
featureSet : FeatureSet
Feature set associated with this study area. | StudyArea | ||
id : String
Study area ID. | StudyArea | ||
location : Graphic
Graphic of the location point. | LocationStudyArea | ||
name : String
Study area name. | StudyArea | ||
radii : Array
Array of radii of rings constructed around the location point. | LocationStudyArea | ||
subtype : LocationStudySubtype
Subtype of the location study. | LocationStudyArea | ||
units : Object
The units of the radii parameter which were used
for constructing the study area around the location point. | LocationStudyArea |
Method | Defined By | ||
---|---|---|---|
LocationStudyArea(subtype:LocationStudySubtype = null)
Creates a new instance of the LocationStudyArea class. | LocationStudyArea | ||
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 |
address | property |
address:Object
Address of the location point.
public function get address():Object
public function set address(value:Object):void
donut | property |
donut:Boolean
Whether non-overlapping donut-style area bands are created instead of overlapping areas that all originate from the same location.
The default value is false
.
public function get donut():Boolean
public function set donut(value:Boolean):void
location | property |
location:Graphic
Graphic of the location point.
public function get location():Graphic
public function set location(value:Graphic):void
radii | property |
radii:Array
Array of radii of rings constructed around the location point.
public function get radii():Array
public function set radii(value:Array):void
subtype | property |
subtype:LocationStudySubtype
Subtype of the location study.
public function get subtype():LocationStudySubtype
public function set subtype(value:LocationStudySubtype):void
units | property |
units:Object
The units of the radii
parameter which were used
for constructing the study area around the location point.
It is recommended to use constants from the com.esri.ags.Units
class for a simple-ring study area and constants from the DriveTimeUnits
class for drive-time/drive-distance study area.
public function get units():Object
public function set units(value:Object):void
LocationStudyArea | () | Constructor |
public function LocationStudyArea(subtype:LocationStudySubtype = null)
Creates a new instance of the LocationStudyArea class.
Parameterssubtype:LocationStudySubtype (default = null ) — of the location study area.
|