public class

GraphSeriesInformation

extends Object
implements Cloneable
java.lang.Object
   ↳ com.microstrategy.web.app.beans.GraphSeriesInformation

Class Overview

This class is used for handling the series information that should be displayed given the current graph major and minor type

Summary

Constants
int FILL_PROPERTY_SUPPORT Constant for indicating fill (color) property is supported by the current graph element
int FONTBOX_PROPERTY_SUPPORT
int FONT_PROPERTY_SUPPORT Constant for indicating font properties are supported by the current graph element
int LINE_PROPERTY_SUPPORT Constant for indicating line (color) property is supported by the current graph element
int SHOW_PROPERTY_SUPPORT Constant for indicating show property is supported by the current graph element
int TOOLTIP_PROPERTY_SUPPORT
Public Constructors
GraphSeriesInformation(int objectID, int major, int minor)
Class constructor, initializing its properties with the given parameters
GraphSeriesInformation(int objectID, int major, int minor, int seriesIndex)
Class constructor
Public Methods
Object clone()
String getCustomDescriptor()
String getDescriptorID(int seriesIndex)
Returns the descriptor ID associated with this title information instance
String getDescriptorID()
String getFilter()
int getObjectID()
Returns the object ID associated with this title information instance
int getPropertySupport()
int getSeriesIndex()
boolean isComposedFilter()
boolean isSupported()
boolean isSupported(int seriesIndex)
boolean isTypeSupported(int major)
void setCustomDescriptor(String value)
Set a custom descriptor to use for this instance
void setSeriesIndex(int value)
Set the series index value for this instance
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int FILL_PROPERTY_SUPPORT

Constant for indicating fill (color) property is supported by the current graph element

Constant Value: 4 (0x00000004)

public static final int FONTBOX_PROPERTY_SUPPORT

Constant Value: 128 (0x00000080)

public static final int FONT_PROPERTY_SUPPORT

Constant for indicating font properties are supported by the current graph element

Constant Value: 1 (0x00000001)

public static final int LINE_PROPERTY_SUPPORT

Constant for indicating line (color) property is supported by the current graph element

Constant Value: 2 (0x00000002)

public static final int SHOW_PROPERTY_SUPPORT

Constant for indicating show property is supported by the current graph element

Constant Value: 16 (0x00000010)

public static final int TOOLTIP_PROPERTY_SUPPORT

Constant Value: 64 (0x00000040)

Public Constructors

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.

public GraphSeriesInformation (int objectID, int major, int minor, int seriesIndex)

Class constructor

Parameters
objectID identifier of the descriptor to use for this title
major int value with a valid graph type
minor int value with a valid graph subtype
seriesIndex int value of the series index represented

Public Methods

public Object clone ()

public String getCustomDescriptor ()

Returns
  • String value of the custom descriptor, if any specified

public String getDescriptorID (int seriesIndex)

Returns the descriptor ID associated with this title information instance

Returns
  • the value of the descriptor ID property

public String getDescriptorID ()

Returns
  • String value of the descriptor ID property, taking into consideration the series index property of this instance

public String getFilter ()

public int getObjectID ()

Returns the object ID associated with this title information instance

Returns
  • the value of the object ID property

public int getPropertySupport ()

Returns

public int getSeriesIndex ()

Returns
  • int value representing the series index

public boolean isComposedFilter ()

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)

public boolean isSupported (int seriesIndex)

public boolean isTypeSupported (int major)

public void setCustomDescriptor (String value)

Set a custom descriptor to use for this instance

Parameters
value String with the descriptor to use

public void setSeriesIndex (int value)

Set the series index value for this instance

Parameters
value int representing the series index