Endeca Presentation API
Dimension Class
NamespacesEndeca.NavigationDimension
Core component of a navigation state query encapsulating all information known about a dimension at the navigation state.
Declaration Syntax
C#Visual BasicVisual C++
public class Dimension
Public Class Dimension
public ref class Dimension
Members
All MembersMethodsProperties



IconMemberDescription
Ancestors
Gets the ancestors pertinent to this dimension.

CompletePath
Returns the complete path of the dimension values consolidating ancestors, descriptor, and implicits in this order.

Descriptor
Gets the descriptor for this dimension.

DimGroupId
Gets the ID of the dimension group to which this dimension belongs.

DimGroupName
Gets the name of the dimension group to which this dimension belongs.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Finalize()()
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
GetHashCode()()
Serves as a hash function for a particular type. GetHashCode()() is suitable for use in hashing algorithms and data structures like a hash table.
(Inherited from Object.)
GetType()()
Gets the Type of the current instance.
(Inherited from Object.)
Id
Gets the ID of the dimension.

ImplicitLocations
Gets the implicit dimension locations contained in this dimension.

Intermediates
Gets the intermediate non-navigable refinements that have been selected and do not affect the query terms.

IsImplicit()()
Determines if the dimension is fully implicit.

MemberwiseClone()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
Name
Gets the name of the dimension.

RefinementParent
Gets the refinements' parent value in this dimension.

Refinements
Gets the refinements available and retrieved in this dimension.

Root
Gets the root dimension value of this dimension.

ToString()()
Returns a String that represents the current Object.
(Inherited from Object.)
Remarks
A dimension is a collection of related dimension values (DimVal objects), organized into a tree. The top-most dimension value in a dimension tree is known as the dimension root. A dimension root always has the same name as its dimension.

Each dimension can belong to only a single dimension group (DimGroup object). If a dimension is not assigned to an explicit dimension group, it is placed in an implicit dimension group of its own. These implicit groups have no name and an ID of zero.

Inheritance Hierarchy
Object
Dimension

Assembly: Endeca.Navigation (Module: Endeca.Navigation) Version: 0.0.0.0