public class

WebGraphAreaImpl

extends Object
implements WebGraphArea
java.lang.Object
   ↳ com.microstrategy.web.objects.WebGraphAreaImpl

Summary

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

Public Methods

public void addHyperLinks (WebHyperLinks links)

public WebGraphArea copy ()

copy WebGraphArea

Returns
  • the copy of WebGraphArea

public 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 String getCoordinates ()

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

public WebDrillMap getDrillMap ()

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

public int getGroupID ()

Returns the group which is associated with the graph area.

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

public List<WebHyperLinks> getHyperLinks ()

public 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 Set<RWControl> getRWControls ()

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

Returns

public int getSeriesID ()

Returns the series which is associated with the graph area.

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

public int getShape ()

Return the shape of the graph area. From EnumDSSXMLAreaShapes

Returns

public String getToolTip ()

Returns the tooltip for the graph area.

Returns
  • String that represents the tooltip

public 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 boolean isLinkedToControl ()

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

public boolean isMetric ()

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

Returns
  • a boolean

public void setCoordinates (String coords)

Set coordinates