Ignite UI API Reference

ig.Level

ig.Level_image
Represents a level 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 level by its unique name
                var lDateCalendarYear = dataSource.getLevel("[Date].[Calendar].[Calendar Year]");
            });
        });            
    </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 level.

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

    • value
    • Type:object
  • depth

    .depth( value:object );
    Return Type:
    number
    Return Type Description:
    The distance of the level from the root of the level. Root level is zero (0).

    Returns the distance of the level from the root of the level. Root level is zero (0).

    • value
    • Type:object
  • description

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

    Returns a user-friendly description of the level.

    • value
    • Type:object
  • dimensionUniqueName

    .dimensionUniqueName( value:object );
    Return Type:
    string
    Return Type Description:
    The unique name of the dimension that contains the level.

    Returns the unique name of the dimension that contains the level.

    • value
    • Type:object
  • hierarchyUniqueName

    .hierarchyUniqueName( value:object );
    Return Type:
    string
    Return Type Description:
    The unique name of the hierarchy that contains the level.

    Returns the unique name of the hierarchy that contains the level.

    • value
    • Type:object
  • levelOrderingProperty

    .levelOrderingProperty( value:object );
    Return Type:
    number
    Return Type Description:
    The ID of the attribute that the level is sorted on.

    Returns the ID of the attribute that the level is sorted on.

    • value
    • Type:object
  • levelOrigin

    .levelOrigin( value:object );
    Return Type:
    number

    Returns a value that defines how the level was sourced.

    • value
    • Type:object
  • membersCount

    .membersCount( value:object );
    Return Type:
    number
    Return Type Description:
    The count of all members in the level.

    Returns the count of all members in the level.

    • value
    • Type:object
  • name

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

    Returns the name of the level.

    • value
    • Type:object
  • uniqueName

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

    Returns the unique name of the level.

    • value
    • Type:object

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

#