Represents a named group of dimensions.

Namespace:  Endeca.Data
Assembly:  Endeca.Data (in Endeca.Data.dll) Version: 2.1.1.0 (2.1.1.620)

Syntax

C#
public class DimensionStateGroup
Visual Basic (Declaration)
Public Class DimensionStateGroup
Visual C++
public ref class DimensionStateGroup

Remarks

A dimension group provides a simple way to organize together one or more dimensions. This is typically done for presentation purposes. Dimension groups can be created and edited by using Developer Studio.

Dimensions are that are not explicitly placed in a named group when using Developer Studio are automatically added to an implicit dimension group containing only that dimension. These dimension groups are all have no name; this is reflected by DimensionStateGroup by returning a 0-length string from Name. Because each dimension is places in its own implicit group, there may be more than one DimensionStateGroup with an empty name.

Because dimension groups are most often used for presentation purposes, DimensionStates returns a list of DimensionStatess, rather than Dimensions. When displaying the refinements available to a user based on their current navigation state, it is common to group the refinable dimensions by dimension group; DimensionStates helps enable this use case.

Inheritance Hierarchy

System..::.Object
  Endeca.Data..::.DimensionStateGroup

See Also