public interface

WebAxisSubtotalInstance

implements WebSubtotalInstance
com.microstrategy.web.objects.WebAxisSubtotalInstance

Class Overview

Subtotal instance that defines an axis subtotal. Also known as subtotal by position

Summary

Public Methods
abstract int getStyle(int axisIndex)
Returns the subtotal style setting for the given axis in the report.
abstract void setStyle(int axisIndex, int style)
Sets the subtotal style setting for a given axis in the report.
[Expand]
Inherited Methods
From interface com.microstrategy.web.objects.WebSubtotalInstance

Public Methods

public abstract int getStyle (int axisIndex)

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
Throws
IllegalArgumentException Thrown if the given axisIndex is invalid.

public abstract void setStyle (int axisIndex, int style)

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.
Throws
IllegalArgumentException Thrown if the given axisIndex or style is invalid.