AnalyticGrid Class Methods
In this section, we discuss the AnalyticGrid class methods. The methods are described in alphabetic order.
Syntax
GetColumn(ColumnName)
Description
Use the GetColumn method to instantiate an AnalyticGridColumn object.
Note: The properties for an AnalyticGridColumn and a GridColumn are the same. Any differences are indicated in the description for the GridColumn property.
Specify the grid column name in the page field properties for that field, consisting of any combination of uppercase letters, digits and "#", "$", "@", and "_".
To specify a grid column name:
Open the page in Application Designer, select the analytic grid and access the Analytic Grid control properties.
On the General tab, type the new grid name in Page Field Name.
Parameters
|
Field or Control |
Definition |
|---|---|
| ColumnName |
Specify the name of the column that you want to access. |
Returns
An AnalyticGridColumn object.
Note: The properties for an AnalyticGridColumn and a GridColumn are the same. Any differences are indicated in the description for the GridColumn property.
Syntax
GetCubeCollection()
Description
Use the GetCubeCollection method to return a reference to the cube collection associated with the analytic grid.
Note: Do not use this method with an analytic grid that is in Freeze Column Mode.
Parameters
None.
Returns
A CubeCollection object.
Syntax
LoadData()
Description
Use the LoadData method to cause the system to get fresh data for the grid from the analytic calculation engine. Generally, you would use this method after you perform some operation, such as SetLayout, that might change the value or layout of the data.
Note: Do not use this method with an analytic grid that is in Freeze Column Mode.
Parameters
None.
Returns
None.
Syntax
SetAnalyticInstance(ID)
Description
Use the SetAnalyticInstance method to specify the analytic instance to be associated with this analytic grid.
An AnalyticGrid object can be bound only once to an analytic instance. If the SetAnalyticInstance method is called after the analytic grid is bound to an instance, the method call has no effect.
Note: Do not use this method with an analytic grid that is in Freeze Column Mode.
Parameters
|
Field or Control |
Definition |
|---|---|
| ID |
Specify the analytic instance ID as a string. |
Returns
None.
Syntax
SetLayout(&SlicerArray, &RowAxisArray, &ColumnAxisArray)
Description
Use the SetLayout method to set the layout for the three axes, slice, row, and column.
Note: Do not use this method with an analytic grid that is in Freeze Column Mode.
If you specify No Drag drop mode for an analytic grid in Application Designer, the analytic grid has the column axis, row axis and slicer axis, but the end user isn't allowed to change the layout by dragging and dropping elements between axes. However, you can still change the layout using the SetLayout method.
Note: You can specify a null value ("") for all the required parameters for this method.
Parameters
|
Field or Control |
Definition |
|---|---|
| &SlicerArray |
Specify an already instantiated array of string containing the list of fields to be put on the slice axis. |
| &RowAxisArray |
Specify an already instantiated array of string containing the list of fields to be put on the row axis. |
| &ColumnAxisArray |
Specify an already instantiated array of string containing the list of fields to be put on the column axis. Note: The maximum number of columns that can be displayed in an analytic grid is four. |
Returns
None.