Package com.microstrategy.web.app.beans
Class GraphSeriesInformation
- java.lang.Object
-
- com.microstrategy.web.app.beans.GraphSeriesInformation
-
- All Implemented Interfaces:
java.lang.Cloneable
public class GraphSeriesInformation extends java.lang.Object implements java.lang.Cloneable
This class is used for handling the series information that should be displayed given the current graph major and minor type- Since:
- MicroStrategy Web 8.0.1
-
-
Field Summary
Fields Modifier and Type Field Description static int
FILL_PROPERTY_SUPPORT
Constant for indicating fill (color) property is supported by the current graph elementstatic int
FONT_PROPERTY_SUPPORT
Constant for indicating font properties are supported by the current graph elementstatic int
FONTBOX_PROPERTY_SUPPORT
static int
LINE_PROPERTY_SUPPORT
Constant for indicating line (color) property is supported by the current graph elementstatic int
SHOW_PROPERTY_SUPPORT
Constant for indicating show property is supported by the current graph elementstatic int
TOOLTIP_PROPERTY_SUPPORT
-
Constructor Summary
Constructors Constructor Description GraphSeriesInformation(int objectID, int major, int minor)
Class constructor, initializing its properties with the given parametersGraphSeriesInformation(int objectID, int major, int minor, int seriesIndex)
Class constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
java.lang.String
getCustomDescriptor()
java.lang.String
getDescriptorID()
java.lang.String
getDescriptorID(int seriesIndex)
Returns the descriptor ID associated with this title information instancejava.lang.String
getFilter()
int
getObjectID()
Returns the object ID associated with this title information instanceint
getPropertySupport()
int
getSeriesIndex()
boolean
isComposedFilter()
boolean
isSupported()
boolean
isSupported(int seriesIndex)
boolean
isTypeSupported(int major)
void
setCustomDescriptor(java.lang.String value)
Set a custom descriptor to use for this instancevoid
setSeriesIndex(int value)
Set the series index value for this instance
-
-
-
Field Detail
-
FONT_PROPERTY_SUPPORT
public static final int FONT_PROPERTY_SUPPORT
Constant for indicating font properties are supported by the current graph element- See Also:
- Constant Field Values
-
LINE_PROPERTY_SUPPORT
public static final int LINE_PROPERTY_SUPPORT
Constant for indicating line (color) property is supported by the current graph element- See Also:
- Constant Field Values
-
FILL_PROPERTY_SUPPORT
public static final int FILL_PROPERTY_SUPPORT
Constant for indicating fill (color) property is supported by the current graph element- See Also:
- Constant Field Values
-
SHOW_PROPERTY_SUPPORT
public static final int SHOW_PROPERTY_SUPPORT
Constant for indicating show property is supported by the current graph element- See Also:
- Constant Field Values
-
TOOLTIP_PROPERTY_SUPPORT
public static final int TOOLTIP_PROPERTY_SUPPORT
- Since:
- MicroStrategy Web 8.1.0
- See Also:
- Constant Field Values
-
FONTBOX_PROPERTY_SUPPORT
public static final int FONTBOX_PROPERTY_SUPPORT
- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
GraphSeriesInformation
public GraphSeriesInformation(int objectID, int major, int minor)
Class constructor, initializing its properties with the given parameters- Parameters:
objectID
- identifier of the descriptor to use for this title.
-
GraphSeriesInformation
public GraphSeriesInformation(int objectID, int major, int minor, int seriesIndex)
Class constructor- Parameters:
objectID
- identifier of the descriptor to use for this titlemajor
- int value with a valid graph typeminor
- int value with a valid graph subtypeseriesIndex
- int value of the series index represented
-
-
Method Detail
-
clone
public java.lang.Object clone()
- Overrides:
clone
in classjava.lang.Object
-
getObjectID
public int getObjectID()
Returns the object ID associated with this title information instance- Returns:
- the value of the object ID property
-
getDescriptorID
public java.lang.String getDescriptorID(int seriesIndex)
Returns the descriptor ID associated with this title information instance- Returns:
- the value of the descriptor ID property
-
getDescriptorID
public java.lang.String getDescriptorID()
- Returns:
- String value of the descriptor ID property, taking into consideration the series index property of this instance
-
setCustomDescriptor
public void setCustomDescriptor(java.lang.String value)
Set a custom descriptor to use for this instance- Parameters:
value
- String with the descriptor to use
-
getCustomDescriptor
public java.lang.String getCustomDescriptor()
- Returns:
- String value of the custom descriptor, if any specified
-
setSeriesIndex
public void setSeriesIndex(int value)
Set the series index value for this instance- Parameters:
value
- int representing the series index
-
getSeriesIndex
public int getSeriesIndex()
- Returns:
- int value representing the series index
-
isComposedFilter
public boolean isComposedFilter()
-
getFilter
public java.lang.String getFilter()
-
getPropertySupport
public int getPropertySupport()
- Returns:
- int bit-wise value with the information about which properties are supported by this
graph element. Values come from the
FONT_PROPERTY_SUPPORT
,LINE_PROPERTY_SUPPORT
,FILL_PROPERTY_SUPPORT
andSHOW_PROPERTY_SUPPORT
constants.
-
isSupported
public boolean isSupported()
- Returns:
- boolean value indicating if the current series information represented on this instance is supported by the graph details defined as properties (series index, major and minor)
-
isSupported
public boolean isSupported(int seriesIndex)
-
isTypeSupported
public boolean isTypeSupported(int major)
-
-