dundas.data.Hierarchy Class

Inheritance Hierarchy

Constructors

	Name	Description
	init	Initializes the Hierarchy. Called during construction. Inherited from dundas.data.UniqueName.

Properties

	Name	Description
	allMember	Gets or sets the hierarchy all member.
	allMemberCaption	Gets or sets the "All" member caption override.
	analysisStructureId	Gets or sets the parent analysis structure ID (if there is one). Inherited from dundas.data.AnalysisElement.
	attribute	Gets or sets the attribute if this is an attribute hierarchy.
	attributeHierarchies	Gets or sets the attribute hierarchies under this hierarchy, if any. If the underlying hierarchy does not support attribute hierarchies, or if the hierarchy is not requested to have them then this property will be null.
	caption	Gets or sets the caption. Inherited from dundas.data.AnalysisElement.
	category	Gets or sets the element type. Inherited from dundas.data.Element.
	compatibleUniqueName	Gets or sets the hierarchy compatible unique name.
	containers	Gets or sets the containers for this element. Inherited from dundas.data.Element.
	description	Gets or sets the description. Inherited from dundas.data.Element.
	entityId	Gets or sets ID of the parent entity. Inherited from dundas.data.Element.
	hasAttributeHierarchies	Gets or sets a value indicating whether this hierarchy has attribute hierarchies in it.
	hierarchyCategory	Gets or sets the current instance hierarchy category.
	isAnonymized	Gets or sets a value indicating whether this hierarchy has the members anonymized during data retrieval.
	isHidden	Gets or sets a value indicating whether this hierarchy is hidden.
	isHierarchy	Gets or sets a value indicating whether this is a hierarchy or not. Inherited from dundas.data.AnalysisElement.
	isMeasure	Gets or sets a value indicating whether this is a measure or not. Inherited from dundas.data.AnalysisElement.
	isTimeHierarchy	Gets or sets a value indicating whether this hierarchy is a time hierarchy.
	levels	Gets or sets the hierarchy levels.
	links	Gets or sets the hierarchy level links. This may not be populated if it's not a user hierarchy or it's not requested.
	parameters	Gets or sets the hierarchy parameters.
	properties	Gets or sets the data properties. Inherited from dundas.data.Element.
	securityAttributeId	Gets or sets the security custom attribute ID, if this is a data security hierarchy.
	sortPolicy	Gets the sorting behaviour defined for the hierarchy.
	supportedAggregators	Gets or sets the supported aggregators. Inherited from dundas.data.AnalysisElement.
	timeProviderFirstDayOfWeek	Gets or sets the time provider first day of week property, if this is a time hierarchy.
	timeProviderId	Gets or sets the time provider ID, if this is a time hierarchy.
	uniqueName	Gets or sets the unique name. Inherited from dundas.data.UniqueName.

Methods

	Name	Description
	fromJObject	Applies the property values from a plain object created from JSON to the properties of this instance. Inherited from Class.
	getChildLevelByDepth	Gets the level that has the next largest depth to levelDepth.
	getId	Gets the ID of this hierarchy, which may be the analysis structure ID, the entity ID, or if this is a user hierarchy, then just the ID itself. If none is found, null will be returned.
	getLevel	Gets the level based on the unique name given.
	getLevelByDepth	Gets the level with the specified level depth.
	getParentLevelByDepth	Gets the level that has the next smallest depth to levelDepth.
	isPrimaryKey	Returns a value indicating whether this element is a primary key in the source or not. Inherited from dundas.data.Element.
	toJSON	Implementation for toJSON to return an object that will include this class's prototype property values when stringified. Inherited from Class.