Supported Bean: ViewBean
This interface provides a unified concept
of the WebTemplate
encapsulated by corresponding
WebViewInstance
along with its associated events for both the report,
and report writing document. Custom ViewBean
transforms and event handlers will work with traditional
reports and the newer report writing document.
It is used to manage and render grid data defined by the
underlying template in the
WebViewInstance,
and graph data encapsulated by the
GraphBean.
It also provides methods to track user states (e.g. view mode).
The ViewBean cannot exist on its own accord -
only as part of the following:
ReportBean.getViewBean(). The
ReportBean always encapsulates a template.RWBean.getDataWebBeans(String)
(tentative, and subject to changes).
Embedded ViewBean in report writing documents may
be rendered as grid, graphs or both.RWBean.getDefinitionWebBean(String)
(tentative, and subject to changes).
The corresponding WebViewInstance
instances here only contain template information, but no data.
Useful representation in design mode.The ViewBean cannot be saved and restored on its own.
It cannot be instantiated from the
WebBeanFactory.
Event handler: com.microstrategy.web.beans.EnumEventHandlerTypes.HANDLER_TYPE_VIEW (4096)
Events
| addAutoThresholds | ||||
| Event to add predefined thresholds to highlight high and low values in one or more template metrics. |
4096050 | |||
|
*metricKeys | Multiple metric keys, each separated by EnumViewBeanEvents.METRIC_ELEM_LIST_SEPARATOR. |
4214 | ||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
| addAxisSubTotalsEvent | ||||
Event for enabling the subtotals of the specified type and style. The subtotals are added to a specific axis, if one is specified. Otherwise they are added to all axes. |
4096055 | |||
|
*subtotalIndex | Specifies the index of the subtotal in the list of available subtotals |
4218 | ||
|
*subtotalStyle | Subtotal style
(see EnumDSSXMLSubtotalStyle). |
4016 | ||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
oAxis | Origin axis. |
4006 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_AXIS |
|
| addDerivedMetricEvent | ||||
Event for adding a new derived metric to the metrics collection.
The position where the new metric should be added needs to be specified.
If not, it is added at the beginning of the metrics collection.
If the EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_METRIC_DESTINATION_POSITION is not specified,
the metric is added at position 1 |
4096012 | |||
|
aggFromBase |
4256 | |||
|
alias | Alias for a metric. |
4031 | ||
|
formula | Formula for a derived metric. |
4032 | ||
|
intAggFromBase | Add a new parameter for AFB setting, because its type change from boolean to integer |
4260 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_METRIC_AGGFROMBASE_INT |
|
|
isTkStream |
4259 | |||
|
metricPos | Destination position of the metric in the metrics collection. |
4029 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_METRIC_DESTINATION_POSITION |
|
|
passThrough |
409606623 | |||
|
stFromBase |
4258 | |||
| addForm | ||||
| Event for adding attribute form. This event can be used to add attribute form to the view template. The (parent) attribute ID for the attribute form should be specified While adding to the view template, if the attribute does not exist on the template it will be added at the axis/position passed to the event (if axis/position is not passed, the attribute will be added to the end of the Row Axis of the template). If the attribute already exists on the template, the event will add(or, if already existing, move) the attribute form at the position specified. Also, if axis and position information is supplied to the event, the attribute will be moved to the specified axis/position before adding the attribute form. |
4096038 | |||
|
*attributeID | Attribute ID. |
4165 | ||
|
*formID | Form ID. |
4166 | ||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
attAxis | Destination axis. |
4008 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_DESTINATION_AXIS |
|
|
attPosition | Destination position of the template unit. |
4009 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_DESTINATION_POSITION |
|
|
datasetID | Data set ID. |
4177 | ||
|
formPos | Form position. |
4168 | ||
|
unitName | Name of the object on this template unit. |
4200 | ||
| addHyperLink | ||||
|
4096060 | ||||
|
*idx |
4239 | |||
|
anyOtherPrompts |
4252 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_HYPERLINK_ANY_OTHER_PROMPTS |
||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
displayText |
4241 | |||
|
isDefault |
4240 | |||
|
linkType |
4242 | |||
|
objKey | Object key. |
2048012 | ||
|
promptAnswers |
4247 | |||
|
selectorOptions | Indicates whether to copy the selector's selections when link drilling from one document to another. The options are: - 0 - Do not pass selector values - 1 - Pass selector values - match selectors by ID - 2 - Pass selector values - match selectors by name |
4257 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_HYPERLINK_SELECTOR_OPTIONS |
|
|
srcID |
4248 | |||
|
srcType |
4249 | |||
|
taregetID |
4244 | |||
|
targetSubType |
4246 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_HYPERLINK_TARGET_SUBTYPE |
||
|
targetType |
4245 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_HYPERLINK_TARGET_TYPE |
||
|
url |
4243 | |||
| addMetric | ||||
Adds the metric passed in with the specified key. If a key is not specified, the metric is added to the beggining of the metric collection. If a metrics collection, does not already exist on the template, the destination axis and position of the template unit where the metrics collection should be placed, needs to be specified. If the alias is not supplied, and the newly added metric exists in working set, the alias of themetric in workingset will be set as default alias of this template metric; if the newly added metric does not exist in working set, no alias will be set, the display of this template metric will be the name of the metric. The arguments |
4096028 | |||
|
*metricID | String argument specifying the id of the metric. |
4122 | ||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
dAxis | Destination axis. |
4008 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_DESTINATION_AXIS |
|
|
disablePU |
4229 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_BORDER_3D_TOP_COLOR |
||
|
dPos | Destination position of the template unit. |
4009 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_DESTINATION_POSITION |
|
|
dsID | Data set ID. |
4177 | ||
|
metricDisplayName | Alias for a metric. |
4031 | ||
|
metricKey | Key of a specific metric in the collection. |
4010 | ||
|
metricName | Name of the metric. |
4201 | ||
|
mPos | Destination position of the metric in the metrics collection. |
4029 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_METRIC_DESTINATION_POSITION |
|
|
objectSubType | Argument indicating the subtype of the object. |
4164 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_WORKING_SET_OBJECT_SUB_TYPE |
|
| addQuickSubtotals | ||||
| Event to turn on 'quick' subtotals. This event will effectively activate the 'Total' subtotal 'By position' with rows, columns and pages set to Outline style |
4096054 | |||
| addTemplateUnit | ||||
| Event for adding a new template unit to the template. If the alias is not supplied, and the newly added object exists in working set, the alias of the working set object will be set as default alias of this template unit; if the newly added object does not exist in working set, no alias will be set, the display of this template unit will be the name of the object. |
4096007 | |||
|
*dAxis | Destination axis. |
4008 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_DESTINATION_AXIS |
|
|
*dPos | Destination position of the template unit. |
4009 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_DESTINATION_POSITION |
|
|
*unitID | DSS ID of the template unit. |
4027 | ||
|
*unitType | Type of template unit, as defined in
EnumDSSXMLTemplateUnitType. |
4026 | ||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
disablePU |
4229 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_BORDER_3D_TOP_COLOR |
||
|
dsID | Data set ID. |
4177 | ||
|
unitDisplayName | New alias of the template unit. |
4014 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_ALIAS_NAME |
|
|
unitName | Name of the object on this template unit. |
4200 | ||
|
xdaDimensionId | Specifies the DSSID of the xda dimension |
4220 | ||
|
xdaHierarchiId | Specifies the DSSID of the xda hierarchy |
4221 | ||
| addUnitSubtotals | ||||
Event to add a subtotal of type EnumSubtotalInstanceType.SubtotalInstanceTypeUnit
Also known as 'Across level' subtotal |
4096051 | |||
|
*subtotalIndex | Specifies the index of the subtotal in the list of available subtotals |
4218 | ||
|
*subtotalUnits | Specifies the list of template units across which a 'Unit' subtotal
needs to be added. Each unit is specified by its type and DSSID with the
EnumViewBeanEvents.UNIT_PROPERTY_SEPARATOR.
Units are separated by a EnumViewBeanEvents.SUBTOTAL_UNIT_SEPARATOR
For example: type1, unitDSSId1; type2, unitDSSId2 ... |
4215 | ||
| aliasEvent | ||||
Event for specifying the alias of a template unit. The template unit can be identified either using the key or the axis/position. If the |
4096004 | |||
|
alias | New alias of the template unit. |
4014 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_ALIAS_NAME |
|
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
hasDynamicAlias | Indicates whether alias is dynamic |
409606620 | ||
|
key | Key of the template unit. |
4030 | ||
|
metricDepth | Key of a specific metric in the collection. |
4010 | ||
|
oAxis | Origin axis. |
4006 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_AXIS |
|
|
oPos | Origin position of the template unit. |
4007 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_POSITION |
|
| changeMetricAggFromBase | ||||
Event for change Aggregate from Base in new Derived Metric Editor. |
4096068 | |||
|
*aggFromBase |
4256 | |||
|
*key | Key of a specific metric in the collection. |
4010 | ||
|
alias | Alias for a metric. |
4031 | ||
|
formula | Formula for a derived metric. |
4032 | ||
| changeMetricFormulaEvent | ||||
| Event for changing the formula and/or alias associated with a metric. |
4096013 | |||
|
*formula | Formula for a derived metric. |
4032 | ||
|
aggFromBase |
4256 | |||
|
alias | Alias for a metric. |
4031 | ||
|
intAggFromBase | Add a new parameter for AFB setting, because its type change from boolean to integer |
4260 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_METRIC_AGGFROMBASE_INT |
|
|
isTkStream |
4259 | |||
|
key | Key of a specific metric in the collection. |
4010 | ||
|
passThrough |
409606623 | |||
|
srcID |
4248 | |||
|
stFromBase |
4258 | |||
| changeStyleEvent | ||||
| Event for changing the style of a view. The style to be applied can be specified either by ID or name. One of the two arguments is required. The ID is first checked. If it not supplied, the name is used. |
4096014 | |||
|
styleID | Style ID of the view. |
4041 | ||
|
styleName | String argument specifying the name of the style to apply. |
4126 | ||
| changeViewMode | ||||
| Event for change view view mode to grid, graph or both. |
4096024 | |||
|
*viewMode | View mode
(see EnumWebReportViewMode). |
4115 | ||
| clearDerivedElements | ||||
|
4096065 | ||||
|
aid | Display flag to be used while performing view execution. |
1001 | ||
| clearHyperLinks | ||||
|
4096064 | ||||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
objKey | Object key. |
2048012 | ||
|
openInNewWindow |
4250 | |||
|
srcID |
4248 | |||
|
srcType |
4249 | |||
| clearSorts | ||||
| Clears all the WebSorts objects contained in the view. |
4096029 | |||
|
oAxis | Origin axis. |
4006 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_AXIS |
|
| copyThresholdsToAlerts | ||||
Event for copying the current thresholds to alerts. Note that this event will
clear all previously saved alerts to all the template metrics and will only
copy over that threshold as specified by the EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_THRESHOLD_ID |
4096058 | |||
|
*metricKey | Key of a specific metric in the collection. |
4010 | ||
|
*thresholdId | Specifies the index of the threshold |
4238 | ||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
| cusomSort | ||||
|
4096070 | ||||
|
data |
409606622 | |||
| deAddQuickCalculation | ||||
|
4096057 | ||||
|
*attId |
4234 | |||
|
*depth |
4235 | |||
|
*function |
4237 | |||
|
*name |
4233 | |||
|
*ordinals |
4236 | |||
|
sliceId |
4254 | |||
| deAddQuickList | ||||
|
4096056 | ||||
|
*attId |
4234 | |||
|
*depth |
4235 | |||
|
*name |
4233 | |||
|
*ordinals |
4236 | |||
|
sliceId |
4254 | |||
| defineDatamart | ||||
| This event can be used to convert a report to a datamart
The possible parameters that can be sent in are:
|
4096046 | |||
|
*dbRoleId | DB role ID |
4204 | ||
|
*dmName | Datamart table name |
4205 | ||
|
dmAppend | Datamart property to specify whether to append to existing table |
4207 | ||
|
dmNameMacro | Datamart property to specify whether the name contains a macro |
4206 | ||
| disableSubTotalsEvent | ||||
| Event for disabling either a specific type of subtotal. If the type is not specified, all the subtotals are disabled. |
4096006 | |||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
subtotalIndex | Specifies the index of the subtotal in the list of available subtotals |
4218 | ||
|
subTotalType | Subtotal type
(see EnumDSSXMLMetricType). |
4015 | ||
| editHyperLink | ||||
|
4096061 | ||||
|
*idx |
4239 | |||
|
anyOtherPrompts |
4252 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_HYPERLINK_ANY_OTHER_PROMPTS |
||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
displayText |
4241 | |||
|
isDefault |
4240 | |||
|
linkType |
4242 | |||
|
objKey | Object key. |
2048012 | ||
|
promptAnswers |
4247 | |||
|
selectorOptions | Indicates whether to copy the selector's selections when link drilling from one document to another. The options are: - 0 - Do not pass selector values - 1 - Pass selector values - match selectors by ID - 2 - Pass selector values - match selectors by name |
4257 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_HYPERLINK_SELECTOR_OPTIONS |
|
|
srcID |
4248 | |||
|
srcType |
4249 | |||
|
taregetID |
4244 | |||
|
targetSubType |
4246 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_HYPERLINK_TARGET_SUBTYPE |
||
|
targetType |
4245 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_HYPERLINK_TARGET_TYPE |
||
|
url |
4243 | |||
| editHyperLinks | ||||
|
4096063 | ||||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
objKey | Object key. |
2048012 | ||
|
openInNewWindow |
4250 | |||
|
srcID |
4248 | |||
|
srcType |
4249 | |||
| enableSubTotalsEvent | ||||
Event for enabling the subtotals of the specified type and style. The subtotals are added to a specific axis, if one is specified. Otherwise they are added to all axes. |
4096005 | |||
|
*subtotalStyle | Subtotal style
(see EnumDSSXMLSubtotalStyle). |
4016 | ||
|
*subTotalType | Subtotal type
(see EnumDSSXMLMetricType). |
4015 | ||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
oAxis | Origin axis. |
4006 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_AXIS |
|
| graphDrillEvent | ||||
| Event for performing a drill on the view graph. |
4096011 | |||
|
*4096011.x | Graph x-pixel offset. |
4036 | ||
|
*4096011.y | Graph y-pixel offset. |
4037 | ||
|
displayMode | Specifies the display mode. A value from the enumeration EnumDSSXMLDisplayMode |
4212 | ||
|
drillPathKey | Drill path key. |
4178 | ||
|
graphHeight | Height of the graph. |
4080 | ||
|
graphWidth | Width of the graph. |
4081 | ||
|
keepThresholds | Specifies whether the thresholds should be kept after performing the drill operation. |
4134 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_DRILL_RETAIN_THRESHOLDS |
|
|
retainParent | Specifies whether the parent should be kept after performing the drill operation. |
4034 | ||
|
sliceId |
4254 | |||
| gridDrillEvent | ||||
| Event for performing a drill on the view grid. The template unit needs to the specified using the axis and position. The drill path is picked up based on the ID passed in. The caller can also specify a list of elements that the drill needs to filter the results on. |
4096010 | |||
|
displayMode | Specifies the display mode. A value from the enumeration EnumDSSXMLDisplayMode |
4212 | ||
|
drillImp | Level of drill importance to retrieve.
possible values are:
EnumViewBeanEvents.DRILL_IMPORTANCE_LOW
EnumViewBeanEvents.DRILL_IMPORTANCE_MEDIUM
EnumViewBeanEvents.DRILL_IMPORTANCE_HIGH |
4124 | ||
|
drillKey | Key for drilling.
axis<separator>position<separator>ordinal<separator>drillPathID
The <separator> is EnumViewBeanEvents.DRILL_TO_KEY_SEPARATOR. |
4033 | ||
|
drillPathKey | Drill path key. |
4178 | ||
|
elementList | List of elements.
This is a list of element IDs separated by EnumViewBeanEvents.METRIC_ELEM_LIST_SEPARATOR. |
4035 | ||
|
filterOnPageBy | Argument specifying whether to filter on the Page By axis during drilling. |
4147 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_DRILL_FILTER_ON_PAGE_BY |
|
|
retainParent | Specifies whether the parent should be kept after performing the drill operation. |
4034 | ||
|
retainThresh | Specifies whether the thresholds should be kept after performing the drill operation. |
4134 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_DRILL_RETAIN_THRESHOLDS |
|
|
sliceId |
4254 | |||
| gridDrillFixTemplateEvent | ||||
| Event for performing a drill with the template fixed. This just filters on a given list of elements. |
4096032 | |||
|
elementList | List of elements.
This is a list of element IDs separated by EnumViewBeanEvents.METRIC_ELEM_LIST_SEPARATOR. |
4035 | ||
|
filterOnPageBy | Argument specifying whether to filter on the Page By axis during drilling. |
4147 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_DRILL_FILTER_ON_PAGE_BY |
|
|
retainThresh | Specifies whether the thresholds should be kept after performing the drill operation. |
4134 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_DRILL_RETAIN_THRESHOLDS |
|
|
sliceId |
4254 | |||
| hierarchicalSort | ||||
Event for applying hierarchical metric sort in outline mode. If the subtotal
parameter is not specified, the default is
EnumDSSXMLMetricType.DssXmlMetricSubtotalSum. |
4096031 | |||
|
*sortKey | Sort key.
The format of the key is as follows:
EnumViewBeanEvents.SORT_PARAM_TYPE=type<sep>EnumViewBeanEvents.SORT_PARAM_ID=id<sep>EnumViewBeanEvents.SORT_PARAM_FORM_ID=id<sep>EnumViewBeanEvents.SORT_PARAM_FORM_TYPE=type<sep>EnumViewBeanEvents.SORT_PARAM_ELEM_LIST<sep>EnumViewBeanEvents.SORT_PARAM_AXIS
where <sep> is EnumViewBeanEvents.SORT_PARAM_SEPARATOR
SORT_PARAM_ELEM_LIST is a list of elements separated by EnumViewBeanEvents.SORT_ELEM_LIST_SEPARATOR |
4011 | ||
|
clearSorts | Specifies whether the previous sorts should be cleared before adding the current ones. |
4013 | ||
|
ctlTPKeys |
4263 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_SORT_CONTROL_TOP_MOST_KEY_LIST |
||
|
sortOrder | Order of the sort - EnumViewBeanEvents.SORT_ORDER_ASCENDING/EnumViewBeanEvents.SORT_ORDER_DESCENDING.
The default is EnumViewBeanEvents.SORT_ORDER_ASCENDING. |
4012 | ||
|
sortsCount | Number of sorts that should be applied to the view. |
4123 | ||
|
subtotalPos | Argument indicating where the subtotals should be placed once the sorting is performed. |
4138 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_SORT_SUBTOTAL_POSITION |
|
|
subTotalType | Subtotal type
(see EnumDSSXMLMetricType). |
4015 | ||
| insertPercentToTotalMetric | ||||
| Event to add Percent to total shortcut metric on the template. |
4096045 |
EnumViewBeanEvents.VIEW_EVENT_INSERT_PERCENT_TO_TOTAL_METRIC |
||
|
*metricId | String argument specifying the id of the metric. |
4122 | ||
|
attributeId | Attribute ID. |
4165 | ||
|
axesBitMap | Axes bitmap. |
4176 | ||
| insertRankMetric | ||||
| Event for inserting rank metric in the view template. |
4096043 | |||
|
*metricId | String argument specifying the id of the metric. |
4122 | ||
|
attributeId | Attribute ID. |
4165 | ||
|
sortOrder | Order of the sort - EnumViewBeanEvents.SORT_ORDER_ASCENDING/EnumViewBeanEvents.SORT_ORDER_DESCENDING.
The default is EnumViewBeanEvents.SORT_ORDER_ASCENDING. |
4012 | ||
| insertTransformationMetric | ||||
| Event to add transformation metric. |
4096044 | |||
|
*metricId | String argument specifying the id of the metric. |
4122 | ||
|
*transformationRole | A value of 1 indicates whether series are displayed by columns. |
4175 | ||
|
metricsFormula | Formula for a derived metric. |
4032 | ||
| moveMetric | ||||
| Event for moving a metric within the metric collection. |
4096009 | |||
|
*dPos | Destination position of the metric in the metrics collection. |
4029 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_METRIC_DESTINATION_POSITION |
|
|
*oPos | Starting position of the metric in the metrics collection. |
4028 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_METRIC_ORIGIN_POSITION |
|
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
| multipleSorts | ||||
Event for setting multiple sort objects. Similar to EnumViewBeanEvents.VIEW_EVENT_HIERARCHICAL_METRIC_SORT
except that this event allows users to specify multiple sorts at the same time. The count parameter
should be passed to indicate the number of sorts. |
4096030 | |||
|
*sortKey | Sort key.
The format of the key is as follows:
EnumViewBeanEvents.SORT_PARAM_TYPE=type<sep>EnumViewBeanEvents.SORT_PARAM_ID=id<sep>EnumViewBeanEvents.SORT_PARAM_FORM_ID=id<sep>EnumViewBeanEvents.SORT_PARAM_FORM_TYPE=type<sep>EnumViewBeanEvents.SORT_PARAM_ELEM_LIST<sep>EnumViewBeanEvents.SORT_PARAM_AXIS
where <sep> is EnumViewBeanEvents.SORT_PARAM_SEPARATOR
SORT_PARAM_ELEM_LIST is a list of elements separated by EnumViewBeanEvents.SORT_ELEM_LIST_SEPARATOR |
4011 | ||
|
clearSorts | Specifies whether the previous sorts should be cleared before adding the current ones. |
4013 | ||
|
respectParent |
4262 | |||
|
sortOrder | Order of the sort - EnumViewBeanEvents.SORT_ORDER_ASCENDING/EnumViewBeanEvents.SORT_ORDER_DESCENDING.
The default is EnumViewBeanEvents.SORT_ORDER_ASCENDING. |
4012 | ||
|
sortsCount | Number of sorts that should be applied to the view. |
4123 | ||
|
subtotalPos | Argument indicating where the subtotals should be placed once the sorting is performed. |
4138 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_SORT_SUBTOTAL_POSITION |
|
| numberFormat | ||||
|
4096066 | ||||
|
currency | Argument indicating currency should be applied to the number formatting on the selected target |
409606612 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_NUMBER_FORMAT_CURRENCY |
|
|
deltaDecimal | Argument indicating the decimal delta to apply to the number formatting on the selected target |
409606611 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_NUMBER_FORMAT_DELTA_DECIMAL |
|
|
gridLevel | Level of the grid unit when saving
the grid properties. The possible values are: 1 - Grid 2 - Header 3 - Subtotal grid 4 - Subtotal header |
4109 | ||
|
gridUnit | Unit of the grid.
The possible values are: 1 - Template Unit 2 - Template Metric 3 - Rows 4 - Cols |
4108 | ||
|
oAxis | Origin axis. |
4006 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_AXIS |
|
|
oPos | Origin position of the template unit. |
4007 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_POSITION |
|
|
percentage | Argument indicating percentage should be applied to the number formatting on the selected target |
409606613 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_NUMBER_FORMAT_PERCENTAGE |
|
|
styleName | String argument specifying the name of the style to apply. |
4126 | ||
|
thousand | Argument indicating thousand separator should be applied to the number formatting on the selected target |
409606614 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_NUMBER_FORMAT_THOUSAND |
|
| pivotAny | ||||
Event for performing pivot. The callers needs to specify the template unit for the origin and the destination. These can be specified using the axis and position |
4096067 | |||
|
dAxis | Destination axis. |
4008 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_DESTINATION_AXIS |
|
|
dPos | Destination position of the template unit. |
4009 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_DESTINATION_POSITION |
|
|
objectID | Argument that specifies whether the graph is set to 'Series by columns' or
'Series by rows'. 1 indicates 'Series by columns' |
4227 | ||
|
objectType | Argument that specifies whether the event should swap the rows and columns. This is useful when we change the graph from series by rows to series by columns. By default, we will swap the number of rows and columns anytime the graph's series by columns property is changed. |
4228 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_SWAP_ROWS_AND_COLUMNS |
|
| pivotEvent | ||||
Event for performing pivot. The callers needs to specify the template unit for the origin and the destination. These can be specified using the axis and position |
4096002 | |||
|
*dAxis | Destination axis. |
4008 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_DESTINATION_AXIS |
|
|
*dPos | Destination position of the template unit. |
4009 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_DESTINATION_POSITION |
|
|
*oAxis | Origin axis. |
4006 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_AXIS |
|
|
*oPos | Origin position of the template unit. |
4007 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_POSITION |
|
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
| pivotMultipleUnits | ||||
Event to pivot multiple units at the same time. These units can be real template units like attributes,
custom groups, hierarchies etc or they can also be individual metrics or even attribute forms.
Please see EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_MULTIPLE_UNITS for more details on the format
of the arguments. The event will preserve the order of the units sent in the argument |
4096059 | |||
|
*dPos | Destination position of the template unit. |
4009 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_DESTINATION_POSITION |
|
|
*multipleUnits | Specifies the multiple units that need to be moved/pivoted or removed.
The argument is of the following format
type1,axis,position ! type2,position ! type3, attributeID, formID
The separators used are EnumViewBeanEvents.UNIT_PROPERTY_SEPARATOR and EnumViewBeanEvents.MULTIPLE_UNITS_SEPARATOR.
In general, the format for each unit is type, property1, property2, ... where type is
from EnumDSSXMLObjectTypes; '-1' is for the metrics collection;
In the above example, the first unit is a template unit, the second is a metric and the third is
an attribute form. The order of these properties needs to be conformed to the above syntax. |
4213 | ||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
dAxis | Destination axis. |
4008 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_DESTINATION_AXIS |
|
| raExpand | ||||
|
4096071 | ||||
|
attID | Attribute ID. |
4165 | ||
|
cellKey | Key for drilling.
axis<separator>position<separator>ordinal<separator>drillPathID
The <separator> is EnumViewBeanEvents.DRILL_TO_KEY_SEPARATOR. |
4033 | ||
|
expMode |
409606624 | |||
| removeForm | ||||
| Event for removing attribute form. This event can be used to add attribute form to the view template or just to the working set. The (parent) attribute ID for the attribute form should be specified. |
4096039 | |||
|
*attributeID | Attribute ID. |
4165 | ||
|
*formID | Form ID. |
4166 | ||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
| removeMetricEvent | ||||
| Removes a metric based on the specified key or position. If the key or position are not specified, then all the metrics are removed. |
4096027 | |||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
disablePU |
4229 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_BORDER_3D_TOP_COLOR |
||
|
isDisableOnly | String argument indicating if it's disable only when remove a unit/metric from template. |
4179 | ||
|
metricKey | Key of a specific metric in the collection. |
4010 | ||
|
oPos | Starting position of the metric in the metrics collection. |
4028 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_METRIC_ORIGIN_POSITION |
|
| removeMultipleUnits | ||||
Event to remove multiple units at the same time. These units can be real template units like attributes,
custom groups, hierarchies etc or they can also be individual metrics or even attribute forms.
Please see EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_MULTIPLE_UNITS for more details on the format
of the arguments |
4096049 | |||
|
*multipleUnits | Specifies the multiple units that need to be moved/pivoted or removed.
The argument is of the following format
type1,axis,position ! type2,position ! type3, attributeID, formID
The separators used are EnumViewBeanEvents.UNIT_PROPERTY_SEPARATOR and EnumViewBeanEvents.MULTIPLE_UNITS_SEPARATOR.
In general, the format for each unit is type, property1, property2, ... where type is
from EnumDSSXMLObjectTypes; '-1' is for the metrics collection;
In the above example, the first unit is a template unit, the second is a metric and the third is
an attribute form. The order of these properties needs to be conformed to the above syntax. |
4213 | ||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
isDisableOnly | String argument indicating if it's disable only when remove a unit/metric from template. |
4179 | ||
| removeTemplateUnit | ||||
| Event for removing a specific template unit from the view template. The template to be removed can be specified using either the key or the axis and position. |
4096008 | |||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
disablePU |
4229 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_BORDER_3D_TOP_COLOR |
||
|
isDisableOnly | String argument indicating if it's disable only when remove a unit/metric from template. |
4179 | ||
|
key | Key of the template unit. |
4030 | ||
|
oAxis | Origin axis. |
4006 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_AXIS |
|
|
oPos | Origin position of the template unit. |
4007 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_POSITION |
|
| resizeColumn | ||||
Event for resizing the an individual column width or all columns. This event supports sending
a single column resize request. The request can be to resize an individual column or to resize
all columns to the same width. In order to resize all columns, the EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_COLUMN_IDENTIFIER
argument should be set to "allcolumns". |
4096035 | |||
|
*columnIdentifier | Argument specifying a column identifier. For a given column, its
identifier can be obtained using WebColumn.getKey(). If the request to resize is for All Columns
then the column identifier should be sent as the string AllColumns (case insensitive). |
4159 | ||
|
*newSize | Argument specifying the new column size for a column resize request. |
4160 | ||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
gridWidth | Argument specifying the default grid width for a column scenario of type
EnumDSSXMLWidthScenario.DssXmlWidthFixed. |
4156 | ||
|
headerWidth | Argument specifying the default header width for a column scenario of type
EnumDSSXMLWidthScenario.DssXmlWidthFixed. |
4155 | ||
| resizeColumns | ||||
| Event for resizing the column widths. This event supports sending multiple column resize requests. |
4096034 | |||
|
*requests | Argument specifying the resize requests for column resizing. The resize requests should be be sequenced as an ordered
list of requests (that will be processed in the order sent) seperated by underscores. Each request is further a colon
seperated list of [1] column identifier and [2] new size. For a given column, its
identifier can be obtained using WebColumn.getKey(). If the request to resize is for All Columns
then the column identifier should be sent as the string AllColumns (case insensitive). |
4158 | ||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
gridWidth | Argument specifying the default grid width for a column scenario of type
EnumDSSXMLWidthScenario.DssXmlWidthFixed. |
4156 | ||
|
headerWidth | Argument specifying the default header width for a column scenario of type
EnumDSSXMLWidthScenario.DssXmlWidthFixed. |
4155 | ||
| saveGraphAxisProperties | ||||
| Event for saving the graph axis properties. |
4096023 | |||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
scaleX | Scale of the X axis. |
4104 | ||
|
scaleY1 | Scale of the Y1 axis. |
4105 | ||
|
scaleY2 | Scale of the Y2 axis. |
4106 | ||
|
scaleZ | Scale of the Z axis. |
4107 | ||
|
show2DOLabel | Specifies whether to show the 2DO Label. |
4092 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRAPHPROPS_SHOW2DOLABEL |
|
|
show2DXValue | Specifies whether to show the 2DX value. |
4093 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRAPHPROPS_SHOW2DXVALUE |
|
|
show2DY1Value | Specifies whether to show the 2DY1 value. |
4094 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRAPHPROPS_SHOW2DY1VALUE |
|
|
show2DY2Value | Specifies whether to show the 2DY2 value. |
4095 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRAPHPROPS_SHOW2DY2VALUE |
|
|
show3DCHeader | Specifies whether to show the 3DC header. |
4096 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRAPHPROPS_SHOW3DCHEADER |
|
|
show3DLNumber | Specifies whether to show the 3DL number. |
4097 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRAPHPROPS_SHOW3DLNUMBER |
|
|
show3DRHeader | Specifies whether to show the 3DR header. |
4099 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRAPHPROPS_SHOW3DRHEADER |
|
|
show3DRNumber | Specifies whether to show the 3DR number. |
4098 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRAPHPROPS_SHOW3DRNUMBER |
|
|
stepX | Step of the X axis. |
4100 | ||
|
stepY1 | Step of the Y1 axis. |
4101 | ||
|
stepY2 | Step of the Y2 axis. |
4102 | ||
|
stepZ | Step of the Z axis. |
4103 | ||
| saveGraphProperties | ||||
| Event for saving the graph properties. |
4096021 | |||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
attributeID | Specifies an attribute in the graph. |
4202 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRAPHPROPS_ATTRIBUTEID |
|
|
autosizeH | A value of 1 indicates whether horizontal autosize should be applied. |
4173 | ||
|
autosizeV | A value of 1 indicates whether vertical autosize should be applied. |
4174 | ||
|
enableTotals | Axes bitmap. |
4176 | ||
|
height | Height of the graph. |
4080 | ||
|
majorType | Major type of the graph. |
4082 | ||
|
minorType | Minor type of the graph. |
4083 | ||
|
objectID | Specifies an object in the graph. |
4085 | ||
|
propValue | Specifies a graph property value. |
4203 | ||
|
seriesByColumns | A value of 1 indicates whether series are displayed by columns. |
4175 | ||
|
seriesID | specifies a series in the graph. |
4209 | ||
|
swapRowsAndCols | Argument that specifies whether the event should swap the rows and columns. This is useful when we change the graph from series by rows to series by columns. By default, we will swap the number of rows and columns anytime the graph's series by columns property is changed. |
4228 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_SWAP_ROWS_AND_COLUMNS |
|
|
width | Width of the graph. |
4081 | ||
| saveGraphTextProperties | ||||
| Event for saving the graph text properties. |
4096022 | |||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
attributeID | Specifies an attribute in the graph. |
4202 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRAPHPROPS_ATTRIBUTEID |
|
|
content | Content of the graph object. |
4091 | ||
|
fillColor | Specifies the fill color in the graph |
4211 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRAPHPROPS_FILL_COLOR |
|
|
fontAlign | Font align property of the graph object. |
4086 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRAPHPROPS_FONT_ALIGN |
|
|
fontColor | Font color property of the graph object. |
4087 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRAPHPROPS_FONT_COLOR |
|
|
fontName | Font name property of the graph object. |
4088 | ||
|
fontSize | Font size property of the graph object. |
4090 | ||
|
fontStyle | Font style property of the graph object. |
4089 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRAPHPROPS_FONT_STYLE |
|
|
lineColor | Specifies the line color in the graph |
4210 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRAPHPROPS_LINE_COLOR |
|
|
objectID | Specifies an object in the graph. |
4085 | ||
|
propValue | Specifies a graph property value. |
4203 | ||
|
seriesID | specifies a series in the graph. |
4209 | ||
|
show | Show property of the graph object. |
4084 | ||
| saveGridAlignmentProperties | ||||
| Event for saving the grid alignment properties. |
4096017 |
EnumViewBeanEvents.VIEW_EVENT_SAVE_GRID_ALIGNMENT_PROPERTIES |
||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
bottomPadding |
4226 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_PATTERN_GRADIENT_ANGLE |
||
|
gridLevel | Level of the grid unit when saving
the grid properties. The possible values are: 1 - Grid 2 - Header 3 - Subtotal grid 4 - Subtotal header |
4109 | ||
|
gridUnit | Unit of the grid.
The possible values are: 1 - Template Unit 2 - Template Metric 3 - Rows 4 - Cols |
4108 | ||
|
horizontal | Specifies horizontal alignment. |
4056 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_ALIGNMENT_HORIZONTAL |
|
|
leftPadding | Specifies the left padding |
4223 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_FORMATTING_LEFT_PADDING |
|
|
oAxis | Origin axis. |
4006 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_AXIS |
|
|
oPos | Origin position of the template unit. |
4007 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_POSITION |
|
|
rightPadding |
4225 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_PATTERN_GRADIENT_COLOR |
||
|
styleName | String argument specifying the name of the style to apply. |
4126 | ||
|
textDirection | Specifies text direction |
4222 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_ALIGNMENT_TEXT_DIRECTION |
|
|
textWrap | Specifies text wrap. |
4058 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_ALIGNMENT_WRAP |
|
|
topPadding |
4224 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_PATTERN_FILL_STYLE |
||
|
vertical | Specifies vertical alignment. |
4057 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_ALIGNMENT_VERTICAL |
|
| saveGridBandingProperties | ||||
| Event for saving the grid banding properties. |
4096020 | |||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
colorGroup1 | Banding color of group 1. |
4078 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_BANDING_COLOR_GROUP1 |
|
|
colorGroup2 | Banding color of group 2. |
4079 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_BANDING_COLOR_GROUP2 |
|
|
enabled | Specifies that banding is enabled. |
4074 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_BANDING_ENABLED |
|
|
gridLevel | Level of the grid unit when saving
the grid properties. The possible values are: 1 - Grid 2 - Header 3 - Subtotal grid 4 - Subtotal header |
4109 | ||
|
gridUnit | Unit of the grid.
The possible values are: 1 - Template Unit 2 - Template Metric 3 - Rows 4 - Cols |
4108 | ||
|
group1 | Banding group 1. |
4076 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_BANDING_GROUP1 |
|
|
group2 | Banding group 2. |
4077 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_BANDING_GROUP2 |
|
|
oAxis | Origin axis. |
4006 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_AXIS |
|
|
oPos | Origin position of the template unit. |
4007 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_POSITION |
|
|
rowsColumns | Specifies whether banding is on rows or columns. |
4075 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_BANDING_ROWSCOLS |
|
|
styleName | String argument specifying the name of the style to apply. |
4126 | ||
| saveGridBorderProperties | ||||
| Event for saving the grid border properties. |
4096018 | |||
|
3DBottomColor |
4230 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_BORDER_3D_BOTTOM_COLOR |
||
|
3DLeftColor |
4231 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_BORDER_3D_LEFT_COLOR |
||
|
3DRightColor |
4232 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_BORDER_3D_RIGHT_COLOR |
||
|
3DStyle | Specifies the left padding |
4223 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_FORMATTING_LEFT_PADDING |
|
|
3DTopColor |
4229 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_BORDER_3D_TOP_COLOR |
||
|
3DWeight | Specifies text direction |
4222 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_ALIGNMENT_TEXT_DIRECTION |
|
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
bottomColor | Bottom border color. |
4069 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_BORDER_BOTTOM_COLOR |
|
|
bottomStyle | Bottom border style. |
4063 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_BORDER_BOTTOM_STYLE |
|
|
gridLevel | Level of the grid unit when saving
the grid properties. The possible values are: 1 - Grid 2 - Header 3 - Subtotal grid 4 - Subtotal header |
4109 | ||
|
gridUnit | Unit of the grid.
The possible values are: 1 - Template Unit 2 - Template Metric 3 - Rows 4 - Cols |
4108 | ||
|
hInsideColor | Horizontal inside border color. |
4065 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_BORDER_HINSIDE_COLOR |
|
|
hInsideStyle | Horizontal inside border style. |
4059 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_BORDER_HINSIDE_STYLE |
|
|
leftColor | Left border color. |
4068 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_BORDER_LEFT_COLOR |
|
|
leftStyle | Left border style. |
4062 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_BORDER_LEFT_STYLE |
|
|
oAxis | Origin axis. |
4006 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_AXIS |
|
|
oPos | Origin position of the template unit. |
4007 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_POSITION |
|
|
rightColor | Right border color. |
4070 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_BORDER_RIGHT_COLOR |
|
|
rightStyle | Right border style. |
4064 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_BORDER_RIGHT_STYLE |
|
|
styleName | String argument specifying the name of the style to apply. |
4126 | ||
|
topColor | Top border color. |
4067 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_BORDER_TOP_COLOR |
|
|
topStyle | Top border style. |
4061 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_BORDER_TOP_STYLE |
|
|
vInsideColor | Vertical inside border color. |
4066 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_BORDER_VINSIDE_COLOR |
|
|
vInsideStyle | Vertical inside border style. |
4060 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_BORDER_VINSIDE_STYLE |
|
| saveGridFontPropertiesEvent | ||||
| Event for saving the grid font properties. |
4096015 | |||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
fontBold | Specifies whether the font is bold. |
4043 | ||
|
fontColor | Color of the font. |
4048 | ||
|
fontItalic | Specifies whether the font is italic. |
4044 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_FONT_ITALIC |
|
|
fontName | Name of the font. |
4042 | ||
|
fontScript | Script of the font. |
4049 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_FONT_SCRIPT |
|
|
fontSize | Size of the font. |
4045 | ||
|
fontStrikeout | Specifies whether the font is striked-out. |
4046 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_FONT_STRIKEOUT |
|
|
fontUnderline | Specifies whether the font is underlined. |
4047 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_FONT_UNDERLINE |
|
|
gridLevel | Level of the grid unit when saving
the grid properties. The possible values are: 1 - Grid 2 - Header 3 - Subtotal grid 4 - Subtotal header |
4109 | ||
|
gridUnit | Unit of the grid.
The possible values are: 1 - Template Unit 2 - Template Metric 3 - Rows 4 - Cols |
4108 | ||
|
oAxis | Origin axis. |
4006 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_AXIS |
|
|
oPos | Origin position of the template unit. |
4007 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_POSITION |
|
|
styleName | String argument specifying the name of the style to apply. |
4126 | ||
| saveGridNumberPropertiesEvent | ||||
| Event for saving the grid number properties. |
4096016 | |||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
category | Number category. |
4050 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_NUM_CATEGORY |
|
|
currencyPosition | Currency position. |
4054 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_NUM_CURRENCY_POS |
|
|
currencySymbol | Currency symbol. |
4053 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_NUM_CURRENCY_SYMBOL |
|
|
decimalPlaces | Decimal places of the number. |
4051 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_NUM_DECIMAL_PLACES |
|
|
format | Number format. |
4055 | ||
|
gridLevel | Level of the grid unit when saving
the grid properties. The possible values are: 1 - Grid 2 - Header 3 - Subtotal grid 4 - Subtotal header |
4109 | ||
|
gridUnit | Unit of the grid.
The possible values are: 1 - Template Unit 2 - Template Metric 3 - Rows 4 - Cols |
4108 | ||
|
negativeNumbers | Currency position. |
4111 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_NUM_NEGATIVE_NUMS |
|
|
oAxis | Origin axis. |
4006 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_AXIS |
|
|
oPos | Origin position of the template unit. |
4007 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_POSITION |
|
|
styleName | String argument specifying the name of the style to apply. |
4126 | ||
|
thousandSeparator | Thousand separator. |
4052 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_NUM_THOUSAND_SEP |
|
| saveGridPatternProperties | ||||
| Event for saving the grid pattern properties. |
4096019 | |||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
fillColor | Pattern fill color. |
4071 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_PATTERN_FILL_COLOR |
|
|
fillStyle |
4224 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_PATTERN_FILL_STYLE |
||
|
gradientAngle |
4226 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_PATTERN_GRADIENT_ANGLE |
||
|
gradientColor |
4225 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_PATTERN_GRADIENT_COLOR |
||
|
gradientXOffset |
4229 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_BORDER_3D_TOP_COLOR |
||
|
gradientYOffset |
4230 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_BORDER_3D_BOTTOM_COLOR |
||
|
gridLevel | Level of the grid unit when saving
the grid properties. The possible values are: 1 - Grid 2 - Header 3 - Subtotal grid 4 - Subtotal header |
4109 | ||
|
gridUnit | Unit of the grid.
The possible values are: 1 - Template Unit 2 - Template Metric 3 - Rows 4 - Cols |
4108 | ||
|
oAxis | Origin axis. |
4006 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_AXIS |
|
|
oPos | Origin position of the template unit. |
4007 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_POSITION |
|
|
patternColor | Pattern color. |
4072 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_PATTERN_COLOR |
|
|
patternStyle | Pattern style. |
4073 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_PATTERN_STYLE |
|
|
styleName | String argument specifying the name of the style to apply. |
4126 | ||
| setColumnScenario | ||||
Event for setting the column scenario. If the scenario is set to EnumDSSXMLWidthScenario.DssXmlWidthFixed,
default grid and header widths should be specified too. |
4096036 | |||
|
*columnScenario | Argument specifying the column scenario to be set.
Possible values are listed in EnumDSSXMLWidthScenario. |
4153 | ||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
clearAllWidths | Argument specifying whether to clear all the widths before setting a column scenario
to EnumDSSXMLWidthScenario.DssXmlWidthFixed. |
4161 | ||
|
gridWidth | Argument specifying the default grid width for a column scenario of type
EnumDSSXMLWidthScenario.DssXmlWidthFixed. |
4156 | ||
|
headerWidth | Argument specifying the default header width for a column scenario of type
EnumDSSXMLWidthScenario.DssXmlWidthFixed. |
4155 | ||
| setGraphProps | ||||
| Event for saving the graph window settings. |
4096040 | |||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
isSeriesByColumns | Argument that specifies whether the graph is set to 'Series by columns' or
'Series by rows'. 1 indicates 'Series by columns' |
4227 | ||
|
maxC | Max number of columns for the grid. |
4025 | ||
|
maxS | Max number of rows for the grid. |
4024 | ||
| setRowScenario | ||||
Event for setting the row scenario. If the row scenario is set to
EnumDSSXMLWidthScenario.DssXmlWidthFixed,
row height should be specified too. |
4096037 | |||
|
*rowScenario | Argument specifying the row scenario to be set. Possible values are
EnumDSSXMLWidthScenario.DssXmlWidthFitToContent
and EnumDSSXMLWidthScenario.DssXmlWidthFixed. |
4154 | ||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
rowHeight | Argument specifying the row height for a row scenario of type
EnumDSSXMLWidthScenario.DssXmlWidthFitToContent. |
4157 | ||
| setSubtotalPosition | ||||
| Event to set the subtotal position for a given axis |
4096053 | |||
|
*axis | Origin axis. |
4006 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_AXIS |
|
|
*subtotalPosition | Specifies the subtotal position for a given axis., from EnumDSSXMLSubtotalsPosition |
4217 | ||
| setViewProps | ||||
Event for setting values for specific properties. |
4096001 | |||
|
*propStr | Argument specifying the propertySet, the property name and the desired property value that needs to be set. The format of the argument is: PropertySetName|sep|PropertyName|sep|PropertyValue|sep|"dft" where |sep| is a separator, the constant for which is the last part "dft" is optional. It means changing the property to default value |
4146 | ||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
styleName | String argument specifying the name of the style to apply. |
4126 | ||
| setVisualizationProps | ||||
|
4096048 | ||||
|
aPhoneVis | Indicates the selected visualization for android phone |
409606619 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_ANDROID_SELECTED_VISUALIZATION |
|
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
aTabletVis | Indicates the selected visualization for android tablet |
409606621 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_ANDROID_TABLET_SELECTED_VISUALIZATION |
|
|
enabled |
4096048 | |||
|
image | Indicates the visualization's image |
409606615 | ||
|
includeMDProps | Indicates whether to include the MD properties on the visualization's data XML |
4255 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_INCLUDE_MD_PROPERTIES |
|
|
ipadVis | Indicates the selected visualization for the ipad |
409606618 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_IPAD_SELECTED_VISUALIZATION |
|
|
iphoneVis | Indicates the selected visualization for the iphone |
409606617 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_IPHONE_SELECTED_VISUALIZATION |
|
|
selectedVisualization |
4096049 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_SELECTED_VISUALIZATION |
||
|
viewMode |
4096051 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_VISUALIZATION_VIEW_MODE |
||
|
visProps | Indicates the visualization's properties |
409606616 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_VISUALIZATION_PROPERTIES |
|
|
visualizationList |
4096050 | |||
| showBandingEvent | ||||
| Event for showing or hiding the banding. |
4096033 | |||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
showBanding | Boolean argument indicating whether banding should be shown.
a value of EnumViewBeanEvents.HIDE_BANDING indicates that banding should be hidden.
otherwise it is shown. |
4125 | ||
|
styleName | String argument specifying the name of the style to apply. |
4126 | ||
| showOutlineMode | ||||
| Sets the flag that specifies whether the view should be displayed as outline mode or not. |
4096026 | |||
|
outlineMode | String argument specifying whether the view should
be displayed in outline mode.
possible values are:
EnumViewBeanEvents.HIDE_OUTLINE_MODE
EnumViewBeanEvents.SHOW_OUTLINE_MODE |
4121 | ||
| showSubtotals | ||||
| Sets the flag that shows subtotals on the template. |
4096025 | |||
|
show | Boolean argument indicating whether subtotals should be shown.
possible values are:
EnumViewBeanEvents.SHOW_SUB_TOTALS
EnumViewBeanEvents.HIDE_SUB_TOTALS |
4116 | ||
| sortEvent | ||||
Event for setting the sort object. Defines the sorts to be added. |
4096003 | |||
|
*sortKey | Sort key.
The format of the key is as follows:
EnumViewBeanEvents.SORT_PARAM_TYPE=type<sep>EnumViewBeanEvents.SORT_PARAM_ID=id<sep>EnumViewBeanEvents.SORT_PARAM_FORM_ID=id<sep>EnumViewBeanEvents.SORT_PARAM_FORM_TYPE=type<sep>EnumViewBeanEvents.SORT_PARAM_ELEM_LIST<sep>EnumViewBeanEvents.SORT_PARAM_AXIS
where <sep> is EnumViewBeanEvents.SORT_PARAM_SEPARATOR
SORT_PARAM_ELEM_LIST is a list of elements separated by EnumViewBeanEvents.SORT_ELEM_LIST_SEPARATOR |
4011 | ||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
|
clearSorts | Specifies whether the previous sorts should be cleared before adding the current ones. |
4013 | ||
|
ctlTPKeys |
4263 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_SORT_CONTROL_TOP_MOST_KEY_LIST |
||
|
respectParent |
4262 | |||
|
sortOrder | Order of the sort - EnumViewBeanEvents.SORT_ORDER_ASCENDING/EnumViewBeanEvents.SORT_ORDER_DESCENDING.
The default is EnumViewBeanEvents.SORT_ORDER_ASCENDING. |
4012 | ||
|
subtotalPos | Argument indicating where the subtotals should be placed once the sorting is performed. |
4138 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_SORT_SUBTOTAL_POSITION |
|
| swapTemplateUnits | ||||
| Event for swapping template units in the Row and Column Axes. |
4096042 | |||
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
| thresholdDisplay | ||||
| Event for enabling/disabling the thresholds correponding to metrics. |
4096041 | |||
|
*enable | Whether threshold display should be enabled. |
4171 |
EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_ENABLE_THRESHOLD_DISPLAY |
|
|
applyNow | Specifies if the user wants to apply the changes by contacting the server. The allowed values are "1" or "0" for true and false respectively. The default value is "1". |
4110 | ||
| toggleHideNullValues | ||||
|
4096069 | ||||
|
*value |
4261 | |||
| unsetDatamart | ||||
| This event can be used to unset a report datamart
The possible parameters that can be sent in are:
|
4096047 | |||
Notes
* denotes required field.