Endeca Presentation API
Grid Class
This class represents a grid (or multidimensional array) that is built from Endeca analytics data. The data is stored in a way that is convenient for building graphs, charts, or tables.
Declaration Syntax
C#Visual BasicVisual C++
public class Grid
Public Class Grid
public ref class Grid
All MembersConstructorsMethodsProperties

GridGridNew(IEnumerator, String, String)
Convenience constructor for a one-axis Grid. Same as passing in an IList containing the string.

GridGridNew(IEnumerator, String, String, String)
Convenience constructor for a two-axis Grid. Same as passing in an IList containing the two strings.

GridGridNew(IEnumerator, String, IList)
Constructs a Grid from the specified Endeca analytics data.

Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
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.)
Returns the List of Labels for the specified axis.

Gets the Type of the current instance.
(Inherited from Object.)
Convenience method. Same as passing in a IList containing the Label.

GetValue(Label, Label)
Convenience method. Same as passing in an IList containing the two Labels.

Returns the value at the location indicated by the labels.

Creates a shallow copy of the current Object.
(Inherited from Object.)
Returns the number of axes (i.e., the number of labels) in the Grid.

SortLabels(Int32, IComparer)
Sorts the labels in the specified axis by the specified comparator.

Returns a String that represents the current Object.
(Inherited from Object.)
A Grid returns values based on one or more "axes". For example, suppose you have cross-tab data in the following form:
{ Name: Smith,   Quarter: 1Q06,    Sales: 3000 }
{ Name: Smith,   Quarter: 2Q06,    Sales: 4200 }
{ Name: Smith,   Quarter: 3Q06,    Sales: 4500 }
{ Name: Jones,   Quarter: 1Q06,    Sales: 1200 }
{ Name: Jones,   Quarter: 2Q06,    Sales: 1600 }
In this case, you create a Grid with 2 axisNames ("Name" and "Quarter") and with a valueName "Sales". The items in each axis (e.g., "Smith" and "3Q06") are called Labels, and are typically used as labels for the axes of a graph or table.

These Labels are also used to look up each value to display using the getValue method. In the example above, getValue for the Labels "Smith" and "3Q06" would return "4500".

Inheritance Hierarchy

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