| XLCubed is now FluenceXL. The new wiki can be found here: https://help.fluencexl.com/ |
Difference between revisions of "XL3MemberSet"
(Created page with 'Returns a reference to a set that can be used by other XLCubed formulae, for example the XL3RankLookup formula. ==Syntax== {{Code|XL3MemberSet( Connection, Hie…') |
|||
| Line 60: | Line 60: | ||
|} | |} | ||
| − | + | ==Examples== | |
| + | |||
| + | ''For examples see [[XL3DataSeriesLookup]] or [[XL3RankLookup]].'' | ||
==See Also== | ==See Also== | ||
Latest revision as of 09:18, 12 October 2010
Returns a reference to a set that can be used by other XLCubed formulae, for example the XL3RankLookup formula.
Syntax
XL3MemberSet( Connection, Hierarchy, Member, Function, [Parameter] )
Parameters
| Parameter | Description |
|---|---|
| Connection | Connection number to use |
| Hierarchy | The hierarchy of the following member |
| Member | The member to define the set relative to. Can also be a level |
| Function | The set function to use |
| Parameter | For set functions that require one, the parameter to use. |
Available Set Functions
| Set Function | Returns | Parameter Required |
|---|---|---|
| Member | A reference to a set containing only the specified member. | |
| Children | A reference to the children of the specified member. | |
| FirstChild | A reference to a set containing the first child of the specified member. | |
| LastChild | A reference to a set containing the last child of the specified member. | |
| Descendants | A reference to all the descendants of the specified member. | |
| LowestDescendants | A reference to the lowest level descendants of the specified member. | |
| DescendantsAt | A reference to the members of the descendants of the given member. Parameter should be either a number specifying the distance, or a level unique name to return the descendants for. | Yes |
| Next | A reference to the specified member and the next N members, specified by Parameter. | Yes |
| Prev | A reference to the specified member and the previous N members, specified by Parameter. | Yes |
| Siblings | A reference to the members at the same level as the specified member. | |
| Parent | A reference to a set containing the parent of the specified member. | |
| Ancestors | A reference to all the ancestors of the specified member. | |
| FirstSibling | A reference to a set containing the first sibling of the specified member. | |
| LastSibling | A reference to a set containing the last sibling of the specified member. | |
| LevelMembers | A reference to the members of a level. The Member parameter should be a level unique name instead of a member unique name. |
Examples
For examples see XL3DataSeriesLookup or XL3RankLookup.
