public interface

WebGraph

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

Class Overview

This object allows a user to manipulate and load a graph data stream.

Summary

Public Methods
abstract boolean getAutosizeHorizontal()
Returns the autosize horizontal property
abstract boolean getAutosizeVertical()
Returns the autosize vertical property
abstract int getCategories()
Returns the number of graph rows fetched.
abstract byte[] getData()
Returns a byte array representing the graph image.
abstract void getData(IContentConsumer consumer)
Obtains graph data from IServer and streams it to the provided content consumer
abstract String getErrorInGraph()
Returns an error number returned when attempting to execute a graph.
abstract SimpleList getGraphAreas()
Returns a SimpleList collection of WebGraphArea objects for this particular WebGraph object.
abstract WebGraphProperties getGraphProperties(boolean populate)
retrieves graph properties
abstract WebGraphProperties getGraphProperties()
retrieves graph properties
abstract int getGraphTotalColumns()
Returns the total number of columns in this graph report.
abstract int getGraphTotalRows()
Returns the total number of rows in this graph report.
abstract int getGraphTypesAvailable()
Returns the available graph types for this particular report.
abstract int getHeight()
Returns the graph height in pixels.
abstract int getImageType()
Returns the current graph type.
abstract int getMajorType()
Returns the graph major type.
abstract int getMinorType()
Returns the graph minor type.
abstract WebResultWindow getResultWindow()
Returns the result window to be used in this report.
abstract int getSeries()
Returns the number of graph columns fetched.
abstract int getWidth()
Returns the graph width in pixels.
abstract boolean isChartAvailable()
abstract boolean isLinkedToControl()
Indicate whether this graph object linked to any control.
abstract void saveToDisk(String fileName)
Saves the current graph file to disk.
abstract void setAutosizeHorizontal(boolean _asH)
Sets the autosize horizontal property
abstract void setAutosizeVertical(boolean _asV)
Sets the autosize vertical property
abstract void setHeight(int graphHeight)
Sets the graph's height.
abstract void setImageType(int imageType)
Specifies the image type to be used for this report.
abstract void setMajorType(int graphMajorType)
Sets the graph's major type.
abstract void setMinorType(int graphMinorType)
Sets the graph's minor type.
abstract void setWidth(int graphWidth)
Sets the graph's width.

Public Methods

public abstract boolean getAutosizeHorizontal ()

Returns the autosize horizontal property

Returns
  • the autosize horizontal property

public abstract boolean getAutosizeVertical ()

Returns the autosize vertical property

Returns
  • the autosize vertical property

public abstract int getCategories ()

Returns the number of graph rows fetched.

Returns
  • the number of graph rows fetched.

public abstract byte[] getData ()

Returns a byte array representing the graph image. This method applies the following properties: sessionID, messageID, windowSettings, stateID, graphImageType and graphProperty.

Returns
  • A byte array of the graph image.
Throws
WebObjectsException Thrown if the graph cannot be loaded.

public abstract void getData (IContentConsumer consumer)

Obtains graph data from IServer and streams it to the provided content consumer

Parameters
consumer Content consumer
Throws
WebObjectsException
WebObjectsException

public abstract String getErrorInGraph ()

Returns an error number returned when attempting to execute a graph.

Returned from XSL pattern search: "/mi/rit/vw/vws/gpp/@en".

Returns
  • A string value of the error number.

public abstract SimpleList getGraphAreas ()

Returns a SimpleList collection of WebGraphArea objects for this particular WebGraph object. Each WebGraphArea object represents an 'area' on the graph image with certain properties, and represents the underlying graph object.

Throws
WebObjectsException
WebObjectsException

public abstract WebGraphProperties getGraphProperties (boolean populate)

retrieves graph properties

Parameters
populate when set to true all graph properties are loaded.
Returns
  • the graph properties. The properties would be populated if data has already been collected Otherwise, an empty collection is returned
Throws
WebObjectsException
WebObjectsException

public abstract WebGraphProperties getGraphProperties ()

retrieves graph properties

Returns
  • the graph properties. The properties would be populated if data has already been collected Otherwise, an empty collection is returned
Throws
WebObjectsException
WebObjectsException

public abstract int getGraphTotalColumns ()

Returns the total number of columns in this graph report.

Returned from XSL search pattern: "/mi/rit/vw/vws/gpp/@tc".

Returns
  • The total number of columns in this report.

public abstract int getGraphTotalRows ()

Returns the total number of rows in this graph report.

Returned from XSL search pattern: "/mi/rit/vw/vws/gpp/@tr".

Returns
  • The total number of rows in this report.

public abstract int getGraphTypesAvailable ()

Returns the available graph types for this particular report.

Returned from XSL search pattern: "/mi/rit/vw/vws/gpp/@gta".

Returns

public abstract int getHeight ()

Returns the graph height in pixels.

Returns
  • The graph height.
See Also

public abstract int getImageType ()

Returns the current graph type.

The default graph image type is DssXmlGraphImgGIF

Returns

public abstract int getMajorType ()

Returns the graph major type.

Returns

public abstract WebResultWindow getResultWindow ()

Returns the result window to be used in this report.

Returns

public abstract int getSeries ()

Returns the number of graph columns fetched.

Returns
  • the number of graph columns fetched.

public abstract int getWidth ()

Returns the graph width in pixels.

Returns
  • The graph width.
See Also

public abstract boolean isChartAvailable ()

public abstract boolean isLinkedToControl ()

Indicate whether this graph object linked to any control.

public abstract void saveToDisk (String fileName)

Saves the current graph file to disk. This method applies the following properties: sessionID, messageID, windowSettings, stateID, graphImageType and graphProperty.

Parameters
fileName File name of the graph file to be produced; with a path if specified.
Throws
WebObjectsException Thrown if the graph cannot be created and saved.

public abstract void setAutosizeHorizontal (boolean _asH)

Sets the autosize horizontal property

public abstract void setAutosizeVertical (boolean _asV)

Sets the autosize vertical property

public abstract void setHeight (int graphHeight)

Sets the graph's height.

Parameters
graphHeight The new graph's height in pixels.
Throws
IllegalArgumentException Thrown if trying to set a height less than or equal to zero.
See Also

public abstract void setImageType (int imageType)

Specifies the image type to be used for this report.

Parameters
imageType Image type defined as EnumDSSXMLGraphImgTypes enumeration.
See Also

public abstract void setMajorType (int graphMajorType)

Sets the graph's major type.

Parameters
graphMajorType The new major type, from EnumDSSXMLMajorGraphTypes.
Throws
IllegalArgumentException Thrown if trying to set a major type less than or equal to zero.
See Also

public abstract void setWidth (int graphWidth)

Sets the graph's width.

Parameters
graphWidth The new graph's width in pixels.
Throws
IllegalArgumentException Thrown if trying to set a width less than or equal to zero.
See Also