ResultMeasureObject

This object is returned by the getAllMeasures() and getMeasures() methods. It can describe:

• Measures selected in the report.
• All available measures.

Properties

{
  name: string,
  uniqueName: string,
  aggregation: string,
  availableAggregations: string[],
  availableAggregationsCaptions: string[],
  caption: string,
  format: string,
  formula: string,
  grandTotalCaption: string,
  groupName: string,
  type: string
}

Property/Type	Description
name String	The measure's name.
uniqueName String	The measure's unique name.
aggregation String	The name of the aggregation applied to the measure. If the measure is calculated, aggregation is set to "none".
availableAggregations String[]	Represents the list of aggregation functions that can be applied to the current measure. If the measure is calculated, availableAggregations is set to [].
availableAggregationsCaptions String[]	Represents the list of available aggregations’ captions. If the measure is calculated, availableAggregationsCaptions is set to [].
caption String	The measure's caption.
format String	The name of the number formatting that will be applied to the measure.
formula String	optional It represents the formula. For calculated measures.
grandTotalCaption String	The measure's grand total caption.
groupName String	optional The measure's group defined in SSAS. Only for the "microsoft analysis services" data source type.
type String	The measure's type. It is returned for "json", "csv", and "elasticsearch" data source types: 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 "elasticsearch", the type’s possible values are described here: Field data types.

Examples

The example below shows an array of ResultMeasureObjects returned by the getMeasures() method:

flexmonster.getMeasures(); 

/* method returns an array of ResultMeasureObjects
[
  {
    aggregation: "sum",
    availableAggregations: ["sum", "average", "percent"],
    availableAggregationsCaptions: ["Sum", "Count", "Percent"],
    caption: "Sum of Sales",
    format: "currency",
    grandTotalCaption: "Total Sum of Sales",
    name: "Sales",
    type: "number",
    uniqueName: "Sales"
  },
  {
    aggregation: "sum",
    availableAggregations: ["sum", "count", "distinctcount", "average", "product", "min", "max", "percent", "percentofcolumn", "percentofrow", "index"],
    availableAggregationsCaptions: ["Sum", "Count", "Distinct Count", "Average", "Product", "Min", "Max", "% of Grand Total", "% of Column", "% of Row", "Index"],
    caption: "Sum of Orders",
    format: "",
    grandTotalCaption: "Total Sum of Orders",
    name: "Orders",
    type: "number",
    uniqueName: "Orders"
  }
]
*/ 

Try on JSFiddle.

See also

getAllMeasures()
getMeasures()