Supported Bean: DrillEditorBean
Event handler: com.microstrategy.web.app.beans.EnumSysBeanTypes.AppBeanDrillEditor (23)
Events
| advDrillEditorProcess | ||||
| This event is used for two purposes. It is used to process the Advanced Drill Editor Form and it is also used to change the dimension shown in the Advanced Drill Editor. Based on whether the user has clicked on the chnage dimension button or process Advanced Drill button, we will decide which event to process. |
23002 | |||
|
*AdvancedDrillSubmit | Argument to specify the name of the image used to show the process advanced drill button on the Advanced Drill Editor. If this argument is present in the request keys we will process the advanced drill event. This argument will be present in the request keys only if the user clicks on it. |
23007 |
EnumDrillEditorEvents.WebEventArgumentAdvDrillSubmitImageName |
|
|
*DrillDim | Argument to specify the name of the dimentsion for the Advanced Drill Editor. This argument is used for changing the dimension shown in the Advanced Drill Editor. The Advanced Drill Editor will show all the drill paths corresponding the dimension shown. |
23005 | ||
|
*SwitchDim | Argument to specify the name of the image used to show the change dimension button on the Advanced Drill Editor. If this argument is present in the request keys we will process the change dimension event. This argument will be present in the request keys only if the user clicks on it. |
23006 |
EnumDrillEditorEvents.WebEventArgumentAdvDrillChangeDimensionImageName |
|
|
AdvancedDrillKeepParent | Argument to specify if we need to keep the parent element after drilling.
The value for Retain Parent is specified in EnumReportBeanEvents.DRILL_RETAIN_PARENT |
23003 | ||
|
deDrillElementList | Argument to specify the list of elements on which the user wants to filter the drill.
The list of elements is seperated by a seperator as specified in EnumReportBeanEvents.METRIC_ELEM_LIST_SEPARATOR. The
Id of the element is retrieved from WebHeader. |
23002 | ||
|
DrillAttributesList | Argument to specify the drill key for the advanced drill editor.
This argument is made up of 5 different arguments and has a structure associated with it. These arguments are comma "," seperated. Usage: The drill key is made up of five different arguments. Axis - The first argument is the axis of the template unit on which the user wants to drill. Allowed values are specified in EnumDSSXMLAxisNamePosition - The second argument is the position of the template unit within the axis. This value is 1-based Ordinal - The third argument is the ordinal of the template unit. DrillPathID - The fourth argument is the Drill Path ID of the template unit. Retain Thresholds - The fifth argument specifies if we need to retain thresholds after drilling. A value of "1" is used to denote Retain Thresholds. |
23008 |
EnumDrillEditorEvents.WebEventArgumentAdvDrillAttributeDrillPaths |
|
|
optimizedDrillKeyAndProps | Argument to specify the drill path key passed in optimized format. This argument should be used to pass the key obtained
from the optimized drill path framework. If drill key corresponds to the old framework use EnumDrillEditorEvents.WebEventArgumentDrillKey instead.
This argument is made up of 2 different arguments and has a structure associated with it. These arguments are seperated by a seperator which is defined
in EnumReportBeanEvents.DRILL_TO_KEY_SEPARATOR. Usage: The drill key is made up of two different arguments. Drill Path Key - This should be the key for the drill path that can be obtained using WebDrillPath.getKey()Retain Thresholds - The second argument specifies if we need to retain thresholds after drilling. A value of "1" is used to denote Retain Thresholds. 0 specifies not to retain thresholds. Any other value instructs to use the value from the report definition. |
23009 |
EnumDrillEditorEvents.WebEventArgumentOptimizedDrillPathInfo |
|
| apply | ||||
| Event to execute the main action of the ReportEditor |
17003 | |||
| cancel | ||||
| Equivalent to close. |
17005 | |||
| closeEditor | ||||
| Event to close the ReportEditor |
17002 | |||
| drillEditorProcess | ||||
| Event to process the Drill Editor Form. |
23001 | |||
|
deDrillElementList | Argument to specify the list of elements on which the user wants to filter the drill.
The list of elements is seperated by a seperator as specified in EnumReportBeanEvents.METRIC_ELEM_LIST_SEPARATOR. The
Id of the element is retrieved from WebHeader. |
23002 | ||
|
deDrillImageName | Argument to specify the name of the check box image on the drill editor. On the drill editor we show all the drill paths for all the titles and each drill is specified with a check image next to it. This image name is used to know which check image the user clicked on, which in turn is used to determine the corresponding drill action. |
23004 | ||
|
deDrillKeepParent | Argument to specify if we need to keep the parent element after drilling.
The value for Retain Parent is specified in EnumReportBeanEvents.DRILL_RETAIN_PARENT |
23003 | ||
|
deDrillKey | Argument to specify the drill key for Drill Editor.
This argument is made up of 4 different arguments and has a structure associated with it. These arguments are seperated by a seperator which is defined
in EnumReportBeanEvents.DRILL_TO_KEY_SEPARATOR. Usage: The drill key is made up of four different arguments. Axis - The first argument is the axis of the template unit on which the user wants to drill. Allowed values are specified in EnumDSSXMLAxisNamePosition - The second argument is the position of the template unit within the axis. This value is 1-based Ordinal - The third argument is the ordinal of the template unit. DrillPathID - The fourth argument is the Drill Path ID of the template unit. |
23001 | ||
|
optimizedDrillKeyAndProps | Argument to specify the drill path key passed in optimized format. This argument should be used to pass the key obtained
from the optimized drill path framework. If drill key corresponds to the old framework use EnumDrillEditorEvents.WebEventArgumentDrillKey instead.
This argument is made up of 2 different arguments and has a structure associated with it. These arguments are seperated by a seperator which is defined
in EnumReportBeanEvents.DRILL_TO_KEY_SEPARATOR. Usage: The drill key is made up of two different arguments. Drill Path Key - This should be the key for the drill path that can be obtained using WebDrillPath.getKey()Retain Thresholds - The second argument specifies if we need to retain thresholds after drilling. A value of "1" is used to denote Retain Thresholds. 0 specifies not to retain thresholds. Any other value instructs to use the value from the report definition. |
23009 |
EnumDrillEditorEvents.WebEventArgumentOptimizedDrillPathInfo |
|
| 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 | ||
Notes
* denotes required field.