Supported Bean: ReportFrameBean
Event handler: com.microstrategy.web.app.beans.EnumSysBeanTypes.AppBeanReportFrame (6)
Events
| addElementQualification | ||||
| Event to add element qualification to the filter. |
6020 | |||
|
*attribute | event argument: to set the attribute id on attribute form editor. |
6042 | ||
|
*elements | event argument: list of elements to be added to filter. The element list should be seperated by EnumReportFrameEvents.ITEM_SEPARATOR |
6045 | ||
| addToFilter | ||||
| event for adding a new element to the filter editor. For example, in object browser, we can click or drag-and-drop an attribute or metric to create a qualification expression for it. |
6004 | |||
|
defaultAQEditMode | event argument: for add to filter event, the default attr qualification mode. |
6043 | ||
|
objectInfo | event argument: element info with ID|Type|Name format. It's used to identify the object user dragged from object browser to filter editor section. |
6006 | ||
|
xdaDimensionId | event argument: indicate the identifier of the xda dimension |
6046 | ||
|
xdaHierarchyId | event argument: indicate the identifier of the xda hierarchy |
6047 | ||
| addViewFilterCondition | ||||
| Event to fire when "Add View filter condition" is clicked. It will open the view filter editor, and display add expression wizard. |
6015 | |||
| advancedDrillEditor | ||||
| event for showing the advanced drill editor within the simple drill editor. |
6006 | |||
|
deEditorName | event argument: the name of the drill editor to display. |
6031 |
EnumReportFrameEvents.WebEventArgumentAdvancedDrillEditorName |
|
|
deShowAdvDE | event argument: argument to show advanced drill editor in the simple drill editor. If it's set to "1", the advanced drill editor will be displayed; If it's set to "0", the advanced drill editor will not be displayed - back to simple drill editor. |
6010 | ||
|
deTitleAxis | Argument to specify the axis of the WebTitle for which we want to show all the drill paths in the advanced drill editor. Allowed values are specified in EnumDSSXMLAxisName. Position - The second argument is the position of the template unit within the axis. This value is 1-based. |
6011 | ||
|
deTitlePostion | Argument to specify the position of the WebTitle within the specified axis for which we want to show all the drill paths in the advanced drill editor. This value is 1-based. |
6012 |
EnumReportFrameEvents.WebEventArgumentDrillEditorTitlePosition |
|
| attributeFormsEditor | ||||
| Event for opening the Attribute Forms Editor |
6018 | |||
|
attributeId | event argument: to set the attribute id on attribute form editor. |
6042 | ||
|
showAttributeList | event argument: whether to show the attribute list on the attribute forms editor |
6044 | ||
| browseParentFolder | ||||
| Event to browse the content of parent folder. |
41003 | |||
| changeDesignMode | ||||
| Event for switching report mode between design mode and execute mode. |
6001 | |||
|
cubeID |
3136 | |||
|
reportDesignMode | Argument to specify report's execution mode. This parameter is a String representation for an int value. It's used to determine how the report will be executed. Report has different behavior depending upon what execution mode is set, hence, permissions and functionality differs among these modes. Argument is used in following event: EnumServletEvents.WebEventEditReport The available int values for this parameter are specified in EnumReportViewModes |
3017 | ||
|
srcID |
3155 | |||
|
srcType |
3138 | |||
| closeEditor | ||||
| Event for closing an element of the report frame. Report frame element is any gui section implementing ReportFrameElement interface. For example, editors like filter editor, sort editor, drill editor, resize editor, formatting editors. |
6012 | |||
|
editorName | event argument: the report frame element name to open or close. |
6034 |
EnumReportFrameEvents.WebEventArgumentReportFrameElementName |
|
| designModePageBy | ||||
| event for the pageby area in design mode. This event handles pivoting and removing actions in the design mode. |
6008 | |||
|
pagebyDesignForm | event argument: the HTML form name for the pageby section. It is used for both execute mode and design mode. |
6007 | ||
|
RepManip_pivot_ | event argument: the prefix name for pivot images in template editor. It's used in design mode. |
6014 |
EnumReportFrameEvents.WebEventArgumentTemplateEditorPivotPrefix |
|
|
RepManip_removeUnit_ | event argument: the prefix name for removing images in template editor. It's used in design mode. |
6015 |
EnumReportFrameEvents.WebEventArgumentTemplateEditorRemovePrefix |
|
| designModeProcess | ||||
| event for the "command" area in design mode page. It includes "execute report", "save report", "cancel" buttons and toggling between template editor and filter editor. |
6010 | |||
|
btnApplyDesignChanges | event argument: HTML name for execute button in design mode. |
6017 | ||
|
btnCancelDesignChanges | event argument: HTML name for cancel button in design mode. |
6019 | ||
|
btnSaveReport | event argument: HTML name for saveas button in design mode. |
6018 | ||
|
changeStage | event argument: the HTML name for the button toggling between template editor and report filter editor. |
6033 | ||
|
frmDesignModeProcess | event argument: HTML form name for design mode "command" area. |
6032 | ||
| designModeTemplateEditor | ||||
| event for the template editor area in design mode. This event handles pivoting and removing actions in the design mode. |
6007 | |||
|
frmTemplateEditor | event argument: the HTML form name for template editor. It's used in design mode. |
6013 | ||
|
RepManip_pivot_ | event argument: the prefix name for pivot images in template editor. It's used in design mode. |
6014 |
EnumReportFrameEvents.WebEventArgumentTemplateEditorPivotPrefix |
|
|
RepManip_pivotMetric_ | event argument: the prefix name for moving metrics in template editor. It's used in design mode. |
6016 |
EnumReportFrameEvents.WebEventArgumentTemplateEditorMoveMetricPrefix |
|
|
RepManip_removeMetric_ | event argument: the prefix name for removing metrics in template editor. It's used in design mode. |
6030 |
EnumReportFrameEvents.WebEventArgumentTemplateEditorRemoveMetricPrefix |
|
|
RepManip_removeUnit_ | event argument: the prefix name for removing images in template editor. It's used in design mode. |
6015 |
EnumReportFrameEvents.WebEventArgumentTemplateEditorRemovePrefix |
|
| dragAndDrop | ||||
| Generic event for drag and drop action in the application. It covers a lot cases, such as pivot, remove, page by, drag from object browser to filter editor, etc. It's only supported in DHTML mode, in which we submit the event throught javascript code. |
6009 | |||
|
*dndFirstMetric | event argument: Indicate whether it's the first metric that is dragged on to grid. |
6035 |
EnumReportFrameEvents.WebEventArgumentDragAndDropFirstMetric |
|
|
*dndForm | event argument: HTML name for drag and drop form. |
6020 | ||
|
*dndObjAlias | event argument: HTML name the dragged object alias item in the drag-and-drop form. It's used to identify the object being dragged. |
6029 |
EnumReportFrameEvents.WebEventArgumentDragAndDropObjectAlias |
|
|
*dndObjID | event argument: HTML name the dragged object id item in the drag-and-drop form. It's used to identify the object being dragged. |
6027 | ||
|
*dndObjType | event argument: HTML name the dragged object type item in the drag-and-drop form. It's used to identify the object being dragged. |
6028 | ||
|
*fromAxis | event argument: HTML name the original axis item in the drag-and-drop form. |
6021 | ||
|
*fromPos | event argument: HTML name the original position item in the drag-and-drop form. |
6022 | ||
|
*fromType | event argument: HTML name the original object type item in the drag-and-drop form. |
6023 | ||
|
*toAxis | event argument: HTML name the target axis item in the drag-and-drop form. |
6024 | ||
|
*toPos | event argument: HTML name the target position axis item in the drag-and-drop form. |
6025 | ||
|
*toType | event argument: HTML name the target object type axis item in the drag-and-drop form. |
6026 | ||
|
dndAttFormID | event argument: HTML name the dragged attribute form id item in the drag-and-drop form. |
6039 | ||
|
dndAttFormPosition | event argument: HTML name the target form position within the attribute item in the drag-and-drop form. |
6040 |
EnumReportFrameEvents.WebEventArgumentDragAndDropAttFormPosition |
|
| mergeColHeader | ||||
| Event for merge/repeat column header. if user has "Read from report" choice on the grid preference page, we will toggle the report property; if user has "Merge" or "Repeat" choice on the grid preference page, we will toggle the browser setting, which applies to all reports. |
6016 | |||
|
mergeOrNot | event argument: whether to merge or repeat column headers. "true" means merge, "false" means repeat. |
6038 | ||
| openDerivedElementsEditor | ||||
|
6021 | ||||
|
forSort | event argument: indicates that the derived element editor needs to be open for custom sort. |
6048 | ||
|
unitID |
1001 |
EnumAttributeBeanEvents.ATTRIBUTE_EVENT_ARGUMENT_ATTRIBUTE_ID |
||
| openEditor | ||||
| Event for opening an element of the report frame. Report frame element is any gui section implementing ReportFrameElement interface. For example, editors like filter editor, sort editor, drill editor, resize editor, formatting editors. |
6011 | |||
|
editorName | event argument: the report frame element name to open or close. |
6034 |
EnumReportFrameEvents.WebEventArgumentReportFrameElementName |
|
| openFormularEditor | ||||
| Event for opening formular editor. It is a special case of WebEventOpenReportFrameElement, in that it has its own arguments to set the preselected item's index in the formular dropdown box. |
6014 | |||
|
absIndex | event argument: whether the active element index for formula editor is absolute or not. Absolute="1" means we preselect this item no matter the current user's previlege; Absolute="0" means we consider whether user has InsertDerivedMetric previlege, if not, decrease the index number by 1. |
6037 |
EnumReportFrameEvents.WebEventArgumentFormularEditorAbsoluteIndex |
|
|
activeElement | event argument: the active element index to preselect when the formula editor is opened. |
6036 |
EnumReportFrameEvents.WebEventArgumentFormularEditorActiveElement |
|
| pageby | ||||
| event for page by. This is different from the pageby event on the report bean level, in that it includes the HTML form information in the application. |
6005 | |||
|
pagebyApply | event argument: apply button/img name for the pageby section. It's only used in HTML mode, not DHTML mode. |
6009 | ||
|
pagebyDropdown | event argument: the HTML dropdown box name for pageby section. If there are multiple pageby attributes, the dropdown boxes will be numbered. |
6008 | ||
|
pagebyForm | event argument: the HTML form name for the pageby section. It is used for both execute mode and design mode. |
6007 | ||
| pivotToPage | ||||
| A special pivot event for pivoting to pageby axis.
We have some extra logic to handle before ReportBean handles the real pivoting functionality. |
6013 | |||
|
fromAxis | event argument: HTML name the original axis item in the drag-and-drop form. |
6021 | ||
|
fromPos | event argument: HTML name the original position item in the drag-and-drop form. |
6022 | ||
|
toPos | event argument: HTML name the target position axis item in the drag-and-drop form. |
6025 | ||
| showAttributeForms | ||||
| Event for the preference to show the attribute forms on the grid. |
6017 | |||
|
showAttributeForms | event argument: whether to show the attribute forms on the grid. "1" means true, "0" means false. |
6041 | ||
| showThresholdFormatting | ||||
|
6019 |
|
|||
|
showThresholdFormatting |
6043 |
|
||
| toggleReportBar | ||||
| Event for toggle the report bar a.k.a. report toolbar |
6022 | |||
|
showReportBar | event argument: indicates we need to display the report toolbar |
6050 | ||
Notes
* denotes required field.