Ignite UI API Reference

ig.Measure

ig.Measure_image
Represents a measure within a cube.

Code Sample

<!doctype html>
<html>
<head>
    <!-- jQuery Core -->
    <script src="js/jquery.js" type="text/javascript"></script>
    <!-- jQuery UI -->
    <script src="js/jquery-ui.js" type="text/javascript"></script>
    <!-- Infragistics Combined Scripts -->
    <script src="js/infragistics.core.js" type="text/javascript"></script>
    <script src="js/infragistics.lob.js" type="text/javascript"></script>
    <script type="text/javascript">
        $.support.cors = true;                
        $(function () {
            var dataSource = new $.ig.OlapXmlaDataSource({
                serverUrl: "http://sampledata.infragistics.com/olap/msmdpump.dll",
                catalog: "Adventure Works DW Standard Edition",
                cube: "Adventure Works"
            });
			
            dataSource.initialize().done(function(metadataTree) {
                // get given measure by its unique name
                var mInternetTaxAmount = dataSource.getMeasure("[Measures].[Internet Tax Amount]");
            });
        });            
    </script>
</head>
<body>
</body>
</html>

Related Topics

Dependencies

jquery-1.4.4.js
infragistics.util.js
The current widget has no options.
The current widget has no events.

  • aggregatorType

    .aggregatorType( value:object );
    Return Type:
    number
    Return Type Description:
    A value from the $.ig.AggregatorType enumeration.

    Returns the aggregator type that identifies how a measure was derived. It is a value from the $.ig.AggregatorType enumeration.

    $.ig.AggregatorType.prototype.unknown = 0;
    The aggregated function is undefined.

    $.ig.AggregatorType.prototype.sum = 1;
    The aggregated function adds all values.

    $.ig.AggregatorType.prototype.count = 2;
    The aggregated function will count the number of the values.

    $.ig.AggregatorType.prototype.min = 3;
    The aggregated function will returns the smallest value.

    $.ig.AggregatorType.prototype.max = 4;
    The aggregated function will returns the largest value.

    $.ig.AggregatorType.prototype.average = 5;
    The aggregated function will returns the average of cells value.

    $.ig.AggregatorType.prototype.variance = 6;
    The aggregated function will estimates variance based on the sample.

    $.ig.AggregatorType.prototype.std = 7;
    The aggregated function will estimates the standart deviation based on sample.

    $.ig.AggregatorType.prototype.distinctCount = 8;
    The aggregated function will returns the number of distinct, nonempty tuples in a set.

    $.ig.AggregatorType.prototype.none = 9;
    No aggregation performed.

    $.ig.AggregatorType.prototype.averageOfChildren = 10;
    The aggregated function will returns the average of the measure's children.

    $.ig.AggregatorType.prototype.firstNonEmpty = 13;
    The aggregated function will returns the measure's first nonempty member.

    $.ig.AggregatorType.prototype.lastNonEmpty = 14;
    The aggregated function will returns the measure's last nonempty member.

    $.ig.AggregatorType.prototype.byAccount = 15;
    Aggregated by the aggregation function associated with the specified account type of an attribute in an account dimension.

    $.ig.AggregatorType.prototype.calculated = 127;
    The aggregated function will returns the result derived from a formula.

    • value
    • Type:object

  • caption

    .caption( value:object );
    Return Type:
    string
    Return Type Description:
    The caption of the measure.

    Returns the caption of the measure used when displaying the name of the measure to the user.

    • value
    • Type:object

  • defaultFormatString

    .defaultFormatString( value:object );
    Return Type:
    string
    Return Type Description:
    The default format string for the measure.

    Returns the default format string for the measure.

    • value
    • Type:object

  • description

    .description( value:object );
    Return Type:
    string
    Return Type Description:
    The description of the measure.

    Returns a user-friendly description of the measure.

    • value
    • Type:object

  • measureDisplayFolder

    .measureDisplayFolder( value:object );
    Return Type:
    string
    Return Type Description:
    The measure display folder path.

    Returns the measure display folder path to be used when displaying the measure in the user interface.
    Folder names will be separated by a semicolon (;). Nested folders are indicated by a backslash (\).

    • value
    • Type:object

  • measureGroupName

    .measureGroupName( value:object );
    Return Type:
    string
    Return Type Description:
    The name of the measure group.

    Returns the name of the measure group this measure belongs to.

    • value
    • Type:object

  • name

    .name( value:object );
    Return Type:
    string
    Return Type Description:
    The name of the measure.

    Returns the name of the measure.

    • value
    • Type:object

  • uniqueName

    .uniqueName( value:object );
    Return Type:
    string
    Return Type Description:
    The unique name of the measure.

    Returns the unique name of the measure.

    • value
    • Type:object

Copyright © 1996 - 2024 Infragistics, Inc. All rights reserved.

#