Class Visualizations

    • Field Detail

      • NODE_VISUALIZATIONS

        public static final java.lang.String NODE_VISUALIZATIONS
        See Also:
        Constant Field Values
    • Constructor Detail

      • Visualizations

        public Visualizations()
      • Visualizations

        public Visualizations​(org.w3c.dom.Node root)
    • Method Detail

      • getVisualizationListFromNames

        public VisualizationList getVisualizationListFromNames​(java.lang.String[] visualizationNames)
        Returns a list of visualizations generated from list of visualization names
        Parameters:
        visualizationNames - a list of visualization names
        Returns:
        a list of visualizations generated from list of visualization names
      • getAllVisualizations

        public VisualizationList getAllVisualizations()
        Returns:
        a list with all visualizations from all visualizations lists
      • getAllWebVisualizations

        public VisualizationList getAllWebVisualizations()
        Returns:
        a list with all visualizations from all visualizations lists that are visible to Web (i.e. not mobile)
      • getAllVisualizations

        @Deprecated
        public VisualizationList getAllVisualizations​(int scope)
        Deprecated.
        use getAllVisualizations() and filter out each visualization using (@link Visualization.isValid())
        Returns a list with all visualizations with the scope specified from all visualizations lists
        Parameters:
        scope - the scope of the visualizations desired
        Returns:
        a list with all visualizations from all visualizations lists
      • getVisualizationList

        public VisualizationList getVisualizationList​(int index)
        Parameters:
        index - the index of the visualization list to return
        Returns:
        the visualization list specified
      • getVisualizationList

        public VisualizationList getVisualizationList​(java.lang.Object key)
        Parameters:
        key - the key (i.e. "flash") of the visualization list to return
        Returns:
        the visualization list specified
      • getVisualizationListForViewMode

        public VisualizationList getVisualizationListForViewMode​(int viewMode)
        Parameters:
        viewMode - the view mode of the visualization list to return (from EnumWebVisualizationViewModes)
        Returns:
        the visualization list specified
      • getVisualizationListName

        public java.lang.String getVisualizationListName​(int viewMode)
        Return the name of the visualization that matches the specified view mode
        Parameters:
        viewMode - the view mode
        Returns:
        the name of the visualization that matches the specified view mode
      • getAllVisualizationsJson

        @Deprecated
        public java.lang.String getAllVisualizationsJson​(Messages messages)
        Deprecated.
        use getAllVisualizationsJson(Messages) as its more efficient
        Returns a String that defines a JSON object used to pass the list of all visualizations to the client side
        Parameters:
        messages - The Messages object
        Returns:
        a String that defines a JSON object used to pass the list of all visualizations to the client side
        Since:
        MicroStrategy Web 9.0.1
      • generateAllVisualizationsJson

        public GenericJsonGenerator generateAllVisualizationsJson​(Messages messages)
        Returns a JSONGenerator object used to pass the list of all visualizations to the client side
        Parameters:
        messages - The Messages object
        Returns:
        a JSONGenerator object used to pass the list of all visualizations to the client side
      • generateVisualizationsJson

        public GenericJsonGenerator generateVisualizationsJson​(Messages messages,
                                                               VisualizationList visList)
        Returns a JSONGenerator object used to pass the list of all visualizations to the client side
        Parameters:
        messages - The Messages object
        visList - the list used to build the JSON
        Returns:
        a JSONGenerator object used to pass the list of all visualizations to the client side