public interface

WebGraphProperties

com.microstrategy.web.objects.WebGraphProperties

Class Overview

The WebGraphProperties interface represents a collection of WebGraphProperty objects, each of which represent a graph format property.

Summary

Public Methods
abstract WebGraphProperty add(int objectID, int attributeID, int seriesID, String value)
Creates a new WebGraphProperty object using the given parameters, adds it to the graph properties collection, and returns it.
abstract WebGraphProperty add(int objectID, int attributeID, String value)
Creates a new WebGraphProperty object using the given parameters, adds it to the graph properties collection, and returns it.
abstract void clear()
Removes all graph properties from the collection.
abstract Enumeration elements(int objectID, int attributeID)
Returns a java.util.Enumeration that is a filtered collection based on the objectID and the attributeID parameters passed in.
abstract Enumeration elements()
Returns a java.util.Enumeration which can be used to iterate through the list of graph properties in the collection.
abstract WebGraphProperty findGraphProperty(int objectID, int attributeID, int seriesID)
Finds the graph property with the given object ID, attribute ID and seriesID
abstract WebGraphProperty findGraphProperty(int objectID, int attributeID)
Finds the graph property with the given object ID and attribute ID.
abstract WebGraphProperty get(int index)
Returns the WebGraphProperty object with the given index.
abstract boolean getAutosizeHorizontal()
Returns the autosize horizontal property
abstract boolean getAutosizeVertical()
Returns the autosize vertical property
abstract int getHeight()
Returns the graph height in pixels.
abstract int getMajorType()
Returns the graph major type.
abstract int getMinorType()
Returns the graph minor type.
abstract String getSeriesColor(int seriesID)
returns the color for a series in the graph.
abstract int getWidth()
Returns the graph width in pixels.
abstract String getXML()
Returns the graph properties XML.
abstract boolean isEmpty()
Returns true if there are no graph properties in this collection, false if there are one or more properties in the collection.
abstract boolean isSeriesByColumns()
returns true if graph series represent the report columns (false means that series represent the rows).
abstract boolean isTotalsEnabled()
returns true if totals (including subtotals) are enabled.
abstract void remove(int index)
Removes the WebGraphProperty object with the given index from the collection.
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 setMajorType(int graphMajorType)
Sets the graph's major type.
abstract void setMinorType(int graphMinorType)
Sets the graph's minor type.
abstract void setSeriesByColumns(boolean _sbc)
Sets graph series to represent report columns if true is passed else series would represent grid rows.
abstract void setSeriesColor(int seriesID, String seriesColor)
sets the color for a series in the graph.
abstract void setTotalsEnabled(boolean _ist)
enables/disables totals (including subtotals).
abstract void setWidth(int graphWidth)
Sets the graph's width.
abstract int size()
Returns the number of graph properties currently in the collection.

Public Methods

public abstract WebGraphProperty add (int objectID, int attributeID, int seriesID, String value)

Creates a new WebGraphProperty object using the given parameters, adds it to the graph properties collection, and returns it.

Parameters
objectID The object ID of the graph property to add.
attributeID The attribute ID of the graph property to add.
seriesID The ID or index of the series whose property is being added
value The value of the graph property.
Returns
Throws
UnsupportedOperationException Thrown if trying to add a property in a read-only collection.

public abstract WebGraphProperty add (int objectID, int attributeID, String value)

Creates a new WebGraphProperty object using the given parameters, adds it to the graph properties collection, and returns it.

Parameters
objectID The object ID of the graph property to add.
attributeID The attribute ID of the graph property to add.
value The value of the graph property.
Returns
Throws
UnsupportedOperationException Thrown if trying to add a property in a read-only collection.

public abstract void clear ()

Removes all graph properties from the collection.

Throws
UnsupportedOperationException Thrown if trying to clear a read-only collection.

public abstract Enumeration elements (int objectID, int attributeID)

Returns a java.util.Enumeration that is a filtered collection based on the objectID and the attributeID parameters passed in.

public abstract Enumeration elements ()

Returns a java.util.Enumeration which can be used to iterate through the list of graph properties in the collection.

Returns
  • An Enumeration which allows iteration through the collection.

public abstract WebGraphProperty findGraphProperty (int objectID, int attributeID, int seriesID)

Finds the graph property with the given object ID, attribute ID and seriesID

