Ignite UI API Reference

ig.Cube

ig.Cube_image
Represents the cube metadata.

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"
            });
			
            dataSource.initialize().done(function(metadataTree) {
                var cube = dataSource.cube();
                var cubes = dataSource.cubes();
                
                dataSource
                    .setCube(cubes[0].uniqueName())
                    .done(function (metadataTree){
                        // metadata tree is now updated to reflect selected cube structure		
                    });
            });
        });            
    </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 cube.

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

    • value
    • Type:object
  • cubeType

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

    Returns the type of the cube which is a value from the $.ig.CubeType enumeration.

    $.ig.CubeType.prototype.cube = 0;
    $.ig.CubeType.prototype.dimension = 1;
    $.ig.CubeType.prototype.unknown = 2;.

    • value
    • Type:object
  • description

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

    Returns a user-friendly description of the cube.

    • value
    • Type:object
  • lastProcessed

    .lastProcessed( value:object );
    Return Type:
    object
    Return Type Description:
    A JavaScript Date object.

    Returns the date and time on which the cube was last processed.

    • value
    • Type:object
  • lastUpdated

    .lastUpdated( value:object );
    Return Type:
    object
    Return Type Description:
    A JavaScript Date object.

    Returns the date and time on which the cube was last updated.

    • value
    • Type:object
  • name

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

    Returns the name of the cube.

    • value
    • Type:object
  • uniqueName

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

    Returns the unique name of the cube.

    • value
    • Type:object

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

#