| Package | mx.olap |
| Class | public class OLAPHierarchy |
| Inheritance | OLAPHierarchy  OLAPElement Proxy |
| Implements | IOLAPHierarchy |
| Subclasses | OLAPAttribute |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Show MXML Syntax
Hide MXML Syntax
The <mx:OLAPHierarchy> tag inherits all of the tag attributes
of its superclass, and adds the following tag attributes:
<mx:OLAPHierarchy
Properties
allMemberName="(All)"
elements="An array of Levels of this hierarchy"
hasAll="true|false"
name="No default"
/>
Default MXML Propertyelements
More examples
Related API Elements
| Property | Defined By | ||
|---|---|---|---|
| allMemberName : String
The name of the all member of the hierarchy. | OLAPHierarchy | ||
| children : IList [read-only]
The children of the all member, as a list of IOLAPMember instances. | OLAPHierarchy | ||
| defaultMember : IOLAPMember [read-only]
The default member of the hierarchy. | OLAPHierarchy | ||
 | dimension : IOLAPDimension
The dimension to which this element belongs. | OLAPElement | |
| displayName : String
The name of the OLAP element, as a String, which can be used for display. | OLAPElement | |
| elements : Array [write-only]
An Array of the levels of the hierarchy, as OLAPLevel instances. | OLAPHierarchy | ||
| hasAll : Boolean
Specifies whether the hierarchy has an all member, true,
or not, false. | OLAPHierarchy | ||
| levels : IList
All the levels of this hierarchy, as a list of IOLAPLevel instances. | OLAPHierarchy | ||
| members : IList [read-only]
All members of all the levels that belong to this hierarchy,
as a list of IOLAPMember instances. | OLAPHierarchy | ||
| name : String [override]
User defined name of this hierarchy. | OLAPHierarchy | ||
| uniqueName : String [read-only]
The unique name of the OLAP element in the cube. | OLAPElement | |
| Method | Defined By | ||
|---|---|---|---|
Constructor
| OLAPHierarchy | ||
Returns the level with the given name within the hierarchy. | OLAPHierarchy | ||
Returns the member with the given name within the hierarchy. | OLAPHierarchy | ||
|
Returns the unique name of the element. | OLAPElement | |
allMemberName | property |
allMemberName:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The name of the all member of the hierarchy.
The default value is "(All)".
Implementation
public function get allMemberName():String public function set allMemberName(value:String):voidchildren | property |
defaultMember | property |
defaultMember:IOLAPMember [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The default member of the hierarchy. The default member is used if the hierarchy is used where a member is expected.
Implementation
public function get defaultMember():IOLAPMemberelements | property |
hasAll | property |
hasAll:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Implementation
public function get hasAll():Boolean public function set hasAll(value:Boolean):voidlevels | property |
levels:IList| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Implementation
public function get levels():IList public function set levels(value:IList):voidmembers | property |
members:IList [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Implementation
public function get members():IListname | property |
name:String[override] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
User defined name of this hierarchy. If user has not set a explicit name then the dimension name is returned.
Implementation
override public function get name():String override public function set name(value:String):voidOLAPHierarchy | () | Constructor |
public function OLAPHierarchy(name:String = null, displayName:String = null)| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor
Parametersname:String (default = null) | |
displayName:String (default = null) |
findLevel | () | method |
public function findLevel(name:String):IOLAPLevel| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
|
Wed Nov 21 2018, 06:34 AM -08:00