| Package | com.flexmonster.pivot.vo |
| Class | public class MeasureValueObject |
| Inheritance | MeasureValueObject  Object |
| Property | Defined By | ||
|---|---|---|---|
| active : Boolean
Boolean value that defines whether the calculated measure will be added to the list of available values but not selected (false) or will be selected for the report (true). | MeasureValueObject | ||
| aggregation : String
Type of aggregation function that will be applied to the measure ("sum", "count", "distinctcount", "average", "product", "min", "max", "percent", "percentofcolumn", "percentofrow", "index"). | MeasureValueObject | ||
| availableAggregations : Array
Array of strings that represents the list of aggregation functions which can be applied to the current measure. | MeasureValueObject | ||
| availableAggregationsCaptions : Array [read-only]
Array of strings that represents the list of aggregation captions. | MeasureValueObject | ||
| calculated : Boolean
Boolean value that defines whether measure is calculated. | MeasureValueObject | ||
| caption : String
Measure caption. | MeasureValueObject | ||
| folder : String
Measure folder. | MeasureValueObject | ||
| format : String
Number formatting name. | MeasureValueObject | ||
| formula : String
String that represents the formula that can contain the following operations: +, -, /; other measures can be addressed using measure unique name and aggregation function, for example sum("[Measures].[Price]") or max("[Measures].[Order]"). | MeasureValueObject | ||
| grandTotalCaption : String
Measure grand total caption. | MeasureValueObject | ||
| individual : Boolean | MeasureValueObject | ||
| originalCaption : String
Measure original caption
| MeasureValueObject | ||
| type : int = 1
Measure type. | MeasureValueObject | ||
| uniqueName : String
Measure unique name, this property will be used as an identifier for the measure inside Pivot component and as the identifier to remove calculated measure via API. | MeasureValueObject | ||
| Method | Defined By | ||
|---|---|---|---|
MeasureValueObject(uniqueName:String, caption:String, aggregation:String, format:String, type:int = 1) | MeasureValueObject | ||
fromObject(object:Object):MeasureValueObject [static]
Convert object to MeasureValueObject class
| MeasureValueObject | ||
getLocalizedCaption(aggregation:String, originalCaption:String):String [static] | MeasureValueObject | ||
toObject():Object
Convert MeasureValueObject to Object
| MeasureValueObject | ||
| active | property |
public var active:BooleanBoolean value that defines whether the calculated measure will be added to the list of available values but not selected (false) or will be selected for the report (true).
| aggregation | property |
public var aggregation:StringType of aggregation function that will be applied to the measure ("sum", "count", "distinctcount", "average", "product", "min", "max", "percent", "percentofcolumn", "percentofrow", "index"). If it is calculated measure, it will be "none".
| availableAggregations | property |
availableAggregations:ArrayArray of strings that represents the list of aggregation functions which can be applied to the current measure. If it is calculated measure, it will be [].
public function get availableAggregations():Array public function set availableAggregations(value:Array):void| availableAggregationsCaptions | property |
availableAggregationsCaptions:Array [read-only] Array of strings that represents the list of aggregation captions. If it is calculated measure, it will be [].
public function get availableAggregationsCaptions():Array| calculated | property |
public var calculated:BooleanBoolean value that defines whether measure is calculated.
| caption | property |
public var caption:StringMeasure caption.
| folder | property |
public var folder:StringMeasure folder.
| format | property |
public var format:StringNumber formatting name.
| formula | property |
public var formula:StringString that represents the formula that can contain the following operations: +, -, /; other measures can be addressed using measure unique name and aggregation function, for example sum("[Measures].[Price]") or max("[Measures].[Order]"). Pivot supports the following aggregation functions for CSV data source: sum, count, average, product, min, max, percent.
| grandTotalCaption | property |
public var grandTotalCaption:StringMeasure grand total caption.
| individual | property |
public var individual:Boolean| originalCaption | property |
public var originalCaption:StringMeasure original caption
| type | property |
public var type:int = 1
Measure type. Default value is MeasureType.NUMBER.
See also
| uniqueName | property |
public var uniqueName:StringMeasure unique name, this property will be used as an identifier for the measure inside Pivot component and as the identifier to remove calculated measure via API.
| MeasureValueObject | () | Constructor |
public function MeasureValueObject(uniqueName:String, caption:String, aggregation:String, format:String, type:int = 1)Constructor for MeasureValueObject class
ParametersuniqueName:String | |
caption:String | |
aggregation:String | |
format:String | |
type:int (default = 1) |
| fromObject | () | method |
public static function fromObject(object:Object):MeasureValueObjectConvert object to MeasureValueObject class
Parameters
object:Object — object
|
MeasureValueObject — MeasureValueObject object
|
| getLocalizedCaption | () | method |
public static function getLocalizedCaption(aggregation:String, originalCaption:String):StringParameters
aggregation:String | |
originalCaption:String |
String |
| toObject | () | method |
public function toObject():ObjectConvert MeasureValueObject to Object
ReturnsObject — object
|