Package | com.flexmonster.pivot.vo |
Class | public class HierarchyValueObject |
Inheritance | HierarchyValueObject ![]() |
Property | Defined 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 |
Method | Defined By | ||
---|---|---|---|
HierarchyValueObject(dimensionUniqueName:String, uniqueName:String, caption:String, sortName:String = asc, type:String = string) | HierarchyValueObject | ||
fromObject(object:Object):HierarchyValueObject [static]
Convert object to HierarchyValueObject class
| HierarchyValueObject | ||
toObject():Object
Convert HierarchyValueObject to Object
| HierarchyValueObject |
caption | property |
public var caption:String
Hierarchy caption.
dimensionCaption | property |
public var dimensionCaption:String
Caption of the dimension
dimensionUniqueName | property |
public var dimensionUniqueName:String
Unique name of the dimension to which hierarchy will be added.
folder | property |
public var folder:String
Hierarchy folder.
sort | property |
sort:String
Sorting type for the members.
public function get sort():String
public function set sort(value:String):void
See also
sortName | property |
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
type | property |
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
uniqueName | property |
public var uniqueName:String
Hierarchy unique name, this property will be used as an identifier for the hierarchy.
HierarchyValueObject | () | Constructor |
public function HierarchyValueObject(dimensionUniqueName:String, uniqueName:String, caption:String, sortName:String = asc, type:String = string)
dimensionUniqueName:String | |
uniqueName:String | |
caption:String | |
sortName:String (default = asc )
| |
type:String (default = string )
|
fromObject | () | method |
public static function fromObject(object:Object):HierarchyValueObject
Convert object to HierarchyValueObject class
Parameters
object:Object — object
|
HierarchyValueObject — HierarchyValueObject object
|
toObject | () | method |
public function toObject():Object
Convert HierarchyValueObject to Object
ReturnsObject — object
|