Package com.microstrategy.web.objects

Interface WebVisualizationSettings

  • All Known Implementing Classes:
    RWUnitVisualizationSettingsImpl, WebReportVisualizationSettingsImpl, WebVisualizationSettingsImpl
    public interface WebVisualizationSettings
    The WebVisualizationSettings interface represents the list of visualization settings for a report, RW document, or RW grid. All changes made to this collection are not persisted to backend unless the appropriate applyChanges method on the report/RW instance is called.
    Since:
    MicroStrategy Web 8.0.2

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addToList​(java.lang.String visualization)
      Adds the given visualization to the list.
      void clearList()
      Clears the visualization list.
      java.lang.String getFileName()
      Returns the file name (e.g. swf file) that corresponds to the selected visualization.
      java.lang.String getImage()
      The image to be used by this visualization
      int getMode()
      Returns the visualization mode.
      java.lang.String getProps()
      The visualization properties
      java.lang.String getSelectedAndroidTabletVisualization()
      Returns the currently selected visualization for Android Tablet.
      java.lang.String getSelectedAndroidVisualization()
      Returns the currently selected visualization for Android.
      java.lang.String getSelectedIPadVisualization()
      Returns the currently selected visualization for the ipad
      java.lang.String getSelectedIPhoneVisualization()
      Returns the currently selected visualization for the iphone.
      java.lang.String getSelectedVisualization()
      Returns the currently selected visualization.
      java.lang.String[] getVisualizationsList()
      Returns a list of the currently activated visualizations.
      boolean isEnabled()
      Returns whether visualizations are enabled on this object.
      void removeFromList​(java.lang.String visualization)
      Removes the given visualization from the list.
      void setEnabled​(boolean val)
      Sets whether visualizations are enabled.
      void setFileName​(java.lang.String fileName)
      Sets the file name (e.g. swf file) that corresponds to the selected visualization.
      void setImage​(java.lang.String image)
      The image to be used by this visualization
      void setIncludeMDProps​(java.lang.String includeMDProps)
      Whether to include the MD properties on the XML passed to the visualization
      void setMode​(int mode)
      Sets the visualization mode.
      void setProps​(java.lang.String value)
      The visualization properties
      void setSelectedAndroidTabletVisualization​(java.lang.String visualization)
      Sets the currently selected visualization.
      void setSelectedAndroidVisualization​(java.lang.String visualization)
      Sets the currently selected visualization.
      void setSelectedIPadVisualization​(java.lang.String visualization)
      Sets the currently selected visualization.
      void setSelectedIPhoneVisualization​(java.lang.String visualization)
      Sets the currently selected visualization.
      void setSelectedVisualization​(java.lang.String visualization)
      Sets the currently selected visualization.

    • Method Detail

      • getMode

        int getMode()
        Returns the visualization mode. If this is 0, then the visualization mode is off. If it is nonzero, then the visualization mode is the value returned. It is up to the API user to define the meanings of the various visualization modes.
        Returns:
        The current visualization mode.

      • setMode

        void setMode​(int mode)
        Sets the visualization mode.
        Parameters:
        mode - The new visualization mode.

      • isEnabled

        boolean isEnabled()
        Returns whether visualizations are enabled on this object.
        Returns:
        Whether visualizations are enabled or not.

      • setEnabled

        void setEnabled​(boolean val)
        Sets whether visualizations are enabled.
        Parameters:
        val - True if the visualizations should be enabled, false otherwise.

      • getSelectedVisualization

        java.lang.String getSelectedVisualization()
        Returns the currently selected visualization.
        Returns:
        The currently selected visualization.

      • setSelectedVisualization

        void setSelectedVisualization​(java.lang.String visualization)
        Sets the currently selected visualization. It is recommended that this be one of the object from the visualization list returned from getVisualizationsList.
        Parameters:
        visualization - The selected visualization.

      • getFileName

        java.lang.String getFileName()
        Returns the file name (e.g. swf file) that corresponds to the selected visualization.
        Returns:
        the file name (e.g. swf file) that corresponds to the selected visualization.
        Since:
        MicroStrategy Web 8.1.0

      • setFileName

        void setFileName​(java.lang.String fileName)
        Sets the file name (e.g. swf file) that corresponds to the selected visualization.
        Parameters:
        fileName - the file name (e.g. swf file) that corresponds to the selected visualization.
        Since:
        MicroStrategy Web 8.1.0

      • getVisualizationsList

        java.lang.String[] getVisualizationsList()
        Returns a list of the currently activated visualizations.
        Returns:
        A String[] containing the names of the activated visualizations.

      • addToList

        void addToList​(java.lang.String visualization)
        Adds the given visualization to the list.
        Parameters:
        visualization - The visualization to add to the list.

      • removeFromList

        void removeFromList​(java.lang.String visualization)
        Removes the given visualization from the list.
        Parameters:
        visualization - The visualization to remove from the list.

      • clearList

        void clearList()
        Clears the visualization list.

      • setIncludeMDProps

        void setIncludeMDProps​(java.lang.String includeMDProps)
        Whether to include the MD properties on the XML passed to the visualization
        Parameters:
        includeMDProps -

      • setImage

        void setImage​(java.lang.String image)
        The image to be used by this visualization
        Parameters:
        image - The image to be used by this visualization

      • getImage

        java.lang.String getImage()
        The image to be used by this visualization

      • setProps

        void setProps​(java.lang.String value)
        The visualization properties
        Parameters:
        value - The visualization properties

      • getProps

        java.lang.String getProps()
        The visualization properties

      • getSelectedIPadVisualization

        java.lang.String getSelectedIPadVisualization()
        Returns the currently selected visualization for the ipad
        Returns:
        The currently selected visualization for the ipad

      • setSelectedIPadVisualization

        void setSelectedIPadVisualization​(java.lang.String visualization)
        Sets the currently selected visualization. It is recommended that this be one of the object from the visualization list returned from getVisualizationsList.
        Parameters:
        visualization - The selected visualization.

      • getSelectedIPhoneVisualization

        java.lang.String getSelectedIPhoneVisualization()
        Returns the currently selected visualization for the iphone.
        Returns:
        The currently selected visualization for the iphone.

      • setSelectedIPhoneVisualization

        void setSelectedIPhoneVisualization​(java.lang.String visualization)
        Sets the currently selected visualization. It is recommended that this be one of the object from the visualization list returned from getVisualizationsList.
        Parameters:
        visualization - The selected visualization.

      • getSelectedAndroidVisualization

        java.lang.String getSelectedAndroidVisualization()
        Returns the currently selected visualization for Android.
        Returns:
        The currently selected visualization for Android.

      • setSelectedAndroidVisualization

        void setSelectedAndroidVisualization​(java.lang.String visualization)
        Sets the currently selected visualization. It is recommended that this be one of the object from the visualization list returned from getVisualizationsList.
        Parameters:
        visualization - The selected visualization.

      • getSelectedAndroidTabletVisualization

        java.lang.String getSelectedAndroidTabletVisualization()
        Returns the currently selected visualization for Android Tablet.
        Returns:
        The currently selected visualization for Android Tablet.

      • setSelectedAndroidTabletVisualization

        void setSelectedAndroidTabletVisualization​(java.lang.String visualization)
        Sets the currently selected visualization. It is recommended that this be one of the object from the visualization list returned from getVisualizationsList.
        Parameters:
        visualization - The selected visualization.