| Package | com.esri.bacore |
| Class | public final class BenchmarkOptions |
| Inheritance | BenchmarkOptions BaseEnum Object |
See also
| Property | Defined By | ||
|---|---|---|---|
| items : Array [static] [read-only]
Array of all items of this enumeration. | BenchmarkOptions | ||
![]() | value : String [read-only]
Value of the enumeration item. | BaseEnum | |
| Method | Defined By | ||
|---|---|---|---|
[static]
Converts a string value to the enumeration item. | BenchmarkOptions | ||
![]() | toString():String
Gets the value of the enumeration item. | BaseEnum | |
| Constant | Defined 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 | ||
| items | property |
items:Array [read-only] Array of all items of this enumeration.
public static function get items():Array| toEnumItem | () | method |
public static function toEnumItem(value:String, defaultItem:BenchmarkOptions = null):BenchmarkOptionsConverts 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.
|
BenchmarkOptions — A enumeration item or the default item.
|
| USE_AVERAGE_VALUES | Constant |
public static const USE_AVERAGE_VALUES:BenchmarkOptionsCreates the benchmark area by calculating average summarization values for all areas in trade area layers.
| USE_MEDIAN_VALUES | Constant |
public static const USE_MEDIAN_VALUES:BenchmarkOptionsCreates the benchmark area by calculating median summarization values for all areas in trade area layers.
| USE_NONE | Constant |
public static const USE_NONE:BenchmarkOptionsCreates a report without comparison with benchmark.
| USE_ONE_OF_THE_TRADE_AREAS | Constant |
public static const USE_ONE_OF_THE_TRADE_AREAS:BenchmarkOptionsSelects a benchmark area from a benchmark layer by its OID. Benchmark Layer and Benchmark Area OID parameters should be specified in benchmark report parameters.