public interface

WebGraphArea

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

Summary

Public Methods
abstract void addHyperLinks(WebHyperLinks links)
abstract WebGraphArea copy()
copy WebGraphArea
abstract int getAxesBitMap()
Returns the axes that the graph area represents.
abstract String getCoordinates()
Returns a string representing the co-ordinates required to define the graph area.
abstract WebDrillMap getDrillMap()
Returns the WebDrillMap associated with the graph area.
abstract int getGroupID()
Returns the group which is associated with the graph area.
abstract List<WebHyperLinks> getHyperLinks()
abstract int getObjectID()
Each graph area is associated to a graph object which is represented by the ID.
abstract Set<RWControl> getRWControls()
Get the set of all available selector controls on current graph area,
abstract int getSeriesID()
Returns the series which is associated with the graph area.
abstract int getShape()
Return the shape of the graph area.
abstract String getToolTip()
Returns the tooltip for the graph area.
abstract boolean isDrillable()
Utility to determine if the graph area is drillable or not.
abstract boolean isLinkedToControl()
returns true if the graph area corresponds to a template unit which has a control.
abstract boolean isMetric()
Returns a boolean true if the graph area is a metric otherwise false.
abstract void setCoordinates(String coords)
Set coordinates

Public Methods

public abstract void addHyperLinks (WebHyperLinks links)

public abstract WebGraphArea copy ()

copy WebGraphArea

Returns
  • the copy of WebGraphArea

public abstract int getAxesBitMap ()

Returns the axes that the graph area represents. A graph area can correspond to 0 or more Axes (e.g. data points corresond to both axes, empty areas corresond to no axes, labels correspond to one axis). The returned value is bitwise ORed one from EnumDSSXMLAxesBitMap.

public abstract String getCoordinates ()

Returns a string representing the co-ordinates required to define the graph area.

public abstract WebDrillMap getDrillMap ()

Returns the WebDrillMap associated with the graph area. If the area is not drillable, this method returns null.

public abstract int getGroupID ()

Returns the group which is associated with the graph area.

Returns
  • int that represents the 'index' of the group

public abstract List<WebHyperLinks> getHyperLinks ()

public abstract int getObjectID ()

Each graph area is associated to a graph object which is represented by the ID. The graph object ID is from EnumDSSXMLGraphObjectID

Returns
  • This method will return the objectID associated to the graph area.

public abstract Set<RWControl> getRWControls ()

Get the set of all available selector controls on current graph area,

Returns

public abstract int getSeriesID ()

Returns the series which is associated with the graph area.

Returns
  • int that represents the 'index' of the series

public abstract int getShape ()

Return the shape of the graph area. From EnumDSSXMLAreaShapes

Returns

public abstract String getToolTip ()

Returns the tooltip for the graph area.

Returns
  • String that represents the tooltip

public abstract boolean isDrillable ()

Utility to determine if the graph area is drillable or not.

Returns
  • boolean true is there is a drill map associated with the area and false otherwise

public abstract boolean isLinkedToControl ()

returns true if the graph area corresponds to a template unit which has a control.

public abstract boolean isMetric ()

Returns a boolean true if the graph area is a metric otherwise false.

Returns
  • a boolean

public abstract void setCoordinates (String coords)

Set coordinates