Package | mx.olap |
Interface | public interface IOLAPHierarchy extends IOLAPElement |
Implementors | OLAPHierarchy |
See also
Property | Defined By | ||
---|---|---|---|
allMemberName : String [read-only]
The name of the all member of the hierarchy. | IOLAPHierarchy | ||
children : IList [read-only]
The children of the all member, as a list of IOLAPMember instances. | IOLAPHierarchy | ||
defaultMember : IOLAPMember [read-only]
The default member of the hierarchy. | IOLAPHierarchy | ||
![]() | dimension : IOLAPDimension [read-only]
The dimension to which this element belongs. | IOLAPElement | |
![]() | displayName : String [read-only]
The name of the OLAP element, as a String, which can be used for display. | IOLAPElement | |
hasAll : Boolean [read-only]
Specifies whether the hierarchy has an all member, true,
or not, false. | IOLAPHierarchy | ||
levels : IList [read-only]
All the levels of this hierarchy, as a list of IOLAPLevel instances. | IOLAPHierarchy | ||
members : IList [read-only]
All members of all the levels that belong to this hierarchy,
as a list of IOLAPMember instances. | IOLAPHierarchy | ||
![]() | name : String [read-only]
The name of the OLAP element that includes the OLAP schema hierarchy of the element. | IOLAPElement | |
![]() | uniqueName : String [read-only]
The unique name of the OLAP element in the cube. | IOLAPElement |
Method | Defined By | ||
---|---|---|---|
Returns the level with the given name within the hierarchy. | IOLAPHierarchy | ||
Returns the member with the given name within the hierarchy. | IOLAPHierarchy |
allMemberName | property |
allMemberName:String
[read-only] The name of the all member of the hierarchy.
The default value is "(All)".
public function get allMemberName():String
children | property |
children:IList
[read-only] The children of the all member, as a list of IOLAPMember instances.
public function get children():IList
defaultMember | property |
defaultMember:IOLAPMember
[read-only] The default member of the hierarchy. The default member is used if the hierarchy is used where a member is expected.
public function get defaultMember():IOLAPMember
hasAll | property |
hasAll:Boolean
[read-only]
Specifies whether the hierarchy has an all member, true
,
or not, false
. If true
, the all member name
is as specified by the allMemberName
property.
The default value is true.
public function get hasAll():Boolean
levels | property |
levels:IList
[read-only] All the levels of this hierarchy, as a list of IOLAPLevel instances. The returned list might represent remote data and therefore can throw an ItemPendingError.
public function get levels():IList
members | property |
members:IList
[read-only] All members of all the levels that belong to this hierarchy, as a list of IOLAPMember instances. The returned list might represent remote data and therefore can throw an ItemPendingError.
public function get members():IList
findLevel | () | method |
public function findLevel(name:String):IOLAPLevel
Returns the level with the given name within the hierarchy.
Parameters
name:String — The name of the level.
|
IOLAPLevel — An IOLAPLevel instance representing the level,
or null if a level is not found.
|
findMember | () | method |
public function findMember(name:String):IOLAPMember
Returns the member with the given name within the hierarchy.
Parameters
name:String — The name of the member.
|
IOLAPMember — An IOLAPMember instance representing the member,
or null if a member is not found.
|