Ignite UI API Reference

ig.Dimension

ig.Dimension_image
Represents a dimension 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 dimension by its unique name
                var dDate = dataSource.getDimension("[Date]");
            });
        });
    </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.
  • caption

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

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

    • value
    • Type:object
  • description

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

    Returns a user-friendly description of the dimension.

    • value
    • Type:object
  • dimensionType

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

    Returns the type of the dimension which is a value from the $.ig.DimensionType enumeration.

    $.ig.DimensionType.prototype.unknown = 0;
    $.ig.DimensionType.prototype.time = 1;
    $.ig.DimensionType.prototype.measure = 2;
    $.ig.DimensionType.prototype.other = 3;
    $.ig.DimensionType.prototype.quantitative = 5;
    $.ig.DimensionType.prototype.accounts = 6;
    $.ig.DimensionType.prototype.customers = 7;
    $.ig.DimensionType.prototype.products = 8;
    $.ig.DimensionType.prototype.scenario = 9;
    $.ig.DimensionType.prototype.utility = 10;
    $.ig.DimensionType.prototype.currency = 11;
    $.ig.DimensionType.prototype.rates = 12;
    $.ig.DimensionType.prototype.channel = 13;
    $.ig.DimensionType.prototype.promotion = 14;
    $.ig.DimensionType.prototype.organization = 15;
    $.ig.DimensionType.prototype.billOfMaterials = 16;
    $.ig.DimensionType.prototype.geography = 17;.

    • value
    • Type:object
  • name

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

    Returns the name of the dimension.

    • value
    • Type:object
  • uniqueName

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

    Returns the unique name of the dimension.

    • value
    • Type:object

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

#