Supported Bean: SortEditorBean
Event handler: com.microstrategy.web.app.beans.EnumSysBeanTypes.AppBeanSortEditor (24)
Events
| apply | ||||
| Event to execute the main action of the ReportEditor |
17003 | |||
| cancel | ||||
| Equivalent to close. |
17005 | |||
| closeEditor | ||||
| Event to close the ReportEditor |
17002 | |||
| ok | ||||
| Event corresponding to apply and close. |
17004 | |||
| openEditor | ||||
| Event to open the ReportEditor |
17001 | |||
| setTopLeft | ||||
| Event for setting the top left position of the component |
73001 | |||
|
*left | Event argument to define the left (x) position of the component |
73002 | ||
|
*top | Event argument to define the top (y) position of the component |
73001 | ||
| sortEditorProcess | ||||
| Event to process the Sort Editor Form. |
24001 | |||
|
*sortKey | Argument to specify the sort key for Sort Editor. This argument is made up of 5 different arguments and has a structure associated with it. These arguments are seperated by a seperator which is defined in EnumReportBeanEvents.SORT_PARAM_SEPARATOR. The sort key is different for sorting on rows and on columns. Based on
what the user is sorting upon, some of these arguments within the sort key will be left blank.Usage: The sort key is made up of five different arguments. Object Type - The first argument is the object type of the template unit on which the user wants to sort. Allowed values are specified in EnumDSSXMLObjectTypes
Since we allow sorting only on metrics in the columns, the value of this argument for column sorting is always EnumDSSXMLObjectTypes.DssXmlTypeMetric Object DSSID - The second argument is the DSS ID of the template unit on which the user wants to sort. Form ID - The third argument is the Attribute Form ID of the template unit on which the user wants to sort. This argument is present only for row sorting and is blank for column sorting. Form Type - The fourth argument is the Attribute Form Type of the template unit on which the user wants to sort. This argument is present only for row sorting and is blank for column sorting. Allowed values are specified in EnumDSSXMLObjectTypes.Element List - The fifth argument is the list of elements included in the sort. This argument is present only for column sorting and is blank for row sorting. The list of elements is seperated by EnumReportBeanEvents.SORT_ELEM_LIST_SEPARATOR. This list of elements is used to identify the
columns headers used in the sort. |
24001 | ||
|
sortActiveViewKey | Argument to specify the active key of the selectd view bean. |
24004 | ||
|
sortGroupByCount | Indicate the number of Group By sorts included in the request |
24006 | ||
|
sortGroupByKey | Argument to specify the sort key for Group By sorting in the Report Writer Sort Editor
The sort key is made up of three different arguments. Section Key - Indicates the Section ID wehre the attribute is present Form ID - The second argument is the Attribute Form ID of the template unit on which the user wants to sort. Sort Order - Indicates the sort order (0. Descending | 1. Ascending) |
24005 | ||
|
sortGroupByOrder | Indicate the Form SOrt Key of the Group By elements. |
24007 | ||
|
sortOrder | Argument to specify the sort order. The sort order can be ascending or descending. If the value of this argument is "TRUE" then the sort order is ascending. Any other value will denote a descending sort order. |
24002 | ||
|
sortRespectParent |
24009 | |||
|
sortSubtotalPostion | Argument to specify the position of subtotals in sorted result. The possible values are in EnumDSSXMLSubtotalsPosition. Default is com.microstrategy.webapi.EnumDSSXMLSubtotalsPosition.DssSubtotalsPositionInherit. |
24003 | ||
| switchTab | ||||
|
24002 | ||||
|
*tab |
24008 | |||
Notes
* denotes required field.