Package com.microstrategy.web.objects

Class 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 WebGraphArea
      int 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 the WebDrillMap 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

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • 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 interface WebGraphArea

      • 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 from EnumDSSXMLGraphObjectID
        Specified by:
        getObjectID in interface WebGraphArea
        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 interface WebGraphArea
        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 interface WebGraphArea
        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 interface WebGraphArea
        Returns:
        String that represents the tooltip

      • isDrillable

        public boolean isDrillable()
        Description copied from interface: WebGraphArea
        Utility to determine if the graph area is drillable or not.
        Specified by:
        isDrillable in interface WebGraphArea
        Returns:
        boolean true is there is a drill map associated with the area and false otherwise

      • setCoordinates

        public void setCoordinates​(java.lang.String coords)
        Description copied from interface: WebGraphArea
        Set coordinates
        Specified by:
        setCoordinates in interface WebGraphArea

      • 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 interface WebGraphArea
        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 interface WebGraphArea

      • 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 from EnumDSSXMLAxesBitMap.
        Specified by:
        getAxesBitMap in interface WebGraphArea