Package | com.esri.bacore.adapters |
Class | public class ComparisonParameters |
Inheritance | ComparisonParameters Object |
Since : | Community Analyst API for Flex 2.2. |
See also
Property | Defined By | ||
---|---|---|---|
benchmark : BenchmarkItem
A benchmark to make comparison with. | ComparisonParameters | ||
respectiveGeographies : Array
Array of geography features containing IGeographyFeature items. | ComparisonParameters | ||
studyAreas : Array
Array of study areas containing IStudyArea items. | ComparisonParameters | ||
summarizations : Array
Array of String items containing names of variables to make comparison by. | ComparisonParameters |
Method | Defined By | ||
---|---|---|---|
Creates a new instance of the ComparisonParameters class. | ComparisonParameters | ||
getBenchmarkObject():Object
Tests the correctness of the benchmark and returns the benchmark object encapsulated within. | ComparisonParameters |
benchmark | property |
benchmark:BenchmarkItem
A benchmark to make comparison with.
public function get benchmark():BenchmarkItem
public function set benchmark(value:BenchmarkItem):void
respectiveGeographies | property |
respectiveGeographies:Array
Array of geography features containing IGeographyFeature items.
public function get respectiveGeographies():Array
public function set respectiveGeographies(value:Array):void
See also
studyAreas | property |
studyAreas:Array
Array of study areas containing IStudyArea items.
public function get studyAreas():Array
public function set studyAreas(value:Array):void
See also
summarizations | property |
summarizations:Array
Array of String items containing names of variables to make comparison by.
public function get summarizations():Array
public function set summarizations(value:Array):void
ComparisonParameters | () | Constructor |
public function ComparisonParameters()
Creates a new instance of the ComparisonParameters class.
getBenchmarkObject | () | method |
public function getBenchmarkObject():Object
Tests the correctness of the benchmark and returns the benchmark object encapsulated within.
This method tests that only one instance is specified in the benchmark: either benchmarkArea or benchmarkFeature or benchmarkOptions. If more than one instance is specified, the method throws BARequestError.
ReturnsObject — IStudyArea or IGeographyFeature or BenchmarkOptions or null.
|
See also