Packagecom.esri.bacore.domain
Classpublic class LocationStudyArea
InheritanceLocationStudyArea Inheritance StudyArea Inheritance flash.events.EventDispatcher
Implements ILocationStudyArea

Since : Community Analyst API for Flex 2.2.

The LocationStudyArea class is the default implementation of ILocationStudyArea interface.


Public Properties
 PropertyDefined By
  address : Object
Address of the location point.
LocationStudyArea
 Inheriteddescription : 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
 InheritedfeatureSet : FeatureSet
Feature set associated with this study area.
StudyArea
 Inheritedid : String
Study area ID.
StudyArea
  location : Graphic
Graphic of the location point.
LocationStudyArea
 Inheritedname : 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
Public Methods
 MethodDefined By
  
LocationStudyArea(subtype:LocationStudySubtype = null)
Creates a new instance of the LocationStudyArea class.
LocationStudyArea
 Inherited
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
 Inherited
toBoundaries(studyArea:IStudyArea, combineGeographyFeatures:Boolean = false):Object
[static] Converts a geography study area to a FeatureSet or StandardLayer instance.
StudyArea
 Inherited
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
Property Detail
addressproperty
address:Object

Address of the location point.


Implementation
    public function get address():Object
    public function set address(value:Object):void
donutproperty 
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.


Implementation
    public function get donut():Boolean
    public function set donut(value:Boolean):void
locationproperty 
location:Graphic

Graphic of the location point.


Implementation
    public function get location():Graphic
    public function set location(value:Graphic):void
radiiproperty 
radii:Array

Array of radii of rings constructed around the location point.


Implementation
    public function get radii():Array
    public function set radii(value:Array):void
subtypeproperty 
subtype:LocationStudySubtype

Subtype of the location study.


Implementation
    public function get subtype():LocationStudySubtype
    public function set subtype(value:LocationStudySubtype):void
unitsproperty 
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.


Implementation
    public function get units():Object
    public function set units(value:Object):void
Constructor Detail
LocationStudyArea()Constructor
public function LocationStudyArea(subtype:LocationStudySubtype = null)

Creates a new instance of the LocationStudyArea class.

Parameters
subtype:LocationStudySubtype (default = null) — of the location study area.



© 2011 Esri, Inc. All rights reserved.

Mon Dec 12 2011, 10:44 AM -08:00