Despite the COVID-19 outbreak, our team continues operating at full speed. We are always here to support and answer all your questions.

Feel free to reach out by filling this quick form.

Fill the form
Get Free Trial
  1. API reference
    1. Introduction
    2. Flexmonster()
  2. Objects
    1. All objects
    2. Report Object
    3. Data Source Object
    4. Mapping Object
    5. Slice Object
    6. Options Object
    7. Filtering
      1. Filter Object
      2. Number Query Object
      3. String Query Object
      4. Date Query Object
      5. Time Query Object
      6. Value Query Object
    8. Format Object
    9. Conditional Format Object
    10. Cell Data Object
    11. Chart Data Object
    12. Toolbar Object
    13. Chart Legend Data Object
  3. Methods
    1. All methods
    2. addCalculatedMeasure
    3. addCondition
    4. alert
    5. clear
    6. clearFilter
    7. clearXMLACache
    8. closeFieldsList
    9. collapseAllData
    10. collapseData
    11. connectTo
    12. customizeAPIRequest
    13. customizeCell
    14. customizeChartElement
    15. customizeContextMenu
    16. dispose
    17. expandAllData
    18. expandData
    19. exportTo
    20. getAllConditions
    21. getAllHierarchies
    22. getAllMeasures
    23. getCell
    24. getColumns
    25. getCondition
    26. getFilter
    27. getFlatSort
    28. getFormat
    29. getMeasures
    30. getMembers
    31. getOptions
    32. getReport
    33. getReportFilters
    34. getRows
    35. getSelectedCell
    36. getSort
    37. getXMLACatalogs
    38. getXMLACubes
    39. getXMLADataSources
    40. getXMLAProviderName
    41. load
    42. off
    43. on
    44. open
    45. openCalculatedValueEditor
    46. openFieldsList
    47. openFilter
    48. print
    49. refresh
    50. removeAllCalculatedMeasures
    51. removeAllConditions
    52. removeCalculatedMeasure
    53. removeCondition
    54. removeSelection
    55. runQuery
    56. save
    57. setFilter
    58. setFlatSort
    59. setFormat
    60. setOptions
    61. setReport
    62. setSort
    63. showCharts
    64. showGrid
    65. showGridAndCharts
    66. sortingMethod
    67. sortValues
    68. updateData
  4. Events
    1. All events
    2. afterchartdraw
    3. aftergriddraw
    4. beforegriddraw
    5. beforetoolbarcreated
    6. cellclick
    7. celldoubleclick
    8. chartclick
    9. datachanged
    10. dataerror
    11. datafilecancelled
    12. dataloaded
    13. drillthroughclose
    14. drillthroughopen
    15. exportcomplete
    16. exportstart
    17. fieldslistclose
    18. fieldslistopen
    19. filterclose
    20. filteropen
    21. loadingdata
    22. loadinglocalization
    23. loadingolapstructure
    24. loadingreportfile
    25. localizationerror
    26. localizationloaded
    27. olapstructureerror
    28. olapstructureloaded
    29. openingreportfile
    30. printcomplete
    31. printstart
    32. querycomplete
    33. queryerror
    34. ready
    35. reportchange
    36. reportcomplete
    37. reportfilecancelled
    38. reportfileerror
    39. runningquery
    40. update
  5. Custom data source API
    1. All requests
    2. /handshake request
    3. /fields request
    4. /members request
    5. /select request for the pivot table
    6. /select request for the flat table
    7. /select request for the drill-through view
    8. Field Object
    9. Filter Object
  6. MongoDB Connector API
    1. All methods
    2. getSchema
    3. getMembers
    4. getSelectResult
Table of contents

getMembers

getMembers(hierarchyName: String, memberName: String, callbackHandler: Function): Array

[starting from version: 1.6]

Returns a list of members for the specified hierarchy.

CSV data source. If the hierarchy has more than one level the method returns a tree where each member has a list of its children. It is enough to specify hierarchyName parameter only.

OLAP data source. If the hierarchy has more than one level the method returns only the members for the first level. To get children of the member, you should call getMembers() with hierarchyName, memberName and callbackHandler parameters.

Parameters

  • hierarchyName – String. The name of the hierarchy.
  • memberName (optional) – String. The hierarchy’s member name. This parameter can be an empty string, only the members for the first level of the hierarchy will be returned.
  • callbackHandler (optional) – Function. A callback handler becomes useful when you work with OLAP data sources and you are not really sure whether you have got all list of members taken in completely or not. OLAP data source is not loaded for the whole data from the moment of call but will be loaded on demand. A callback handler will be called by the component to pass the result asynchronously when the list of members is loaded. If you have already loaded the specified hierarchy members’ list into the component, callbackHandler will return instantly the result of the object.

