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