Package com.microstrategy.web.objects
Interface WebGraphArea
-
- All Known Implementing Classes:
WebGraphAreaImpl
public interface WebGraphArea
- Since:
- MicroStrategy Web 8.1.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addHyperLinks(WebHyperLinks links)
WebGraphArea
copy()
copy WebGraphAreaint
getAxesBitMap()
Returns the axes that the graph area represents.java.lang.String
getCoordinates()
Returns a string representing the co-ordinates required to define the graph area.WebDrillMap
getDrillMap()
Returns theWebDrillMap
associated with the graph area.int
getGroupID()
Returns the group which is associated with the graph area.java.util.List<WebHyperLinks>
getHyperLinks()
int
getObjectID()
Each graph area is associated to a graph object which is represented by the ID.java.util.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.java.lang.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(java.lang.String coords)
Set coordinates
-
-
-
Method Detail
-
getShape
int getShape()
Return the shape of the graph area. FromEnumDSSXMLAreaShapes
- Returns:
- integer value from
EnumDSSXMLAreaShapes
that defines the shape of the graph area
-
getCoordinates
java.lang.String getCoordinates()
Returns a string representing the co-ordinates required to define the graph area.
-
setCoordinates
void setCoordinates(java.lang.String coords)
Set coordinates- Parameters:
coords
-
-
getObjectID
int getObjectID()
Each graph area is associated to a graph object which is represented by the ID. The graph object ID is fromEnumDSSXMLGraphObjectID
- Returns:
- This method will return the objectID associated to the graph area.
-
getSeriesID
int getSeriesID()
Returns the series which is associated with the graph area.- Returns:
- int that represents the 'index' of the series
-
getGroupID
int getGroupID()
Returns the group which is associated with the graph area.- Returns:
- int that represents the 'index' of the group
-
getToolTip
java.lang.String getToolTip()
Returns the tooltip for the graph area.- Returns:
- String that represents the tooltip
-
getDrillMap
WebDrillMap getDrillMap()
Returns theWebDrillMap
associated with the graph area. If the area is not drillable, this method returns null.
-
addHyperLinks
void addHyperLinks(WebHyperLinks links)
-
getHyperLinks
java.util.List<WebHyperLinks> getHyperLinks()
-
isDrillable
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 andfalse
otherwise
-
isLinkedToControl
boolean isLinkedToControl()
returns true if the graph area corresponds to a template unit which has a control.
-
getAxesBitMap
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 fromEnumDSSXMLAxesBitMap
.
-
isMetric
boolean isMetric()
Returns a boolean true if the graph area is a metric otherwise false.- Returns:
- a boolean
- Since:
- MicroStrategy Web 9.0.0
-
getRWControls
java.util.Set<RWControl> getRWControls()
Get the set of all available selector controls on current graph area,- Returns:
- Set of
RWControl
- Since:
- MicroStrategy Web 9.2.0
-
copy
WebGraphArea copy()
copy WebGraphArea- Returns:
- the copy of WebGraphArea
-
-