Packagecom.esri.bacore
Classpublic final class BenchmarkOptions
InheritanceBenchmarkOptions Inheritance BaseEnum

The BenchmarkOptions class provides an enumeration of methods used in the creation of a benchmark area.

See also

com.esri.bao.tasks.reports.BenchmarkReportParameters


Public Properties
 PropertyDefined by
  items : Array
[static][read-only] Array of all items of this enumeration.
BenchmarkOptions
 Inheritedvalue : String
Value of the enumeration item.
BaseEnum
Public Methods
 MethodDefined by
  
toEnumItem(value:String, defaultItem:BenchmarkOptions = null):BenchmarkOptions
[static] Converts a string value to the enumeration item.
BenchmarkOptions
 Inherited
toString():String
Gets the value of the enumeration item.
BaseEnum
Public Constants
 ConstantDefined by
  USE_AVERAGE_VALUES : BenchmarkOptions
[static] Creates the benchmark area by calculating average summarization values for all areas in trade area layers.
BenchmarkOptions
  USE_MEDIAN_VALUES : BenchmarkOptions
[static] Creates the benchmark area by calculating median summarization values for all areas in trade area layers.
BenchmarkOptions
  USE_NONE : BenchmarkOptions
[static] Creates a report without comparison with benchmark.
BenchmarkOptions
  USE_ONE_OF_THE_TRADE_AREAS : BenchmarkOptions
[static] Selects a benchmark area from a benchmark layer by its OID.
BenchmarkOptions
Property detail
itemsproperty
items:Array  [read-only]

Array of all items of this enumeration.

Implementation
    public static function get items():Array
Method detail
toEnumItem()method
public static function toEnumItem(value:String, defaultItem:BenchmarkOptions = null):BenchmarkOptions

Converts a string value to the enumeration item.

Parameters
value:String — String value of the enumeration.
 
defaultItem:BenchmarkOptions (default = null) — A enumeration value to be used if the value is not recognized.

Returns
BenchmarkOptions — A enumeration item or the default item.
Constant detail
USE_AVERAGE_VALUESconstant
public static const USE_AVERAGE_VALUES:BenchmarkOptions

Creates the benchmark area by calculating average summarization values for all areas in trade area layers.

USE_MEDIAN_VALUESconstant 
public static const USE_MEDIAN_VALUES:BenchmarkOptions

Creates the benchmark area by calculating median summarization values for all areas in trade area layers.

USE_NONEconstant 
public static const USE_NONE:BenchmarkOptions

Creates a report without comparison with benchmark.

USE_ONE_OF_THE_TRADE_AREASconstant 
public static const USE_ONE_OF_THE_TRADE_AREAS:BenchmarkOptions

Selects a benchmark area from a benchmark layer by its OID. Benchmark Layer and Benchmark Area OID parameters should be specified in benchmark report parameters.