Interface EnumViewBeanEvents


  • public interface EnumViewBeanEvents
    Constants for ViewBean events
    Since:
    MicroStrategy Web 8.0.0
    • Field Detail

      • VIEW_EVENT_SET_PROPERTY_VALUES

        static final int VIEW_EVENT_SET_PROPERTY_VALUES

        Event for setting values for specific properties.

        See Also:
        Constant Field Values
      • VIEW_EVENT_PIVOT

        static final int VIEW_EVENT_PIVOT

        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

        See Also:
        Constant Field Values
      • VIEW_EVENT_SORT

        static final int VIEW_EVENT_SORT

        Event for setting the sort object. Defines the sorts to be added.

        See Also:
        Constant Field Values
      • VIEW_EVENT_ENABLE_SUB_TOTALS

        static final int VIEW_EVENT_ENABLE_SUB_TOTALS
        Deprecated.

        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.

        See Also:
        Constant Field Values
      • VIEW_EVENT_DISABLE_SUB_TOTALS

        static final int VIEW_EVENT_DISABLE_SUB_TOTALS
        Event for disabling either a specific type of subtotal. If the type is not specified, all the subtotals are disabled.
        See Also:
        Constant Field Values
      • VIEW_EVENT_ADD_TEMPLATE_UNIT

        static final int VIEW_EVENT_ADD_TEMPLATE_UNIT
        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.
        See Also:
        Constant Field Values
      • VIEW_EVENT_REMOVE_TEMPLATE_UNIT

        static final int VIEW_EVENT_REMOVE_TEMPLATE_UNIT
        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.
        See Also:
        Constant Field Values
      • VIEW_EVENT_MOVE_METRIC

        static final int VIEW_EVENT_MOVE_METRIC
        Event for moving a metric within the metric collection.
        See Also:
        Constant Field Values
      • VIEW_EVENT_GRID_DRILL

        static final int VIEW_EVENT_GRID_DRILL
        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.
        See Also:
        Constant Field Values
      • VIEW_EVENT_GRAPH_DRILL

        static final int VIEW_EVENT_GRAPH_DRILL
        Event for performing a drill on the view graph.
        See Also:
        Constant Field Values
      • VIEW_EVENT_ADD_DERIVED_METRIC

        static final int VIEW_EVENT_ADD_DERIVED_METRIC
        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 VIEW_EVENT_ARGUMENT_METRIC_DESTINATION_POSITION is not specified, the metric is added at position 1
        See Also:
        Constant Field Values
      • VIEW_EVENT_CHANGE_METRIC_FORMULA

        static final int VIEW_EVENT_CHANGE_METRIC_FORMULA
        Event for changing the formula and/or alias associated with a metric.
        See Also:
        Constant Field Values
      • VIEW_EVENT_CHANGE_STYLE

        static final int VIEW_EVENT_CHANGE_STYLE
        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.
        See Also:
        Constant Field Values
      • VIEW_EVENT_SAVE_GRID_FONT_PROPERTIES

        static final int VIEW_EVENT_SAVE_GRID_FONT_PROPERTIES
        Event for saving the grid font properties.
        See Also:
        Constant Field Values
      • VIEW_EVENT_SAVE_GRID_NUMBER_PROPERTIES

        static final int VIEW_EVENT_SAVE_GRID_NUMBER_PROPERTIES
        Event for saving the grid number properties.
        See Also:
        Constant Field Values
      • VIEW_EVENT_SAVE_GRID_ALIGNMENT_PROPERTIES

        static final int VIEW_EVENT_SAVE_GRID_ALIGNMENT_PROPERTIES
        Event for saving the grid alignment properties.
        See Also:
        Constant Field Values
      • VIEW_EVENT_SAVE_GRID_BORDER_PROPERTIES

        static final int VIEW_EVENT_SAVE_GRID_BORDER_PROPERTIES
        Event for saving the grid border properties.
        See Also:
        Constant Field Values
      • VIEW_EVENT_SAVE_GRID_PATTERN_PROPERTIES

        static final int VIEW_EVENT_SAVE_GRID_PATTERN_PROPERTIES
        Event for saving the grid pattern properties.
        See Also:
        Constant Field Values
      • VIEW_EVENT_SAVE_GRID_BANDING_PROPERTIES

        static final int VIEW_EVENT_SAVE_GRID_BANDING_PROPERTIES
        Event for saving the grid banding properties.
        See Also:
        Constant Field Values
      • VIEW_EVENT_SAVE_GRAPH_PROPERTIES

        static final int VIEW_EVENT_SAVE_GRAPH_PROPERTIES
        Event for saving the graph properties.
        See Also:
        Constant Field Values
      • VIEW_EVENT_SAVE_GRAPH_FORMAT_PROPERTIES

        static final int VIEW_EVENT_SAVE_GRAPH_FORMAT_PROPERTIES
        Event for saving the graph format properties.
        See Also:
        Constant Field Values
      • VIEW_EVENT_SAVE_GRAPH_AXIS_PROPERTIES

        static final int VIEW_EVENT_SAVE_GRAPH_AXIS_PROPERTIES
        Event for saving the graph axis properties.
        See Also:
        Constant Field Values
      • VIEW_EVENT_CHANGE_VIEW_MODE

        static final int VIEW_EVENT_CHANGE_VIEW_MODE
        Event for change view view mode to grid, graph or both.
        See Also:
        Constant Field Values
      • VIEW_EVENT_SHOW_SUBTOTALS

        static final int VIEW_EVENT_SHOW_SUBTOTALS
        Sets the flag that shows subtotals on the template.
        See Also:
        Constant Field Values
      • VIEW_EVENT_SHOW_OUTLINE_MODE

        static final int VIEW_EVENT_SHOW_OUTLINE_MODE
        Sets the flag that specifies whether the view should be displayed as outline mode or not.
        See Also:
        Constant Field Values
      • VIEW_EVENT_REMOVE_METRIC

        static final int VIEW_EVENT_REMOVE_METRIC
        Removes a metric based on the specified key or position. If the key or position are not specified, then all the metrics are removed.
        See Also:
        Constant Field Values
      • VIEW_EVENT_ADD_METRIC

        static final int VIEW_EVENT_ADD_METRIC

        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 VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_DESTINATION_AXIS and VIEW_EVENT_ARGUMENT_TEMPLATE_UNIT_DESTINATION_POSITION are used if the metrics collection is not defined on the template. These parameters define where the new collection will be placed.

        See Also:
        Constant Field Values
      • VIEW_EVENT_CLEAR_SORTS

        static final int VIEW_EVENT_CLEAR_SORTS
        Clears all the WebSorts objects contained in the view.
        See Also:
        Constant Field Values
      • VIEW_EVENT_MULTIPLE_SORTS

        static final int VIEW_EVENT_MULTIPLE_SORTS
        Event for setting multiple sort objects. Similar to 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.
See Also:
Constant Field Values
See Also:
Constant Field Values