Package com.microstrategy.web.objects.rw

Interface RWGridGraphDef

    • Method Detail

      • getDataSet

        RWDataSet getDataSet()
        Returns the data set this object is based on
        Returns:
        the data set this grid/graph is based on

      • getEffectiveDataSet

        RWDataSet getEffectiveDataSet()
        Returns either Joined data set or data set this object is based on
        Returns:
        either Joined data set or data set this object is based on

      • setDataSet

        void setDataSet​(java.lang.String id)
        Connects this object to a data set
        Parameters:
        id - data set ID

      • setDataSet

        void setDataSet​(RWDataSet value)
        Connects this object to a data set
        Parameters:
        value - data set

      • getViewInstance

        WebViewInstance getViewInstance()
        Returns a view instance representing grid/graph definition
        Returns:
        a view instance representing grid/graph definition

      • getDisplayMode

        int getDisplayMode()
        Returns the view mode from EnumDSSXMLDisplayMode. By default, the view mode is set to the grid mode.
        Returns:
        the report view mode.

      • setDisplayMode

        void setDisplayMode​(int displayMode)
        Sets the report view mode (EnumDSSXMLDisplayMode) By default, the view mode was set to the gride mode.
        Parameters:
        displayMode - a new report view mode.

      • addUserMetric

        WebTemplateMetric addUserMetric​(RWUserMetric userMetric,
                                int beforeKey)
                         throws java.lang.IllegalArgumentException,
                                WebObjectsException
        Adds the user derived metric to the view defintion. Note that this would change the TemplateMetrics collection for the view instance corresponding to this definition object.
        Parameters:
        userMetric - the user metric to add. The user metric should be present on the dataset object associate with the definition.
        Returns:
        the template metric corresponding to the user metric added.
        Throws:
        java.lang.IllegalArgumentException - if the user metric is not in the dataset.
        WebObjectsException

      • addUserMetric

        WebTemplateMetric addUserMetric​(RWUserMetric userMetric)
                         throws java.lang.IllegalArgumentException,
                                WebObjectsException
        Adds the user derived metric to the view defintion. Note that this would change the TemplateMetrics collection for the view instance corresponding to this definition object. The metric would be added at the end of the template metrics collection.
        Parameters:
        userMetric - the user metric to add. The user metric should be present on the dataset object associate with the definition.
        Returns:
        the template metric corresponding to the user metric added.
        Throws:
        java.lang.IllegalArgumentException - if the user metric is not in the dataset.
        WebObjectsException

      • getViewFilter

        WebFilter getViewFilter()
        Returns the view filter that is applied to the grid object within the RW document. This filter can be edited to change the filter that is on the grid. In order to apply any filter changes, the applyChanges method on the RWManipulation interface must be called.
        Returns:
        A WebFilter object, that represents the view filter of the grid/graph def.
        Since:
        MicroStrategy Web 8.0.1

      • addControl

        RWControl addControl​(java.lang.String controlKey,
                     int templateAxis,
                     int templatePosition)
              throws WebObjectsException
        Adds control to template unit
        Parameters:
        controlKey - control key
        templateAxis - template axis
        templatePosition - template unit position on the axis
        Returns:
        RWControl control
        Throws:
        WebObjectsException
        Since:
        MicroStrategy Web 8.1.0

      • addControl

        RWControl addControl​(java.lang.String controlKey,
                     java.lang.String tuObjectId,
                     int tuObjectType)
              throws WebObjectsException
        Adds control to template unit
        Parameters:
        controlKey - control key
        tuObjectId - template unit object ID
        tuObjectType - template unit object type
        Returns:
        RWControl control
        Throws:
        WebObjectsException
        Since:
        MicroStrategy Web 8.1.0

      • getControl

        RWControl getControl​(java.lang.String tuObjectId,
                     int tuObjectType)
        Returns control for specified template unit
        Parameters:
        tuObjectId - template unit object ID
        tuObjectType - template unit object type
        Returns:
        control or null
        Since:
        MicroStrategy Web 8.1.0

      • removeControl

        void removeControl​(java.lang.String ctlKey)
            throws WebObjectsException
        Removes control by its key
        Parameters:
        ctlKey - control key
        Throws:
        WebObjectsException
        Since:
        MicroStrategy Web 8.1.0

      • removeControl

        void removeControl​(java.lang.String tuObjectId,
                   int tuObjectType)
            throws WebObjectsException
        Removes control from specified template unit
        Parameters:
        tuObjectId - template unit object ID
        tuObjectType - template unit object type
        Throws:
        WebObjectsException
        Since:
        MicroStrategy Web 8.1.0

      • hasControls

        boolean hasControls()
        Since:
        MicroStrategy Web 9.0.1

      • getControlKeysWithTopMost

        java.lang.String getControlKeysWithTopMost()
        get the keys of controls that are set to auto pick top most.
        Returns:
        keys join by ''

      • getControls

        java.util.List getControls()

      • getAssociatedNodes

        java.util.Set<java.lang.String> getAssociatedNodes​(int manipulationCategory)
        Returns associated nodes for the specified manipulationCategory. The returned set is never null.
        Parameters:
        manipulationCategory - in EnumDSSXMLRWManipulationCategory
        Returns:
        a set containing associated nodes. If no associated node is found returns a empty set

      • removeAssociatedNodes

        void removeAssociatedNodes​(java.util.Set<java.lang.String> nodeKeys,
                           int manipulationCategory)

      • addAssociatedNodes

        void addAssociatedNodes​(java.util.Set<java.lang.String> nodeKeys,
                        int manipulationCategory)

      • removePlaceHolderTargets

        void removePlaceHolderTargets​(java.util.Set<java.lang.Integer> phRemoves)
        Remove placeholders that has been targeted to a selector
        Parameters:
        phRemoves -

      • setCurrentSliceID

        void setCurrentSliceID​(int sliceID)
        Set current grid's slice ID, which will be used when rendering. Since when we have page bys, different grids will share the same definition.
        Parameters:
        sliceID -

      • getCurrentSliceID

        int getCurrentSliceID()
        Get current grid's slice ID.
        Returns: