XLCubed is now FluenceXL. The new wiki can be found here: https://help.fluencexl.com/ |
XL3MemberNavigate
Returns a member based on its relationship to the member passed in. Allows you to navigate a hierarchy, moving between members and levels using formulae alone.
You can combine formulae, for example to move up a hierarchy, then along the level you get to.
Use the Insert Formula > Member Navigate menu or ribbon item to insert the formula using a wizard.
Contents
[hide]Syntax
XL3MemberNavigate( Connection, Hierarchy, Member or Level, Relationship, [Index], [Hierarchy1], [Member1],…, [Hierarchy100], [Member100] )
Parameters
Parameter | Description |
---|---|
Connection | Connection number to use |
Hierarchy | Name of the hierarchy that the member applies to e.g. "Measures" or "[Customer].[Customer Geography]" |
Member or Level | Members or Level to use as starting position |
Relationship | Relationship of the desired member to the Member or Level passed in, see below |
Index | Index of the member in the Relationship, meaning depends on the Relationship |
Hierarchy1,…, HierarchyN | Name of the hierarchy that the following member applies to e.g. "Measures" or "[Customer].[Customer Geography]" |
Member1,…, MemberN | Either a single member unique name or an XL3Member formula in order to specify that only non-empty members should be returned |
Relationship types
The valid relationship types are as follows, and the meaning of the Index parameter is decribed for each.
Relationship | Member or Level | Description |
---|---|---|
FirstMember | Level | By default returns the first member of the specified level. If the Index parameter is passed as 'x' it gets the xth member of the level. |
LastMember | Level | By default returns the last member of the specified level. If the Index parameter is passed as 'x' it gets the xth member from the end of the level. |
Members | Level | Equivalent to FirstMember or LastMember. If index is positive it acts like FirstMember, if it is negative it acts like LastMember. |
Parent | Member | Gets the parent of the member passed in. If index is 2, it will retreive the grandparent (parent of the parent), 3 the great-grandparent etc. |
ParentAtLevel | Member | Gets the parent or ancestor of the member passed in. If the index parameter is passed this is the level number the parent must come from. Level number is one-based. (new in Version 8) |
Next | Member | Gets the next member following the member passed in. If index is greater than one then it skips forwards that number of members. |
Previous | Member | Gets the previous member preceding the member passed in. If index is greater than one then it skips backwards that number of members. |
FirstSibling | Member | Gets the first member with the same parent as the member passed in. If index is greater than one then it gets the child at that index. |
LastSibling | Member | Gets the last member with the same parent as the member passed in. If index is greater than one then it gets the child at that index from the last sibling. |
Siblings | Member | Equivalent to FirstSibling or LastSibling. If index is positive it acts like FirstSibling, if it is negative it acts like LastSibling. |
FirstChild | Member | Gets the first child of the member passed in. If index is greater than one then it gets the child as that index. |
LastChild | Member | Gets the last child of the member passed in. If index is greater than one then it gets the child at that index from the last child. |
Children | Member | Equivalent to FirstChild or LastChild. If index is positive it acts like FirstChild, if it is negative it acts like LastChild. |
FirstDescendantAtLevel | Member | Gets the first descendant of the member at a level specified by index. Index is one based. (New in V7.1) |
LastDescendantAtLevel | Member | Gets the last descendant of the member at a level specified by index. Index is one based. (New in V7.1) |
FirstDescendantAtDistance | Member | Gets the first descendant of the member at a distance specified by index. An index of one is equivalent of children. (New in V7.1) |
LastDescendantAtDistance | Member | Gets the last descendant of the member at a distance specified by index. An index of one is equivalent of children. (New in V7.1) |
DefaultMember | Any | Gets the default member for the hierarchy. (New in Version 7.6) |
Item | Level | If the Index parameter is passed as 'x' it gets the xth member of the level. Useful as it also supports sets using the MdxSet: syntax (New in Version 8.1) |
Non-Empty behaviour
Sometimes you need to restrict the members by those with data. To do this you can specify hierarchy/member pairs for which data must exist.
For example you may want the last date where data exists. To do this you could add a measure to a XL3MemberNavigate on the LastMember of a level.
For example:
=XL3MemberNavigate(1,"[Date].[Calendar]","[Date].[Calendar].[Date]","LastMember")
- August 31, 2004
=XL3MemberNavigate(1,"[Date].[Calendar]","[Date].[Calendar].[Date]","LastMember", 1, "[Measures]", "[Measures].[Reseller Sales Amount]")
- June 1, 2004
Examples (based on the Bicycle Sales cube)
Level Relationships
These examples assume that [Time].[Year] is in cell A1
=XL3MemberNavigate( 1, "Time", A1, "FirstMember" )
- 2002
=XL3MemberNavigate( 1, "Time", A1, "LastMember", 2 )
- 2004
Member Relationships
These examples assume that [Time].[All].&[2003].&[Q2] is in cell A1
=XL3MemberNavigate( 1, "Time", A1, "Parent" )
- 2003
=XL3MemberNavigate( 1, "Time", A1, "Parent", 2 )
- All
=XL3MemberNavigate( 1, "Time", A1, "Next" )
- Q3
=XL3MemberNavigate( 1, "Time", A1, "Previous", 2 )
- Q4 (from 2002)
=XL3MemberNavigate( 1, "Time", A1, "FirstSibling" )
- Q1
=XL3MemberNavigate( 1, "Time", A1, "LastSibling", 2 )
- Q3
=XL3MemberNavigate( 1, "Time", A1, "FirstChild" )
- April 2003
=XL3MemberNavigate( 1, "Time", A1, "LastChild", 2 )
- May 2003