Packagecom.flexmonster.pivot.vo
Classpublic class HierarchyValueObject
InheritanceHierarchyValueObject Inheritance Object

The HierarchyValueObject class describes hierarchy.



Public Properties
 PropertyDefined By
  caption : String
Hierarchy caption.
HierarchyValueObject
  dimensionCaption : String
Caption of the dimension
HierarchyValueObject
  dimensionUniqueName : String
Unique name of the dimension to which hierarchy will be added.
HierarchyValueObject
  folder : String
Hierarchy folder.
HierarchyValueObject
  sort : String
Deprecated Since version 1.901
Sorting type for the members.
HierarchyValueObject
  sortName : String = asc
Sorting type for the members.
HierarchyValueObject
  type : String = string
Data type.
HierarchyValueObject
  uniqueName : String
Hierarchy unique name, this property will be used as an identifier for the hierarchy.
HierarchyValueObject
Public Methods
 MethodDefined By
  
HierarchyValueObject(dimensionUniqueName:String, uniqueName:String, caption:String, sortName:String = asc, type:String = string)
HierarchyValueObject
  
[static] Convert object to HierarchyValueObject class
HierarchyValueObject
  
toObject():Object
Convert HierarchyValueObject to Object
HierarchyValueObject
Property Detail
captionproperty
public var caption:String

Hierarchy caption.

dimensionCaptionproperty 
public var dimensionCaption:String

Caption of the dimension

dimensionUniqueNameproperty 
public var dimensionUniqueName:String

Unique name of the dimension to which hierarchy will be added.

folderproperty 
public var folder:String

Hierarchy folder.

sortproperty 
sort:String
Deprecated Since version 1.901

Sorting type for the members.


Implementation
    public function get sort():String
    public function set sort(value:String):void

See also

sortNameproperty 
public var sortName:String = asc

Sorting type for the members. The following sort types can be applied: SortType.ASC, SortType.DESC or SortType.UNSORTED.

See also

typeproperty 
public var type:String = string

Data type. Possible values are DataFieldType.STRING, DataFieldType.NUMBER, DataFieldType.MONTH, DataFieldType.WEEKDAY, DataFieldType.DATE, DataFieldType.DATE_STRING, DataFieldType.HIERARCHICAL_DATE, DataFieldType.HIERARCHICAL_DATE_WITH_QUARTERS, DataFieldType.TIME, DataFieldType.DATETIME. Default value is DataFieldType.STRING.

See also

uniqueNameproperty 
public var uniqueName:String

Hierarchy unique name, this property will be used as an identifier for the hierarchy.

Constructor Detail
HierarchyValueObject()Constructor
public function HierarchyValueObject(dimensionUniqueName:String, uniqueName:String, caption:String, sortName:String = asc, type:String = string)



Parameters
dimensionUniqueName:String
 
uniqueName:String
 
caption:String
 
sortName:String (default = asc)
 
type:String (default = string)
Method Detail
fromObject()method
public static function fromObject(object:Object):HierarchyValueObject

Convert object to HierarchyValueObject class

Parameters

object:Object — object

Returns
HierarchyValueObject — HierarchyValueObject object
toObject()method 
public function toObject():Object

Convert HierarchyValueObject to Object

Returns
Object — object