Package com.microstrategy.web.objects

Interface WebGraphProperties

public interface WebGraphProperties

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

Since:

MicroStrategy Web 7.3.1 or earlier

Method Summary

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

Method Detail

findGraphProperty

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:

The WebGraphProperty object found, null if not found.

findGraphProperty

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:

The WebGraphProperty object found, null if not found.

Since:

MicroStrategy Web 8.0.1

add

WebGraphProperty add(int objectID,
                     int attributeID,
                     java.lang.String value)
              throws java.lang.UnsupportedOperationException

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:

The newly created WebGraphProperty.

Throws:

java.lang.UnsupportedOperationException - Thrown if trying to add a property in a read-only collection.

add

WebGraphProperty add(int objectID,
                     int attributeID,
                     int seriesID,
                     java.lang.String value)
              throws java.lang.UnsupportedOperationException

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:

The newly created WebGraphProperty.

Throws:

java.lang.UnsupportedOperationException - Thrown if trying to add a property in a read-only collection.

Since:

MicroStrategy Web 8.0.1

get

WebGraphProperty get(int index)
              throws java.lang.IndexOutOfBoundsException

Returns the WebGraphProperty object with the given index.

Parameters:

index - The index of the graph property in the collection.

Returns:

The WebGraphProperty object corresponding to the given index in the collection.

Throws:

java.lang.IndexOutOfBoundsException - Thrown if the given index is out of the bounds of the collection.

remove

void remove(int index)
     throws java.lang.UnsupportedOperationException,
            java.lang.IndexOutOfBoundsException

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

Parameters:

index - The index of the property in the collection to remove.

Throws:

java.lang.IndexOutOfBoundsException - Thrown if the given index is out of the bounds of the collection.

java.lang.UnsupportedOperationException - Thrown if trying to remove a property from a read-only collection.

clear

void clear()
    throws java.lang.UnsupportedOperationException

Removes all graph properties from the collection.

Throws:

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

size

int size()

Returns the number of graph properties currently in the collection.

Returns:

The current number of properties in the collection.

isEmpty

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.

elements

java.util.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.

elements

java.util.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.

Parameters:

objectID -

attributeID -

Since:

MicroStrategy Web 8.0.1

getXML

java.lang.String getXML()

Returns the graph properties XML.

Returns:

A string representation of the graph properties.

getHeight

int getHeight()

Returns the graph height in pixels.

Returns:

The graph height.

See Also:

setHeight(int)

getWidth

int getWidth()

Returns the graph width in pixels.

Returns:

The graph width.

See Also:

setWidth(int)

getMajorType

int getMajorType()

Returns the graph major type.

Returns:

the graph major type, from EnumDSSXMLMajorGraphTypes.

See Also:

setMajorType(int)

getMinorType

int getMinorType()

Returns the graph minor type.

Returns:

the graph minor type, from EnumDSSXMLVAreaMinorTypes, EnumDSSXMLHAreaMinorTypes, EnumDSSXMLVBarMinorTypes, EnumDSSXMLHBarMinorTypes, EnumDSSXMLVLineMinorTypes, EnumDSSXMLHLineMinorTypes, EnumDSSXMLPieMinorTypes, EnumDSSXMLScatterMinorTypes, EnumDSSXMLPolarMinorTypes, EnumDSSXMLRadarMinorTypes, EnumDSSXMLBubbleMinorTypes, EnumDSSXMLHiloStockMinorTypes, EnumDSSXMLHistogramMinorTypes, EnumDSSXML3DRiserMinorTypes, EnumDSSXML3DFloatMinorTypes, EnumDSSXML3DConnGrpMinorTypes, EnumDSSXML3DConnSeriesMinorTypes, EnumDSSXML3DSurfaceMinorTypes, or EnumDSSXML3DScatterMinorTypes.

See Also:

setMinorType(int)

setHeight

void setHeight(int graphHeight)
        throws java.lang.UnsupportedOperationException,
               java.lang.IllegalArgumentException

Sets the graph's height.

Parameters:

graphHeight - The new graph's height in pixels.

Throws:

java.lang.UnsupportedOperationException - if trying to modify a read-only object.

java.lang.IllegalArgumentException - Thrown if trying to set a height less than or equal to zero.

See Also:

getHeight()

setWidth

void setWidth(int graphWidth)
       throws java.lang.UnsupportedOperationException,
              java.lang.IllegalArgumentException

Sets the graph's width.

Parameters:

graphWidth - The new graph's width in pixels.

Throws:

java.lang.UnsupportedOperationException - if trying to modify a read-only object.

java.lang.IllegalArgumentException - Thrown if trying to set a width less than or equal to zero.

See Also:

getWidth()

setMajorType

void setMajorType(int graphMajorType)
           throws java.lang.UnsupportedOperationException,
                  java.lang.IllegalArgumentException

Sets the graph's major type.

Parameters:

graphMajorType - The new major type, from EnumDSSXMLMajorGraphTypes.

Throws:

java.lang.UnsupportedOperationException - if trying to modify a read-only object.

java.lang.IllegalArgumentException - Thrown if trying to set a major type less than or equal to zero.

See Also:

getMajorType()

setMinorType

void setMinorType(int graphMinorType)
           throws java.lang.UnsupportedOperationException,
                  java.lang.IllegalArgumentException

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:

java.lang.UnsupportedOperationException - Thrown if trying to modify a read-only object.

java.lang.IllegalArgumentException - Thrown if trying to set a minor type less than or equal to zero.

See Also:

getMinorType()

getAutosizeHorizontal

boolean getAutosizeHorizontal()

Returns the autosize horizontal property

Returns:

the autosize horizontal property

Since:

MicroStrategy Web 8.0.0

getAutosizeVertical

boolean getAutosizeVertical()

Returns the autosize vertical property

Returns:

the autosize vertical property

Since:

MicroStrategy Web 8.0.0

setAutosizeHorizontal

void setAutosizeHorizontal(boolean _asH)

Sets the autosize horizontal property

Since:

MicroStrategy Web 8.0.0

setAutosizeVertical

void setAutosizeVertical(boolean _asV)

Sets the autosize vertical property

Since:

MicroStrategy Web 8.0.0

isSeriesByColumns

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).

Since:

MicroStrategy Web 8.0.0

setSeriesByColumns

void setSeriesByColumns(boolean _sbc)

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

Since:

MicroStrategy Web 8.0.0

isTotalsEnabled

boolean isTotalsEnabled()

returns true if totals (including subtotals) are enabled.

Returns:

true if totals (including subtotals) are enabled

Since:

MicroStrategy Web 8.0.0

setTotalsEnabled

void setTotalsEnabled(boolean _ist)

enables/disables totals (including subtotals).

Since:

MicroStrategy Web 8.0.0

getSeriesColor

java.lang.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

Since:

MicroStrategy Web 8.0.0

setSeriesColor

void setSeriesColor(int seriesID,
                    java.lang.String seriesColor)

sets the color for a series in the graph.

Parameters:

seriesID - the index of the series (0 based)

seriesColor - the desired color

Since:

MicroStrategy Web 8.0.0