The DrilldownByGrouping client API is used to expand groups of objects in a drilldown.
Argument |
Description |
---|---|
Parameter 1 |
Starting object to target object relationship or edge |
Parameter 1 default |
None |
Parameter 1 description |
Edge/Rel definition - Provide the UID of the edge definition or relationship definition that will be traversed by this method to find objects at the other end. If this argument contains a relationship definition, it must be prefixed with a + or - to specify the direction that the relationship definition should be traversed. This argument is required. |
Parameter 1 type |
String |
Parameter 2 |
First grouping path |
Parameter 2 default |
None |
Parameter 2 description |
Define the first level path. This argument is required, and represents the relationship to navigate from the target object to provide the first grouping |
Parameter 2 type |
String |
Parameter 3 |
Second grouping path |
Parameter 3 default |
None |
Parameter 3 description |
Define the second-level path. If the second grouping is necessary, this path represents the relationship to navigate from the first grouping object to the second. |
Parameter 3 type |
String |
Parameter 4 |
Output to the new tree |
Parameter 4 default |
True |
Parameter 4 description |
When set to TRUE, the results of the expansion will be displayed in the New Items window when the expansion is initiated in a list view. The default is TRUE. If the expansion is initiated in either the tree view or the New Items window, the results will appear in place. |
Parameter 4 type |
Boolean |
Parameter 5 |
Display grouping class definition |
Parameter 5 default |
None |
Parameter 5 description |
Specify whether the grouping items show additional information to help users identify them. |
Parameter 5 type |
Boolean |
Parameter 6 |
Honor query limit |
Parameter 6 default |
True |
Parameter 6 description |
If set to TRUE, the expansion operation will honor the user's query limit set on the Change User Preferences dialog box. The number of items returned by the expansion will be limited to the Maximum query limit, and the user will receive a message indicating that the query limit was exceeded. If set to FALSE, the system will return all matching results. |
Parameter 6 type |
Boolean |
Parameter 7 |
Expand first grouping |
Parameter 7 default |
True |
Parameter 7 description |
Specify whether the first grouping will be expanded by default in the user interface. |
Parameter 7 type |
False |
Using drilldown tree items with grouping might affect performance due to the internal expansion of additional relationships.
The following example illustrates how to use the DrilldownByGrouping client API to expand an area and see the related documents organized by document type:
Arg1: -SPFADocumentMasterArea
Arg2: -SPFPrimaryClassification
Arg3: <empty> (no second grouping)
Arg4: True
Arg5: True
Arg6: True
Arg7: True
The Expand Items by Group for tag method uses the DrilldownByGrouping client API to to expand groups of objects in a drill down.