Packagecom.esri.bacore
Classpublic final class BenchmarkSortOptions
InheritanceBenchmarkSortOptions Inheritance BaseEnum Inheritance Object

The BenchmarkSortOptions class provides an enumeration of report fields sorting options used in the creation of a Benchmark report.

See also

BenchmarkReportParameters - Community Analyst
BenchmarkReportParameters - Business Analyst Server


Public Properties
 PropertyDefined By
  items : Array
[static] [read-only] Array of all items of this enumeration.
BenchmarkSortOptions
 Inheritedvalue : String
[read-only] Value of the enumeration item.
BaseEnum
Public Methods
 MethodDefined By
  
toEnumItem(value:String, defaultItem:BenchmarkSortOptions = null):BenchmarkSortOptions
[static] Converts a string value to the enumeration item.
BenchmarkSortOptions
 Inherited
toString():String
Gets the value of the enumeration item.
BaseEnum
Public Constants
 ConstantDefined By
  SORT_BY_FIELD_DIFFERENCE : BenchmarkSortOptions
[static] Sort by difference between field value and benchmark field value.
BenchmarkSortOptions
  SORT_BY_FIELD_INDEX : BenchmarkSortOptions
[static] Sort by field index.
BenchmarkSortOptions
  SORT_BY_FIELD_ONLY : BenchmarkSortOptions
[static] Sort by field value.
BenchmarkSortOptions
  SORT_BY_FIELD_PERCENT : BenchmarkSortOptions
[static] Sort by percentage of field value with respect to benchmark field value.
BenchmarkSortOptions
  SORT_NONE : BenchmarkSortOptions
[static] No sorting.
BenchmarkSortOptions
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:BenchmarkSortOptions = null):BenchmarkSortOptions

Converts a string value to the enumeration item.

Parameters

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

Returns
BenchmarkSortOptions — A enumeration item or the default item.
Constant Detail
SORT_BY_FIELD_DIFFERENCEConstant
public static const SORT_BY_FIELD_DIFFERENCE:BenchmarkSortOptions

Sort by difference between field value and benchmark field value.

SORT_BY_FIELD_INDEXConstant 
public static const SORT_BY_FIELD_INDEX:BenchmarkSortOptions

Sort by field index.

SORT_BY_FIELD_ONLYConstant 
public static const SORT_BY_FIELD_ONLY:BenchmarkSortOptions

Sort by field value.

SORT_BY_FIELD_PERCENTConstant 
public static const SORT_BY_FIELD_PERCENT:BenchmarkSortOptions

Sort by percentage of field value with respect to benchmark field value.

SORT_NONEConstant 
public static const SORT_NONE:BenchmarkSortOptions

No sorting.