Pricing changes are coming in January. Contact our Sales team to secure the current price for your desired license.
All documentation
  • API Reference for older versions
  • ResultHierarchyObject

    This object is returned by the filteropen event and the getAllHierarchies(), getColumns(), getReportFilters(), getRows() methods. It can describe:

    • A field for which the filter pop-up window was opened.
    • Fields in rows, columns, or report filters.
    • All fields from the dataset.

    Properties

    {
      uniqueName: string,
      caption: string,
      dimensionUniqueName: string
      dimensionCaption: string
      folder: string,
      levels: ResultHierarchyObject[]
      sort: string,
      type: string
    }
    Property/TypeDescription
    uniqueName
    String
    The field's unique name.
    caption
    String
    The field's caption.
    dimensionUniqueName
    String
    The dimension name.
    dimensionCaption
    String
    The dimension caption.
    folder
    String
    The field’s folder. Folders are used to group several fields in the Field List. folder supports nesting via / (e.g., "Folder/Subfolder/").
    Only for "json", "csv", and "api" data source types.
    levels
    ResultHierarchyObject[]
    If the field is a multilevel hierarchy, this property lists the field members that compose the hierarchy.
    Each member is a ResultHierarchyObject with only the uniqueName and caption properties.
    sort
    String
    The sorting type for members: "asc", "desc" or "unsorted".
    type
    String
    The field's data type. Only for "json", "csv", "api", and "elasticsearch" data sources:
    • For "json" and "csv", the type can be the following: "string", "number", "date", "date string", "year/month/day", "year/quarter/month/day", "datetime", "time".
    • For "api", the type can be the following: "string", "number", "date string", "datetime", "time".
    • For "elasticsearch", the type’s possible values are described here: Field data types.

    Examples

    The example below shows an array of ResultHierarchyObjects returned by the getAllHierarchies() method:

    flexmonster.getAllHierarchies();
    
    /* method returns an array of ResultHierarchyObjects
    [
      {caption: "Business Type", uniqueName: "Business Type", type: "string"},
      {caption: "Category", uniqueName: "Category", type: "string"},
      {caption: "Country", uniqueName: "Country", type: "string"}
    ]
    */

    Live example

    See also

    getAllHierarchies()
    getColumns()
    getReportFilters()
    getRows()
    filteropen