public interface

WebVisualizationSettings

com.microstrategy.web.objects.WebVisualizationSettings
Known Indirect Subclasses

Class Overview

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.

Summary

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

Public Methods

public abstract void addToList (String visualization)

Adds the given visualization to the list.

Parameters
visualization The visualization to add to the list.

public abstract void clearList ()

Clears the visualization list.

public abstract 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.

public abstract String getImage ()

The image to be used by this visualization

public abstract 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.

public abstract String getProps ()

The visualization properties

public abstract String getSelectedAndroidTabletVisualization ()

Returns the currently selected visualization for Android Tablet.

Returns
  • The currently selected visualization for Android Tablet.

public abstract String getSelectedAndroidVisualization ()

Returns the currently selected visualization for Android.

Returns
  • The currently selected visualization for Android.

public abstract String getSelectedIPadVisualization ()

Returns the currently selected visualization for the ipad

Returns
  • The currently selected visualization for the ipad

public abstract String getSelectedIPhoneVisualization ()

Returns the currently selected visualization for the iphone.

Returns
  • The currently selected visualization for the iphone.

public abstract String getSelectedVisualization ()

Returns the currently selected visualization.

Returns
  • The currently selected visualization.

public abstract String[] getVisualizationsList ()

Returns a list of the currently activated visualizations.

Returns
  • A String[] containing the names of the activated visualizations.

public abstract boolean isEnabled ()

Returns whether visualizations are enabled on this object.

Returns
  • Whether visualizations are enabled or not.

public abstract void removeFromList (String visualization)

Removes the given visualization from the list.

Parameters
visualization The visualization to remove from the list.

public abstract void setEnabled (boolean val)

Sets whether visualizations are enabled.

Parameters
val True if the visualizations should be enabled, false otherwise.

public abstract void setFileName (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.

public abstract void setImage (String image)

The image to be used by this visualization

Parameters
image The image to be used by this visualization

public abstract void setIncludeMDProps (String includeMDProps)

Whether to include the MD properties on the XML passed to the visualization

public abstract void setMode (int mode)

Sets the visualization mode.

Parameters
mode The new visualization mode.

public abstract void setProps (String value)

The visualization properties

Parameters
value The visualization properties

public abstract void setSelectedAndroidTabletVisualization (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.

public abstract void setSelectedAndroidVisualization (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.

public abstract void setSelectedIPadVisualization (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.

public abstract void setSelectedIPhoneVisualization (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.

public abstract void setSelectedVisualization (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.