Returns

An array of objects with member’s caption, uniqueName, hierarchyName, children, isLeaf and parentMember properties.

If data load is in progress and callbackHandler is not set, an empty array will be returned.

Examples

1) CSV data source, where Category hierarchy has only one level:

flexmonster.getMembers("Category"); 

/* method returns an array of objects
[
  {caption: "Accessories", hierarchyName: "Category",
uniqueName: "category.[accessories]", children: [],
isLeaf:true, parentMember:"(All)"
},
  {caption: "Cars", hierarchyName: "Category",
uniqueName: "category.[cars]", children: [],
isLeaf:true, parentMember:"(All)"
},
  {caption: "Clothing", hierarchyName: "Category",
uniqueName: "category.[clothing]", children: [],
isLeaf:true, parentMember:"(All)"
}
]
*/

Check out on JSFiddle.

2) CSV data source, where Date hierarchy has more than one level:

flexmonster.getMembers('Date'); 

/* method returns an array of objects
[
  {
caption: "2003",
  hierarchyName: "Date",
  uniqueName: "date.[2003]",
  children: [
   {
caption: "Quarter 1",
   hierarchyName: "Date",
   uniqueName: "date.quarter.[2003/quarter 1]",
   children: [
   {
caption: "January",
    hierarchyName: "Date",
    uniqueName: "date.quarter.[2003/quarter 1/january]",    
children: [ ],
isLeaf:true,
parentMember: "(All)"
  }
]
},
 {
caption: "Quarter 2",
 hierarchyName: "Date",
 uniqueName: "date.quarter.[2003/quarter 2]",
 children: [
  {
caption: "April",
  hierarchyName: "[Date].[Date]",
  uniqueName: "date.quarter.[2003/quarter 2/april]",
  children: [ ],
isLeaf:true,
parentMember: "(All)"
}
]
}
],
isLeaf:true,
parentMember: "(All)"
},
{
caption: "2004",
hierarchyName: "Date",
uniqueName: "date.[2004]",
children: [
{
caption: "Quarter 3",
hierarchyName: "Date",
uniqueName: "date.quarter.[2004/quarter 3]",
children: [
{
caption: "July",
hierarchyName: "Date",
uniqueName: "date.quarter.[2004/quarter 3/july]",    
children: [ ],
isLeaf:true,
parentMember: "(All)"
},
 {
caption: "August",
hierarchyName: "Date",
uniqueName: "date.quarter.[2004/quarter 3/august]",
    children: [ ],
isLeaf:true,
parentMember: "(All)"
}
]
}
],
isLeaf:true,
parentMember: "(All)"
}
]
*/

3) OLAP data source, where [Product].[Product Categories] hierarchy has more than one level:

flexmonster.getMembers('[Product].[Product Categories]', '', onGetMembers); 

function onGetMembers(members) {
  for (var i = 0; i < members.length; i++) {
   console.log(members[i]);
  }
}

/* the output will be the following:
[{
caption: "Accessories",
dimensionName: "[Product]",
hierarchyCaption: "Product Categories",
hierarchyName: "[Product].[Product Categories]",
isLeaf: false,
parentMember: "[Product].[Product Categories].[All Products]",
uniqueName: "[Product].[Product Categories].[Category].&[4]"
}
{
caption: "Bikes",
dimensionName: "[Product]",
hierarchyCaption: "Product Categories",
hierarchyName: "[Product].[Product Categories]",
isLeaf: false,
parentMember: "[Product].[Product Categories].[All Products]",
uniqueName: "[Product].[Product Categories].[Category].&[1]"
}
{
caption: "Clothing",
dimensionName: "[Product]",
hierarchyCaption: "Product Categories",
hierarchyName: "[Product].[Product Categories]",
isLeaf: false,
parentMember: "[Product].[Product Categories].[All Products]",
uniqueName: "[Product].[Product Categories].[Category].&[3]"
}
{
caption: "Components",
dimensionName: "[Product]",
hierarchyCaption: "Product Categories",
hierarchyName: "[Product].[Product Categories]",
isLeaf: false,
parentMember: "[Product].[Product Categories].[All Products]",
uniqueName: "[Product].[Product Categories].[Category].&[2]"
}]

now you can ask for '[Product].[Product Categories].[Category].&[4]' members:
flexmonster.getMembers('[Product].[Product Categories]',
'[Product].[Product Categories].[Category].&[4]', onGetMembers);
*/

Open the example on JSFiddle.