Packagecom.esri.bacore.domain
Interfacepublic interface ILocationStudyArea extends IStudyArea, flash.utils.IExternalizable
Implementors LocationStudyArea

Since : Community Analyst API for Flex 2.2.

The ILocationStudyArea interface provides properties of a study area constructed around a location point. As an example, simple rings or drive-time areas could be constructed around the given location point.


Public Properties
 PropertyDefined By
  address : Object
Address of the location point.
ILocationStudyArea
 Inheriteddescription : String
Study area description.
IStudyArea
  donut : Boolean
Whether non-overlapping donut-style area bands are created instead of overlapping areas that all originate from the same location.
ILocationStudyArea
 InheritedfeatureSet : FeatureSet
Feature set associated with this study area.
IStudyArea
 Inheritedid : String
Study area ID.
IStudyArea
  location : Graphic
Graphic of the location point.
ILocationStudyArea
 Inheritedname : String
Study area name.
IStudyArea
  radii : Array
Array of radii of rings constructed around the location point.
ILocationStudyArea
  subtype : LocationStudySubtype
Subtype of location study.
ILocationStudyArea
  units : Object
The units of the radii parameter which were used for constructing the study area around the location point.
ILocationStudyArea
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.


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 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



© 2011 Esri, Inc. All rights reserved.

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