Interface WebAxisSubtotalInstance

  • All Superinterfaces:
    WebSubtotalInstance

    public interface WebAxisSubtotalInstance
    extends WebSubtotalInstance
    Subtotal instance that defines an axis subtotal. Also known as subtotal by position
    Since:
    MicroStrategy Web 9.0.0
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int getStyle​(int axisIndex)
      Returns the subtotal style setting for the given axis in the report.
      void setStyle​(int axisIndex, int style)
      Sets the subtotal style setting for a given axis in the report.
    • Method Detail

      • getStyle

        int getStyle​(int axisIndex)
              throws java.lang.IllegalArgumentException
        Returns the subtotal style setting for the given axis in the report. This value, from EnumDSSXMLSubtotalStyle, will tell the setting of the subtotal on the given axis.
        Parameters:
        axisIndex - The index of the axis to check, from EnumDSSXMLAxisName.
        Returns:
        The setting for the subtotal on the given axis, from EnumDSSXMLSubtotalStyle.
        Throws:
        java.lang.IllegalArgumentException - Thrown if the given axisIndex is invalid.
      • setStyle

        void setStyle​(int axisIndex,
                      int style)
               throws java.lang.IllegalArgumentException
        Sets the subtotal style setting for a given axis in the report. This value if from EnumDSSXMLSubtotalStyle
        Parameters:
        axisIndex - The index of the axis to check, from EnumDSSXMLAxisName.
        style -
        Throws:
        java.lang.IllegalArgumentException - Thrown if the given axisIndex or style is invalid.