Parameters
objectID The object ID of the property to find, from EnumDSSXMLGraphObjectID.
attributeID The attribute ID of the property to find, from EnumDSSXMLGraphAttributeID.
seriesID The ID or index of the series for that graph
Returns

public abstract WebGraphProperty findGraphProperty (int objectID, int attributeID)

Finds the graph property with the given object ID and attribute ID.

Parameters
objectID The object ID of the property to find, from EnumDSSXMLGraphObjectID.
attributeID The attribute ID of the property to find, from EnumDSSXMLGraphAttributeID.
Returns

public abstract WebGraphProperty get (int index)

Returns the WebGraphProperty object with the given index.

Parameters
index The index of the graph property in the collection.
Returns
Throws
IndexOutOfBoundsException Thrown if the given index is out of the bounds of the collection.

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 getHeight ()

Returns the graph height in pixels.

Returns
  • The graph height.
See Also

public abstract int getMajorType ()

Returns the graph major type.

Returns
See Also

public abstract int getMinorType ()

Returns the graph minor type.

Returns
See Also

public abstract String getSeriesColor (int seriesID)

returns the color for a series in the graph.

Parameters
seriesID the index of the series (0 based)
Returns
  • graph series color

public abstract int getWidth ()

Returns the graph width in pixels.

Returns
  • The graph width.
See Also

public abstract String getXML ()

Returns the graph properties XML.

Returns
  • A string representation of the graph properties.

public abstract boolean isEmpty ()

Returns true if there are no graph properties in this collection, false if there are one or more properties in the collection.

Returns
  • Whether the collection is empty.

public abstract boolean isSeriesByColumns ()

returns true if graph series represent the report columns (false means that series represent the rows).

Returns
  • true if graph series represent the report columns (false means that series represent the rows).

public abstract boolean isTotalsEnabled ()

returns true if totals (including subtotals) are enabled.

Returns
  • true if totals (including subtotals) are enabled

public abstract void remove (int index)

Removes the WebGraphProperty object with the given index from the collection.

Parameters
index The index of the property in the collection to remove.
Throws
IndexOutOfBoundsException Thrown if the given index is out of the bounds of the collection.
UnsupportedOperationException Thrown if trying to remove a property from a read-only collection.

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
UnsupportedOperationException if trying to modify a read-only object.
IllegalArgumentException Thrown if trying to set a height less than or equal to zero.
See Also

public abstract void setMajorType (int graphMajorType)

Sets the graph's major type.

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

public abstract void setMinorType (int graphMinorType)

Sets the graph's minor type.

Parameters
graphMinorType The new minor type, from EnumDSSXMLVAreaMinorTypes, EnumDSSXMLHAreaMinorTypes, EnumDSSXMLVBarMinorTypes, EnumDSSXMLHBarMinorTypes, EnumDSSXMLVLineMinorTypes, EnumDSSXMLHLineMinorTypes, EnumDSSXMLPieMinorTypes, EnumDSSXMLScatterMinorTypes, EnumDSSXMLPolarMinorTypes, EnumDSSXMLRadarMinorTypes, EnumDSSXMLBubbleMinorTypes, EnumDSSXMLHiloStockMinorTypes, EnumDSSXMLHistogramMinorTypes, EnumDSSXML3DRiserMinorTypes, EnumDSSXML3DFloatMinorTypes, EnumDSSXML3DConnGrpMinorTypes, EnumDSSXML3DConnSeriesMinorTypes, EnumDSSXML3DSurfaceMinorTypes, or EnumDSSXML3DScatterMinorTypes.
Throws
UnsupportedOperationException Thrown if trying to modify a read-only object.
IllegalArgumentException Thrown if trying to set a minor type less than or equal to zero.
See Also

public abstract void setSeriesByColumns (boolean _sbc)

Sets graph series to represent report columns if true is passed else series would represent grid rows.

public abstract void setSeriesColor (int seriesID, String seriesColor)

sets the color for a series in the graph.

Parameters
seriesID the index of the series (0 based)
seriesColor the desired color

public abstract void setTotalsEnabled (boolean _ist)

enables/disables totals (including subtotals).

public abstract void setWidth (int graphWidth)

Sets the graph's width.

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

public abstract int size ()

Returns the number of graph properties currently in the collection.

Returns
  • The current number of properties in the collection.