public interface

VisualizationsEditorBean

implements ReportFrameElement ViewBeanParserBean
com.microstrategy.web.app.beans.VisualizationsEditorBean
Known Indirect Subclasses

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract boolean areVisualizationsEnabled()
abstract String getActiveLayoutID()
The ID of the layout whose visualization is being set.
abstract VisualizationList getAndroidTabletVisualizations()
abstract VisualizationList getAndroidVisualizations()
abstract VisualizationList getAvailableVisualizations()
abstract VisualizationList getIPadVisualizations()
abstract VisualizationList getIPhoneVisualizations()
abstract int getScope()
abstract String getSelectedAndroidTabletVisualization()
abstract String getSelectedAndroidVisualization()
abstract String getSelectedIPadVisualization()
abstract String getSelectedIPadVisualizations()
This method is deprecated. use getSelectedIPadVisualization()
abstract String getSelectedIPhoneVisualization()
abstract String getSelectedIPhoneVisualizations()
This method is deprecated. use getSelectedIPhoneVisualization()
abstract String getSelectedSecondaryDataSourceKeys()
abstract VisualizationList getSelectedVisualizations()
abstract HashList<String, String> getVisProps()
abstract boolean haveSecondarySourcesChanged()
abstract void setScope(int scope)
Whether this editor applies to a Report (SCOPE_REPORT), a Grid in a Document (SCOPE_RW_GRID) or a Document (SCOPE_RW)
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.FrameElement
From interface com.microstrategy.web.app.beans.ReportFrameElement
From interface com.microstrategy.web.app.beans.ViewBeanParserBean
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Public Methods

public abstract boolean areVisualizationsEnabled ()

Returns
  • whether visualizations are enabled for the current report or document.

public abstract String getActiveLayoutID ()

The ID of the layout whose visualization is being set.
Note: only relevant when the scope is (SCOPE_RW_LAYOUT)

public abstract VisualizationList getAndroidTabletVisualizations ()

Returns
  • the list of available visualizations for android tablet

public abstract VisualizationList getAndroidVisualizations ()

Returns
  • the list of available visualizations for android phone

public abstract VisualizationList getAvailableVisualizations ()

Returns
  • the list of available visualizations with the scope set on the editor

public abstract VisualizationList getIPadVisualizations ()

Returns
  • the list of available visualizations for the ipad

public abstract VisualizationList getIPhoneVisualizations ()

Returns
  • the list of available visualizations for the iphone

public abstract int getScope ()

Returns

public abstract String getSelectedAndroidTabletVisualization ()

Returns
  • the selected visualization for android tablet

public abstract String getSelectedAndroidVisualization ()

Returns
  • the selected visualization for android phone

public abstract String getSelectedIPadVisualization ()

Returns
  • the selected visualization for the ipad

public abstract String getSelectedIPadVisualizations ()

This method is deprecated.
use getSelectedIPadVisualization()

Returns
  • the selected visualization for the ipad

public abstract String getSelectedIPhoneVisualization ()

Returns
  • the selected visualization for the iphone

public abstract String getSelectedIPhoneVisualizations ()

This method is deprecated.
use getSelectedIPhoneVisualization()

Returns
  • the selected visualization for the iphone

public abstract String getSelectedSecondaryDataSourceKeys ()

Returns
  • A comma separated list of the secondary providers for the selected grid

public abstract VisualizationList getSelectedVisualizations ()

Returns
  • the list of visualizations available for the current report or document.

public abstract HashList<String, String> getVisProps ()

Returns
  • the list of Visualization Properties

public abstract boolean haveSecondarySourcesChanged ()

Returns
  • whether the original list of secondary providers changed.
    This happens when one of the keys become invalid
Throws
WebBeanException
WebBeanException

public abstract void setScope (int scope)

Whether this editor applies to a Report (SCOPE_REPORT), a Grid in a Document (SCOPE_RW_GRID) or a Document (SCOPE_RW)

Parameters
scope int