Ignite UI API Reference
ig.Hierarchy
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 hierarchy by its unique name
var hDateCalendar = dataSource.getHierarchy("[Date].[Calendar]");
});
});
</script>
</head>
<body>
</body>
</html>
Related Topics
Dependencies
-
allMember
- .allMember( value:object );
- Return Type:
- string
- Return Type Description:
- The unique name of the 'All' member for the hierarchy.
Returns the unique name of the 'All' member for the hierarchy.
- value
- Type:object
-
caption
- .caption( value:object );
- Return Type:
- string
- Return Type Description:
- The caption of the hierarchy.
Returns the caption of the hierarchy used when displaying the name of the hierarchy to the user.
- value
- Type:object
-
defaultMember
- .defaultMember( value:object );
- Return Type:
- string
- Return Type Description:
- The unique name of the default member for the hierarchy.
Returns the unique name of the default member for the hierarchy.
- value
- Type:object
-
description
- .description( value:object );
- Return Type:
- string
- Return Type Description:
- The description of the hierarchy.
Returns a user-friendly description of the hierarchy.
- value
- Type:object
-
dimensionUniqueName
- .dimensionUniqueName( value:object );
- Return Type:
- string
- Return Type Description:
- The unique name of the dimension that contains the hierarchy.
Returns the unique name of the dimension that contains the hierarchy.
- value
- Type:object
-
hierarchyDisplayFolder
- .hierarchyDisplayFolder( value:object );
- Return Type:
- string
- Return Type Description:
- The hierarchy display folder path.
Returns the hierarchy display folder path to be used when displaying the hierarchy in the user interface.
Folder names will be separated by a semicolon (;). Nested folders are indicated by a backslash (\).- value
- Type:object
-
hierarchyOrigin
- .hierarchyOrigin( value:object );
- Return Type:
- number
- Return Type Description:
- A value from the $.ig.HierarchyOrigin enumeration.
Returns the source of the hierarchy which is a value from the $.ig.HierarchyOrigin enumeration.
$.ig.HierarchyOrigin.prototype.userDefined = 1;
Identifies user defined hierarchies.
$.ig.HierarchyOrigin.prototype.systemEnabled = 2;
Identifies attribute hierarchies.
$.ig.HierarchyOrigin.prototype.systemInternal = 4;
Identifies attributes with no attribute .- value
- Type:object
-
name
- .name( value:object );
- Return Type:
- string
- Return Type Description:
- The name of the hierarchy.
Returns the name of the hierarchy.
- value
- Type:object
-
uniqueName
- .uniqueName( value:object );
- Return Type:
- string
- Return Type Description:
- The unique name of the hierarchy.
Returns the unique name of the hierarchy.
- value
- Type:object