oracle.dss.graph
Class Graph

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--oracle.dss.dataView.Dataview
                                |
                                +--oracle.dss.graph.Graph

All Implemented Interfaces:

javax.accessibility.Accessible, ComponentTypeConverter, DataviewCommon, ErrorHandlerCallback, GraphAttribute, java.awt.image.ImageObserver, java.awt.MenuContainer, PagingControlAttributes, Persistable, java.io.Serializable, StringXMLizable, UIDataview, UIGraph

Direct Known Subclasses:

GraphRef, ThinGraph

public class Graph

extends Dataview

implements UIGraph

The graph bean class. This graph uses Perspective for Java, from Three-D Graphics, to produce a graphical presentation of data.

To display data in this graph, call its setDataSource method, or use the constructor that takes a data source as an argument. You can use the BI Beans DataSource bean, or you can supply your own data source. The DataAccess and DataAccess interfaces, in the oracle.dss.util package, define the methods and constants that a data source must provide.

Alternately, you can call setTabularData to set data that you get from a comma-separated or tab-delimited file, or from a JDBC ResultSet. Note that, when you use setTabularData, the data is not dynamic. If you want users to be able to rotate or drill the data, you must provide a way for users to signal a rotation or a drill, and you must then pass another set of data to setTabularData.

You can set properties on the graph to customize its appearance and behavior. In addition, the graph has a number of components, whose properties you can also set in order to customize the graph.

The BI Beans also provide Java-client user interface classes for setting the graph type, configuring graph axes and titles, and so on. The Java-client user-interface classes are in the oracle.dss.graph.gui package.

See Also:

setTabularData(java.util.List), DataAccess, DataDirector, oracle.dss.graph.gui, Serialized Form

Inner classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Field Summary

static int	ACP_ALWAYS Deprecated. As of 2.6.0.12, replaced by AL_AS_NEEDED or by AL_ALWAYS
static int	ACP_NEVER Deprecated. As of 2.6.0.12, replaced by AL_NEVER
static int	AL_ALWAYS AutoLayout: Always layout components automatically, without checking whether it is necessary.
static int	AL_AS_NEEDED AutoLayout: Layout components automatically only when necessary.
static int	AL_NEVER AutoLayout: Never layout components automatically.
static int	AREA_VERT_ABS Graph type: Absolute area graph.
static int	AREA_VERT_ABS_SPLIT2Y Graph type: Absolute, split dual-Y area graph.
static int	AREA_VERT_PERCENT Graph type: Percent area graph.
static int	AREA_VERT_STACK Graph type: Stacked area graph.
static int	AREA_VERT_STACK_SPLIT2Y Graph type: Stacked, split dual-Y area graph.
static int	AREAMARKER The AreaMarker component.
static int	BACKGROUND The GraphBackground component.
static int	BAR_HORIZ_CLUST Graph type: Clustered bar graph that is horizontal.
static int	BAR_HORIZ_CLUST_2Y Graph type: Clustered, dual-Y bar graph that is horizontal.
static int	BAR_HORIZ_CLUST_SPLIT2Y Graph type: Clustered, split dual-Y graph that is horizontal.
static int	BAR_HORIZ_STACK Graph type: Stacked bar graph that is horizontal.
static int	BAR_HORIZ_STACK_2Y Graph type: Stacked, dual-Y bar graph that is horizontal.
static int	BAR_HORIZ_STACK_SPLIT2Y Graph type: Stacked, split dual-Y bar graph that is horizontal.
static int	BAR_VERT_CLUST Graph type: Clustered bar graph that has a vertical orientation.
static int	BAR_VERT_CLUST_SPLIT2Y Graph type: Clustered, split dual-Y bar graph that is vertical.
static int	BAR_VERT_CLUST2Y Graph type: Clustered, dual-Y bar graph that is vertical.
static int	BAR_VERT_PERCENT Graph type: Percent bar graph that is vertical.
static int	BAR_VERT_STACK Graph type: Stacked bar graph that is vertical.
static int	BAR_VERT_STACK_SPLIT2Y Graph type: Stacked, split dual-Y bar graph that is vertical.
static int	BAR_VERT_STACK2Y Graph type: Stacked, dual-Y bar graph that is vertical.
static int	BUBBLE Graph type: Bubble graph.
static int	BUBBLE_2Y Graph type: Dual-Y bubble graph.
static int	COLOR_BY_GROUP Color Mode: Markers of the same color indicate a group of data.
static int	COLOR_BY_SERIES Color Mode: Markers of the same color indicate a series of data.
static int	CONNECTOR The Connector component.
static int	DATALINE The DataLine component.
static int	DATAMARKER The DataMarker component.
static int	DDT_CUBE Data director type: The DataDirector is a CubeDataDirector, for multidimensional data.
static int	DDT_RELATIONAL Data director type: The DataDirector is a RelationalDataDirector, for relational data.
static int	FITLINE The Fitline component.
static int	GRAPH This graph.
static java.lang.String	GRAPH_TYPE The graph type attribute for searches.
static int	GROUPANDSERIESLIMIT The maximum number of groups and series that this graph can display.
static int	HONOR_PROPERTIES doAutoLayout: Honor the properties that automatic layout normally respects.
static int	LEGENDAREA The LegendArea component.
static int	LEGENDMARKER The LegendMarker component.
static int	LEGENDTEXT The LegendText component.
static int	LINE_VERT_ABS Graph type: Absolute line graph.
static int	LINE_VERT_ABS_2Y Graph type: Absolute, dual-Y line graph.
static int	LINE_VERT_ABS_SPLIT2Y Graph type: Absolute, split dual-Y line graph.
static int	LINE_VERT_PERCENT Graph type: Percent line graph.
static int	LINE_VERT_STACK Graph type: Stacked line graph.
static int	LINE_VERT_STACK_2Y Graph type: Stacked, dual-Y line graph.
static int	LINE_VERT_STACK_SPLIT2Y Graph type: Stacked, split dual-Y line graph.
static int	MAP_ALL All of the image map components that are supported by the graph.
static int	MAP_DATA All of the data points in the plot area of the graph.
static int	MAP_DATATEXT The data text, pie slice labels and pie labels of the graph.
static int	MAP_LABELS The tick labels for the data axes of the graph.
static int	MAP_LEGEND The legend text and legend markers of the graph.
static int	MAP_ORDINALLABELS The labels for the ordinal axis of the graph.
static int	MAP_TITLES The title, subtitle, footnote, and axis titles of the graph.
static int	MARKERTEXT The MarkerText component.
static int	MTT_CUM_VAL Display cumulative data value (stacked graphs only).
static int	MTT_NONE Marker ToolTip Type: No tooltips displayed.
static int	MTT_PERCENT_VAL Display percentage data value (pie slices only).
static int	MTT_PERCENT_VAL_TEXT Marker text type: Display percentage data value (pie slices only) and QDR information, such as "January, Shoes".
static int	MTT_PERCENT_VAL_VALUES Marker text type: Display percentage data value (pie slices only) and data value or values.
static int	MTT_PERCENT_VAL_VALUES_TEXT Marker text type: Display percentage data value (pie slices only), data value or values, and QDR information, such as "January, Shoes".
static int	MTT_TEXT Marker text type: Display QDR information, such as "January, Shoes".
static int	MTT_VALUES Marker ToolTip Type: Display data value or values.
static int	MTT_VALUES_TEXT Marker text type: Display data value or values and QDR information, such as "January, Shoes."
static int	O1AXIS The O1Axis component.
static int	O1MAJORTICK The O1MajorTick component.
static int	O1TICKLABEL The O1TickLabel component.
static int	O1TITLE The O1Title component.
static int	PARETO Graph type: Pareto graph.
static int	PARETOLINE The ParetoLine component.
static int	PIE Graph type: Pie graph.
static int	PIE_BAR Graph type: Pie-Bar graph.
static int	PIE_MULTI Graph type: Multiple pie graph.
static int	PIEFEELER The PieFeeler component.
static int	PIEFRAME The PieFrame component.
static int	PIELABEL The PieLabel component.
static int	PLOTAREA The PlotArea component.
static int	POLAR Graph type: Polar graph.
static int	QUADRANTLINE The QuadrantLine component.
static int	RADAR_LINE Graph type: Radar graph.
static int	REFERENCELINEMARKER The ReferenceLineMarker component.
static int	REFERENCELINETEXT The ReferenceLineText component.
static int	RESET_PROPERTIES doAutoLayout: Reset property values that can be set automatically.
static int	RING Graph type: Ring graph.
static int	RING_BAR Graph type: Ring-Bar graph.
static int	RING_MULTI Graph type: Multiple ring graph.
static int	RINGTOTALLABEL The RingTotalLabel component.
static int	SCATTER Graph type: Scatter graph.
static int	SCATTER_2Y Graph type: Dual-Y scatter graph.
static int	SERIES The Series component.
static int	SERIESOBJECTCOUNTLIMIT The maximum number of different series for which you can save properties.
static int	SLICE The Slice component.
static int	SLICELABEL The SliceLabel component.
static int	SP_ALWAYS Scrollbar presence: Always display scrollbars.
static int	SP_AS_NEEDED Scrollbar presence: Display scrollbars when they are needed.
static int	SP_NEVER Scrollbar presence: Never display scrollbars.
static int	SPLITDIVIDER The SplitDivider component.
static int	STOCK_CANDLE Graph type: Candle open-close stock graph.
static int	STOCK_CANDLE_VOLUME Graph type: Candle open-close stock with volume.
static int	STOCK_HILO_CLOSE Graph type: High-low-close stock graph.
static int	STOCK_HILO_CLOSE_VOLUME Graph type: High-low-close stock graph with volume.
static int	STOCK_OHLC_CANDLE Graph type: Candle open-high-low-close stock graph.
static int	STOCK_OHLC_CANDLE_VOLUME Graph type: Candle open-high-low-close stock graph with volume.
static int	STOCK_OPEN_HILO_CLOSE Graph type: Open-high-low-close stock graph.
static int	STOCK_VOLUME Graph type: Open-high-low-close stock graph with volume.
static int	STOCKMARKER The StockMarker component.
static int	TEXT_COMPONENTS_ALL Scale font size: Scale the font size of all text components in the graph.
static int	TEXT_COMPONENTS_NONE Scale font size: Do not scale the font size of any text components in the graph.
static int	THREED_AREA_SERIES Graph type: 3-D area graph.
static int	THREED_BAR Graph type: 3-D bar graph.
static int	THREED_CUBE Graph type: 3-D floating cubes.
static int	THREED_RIBBON_SERIES Graph type: 3-D ribbon graph.
static int	THREED_SURFACE Graph type: 3D surface.
static int	THREEDFLOOR The ThreeDFloor component.
static int	THREEDLEFTWALL The ThreeDLeftWall component.
static int	THREEDMARKER The ThreeDMarker component.
static int	THREEDRIGHTWALL The ThreeDRightWall component.
static int	TLT_DIM_MEMBER Tooltip label type: Display dimension names and dimension members, such as "Product: Shoes".
static int	TLT_MEMBER Tooltip label type: Display only dimension names, such as "Product".
static int	TLT_NONE Tooltip label type: Do not display information.
static int	TWODMARKER The TwoDMarker component.
static int	UNDEFINED An undefined component.
static int	UNDEFINEDTYPE Undetermined how to format the data value.
static int	VOLUMEMARKER The VolumeMarker component.
static int	X1AXIS The X1Axis component.
static int	X1MAJORTICK The X1MajorTick component.
static int	X1REFERENCELINE The X1ReferenceLine component.
static int	X1TICKLABEL The X1TickLabel component.
static int	X1TITLE The X1Title component.
static int	XPANELGRID The XPanelGrid component.
static int	XTICKLBL Format the data value as an X tick label.
static int	XVALUE Format the data value as an X value.
static int	Y1AXIS The Y1Axis component.
static int	Y1MAJORTICK The Y1MajorTick component.
static int	Y1REFERENCELINE The Y1ReferenceLine component.
static int	Y1TICKLABEL The Y1TickLabel component.
static int	Y1TICKLBL Format the data as a Y1 tick label.
static int	Y1TITLE The Y1Title component.
static int	Y1VALUE Format the data value as a Y1 value.
static int	Y1ZEROLINE The Y1ZeroLine component.
static int	Y2AXIS The Y2Axis component.
static int	Y2MAJORTICK The Y2MajorTick component.
static int	Y2REFERENCELINE The Y2ReferenceLine component.
static int	Y2TICKLABEL The Y2TickLabel component.
static int	Y2TICKLBL Format the data value a Y2 tick label.
static int	Y2TITLE The Y2Title component.
static int	Y2VALUE Format the data value as a Y2 value.
static int	Y2ZEROLINE The Y2ZeroLine component.
static int	Y3DMARKERGRID The Y3DMarkerGrid component.
static int	YPANELGRID The YPanelGrid component.
static int	ZPANELGRID The ZPanelGrid component.
static int	ZTICKLABEL The ZTickLabel component.
static int	ZTITLE The ZTitle component.
static int	ZVALUE Format the data value as a Z value.

Fields inherited from class oracle.dss.dataView.Dataview

DATAVIEW_FOOTNOTE, DATAVIEW_FOOTNOTE_NAME, DATAVIEW_SUBTITLE, DATAVIEW_SUBTITLE_NAME, DATAVIEW_TITLE, DATAVIEW_TITLE_NAME, DEFAULT_ZOOM_FACTOR, FOOTNOTE, FOOTNOTE_NAME, PAGE_CONTROL, PAGE_HEADER, PAGE_HEADER_NAME, PAGE_ITEM, PAGE_ITEM_NAME, PAGING_COMPONENT_NAME, PAGING_CONTROL_ABOVE_TITLES, PAGING_CONTROL_BELOW_TITLES, RESET_EVERYTHING, RESET_NONE, RESET_XML_PROPERTIES, SUBTITLE, SUBTITLE_NAME, TITLE, TITLE_NAME, VIEW_TYPE_CROSSTAB, VIEW_TYPE_GRAPH, VIEW_TYPE_TABLE

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Graph()
Constructor that does not specify a DataSource.

Graph(DataSource dataSource)
Constructor that specifies a DataSource.

Graph(DataSource dataSource, int type)
Constructor that specifies a DataSource and the type of DataDirector that this Graph will use.

Graph(ErrorHandler errorHandler)
Constructor that specifies a ErrorHandler.

Method Summary

void	addAlertListener(AlertListener l) Adds an alert listener to this graph.
void	addKeyListener(java.awt.event.KeyListener l) Adds a key listener to this graph.
void	addMouseListener(java.awt.event.MouseListener l) Adds a mouse listener to this graph.
void	addMouseMotionListener(java.awt.event.MouseMotionListener l) Adds a mouse motion listener to this graph.
void	beginAxisChanges() Prevents calculation of axis values while the user interface panel sets axis scaling properties.
void	calculatePlacement() Forces the graph to perform a complete calculation of its elements.
void	cleanUp() Clears the memory of the graph.
static java.lang.String	convertGraphTypeToString(int value) Generates a String representation of a graph type constant.
ExceptionalRiser	createExceptionalRiser(int series, int group) Creates an ExceptionalRiser.
void	destroyAllExceptionalRisers() Destroys all ExceptionalRiser components in this graph.
void	doAutoLayout(int level) Automatically places and sizes graph components once.
void	endAxisChanges() Re-enables calculation of axis values after the user interface panel sets axis scaling properties.
void	exportToGIF(java.io.OutputStream os) Exports a snapshot of the page that is currently displayed to the GIF file.
void	exportToGIFWithException(java.io.OutputStream os) Exports a snapshot of the page that is currently displayed to the GIF file.
void	exportToJPEG(java.io.OutputStream os, int quality) Exports a snapshot of the page that is currently displayed to a JPEG file.
void	exportToPNG(java.io.OutputStream os) Exports a snapshot of the page that is currently displayed to the PNG file.
void	exportToPNGWithException(java.io.OutputStream os) Exports a snapshot of the page that is currently displayed to the PNG file.
TwoDMarker	get2DMarker() Retrieves the TwoDMarker component for this graph.
ThreeDFloor	get3DFloor() Retrieves the ThreeDFloor component for this graph.
ThreeDLeftWall	get3DLeftWall() Retrieves the ThreeDLeftWall component for this graph.
ThreeDMarker	get3DMarker() Retrieves the ThreeDMarker component for this graph.
ThreeDRightWall	get3DRightWall() Retrieves the ThreeDRightWall component for this graph.
ThreeDViewMatrix	get3DViewMatrix() Retrieves the ThreeDViewMatrix component for this graph.
AreaMarker	getAreaMarker() Retrieves the AreaMarker component for this graph.
int	getAutoLayout() Retrieves information about when the graph automatically places and sizes its components.
int	getAutomaticComponentPlacement() Deprecated. As of 2.6.0.12, replaced by getAutoLayout()
int	getColorMode() Indicates whether markers of the same color comprise a group of data or a series of data.
int	getColumnCount() Retrieves the number of columns of data that this graph displays.
Connector	getConnector() Retrieves the Connector component for this graph.
CustomToolTipCallback	getCustomToolTipCallback() Retrieves the CustomToolTipCallback that this Graph uses to get text for tooltips.
java.lang.Object	getDataAccessSliceLabel(int edge, int slice, java.lang.String type) Retrieves the label for the data slice in the DataAccess for this graph.
int	getDataDirectorType() Retrieves the the type of the current DataDirector, either a cube data director, for multidimensional data, or a relational data director, for relational data.
java.awt.Font	getDataErrorFont() Retrieves the font for the message that indicates that there is not enough data to draw the graph.
DataErrorTextCallback	getDataErrorTextCallback() Retrieves the DataErrorTextCallback that this Graph uses to get text for the data error message.
DataFilter	getDataFilter() Retrieves an implementation of the DataFilter interface.
DataLine	getDataLine() Retrieves the DataLine component for this graph.
DataMarker	getDataMarker() Retrieves the DataMarkercomponent for this graph.
java.awt.Dimension	getDefaultImageSize() Retrieves the default size of this graph.
int	getDepthAngle() Retrieves the angle that implies depth on a bar, line, or area graph.
int	getDepthRadius() Retrieves the depth of a bar, line, or area graph.
int	getDisplayGroups() Retrieves the number of groups that this graph currently displays.
int	getDisplayGroupsLimit() Retrieves the maximum value allowed for the DisplayGroups property.
int	getDisplaySeries() Retrieves the number of series that this graph currently displays.
int	getDisplaySeriesLimit() Retrieves the maximum value allowed for the DisplaySeries property.
java.lang.String	getDrillDimension() Retrieves the name of the dimension that will be drilled when a drill operation is ambiguous.
Fitline	getFitline() Retrieves the Fitline component for this graph.
Titles	getFootnote() Retrieves the GraphFootnote component for this graph.
GraphBackground	getGraphBackground() Retrieves the GraphBackground component for this graph.
GraphController	getGraphController() Retrieves the controller for this graph.
GraphFormatManager	getGraphFormatManager() Retrieves the format manager that the graph uses.
GraphModel	getGraphModel() Retrieves the model that this graph uses.
GraphStyleManager	getGraphStyleManager() Retrieves the style manager that this graph uses.
int	getGraphType() Retrieves the current graph type for this graph.
GraphTypeConverter	getGraphTypeConverter() Retrieves the GraphTypeConverter that this graph uses.
int	getGroupSize(int type) Retrieves the number of columns or rows that comprise a group in a specified graph type.
int	getGroupTooltipLabelType() Retrieves the type of information about groups that this graph displays in tooltips.
java.util.Enumeration	getImagemapEnumeration(int filter) Retrieves the enumeration of specific kinds of components that are currently in use and visible on the graph.
java.awt.Dimension	getImageSize() Retrieves the size of this graph.
LegendArea	getLegendArea() Retrieves the LegendArea component for this graph.
LegendMarker	getLegendMarker() Retrieves the LegendMarker component for this graph.
int	getLegendScrollbarPresence() Retrieves the circumstances under which a scrollbar appears for the legend of this graph.
int	getLegendSeriesCount() Retrieves the number of series that are represented in the legend, independent of the number that the graph displays.
int	getLegendSeriesStart() Retrieve the index of the first series that appears in the legend, independent of the first series that the graph displays.
LegendText	getLegendText() Retrieves the LegendText component for this graph.
MarkerText	getMarkerText() Retrieves the MarkerText component for this graph.
int	getMarkerTooltipType() Indicates the type of information that this graph displays in tooltips for markers.
int	getMaxBarWidth() Retrieves the maximum width of bar in this graph, in virtual coordinates.
int	getMaxTickLabelAutoFontSize() Retrieves the maximum font size for tick labels that are automatically sized to fit in this graph.
int	getMinimumGroups(int type) Retrieves the minimum number of groups that a graph type requires.
int	getMinimumSeries(int type) Retrieves the minimum number of series that a graph type requires.
int	getMinTickLabelAutoFontSize() Retrieves the minimum font size for tick labels that are automatically sized to fit in this graph.
O1Axis	getO1Axis() Retrieves the O1Axis component for this graph.
O1MajorTick	getO1MajorTick() Retrieves the O1MajorTick component for this graph.
O1TickLabel	getO1TickLabel() Retrieves the O1TickLabel component for this graph.
O1Title	getO1Title() Retrieves the 01Title component for this graph.
UIParetoLine	getParetoLine() Retrieves the implementation of the UIParetoLine interface for this graph.
int	getPieBarSeries() Retrieves the index of series for which the bar shows detail, in a pie-bar or ring-bar graph.
int	getPieDepth() Retrieves the depth of a pie in a pie graph.
PieFeeler	getPieFeeler() Retrieves the PieFeeler component for this graph.
PieFrame	getPieFrame() Retrieves the PieFrame component for this graph.
PieLabel	getPieLabel() Retrieves the PieLabel component for this graph.
int	getPieRotation() Retrieves the amount that a pie or ring is rotated in a pie graph.
int	getPieTilt() Retrieves the amount that a pie or ring appears to be tilted.
PlotArea	getPlotArea() Retrives the PlotArea component for this graph.
int	getPresentationHeight() Retrieves the height of this graph in pixels.
int	getPresentationWidth() Retrieves the width of the graph in pixels.
QuadrantLine	getQuadrantLine() Retrieves the QuadrantLine component for this graph.
ReferenceLineMarker	getReferenceLineMarker() Retrieves the ReferenceLineMarker component for this graph.
ReferenceLineText	getReferenceLineText() Retrieves the ReferenceLineText component for this graph.
RingTotalLabel	getRingTotalLabel() Retrieves the RingTotalLabel component for this graph.
int	getRowCount() Retrieves the number of rows of data that this graph displays.
int	getScaleFontSizeForGIF() Retrieves which text components should be resized when the graph is scaled to a different size for output to a graphic file, such as a GIF file.
int	getScrollbarPresenceGroups() Retrieves the circumstances under which scrollbars for groups appear on this graph.
int	getScrollbarPresenceSeries() Retrieves the circumstances under which scrollbars for series appear on this graph.
ComponentHandle	getSelectedObject() Retrieves the selected component.
Series	getSeries() Retrieves the Series component for this graph.
int	getSeriesObjectCount() Retrieves the number of series that this graph stores properties for.
int	getSeriesTooltipLabelType() Retrieves the type of information about series that this graph displays in tooltips.
Slice	getSlice() Retrieves the Slice component for this graph.
SliceLabel	getSliceLabel() Retrieves the SliceLabel component for this graph.
SplitDivider	getSplitDivider() Retrieves the SplitDivider component for this graph.
int	getStartColumn() Deprecated. As of 2.6.0.27, replaced by getStartGroup() or by getStartSeries().
int	getStartGroup() Retrieves the first group that this graph currently displays.
int	getStartRow() Deprecated. As of 2.6.0.27, replaced by getStartSeries() or by getStartGroup().
int	getStartSeries() Retrieves the first series that this graph currently displays.
StockMarker	getStockMarker() Retrieves the StockMarker component for this graph.
Titles	getSubtitle() Retrieves the GraphSubtitle component for this graph.
java.util.TimeZone	getTimeZone() Retrieves the TimeZone object this graph uses to format time data on the group axis.
Titles	getTitle() Retrieves the GraphTitle component for this graph.
int	getToolTipDelay() Retrieves the amount of time before tooltips appear.
int	getViewType() Retrieves the specific type of subclass of this Dataview.
VolumeMarker	getVolumeMarker() Retrieves the VolumeMarker component for this graph.
X1Axis	getX1Axis() Retrieves the X1Axis component for this graph.
X1MajorTick	getX1MajorTick() Retrieves the X1MajorTick component for this graph.
X1ReferenceLine	getX1ReferenceLine() Retrieves the X1ReferenceLine component for this graph.
X1TickLabel	getX1TickLabel() Retrieves the X1TickLabel component for this graph.
X1Title	getX1Title() Retrieves the X1Title component for this graph.
XPanelGrid	getXPanelGrid() Retrieves the XPanelGrid component for this graph.
Y1Axis	getY1Axis() Retrieves the Y1Axis component for this graph.
Y1BaseLine	getY1BaseLine() Retrieves the Y1BaseLine component for this graph.
Y1MajorTick	getY1MajorTick() Retrieves the Y1MajorTick component for this graph.
Y1ReferenceLine	getY1ReferenceLine() Retrieves the Y1ReferenceLine component for this graph.
Y1TickLabel	getY1TickLabel() Retrieves the Y1TickLabel component for this graph.
Y1Title	getY1Title() Retrieves the Y1Title component for this graph.
Y1ZeroLine	getY1ZeroLine() Retrieves the Y1ZeroLine component for this graph.
Y2Axis	getY2Axis() Retrieves the Y2Axis component for this graph.
Y2BaseLine	getY2BaseLine() Retrieves the Y2BaseLine component for this graph.
Y2MajorTick	getY2MajorTick() Retrieves the Y2MajorTick component for this graph.
Y2ReferenceLine	getY2ReferenceLine() Retrieves the Y2ReferenceLine component for this graph.
Y2TickLabel	getY2TickLabel() Retrieves the Y2TickLabel component for this graph.
Y2Title	getY2Title() Retrieves the Y2Title component for this graph.
Y2ZeroLine	getY2ZeroLine() Retrieves the Y2ZeroLine component for this graph.
Y3DMarkerGrid	getY3DMarkerGrid() Retrieves the Y3DMarkerGrid component for this graph.
YPanelGrid	getYPanelGrid() Retrieves the YPanelGrid component for this graph.
ZPanelGrid	getZPanelGrid() Retrieves the ZPanelGrid component for this graph.
ZTickLabel	getZTickLabel() Retrieves the ZTickLabel component for this graph.
ZTitle	getZTitle() Retrieves the ZTitle component for this graph.
boolean	isDataRowShownAsASeries() Indicates whether rows of data appear as series or as groups.
boolean	isFitToContainer() Indicates whether the graph automatically resizes itself to fit its container.
boolean	isFontSizeAbsolute() Indicates whether the font size is absolute or proportional to the size of the graph.
boolean	isFrameSizeAutomatic() Indicates whether the plot area or pie frame is automatically resized when the graph type changes.
boolean	isGraphicAntialiasing() Indicates whether lines appear in a graph as smooth or more jagged.
boolean	isGroupSeriesTooltipSupported(int edge) Indicates whether group or series option (depending on the edge passed in) is supported in the tooltips.
boolean	isHorizontal() Indicates whether the graph has a horizontal graph type.
boolean	isLineDataLineDisplayed() Indicates whether data lines appear in a line graph.
boolean	isMarkerDisplayed() Indicates whether data markers appear in a line graph.
boolean	isMarkerShapeInLegend() Indicates whether legend markers are shaped like their corresponding data markers or 2-D markers.
boolean	isMouseMovingEnabled() Indicates whether the selected component can be moved and resized with the mouse.
boolean	isO1AxisSupported() Indicates whether the current graph type has an ordinal axis.
boolean	isParetoBarsConnected() Indicates whether pareto bars are connected.
boolean	isScatterDataLineDisplayed() Indicates whether data lines appear on a scatter graph.
boolean	isSwapAllowed() Indicates whether swapping is allowed in this view.
boolean	isTextAntialiasing() Indicates whether text appears in a graph as smooth or more jagged.
boolean	readXML(java.io.InputStream stream, boolean reset) Deprecated. As of 1.7.0.12, replaced by readXML(InputStream, int)
boolean	readXML(java.io.InputStream stream, int reset) Applies XML to this Graph, from a String.
void	removeAlertListener(AlertListener l) Removes an alert listener from this graph.
void	removeKeyListener(java.awt.event.KeyListener l) Removes a key listener from this graph.
void	removeMouseListener(java.awt.event.MouseListener l) Removes a mouse listener from this graph.
void	removeMouseMotionListener(java.awt.event.MouseMotionListener l) Removes a mouse motion listener from this graph.
void	resetToDefault() Deprecated. As of 1.7.0.12, replaced by resetToDefault(int)
void	resetToDefault(int reset) Resets properties of this Graph to their default values.
boolean	selectObject(ComponentHandle id) Selects a graph component.
void	setAutoLayout(int auto) Specifies when the graph automatically places and sizes its components.
void	setAutomaticComponentPlacement(int placement) Deprecated. As of 2.6.0.12, replaced by setAutoLayout(int)
void	setColorMode(int mode) Specifies whether markers of the same color comprise a group of data or a series of data.
void	setCustomToolTipCallback(CustomToolTipCallback callback) Specifies the CustomToolTipCallback that will provide tooltip text to this Graph.
void	setDataDirectorType(int type) Specifies the the type of DataDirector, either a cube data director, for multidimensional data, or a relational data director, for relational data.
void	setDataErrorFont(java.awt.Font font) Specifies the font for the message that indicates that there is not enough data to draw the graph.
void	setDataErrorTextCallback(DataErrorTextCallback callback) Specifies the DataErrorTextCallback that will provide data error text to this Graph.
void	setDataRowShownAsASeries(boolean yesNo) Specifies whether to display data rows as series or as groups.
void	setDataSource(DataSource ds) Specifies the data source for this graph.
void	setDefaultImageSize(java.awt.Dimension d) Specifies a default size for this graph.
void	setDepthAngle(int angle) Specifies the angle that implies depth on a bar, line, or area graph.
void	setDepthRadius(int depth) Specifies how deep a bar, line, or area graph should appear to be.
void	setDisplayGroups(int maxGroup) Specifies the number of groups to display in this graph.
void	setDisplayGroupsLimit(int maxDisplayGroups) Specifies the maximum value allowed for the DisplayGroups property.
void	setDisplaySeries(int maxSeries) Specifies the number of series to display in this graph.
void	setDisplaySeriesLimit(int maxDisplaySeries) Specifies the maximum value allowed for the DisplaySeries property.
void	setDrillDimension(java.lang.String dim) Specifies the name of a dimension that should be used when a drill operation is ambiguous.
void	setFitToContainer(boolean fitToContainer) Specifies whether the graph resizes itself automatically to fit its container.
void	setFontName(java.lang.String name) Specifies the font name for all of the components of this graph.
void	setFontSizeAbsolute(boolean yesNo) Specifies whether to use absolute font sizes or sizes that are proportional to the size of the graph.
void	setFrameSizeAutomatic(boolean isAuto) Specifies whether the plot area or pie frame is automatically resized when the graph type changes.
void	setGraphicAntialiasing(boolean yesNo) Specifies whether lines in a graph appear more smooth or more jagged.
void	setGraphType(int type) Specifies the graph type for this graph.
void	setGraphTypeConverter(GraphTypeConverter converter) Specifies the GraphTypeConverter for the graph type to use.
void	setGroupTooltipLabelType(int type) Specifies the type of information about groups that this graph displays in tooltips.
void	setImageSize(java.awt.Dimension d) Specifies a size for this graph.
void	setLegendScrollbarPresence(int presence) Specifies the circumstances under which a scrollbar appears for the legend of this graph.
void	setLegendSeriesCount(int count) Specifies the number of series to show in the legend, independent of the number of series that the graph displays.
void	setLegendSeriesStart(int start) Specifies the index of the first series that appears in the legend, independent of the first series that the graph displays.
void	setLineDataLineDisplayed(boolean yesNo) Specifies whether data lines appear in a line graph.
void	setLocale(java.util.Locale loc) Specifies the Locale for this Graph.
void	setMarkerDisplayed(boolean yesNo) Specifies whether data markers appear in a line graph.
void	setMarkerShapeInLegend(boolean yesNo) Specifies whether legend markers are shaped like their corresponding data markers or 2-D markers.
void	setMarkerTooltipType(int type) Specifies the type of information that this graph displays in tooltips for markers.
void	setMaxBarWidth(int width) Specifies the maximum width of a bar, in virtual coordinate units.
void	setMaxTickLabelAutoFontSize(int size) Specifies the maximum font size for tick labels that are automatically sized to fit in this graph.
void	setMinTickLabelAutoFontSize(int size) Specifies the minimum font size for tick labels that are automatically sized to fit in this graph.
void	setMouseMovingEnabled(boolean yesNo) Specifies whether a selected component can be moved and resized with the mouse.
void	setParetoBarsConnected(boolean connected) Specifies whether the pareto bars are connected to each other.
void	setPieBarSeries(int series) Specifies the series for which the bar shows detail, in a pie-bar or ring-bar graph.
void	setPieDepth(int depth) Specifies how deep a pie in a pie graph should be.
void	setPieRotation(int degrees) Specifies the amount that a pie is rotated in a pie graph.
void	setPieTilt(int tilt) Specifies the amount to tilt a pie or ring.
void	setScaleFontSizeForGIF(int scale) Specifies which text components should be resized when the graph is scaled to a different size for output to a graphic file, such as GIF file.
void	setScatterDataLineDisplayed(boolean yesNo) Specifies whether data lines appear on a scatter graph.
void	setScrollbarPresenceGroups(int scroll) Specifies the circumstances under which scrollbars for groups appear on this graph.
void	setScrollbarPresenceSeries(int scroll) Specifies the circumstances under which scrollbars for series appear on this graph.
void	setSeriesObjectCount(int count) Specifies the number of series that this graph stores properties for.
void	setSeriesTooltipLabelType(int type) Specifies the type of information about series that this graph displays in tooltips.
void	setStartColumn(int column) Deprecated. As of 2.2.0.14, replaced by setStartGroup(int) or by setStartSeries(int)
void	setStartGroup(int group) Specifies the first group to display in this graph.
void	setStartRow(int row) Deprecated. As of 2.2.0.14, replaced by setStartSeries(int) or by setStartGroup(int)
void	setStartSeries(int series) Specifies the first series to display in this graph.
void	setSwapAllowed(boolean swap) Specifies whether users can swap page items in this view.
boolean	setTabularData(java.util.List tableRows) Specifies data for the Graph, from a table of data.
void	setTextAntialiasing(boolean yesNo) Specifies whether text in a graph appears more smooth or more jagged.
void	setTimeZone(java.util.TimeZone tz) Specifies the TimeZone for this graph.
void	setToolTipDelay(int delay) Specifies the amount of time before tooltips appear.
boolean	setVersion(java.lang.String version) Sets the Graph to use default values of the specified version.
boolean	setXML(java.lang.String xmlString, boolean reset) Deprecated. As of 1.7.0.12, replaced by setXML(String, int)
boolean	setXML(java.lang.String xmlString, int reset) Applies XML to this Graph, from a String.
boolean	setXMLAsString(java.lang.String xml) Specifies the XML representation of this Graph.
void	writeImagemapXML(java.io.OutputStream os, int filter) Writes an XML representation of information about specific kinds of components that are currently in use and visible on the graph.
void	writeImagemapXML(java.io.PrintWriter out, int filter) Writes an XML representation of information about specific kinds of components that are currently in use and visible on the graph.

Methods inherited from class oracle.dss.dataView.Dataview

addControllerListener, addDataListener, addErrorHandler, addPropertyChangeListener, addViewFocusListener, addViewKeyListener, addViewListener, addViewMouseListener, addViewMouseMotionListener, getController, getDataDirector, getDataSource, getDataviewFootnote, getDataviewSubtitle, getDataviewTitle, getDescription, getHTMLPagingControlWidth, getInsertCallBack, getLocale, getLocalName, getModel, getName, getPagingControl, getPagingControlPosition, getPersistableAttributes, getPersistableComponents, getPhysicalComponents, getPopupManager, getRolloverTextManager, getTokenSubstitution, getXML, getXMLAsString, isDrillingEnabled, isHTMLPagingControlAutosubmit, isPagingControlVisible, isXMLValidated, removeControllerListener, removeDataListener, removeErrorHandler, removePropertyChangeListener, removeViewFocusListener, removeViewKeyListener, removeViewListener, removeViewMouseListener, removeViewMouseMotionListener, setDescription, setDrillingEnabled, setEnabled, setHTMLPagingControlAutosubmit, setHTMLPagingControlWidth, setInsertCallBack, setLocalName, setName, setPagingControlPosition, setPagingControlVisible, setPersistableAttributes, setPopupManager, setRolloverTextManager, setTokenSubstitution, setXMLValidated, writeXML

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUIClassID, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setLayout, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, bounds, checkImage, checkImage, contains, createImage, createImage, dispatchEvent, enable, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocation, getLocationOnScreen, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocation, setLocation, setSize, setSize, show, show, size, toString, transferFocus

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.dss.graph.UIGraph

getUIX1ReferenceLine, getUIY1ReferenceLine, getUIY2ReferenceLine, isPagingControlVisible, setPagingControlVisible

Methods inherited from interface oracle.dss.dataView.UIDataview

addControllerListener, getDataviewFootnote, getDataviewSubtitle, getDataviewTitle, getLocale, getTokenSubstitution, removeControllerListener, setTokenSubstitution

Methods inherited from interface oracle.dss.dataView.GraphAttribute

applyViewStyle, getComponentViewStyle, getUISeriesColor

Methods inherited from interface oracle.dss.rules.ComponentTypeConverter

convertComponentTypeToInteger, convertComponentTypeToString

Methods inherited from interface oracle.dss.util.persistence.Persistable

initialize, setPersistableComponents

Methods inherited from interface oracle.dss.dataView.DataviewCommon

getErrorHandler

Field Detail

GRAPH_TYPE

public static final java.lang.String GRAPH_TYPE

The graph type attribute for searches. Use this constant when you use the BI Beans persistence service, to search for graphs that have a particular graph type. This constant is an appropriate value to pass as an attribute in an Attributes.

See Also:

convertGraphTypeToString(int)

GRAPH

public static final int GRAPH

This graph.

AREAMARKER

public static final int AREAMARKER

The AreaMarker component.

See Also:

AreaMarker, Series

BACKGROUND

public static final int BACKGROUND

The GraphBackground component.

See Also:

GraphBackground

CONNECTOR

public static final int CONNECTOR

The Connector component.

See Also:

Connector

DATALINE

public static final int DATALINE

The DataLine component.

See Also:

DataLine

DATAMARKER

public static final int DATAMARKER

The DataMarker component.

See Also:

DataMarker

FITLINE

public static final int FITLINE

The Fitline component.

See Also:

Fitline

LEGENDAREA

public static final int LEGENDAREA

The LegendArea component.

See Also:

LegendArea

LEGENDMARKER

public static final int LEGENDMARKER

The LegendMarker component.

See Also:

LegendMarker

LEGENDTEXT

public static final int LEGENDTEXT

The LegendText component.

See Also:

LegendText

MARKERTEXT

public static final int MARKERTEXT

The MarkerText component.

See Also:

MarkerText

O1AXIS

public static final int O1AXIS

The O1Axis component.

See Also:

O1Axis

O1MAJORTICK

public static final int O1MAJORTICK

The O1MajorTick component.

See Also:

O1MajorTick

O1TICKLABEL

public static final int O1TICKLABEL

The O1TickLabel component.

See Also:

O1TickLabel

O1TITLE

public static final int O1TITLE

The O1Title component.

See Also:

O1Title

PIEFEELER

public static final int PIEFEELER

The PieFeeler component.

See Also:

PieFeeler

PIEFRAME

public static final int PIEFRAME

The PieFrame component.

See Also:

PieFrame

PIELABEL

public static final int PIELABEL

The PieLabel component.

See Also:

PieLabel

PLOTAREA

public static final int PLOTAREA

The PlotArea component.

See Also:

PlotArea

QUADRANTLINE

public static final int QUADRANTLINE

The QuadrantLine component.

See Also:

QuadrantLine

SERIES

public static final int SERIES

The Series component.

See Also:

Series

SLICE

public static final int SLICE

The Slice component.

See Also:

Slice

SLICELABEL

public static final int SLICELABEL

The SliceLabel component.

See Also:

SliceLabel

SPLITDIVIDER

public static final int SPLITDIVIDER

The SplitDivider component.

See Also:

SplitDivider

STOCKMARKER

public static final int STOCKMARKER

The StockMarker component.

See Also:

StockMarker

THREEDFLOOR

public static final int THREEDFLOOR

The ThreeDFloor component.

See Also:

ThreeDFloor

THREEDLEFTWALL

public static final int THREEDLEFTWALL

The ThreeDLeftWall component.

See Also:

ThreeDLeftWall

THREEDMARKER

public static final int THREEDMARKER

The ThreeDMarker component.

See Also:

ThreeDMarker

THREEDRIGHTWALL

public static final int THREEDRIGHTWALL

The ThreeDRightWall component.

See Also:

ThreeDRightWall

TWODMARKER

public static final int TWODMARKER

The TwoDMarker component.

See Also:

TwoDMarker

X1AXIS

public static final int X1AXIS

The X1Axis component.

See Also:

X1Axis

X1MAJORTICK

public static final int X1MAJORTICK

The X1MajorTick component.

See Also:

X1MajorTick

X1TICKLABEL

public static final int X1TICKLABEL

The X1TickLabel component.

See Also:

X1TickLabel

X1TITLE

public static final int X1TITLE

The X1Title component.

See Also:

X1Title

XPANELGRID

public static final int XPANELGRID

The XPanelGrid component.

See Also:

XPanelGrid

Y1AXIS

public static final int Y1AXIS

The Y1Axis component.

See Also:

Y1Axis

Y1MAJORTICK

public static final int Y1MAJORTICK

The Y1MajorTick component.

See Also:

Y1MajorTick

Y1TICKLABEL

public static final int Y1TICKLABEL

The Y1TickLabel component.

See Also:

Y1TickLabel

Y1TITLE

public static final int Y1TITLE

The Y1Title component.

See Also:

Y1Title

Y1ZEROLINE

public static final int Y1ZEROLINE

The Y1ZeroLine component.

See Also:

Y1ZeroLine

Y2AXIS

public static final int Y2AXIS

The Y2Axis component.

See Also:

Y2Axis

Y2MAJORTICK

public static final int Y2MAJORTICK

The Y2MajorTick component.

See Also:

Y2MajorTick

Y2TICKLABEL

public static final int Y2TICKLABEL

The Y2TickLabel component.

See Also:

Y2TickLabel

Y2TITLE

public static final int Y2TITLE

The Y2Title component.

See Also:

Y2Title

Y2ZEROLINE

public static final int Y2ZEROLINE

The Y2ZeroLine component.

See Also:

Y2ZeroLine

Y3DMARKERGRID

public static final int Y3DMARKERGRID

The Y3DMarkerGrid component.

See Also:

Y3DMarkerGrid

YPANELGRID

public static final int YPANELGRID

The YPanelGrid component.

See Also:

YPanelGrid

ZPANELGRID

public static final int ZPANELGRID

The ZPanelGrid component.

See Also:

ZPanelGrid

ZTICKLABEL

public static final int ZTICKLABEL

The ZTickLabel component.

See Also:

ZTickLabel

ZTITLE

public static final int ZTITLE

The ZTitle component.

See Also:

ZTitle

VOLUMEMARKER

public static final int VOLUMEMARKER

The VolumeMarker component.

See Also:

VolumeMarker

RINGTOTALLABEL

public static final int RINGTOTALLABEL

The RingTotalLabel component.

See Also:

RingTotalLabel

PARETOLINE

public static final int PARETOLINE

The ParetoLine component.

See Also:

ParetoLine

X1REFERENCELINE

public static final int X1REFERENCELINE

The X1ReferenceLine component.

See Also:

X1ReferenceLine

Y1REFERENCELINE

public static final int Y1REFERENCELINE

The Y1ReferenceLine component.

See Also:

Y1ReferenceLine

Y2REFERENCELINE

public static final int Y2REFERENCELINE

The Y2ReferenceLine component.

See Also:

Y2ReferenceLine

UNDEFINED

public static final int UNDEFINED

An undefined component. This is a component that Perspective For Java supports but that the BI Beans does not expose. If you get this constant in a return method, the current graph type might be one of the graph types that the BI Beans does not support, or there might be a bug that needs to be reported.

REFERENCELINEMARKER

public static final int REFERENCELINEMARKER

The ReferenceLineMarker component.

See Also:

ReferenceLineMarker

REFERENCELINETEXT

public static final int REFERENCELINETEXT

The ReferenceLineText component.

See Also:

ReferenceLineText

MAP_DATA

public static final int MAP_DATA

All of the data points in the plot area of the graph. When you use this constant in the getImagemapEnumeration method and writeImagemapXML method, you get a report of the data points that are currently present and visible in the graph.

See Also:

getImagemapEnumeration(int), writeImagemapXML(java.io.OutputStream, int)

MAP_LEGEND

public static final int MAP_LEGEND

The legend text and legend markers of the graph. When you use this constant in the getImagemapEnumeration method and writeImagemapXML method, you get a report of the legend text and legend markers that are currently present and visible in the graph.

See Also:

getImagemapEnumeration(int), writeImagemapXML(java.io.OutputStream, int)

MAP_DATATEXT

public static final int MAP_DATATEXT

The data text, pie slice labels and pie labels of the graph. When you use this constant in the getImagemapEnumeration method and writeImagemapXML method, you get a report of the data text, pie slice labels and pie labels that are currently present and visible in the graph.

See Also:

getImagemapEnumeration(int), writeImagemapXML(java.io.OutputStream, int)

MAP_ORDINALLABELS

public static final int MAP_ORDINALLABELS

The labels for the ordinal axis of the graph. When you use this constant in the getImagemapEnumeration method and writeImagemapXML method, you get a report of the ordinal axis tick labels that are currently present and visible in the graph.

See Also:

getImagemapEnumeration(int), writeImagemapXML(java.io.OutputStream, int)

MAP_LABELS

public static final int MAP_LABELS

The tick labels for the data axes of the graph. When you use this constant in the getImagemapEnumeration method and writeImagemapXML method, you get a report of the data-axis tick labels that are currently present and visible in the graph.

See Also:

getImagemapEnumeration(int), writeImagemapXML(java.io.OutputStream, int)

MAP_TITLES

public static final int MAP_TITLES

The title, subtitle, footnote, and axis titles of the graph. When you use this constant in the getImagemapEnumeration and writeImagemapXML methods, you will get a report of the title components of the graph that are currently present and visible.

See Also:

getImagemapEnumeration(int), writeImagemapXML(java.io.OutputStream, int)

MAP_ALL

public static final int MAP_ALL

All of the image map components that are supported by the graph. When you use this constant in the getImagemapEnumeration method and writeImagemapXML method, you get a report of the tick labels for the data axes, tick labels for the ordinal axis, title, subtitle, footnote, and axis titles, legend text and legend markers, data text, pie slice labels and pie labels that are currently present and visible in the graph.

writeImagemapXML(MAP_ALL) is equivalent to writeImagemapXML(MAP_DATA|MAP_LEGEND|MAP_DATATEXT| MAP_ORDINALLABELS|MAP_LABELS|MAP_TITLES).

See Also:

getImagemapEnumeration(int), writeImagemapXML(java.io.OutputStream, int)

THREED_BAR

public static final int THREED_BAR

Graph type: 3-D bar graph. Three-dimensional bar graphs show trends over time or comparisons of items at the same time.

Series appear along the left edge of the graph. Groups appear long the right edge of the graph.

THREED_CUBE

public static final int THREED_CUBE

Graph type: 3-D floating cubes. This graph type is like a three-dimensional point graph. All markers are the same size.

Series appear along the left edge of the graph. Groups appear long the right edge of the graph.

THREED_AREA_SERIES

public static final int THREED_AREA_SERIES

Graph type: 3-D area graph. In this graph, a marker represents a series of data.

Series appear along the left edge of the graph. Groups appear long the right edge of the graph.

THREED_RIBBON_SERIES

public static final int THREED_RIBBON_SERIES

Graph type: 3-D ribbon graph. This graph type is like a three-dimensional line graph. In this graph, a ribbon represents a series of data.

Series appear along the left edge of the graph. Groups appear long the right edge of the graph.

THREED_SURFACE

public static final int THREED_SURFACE

Graph type: 3D surface. In this graph, all the data values are connected by a topographical surface.

BAR_VERT_CLUST

public static final int BAR_VERT_CLUST

Graph type: Clustered bar graph that has a vertical orientation. Use bar graphs to show trends over time or to compare items at the same time.

Bars of the same color represent a series. Each cluster of bars represents a group.

BAR_VERT_STACK

public static final int BAR_VERT_STACK

Graph type: Stacked bar graph that is vertical. Use bar graphs to show trends over time or to compare items at the same time.

Bars of the same color represent a series. Each stack of bars represents a group.

BAR_VERT_CLUST2Y

public static final int BAR_VERT_CLUST2Y

Graph type: Clustered, dual-Y bar graph that is vertical. Use dual-Y graphs to compare measures that have different magnitudes.

Bars of the same color represent a series. Each cluster of bars represents a group.

Assign each series either to the Y1-axis or to the Y2-axis, according to the measure that the series represents. This graph type requires at least two series of data.

BAR_VERT_STACK2Y

public static final int BAR_VERT_STACK2Y

Graph type: Stacked, dual-Y bar graph that is vertical. Use dual-Y graphs to compare measures that have different magnitudes.

Bars of the same color represent a series. Each stack of bars represents a group.

Assign each series either to the Y1-axis or to the Y2-axis, according to the measure that the series represents. This graph type requires at least two series of data.

BAR_VERT_CLUST_SPLIT2Y

public static final int BAR_VERT_CLUST_SPLIT2Y

Graph type: Clustered, split dual-Y bar graph that is vertical. Use dual-Y graphs to compare measures that have different magnitudes. In a split dual-Y graph, each axis occupies a different segment of the graph.

Bars of the same color represent a series. Each cluster of bars represents a group.

Assign each series either to the Y1-axis or to the Y2-axis, according to the measure that the series represents. This graph type requires at least two series of data.

BAR_VERT_STACK_SPLIT2Y

public static final int BAR_VERT_STACK_SPLIT2Y

Graph type: Stacked, split dual-Y bar graph that is vertical. Use dual-Y graphs to compare measures that have different magnitudes. In a split dual-Y graph, each axis occupies a different segment of the graph.

Bars of the same color represent a series. Each stack of bars represents a group.

Assign each series either to the Y1-axis or to the Y2-axis, according to the measure that the series represents. This graph type requires at least two series of data.

BAR_VERT_PERCENT

public static final int BAR_VERT_PERCENT

Graph type: Percent bar graph that is vertical. Percent graphs show changes in relationships over time.

Bars of the same color represent a series. Each stack of bars represents the total data value for the group.

This graph type is not appropriate for data that includes negative numbers.

BAR_HORIZ_CLUST

public static final int BAR_HORIZ_CLUST

Graph type: Clustered bar graph that is horizontal. Use bar graphs to show trends over time or to compare items at the same time.

Bars of the same color represent a series. Each cluster of bars represents a group.

BAR_HORIZ_STACK

public static final int BAR_HORIZ_STACK

Graph type: Stacked bar graph that is horizontal. Use bar graphs to show trends over time or to compare items at the same time.

Bars of the same color represent a series. Each stack of bars represents a group.

BAR_HORIZ_CLUST_2Y

public static final int BAR_HORIZ_CLUST_2Y

Graph type: Clustered, dual-Y bar graph that is horizontal. Use dual-Y graphs to compare measures that have different magnitudes.

Bars of the same color represent a series. Each cluster of bars represents a group.

Assign each series either to the Y1-axis or to the Y2-axis, according to the measure that the series represents. This graph type requires at least two series of data.

BAR_HORIZ_STACK_2Y

public static final int BAR_HORIZ_STACK_2Y

Graph type: Stacked, dual-Y bar graph that is horizontal. Use dual-Y graphs to compare measures that have different magnitudes.

Bars of the same color represent a series. Each stack of bars represents a group.

Assign each series either to the Y1-axis or to the Y2-axis, according to the measure that the series represents. This graph type requires at least two series of data.

BAR_HORIZ_CLUST_SPLIT2Y

public static final int BAR_HORIZ_CLUST_SPLIT2Y

Graph type: Clustered, split dual-Y graph that is horizontal. Use dual-Y graphs to compare measures that have different magnitudes. In a split dual-Y graph, each Y-axis occupies a different segment of the graph.

Bars of the same color represent a series. Each cluster of bars represents a group.

Assign each series either to the Y1-axis or to the Y2-axis, according to the measure that the series represents. This graph type requires at least two series of data.

BAR_HORIZ_STACK_SPLIT2Y

public static final int BAR_HORIZ_STACK_SPLIT2Y

Graph type: Stacked, split dual-Y bar graph that is horizontal. Use dual-Y graphs to compare measures that have different magnitudes. In a split dual-Y graph, each Y-axis occupies a different segment of the graph.

Bars of the same color represent a series. Each stack of bars represents a group.

Assign each series either to the Y1-axis or to the Y2-axis, according to the measure that the series represents. This graph type requires at least two series of data.

AREA_VERT_ABS

public static final int AREA_VERT_ABS

Graph type: Absolute area graph. Use this graph type to feature spikes in data. Area markers represent actual data values, so they can overlap each other.

Each area marker represents a series. Each column of points along the ordinal axis represents a group.

AREA_VERT_STACK

public static final int AREA_VERT_STACK

Graph type: Stacked area graph. Area markers represent cumulative data values, so they are stacked on top of each other.

Each area marker represents a series. Each column of points along the ordinal axis represents a group.

AREA_VERT_ABS_SPLIT2Y

public static final int AREA_VERT_ABS_SPLIT2Y

Graph type: Absolute, split dual-Y area graph. Area markers represent cumulative data values, so they are stacked on top of each other.

Use dual-Y graphs to compare measures that have different magnitudes. In a split dual-Y graph, each Y-axis occupies a different segment of the graph.

Each area marker represents a series. Each column of points along the ordinal axis represents a group.

Assign each series either to the Y1-axis or to the Y2-axis, according to the measure that the series represents. This graph type requires at least two series of data.

AREA_VERT_STACK_SPLIT2Y

public static final int AREA_VERT_STACK_SPLIT2Y

Graph type: Stacked, split dual-Y area graph. Area markers represent cumulative data values, so they are stacked on top of each other.

Use dual-Y graphs to compare measures that have different magnitudes. In a split dual-Y graph, each axis occupies a different segment of the graph.

Each area marker represents a series. Each column of points along the ordinal axis represents a group.

Assign each series either to the Y1-axis or to the Y2-axis, according to the measure that the series represents. This graph type requires at least two series of data.

AREA_VERT_PERCENT

public static final int AREA_VERT_PERCENT

Graph type: Percent area graph. Percent graphs show changes in relationships over time. Area markers represent cumulative percentages of the total value for the column.

Each area marker represents a series. Each column of points along the ordinal axis represents a group.

LINE_VERT_ABS

public static final int LINE_VERT_ABS

Graph type: Absolute line graph. Use line graphs to show trends over time or to compare items at the same time. Each point on the line graph represents an actual data value.

Each line represents a series. Each column of points along the ordinal axis represents a group.

The default UI for the BI Beans presents point graphs. These point graphs are line graphs in which the lines are not displayed.

See Also:

isLineDataLineDisplayed()

LINE_VERT_STACK

public static final int LINE_VERT_STACK

Graph type: Stacked line graph. Use line graphs to show trends over time or to compare items at the same time. Points represent cumulative values, so the lines do not normally cross each other.

Each line represents a series. Each column of points along the ordinal axis represents a group.

LINE_VERT_ABS_2Y

public static final int LINE_VERT_ABS_2Y

Graph type: Absolute, dual-Y line graph. Points represent cumulative values, so the lines do not normally cross each other.

Use dual-Y graphs to compare measures that have different magnitudes.

Each line represents a series. Each column of points along the ordinal axis represents a group.

Assign each series either to the Y1-axis or to the Y2-axis, according to the measure that the series represents. This graph type requires at least two series of data.

The default UI for the BI Beans presents point graphs. These point graphs are line graphs in which the lines are not displayed.

See Also:

isLineDataLineDisplayed()

LINE_VERT_STACK_2Y

public static final int LINE_VERT_STACK_2Y

Graph type: Stacked, dual-Y line graph. Points represent cumulative values, so the lines do not normally cross each other. Use dual-Y graphs to compare measures that have different magnitudes.

Each line represents a series. Each column of points along the ordinal axis represents a group.

Assign each series either to the Y1-axis or to the Y2-axis, according to the measure that the series represents. This graph type requires at least two series of data.

LINE_VERT_ABS_SPLIT2Y

public static final int LINE_VERT_ABS_SPLIT2Y

Graph type: Absolute, split dual-Y line graph. Use dual-Y graphs to compare measures that have different magnitudes. In a split dual-Y graph, each Y-axis occupies a different segment of the graph.

Each line represents a series. Each column of points along the ordinal axis represents a group.

Assign each series either to the Y1-axis or to the Y2-axis, according to the measure that the series represents. This graph type requires at least two series of data.

The default UI for the BI Beans presents point graphs. These point graphs are line graphs in which the lines are not displayed.

See Also:

isLineDataLineDisplayed()

LINE_VERT_STACK_SPLIT2Y

public static final int LINE_VERT_STACK_SPLIT2Y

Graph type: Stacked, split dual-Y line graph. Points represent cumulative values, so the lines do not normally cross each other. Use dual-Y graphs to compare measures that have different magnitudes. In a split dual-Y graph, each axis occupies a different segment of the graph.

Each line represents a series. Each column of points along the ordinal axis represents a group.

Assign each series either to the Y1-axis or to the Y2-axis, according to the measure that the series represents. This graph type requires at least two series of data.

LINE_VERT_PERCENT

public static final int LINE_VERT_PERCENT

Graph type: Percent line graph. Percent graphs show changes in relationships over time.

Each line represents a series. Each column of points along the ordinal axis represents a group.

This graph type is not appropriate for data that includes negative numbers.

PIE

public static final int PIE

Graph type: Pie graph. Use pie graphs to show percentage of a total. Each slice represents a series. The pie represents a group.

This graph type is not appropriate for data that includes negative numbers.

RING

public static final int RING

Graph type: Ring graph. Use ring graphs to show percentage of a total. The total appears in the center of the ring.

Each slice represents a series. The ring represents a group.

This graph type is not appropriate for data that includes negative numbers.

PIE_MULTI

public static final int PIE_MULTI

Graph type: Multiple pie graph. Use pie graphs to show percentages of totals.

Slices of the same color represent a series. Each pie represents a group.

This graph type is not appropriate for data that includes negative numbers.

RING_MULTI

public static final int RING_MULTI

Graph type: Multiple ring graph. Use ring graphs to show percentages of totals. The totals appear in the centers of the rings.

Slices of the same color represent a series. Each ring represents a group.

This graph type is not appropriate for data that includes negative numbers.

SCATTER

public static final int SCATTER

Graph type: Scatter graph. Scatter graphs have two data axes and no ordinal axis. The location of the data marker represents two data values, one for the X-axis and one for the Y-axis. Scatter graphs are especially useful when you have a number of data items and you want to see general relationships.

Markers of the same color represent a series. The location of the marker along the X-axis represents one group value. The location of the marker along the Y-axis represents the other group value.

This graph type requires at least two groups of data, one for each data axis.

SCATTER_2Y

public static final int SCATTER_2Y

Graph type: Dual-Y scatter graph. Dual-Y scatter graphs have three data axes (one X-axis and two Y-axes) and no ordinal axis. The location of the data marker represents two data values, one for the X-axis and one for a Y-axis. Scatter graphs are especially useful when you have a number of data items and you want to see general relationships.

Markers of the same color represent a series. The location of the marker along the X-axis represents one group value. The location of the marker along a Y-axis represents the other group value.

Dual-Y graphs show measures of different magnitudes. Assign each series either to the Y1-axis or to the Y2-axis, according to the measure that the series represents.

This graph type requires at least two series of data (one for each Y-axis) and two groups of data (one for the X-axis and one for a Y-axis).

POLAR

public static final int POLAR

Graph type: Polar graph.

RADAR_LINE

public static final int RADAR_LINE

Graph type: Radar graph.

STOCK_OHLC_CANDLE

public static final int STOCK_OHLC_CANDLE

Graph type: Candle open-high-low-close stock graph. This stock graph shows opening, high, low, and closing values.

STOCK_OHLC_CANDLE_VOLUME

public static final int STOCK_OHLC_CANDLE_VOLUME

Graph type: Candle open-high-low-close stock graph with volume. This stock graph shows opening, high, low, and closing values, as well as trading volume.

STOCK_CANDLE

public static final int STOCK_CANDLE

Graph type: Candle open-close stock graph. This candle stock graph shows opening and closing values only.

STOCK_HILO_CLOSE

public static final int STOCK_HILO_CLOSE

Graph type: High-low-close stock graph. This stock graph shows high, low, and closing values.

STOCK_OPEN_HILO_CLOSE

public static final int STOCK_OPEN_HILO_CLOSE

Graph type: Open-high-low-close stock graph. This stock graph shows opening, high, low, and closing values.

STOCK_VOLUME

public static final int STOCK_VOLUME

Graph type: Open-high-low-close stock graph with volume. This stock graph shows opening, high, low, and closing values, as well as trading volume.

STOCK_CANDLE_VOLUME

public static final int STOCK_CANDLE_VOLUME

Graph type: Candle open-close stock with volume. This candle stock graph shows opening and closing values, as well as trading volume.

STOCK_HILO_CLOSE_VOLUME

public static final int STOCK_HILO_CLOSE_VOLUME

Graph type: High-low-close stock graph with volume. This stock graph shows high, low, and closing values, as well as trading volume.

BUBBLE

public static final int BUBBLE

Graph type: Bubble graph.

BUBBLE_2Y

public static final int BUBBLE_2Y

Graph type: Dual-Y bubble graph.

PIE_BAR

public static final int PIE_BAR

Graph type: Pie-Bar graph.

This graph type is not appropriate for data that includes negative numbers.

RING_BAR

public static final int RING_BAR

Graph type: Ring-Bar graph.

This graph type is not appropriate for data that includes negative numbers.

PARETO

public static final int PARETO

Graph type: Pareto graph.

This graph type is not appropriate for data that includes negative numbers.

UNDEFINEDTYPE

public static final int UNDEFINEDTYPE

Undetermined how to format the data value.

XVALUE

public static final int XVALUE

Format the data value as an X value.

Y1VALUE

public static final int Y1VALUE

Format the data value as a Y1 value.

Y2VALUE

public static final int Y2VALUE

Format the data value as a Y2 value.

ZVALUE

public static final int ZVALUE

Format the data value as a Z value.

XTICKLBL

public static final int XTICKLBL

Format the data value as an X tick label.

Y1TICKLBL

public static final int Y1TICKLBL

Format the data as a Y1 tick label.

Y2TICKLBL

public static final int Y2TICKLBL

Format the data value a Y2 tick label.

MTT_NONE

public static final int MTT_NONE

Marker ToolTip Type: No tooltips displayed.

MTT_VALUES

public static final int MTT_VALUES

Marker ToolTip Type: Display data value or values.

MTT_CUM_VAL

public static final int MTT_CUM_VAL

Display cumulative data value (stacked graphs only).

MTT_PERCENT_VAL

public static final int MTT_PERCENT_VAL

Display percentage data value (pie slices only).

MTT_TEXT

public static final int MTT_TEXT

Marker text type: Display QDR information, such as "January, Shoes".

MTT_PERCENT_VAL_VALUES

public static final int MTT_PERCENT_VAL_VALUES

Marker text type: Display percentage data value (pie slices only) and data value or values.

MTT_PERCENT_VAL_TEXT

public static final int MTT_PERCENT_VAL_TEXT

Marker text type: Display percentage data value (pie slices only) and QDR information, such as "January, Shoes".

MTT_PERCENT_VAL_VALUES_TEXT

public static final int MTT_PERCENT_VAL_VALUES_TEXT

Marker text type: Display percentage data value (pie slices only), data value or values, and QDR information, such as "January, Shoes".

MTT_VALUES_TEXT

public static final int MTT_VALUES_TEXT

Marker text type: Display data value or values and QDR information, such as "January, Shoes."

SP_NEVER

public static final int SP_NEVER

Scrollbar presence: Never display scrollbars.

SP_AS_NEEDED

public static final int SP_AS_NEEDED

Scrollbar presence: Display scrollbars when they are needed. Scrollbars appear when there are more groups or series of data than the maximum that should be displayed.

See Also:

setDisplayGroups(int), setDisplaySeries(int)

SP_ALWAYS

public static final int SP_ALWAYS

Scrollbar presence: Always display scrollbars.

DDT_CUBE

public static final int DDT_CUBE

Data director type: The DataDirector is a CubeDataDirector, for multidimensional data.

See Also:

DataDirector

DDT_RELATIONAL

public static final int DDT_RELATIONAL

Data director type: The DataDirector is a RelationalDataDirector, for relational data.

See Also:

DataDirector

ACP_NEVER

public static final int ACP_NEVER

Deprecated. As of 2.6.0.12, replaced by AL_NEVER

setAutomaticComponentPlacement is deprecated; call setAutoLayout(AL_NEVER) to prevent the graph from placing and sizing components automatically.

See Also:

AL_NEVER, setAutoLayout(int)

ACP_ALWAYS

public static final int ACP_ALWAYS

Deprecated. As of 2.6.0.12, replaced by AL_AS_NEEDED or by AL_ALWAYS

setAutomaticComponentPlacement is deprecated; call setAutoLayout(AL_ALWAYS) to have the graph always calculate automatic placement and sizing of components. Call setAutoLayout(AL_AS_NEEDED) to have the graph place and size components only when adjustments are needed, such as when components overlap each other or when legend text extends beyond the legend area.

An AutomaticComponentPlacement setting of AL_ALWAYS is treated as an AutoLayout setting of AL_AS_NEEDED.

See Also:

AL_ALWAYS, AL_AS_NEEDED, setAutoLayout(int)

AL_NEVER

public static final int AL_NEVER

AutoLayout: Never layout components automatically.

AL_AS_NEEDED

public static final int AL_AS_NEEDED

AutoLayout: Layout components automatically only when necessary. With this setting, the graph looks for display problems, such as overlapping components or text that extends outside the legend area. If the graph detects a problem with any component, all automatically placed components are adjusted.

Use this setting if your application handles layout, but you want to ensure that overlap does not occur in case the user displays a set of data that you did not account for in your layout code.

AL_ALWAYS

public static final int AL_ALWAYS

AutoLayout: Always layout components automatically, without checking whether it is necessary.

COLOR_BY_SERIES

public static final int COLOR_BY_SERIES

Color Mode: Markers of the same color indicate a series of data.

COLOR_BY_GROUP

public static final int COLOR_BY_GROUP

Color Mode: Markers of the same color indicate a group of data.

TLT_NONE

public static final int TLT_NONE

Tooltip label type: Do not display information.

TLT_MEMBER

public static final int TLT_MEMBER

Tooltip label type: Display only dimension names, such as "Product".

TLT_DIM_MEMBER

public static final int TLT_DIM_MEMBER

Tooltip label type: Display dimension names and dimension members, such as "Product: Shoes".

GROUPANDSERIESLIMIT

public static final int GROUPANDSERIESLIMIT

The maximum number of groups and series that this graph can display.

See Also:

setStartGroup(int), setStartSeries(int), setStartRow(int), setStartColumn(int)

SERIESOBJECTCOUNTLIMIT

public static final int SERIESOBJECTCOUNTLIMIT

The maximum number of different series for which you can save properties.

See Also:

setSeriesObjectCount(int)

TEXT_COMPONENTS_ALL

public static final int TEXT_COMPONENTS_ALL

Scale font size: Scale the font size of all text components in the graph.

TEXT_COMPONENTS_NONE

public static final int TEXT_COMPONENTS_NONE

Scale font size: Do not scale the font size of any text components in the graph.

HONOR_PROPERTIES

public static final int HONOR_PROPERTIES

doAutoLayout: Honor the properties that automatic layout normally respects. When you pass this value to the doAutoLayout method, then the automatic layout code respects the settings of properties that are set manually.

For example, tick label skipping is automatic by default, but you can specify BaseGraphComponent.TLS_MANUAL as the TickLabelSkipMode property. If you do this, then automatic layout code respects the values of the TickLabelSkipCount and TickLabelSkipFirst properties of the O1Axis.

The doAutoLayout code also respects these properties, if you set HONOR_PROPERTIES as the level. Using this value limits the strategies that the automatic layout code can use in placing components.

When you use this level, the doAutoLayout method honors:

• The TickLabelSkipMode property of the O1TickLabel.
• The AutomaticRotation property of the
• O1TickLabel.
• The TextRotation property of the
• O1TickLabel.
• The AutomaticPlacement property of the LegendArea.

Now matter how these properties are set before you call doAutoLayout, the doAutoLayout method always sets these properties to their manual settings, so that you can tweak the layout afterward by setting the related properties.

See Also:

RESET_PROPERTIES, doAutoLayout(int), setAutoLayout(int)

RESET_PROPERTIES

public static final int RESET_PROPERTIES

doAutoLayout: Reset property values that can be set automatically. When you pass this value to the doAutoLayout method, then the automatic layout code treats as automatic any property that can be set automatically.

For example, tick label skipping is automatic by default, but you can specify BaseGraphComponent.TLS_MANUAL as the TickLabelSkipMode property. If you do this, then automatic layout code respects the values of the TickLabelSkipCount and TickLabelSkipFirst properties of the O1Axis.

If you set RESET_PROPERTIES as the level for doAutoLayout, then doAutoLayout treats the properties as if they were set to their automatic values. Using this value allows the automatic layout code more flexibility in placing components.

When you use this level, the doAutoLayout method:

• Treats the TickLabelSkipMode property of the O1TickLabel as if it were set to BaseGraphComponent.TLS_AUTOMATIC.
• Treats the AutomaticRotation property of the O1TickLabel as if it were set to BaseGraphComponent.AR_HORIZ_ROTATE_270.
• Treats the TextRotation property of the O1TickLabel as if it were set to BaseGraphComponent.AR_HORIZ.
• Treats the AutomaticPlacement property of the LegendArea as if it were BaseGraphComponent.AP_ALWAYS.

The doAutoLayout method always sets these properties to their manual settings, so that you can tweak the layout by setting the related properties.

See Also:

HONOR_PROPERTIES, doAutoLayout(int), setAutoLayout(int)

Constructor Detail

Graph

public Graph()

Constructor that does not specify a DataSource. If you use this constructor, call the setDataSource method to specify the data that this graph displays.

Graph

public Graph(DataSource dataSource)

Constructor that specifies a DataSource.

Parameters:

dataSource - The DataSource from which this graph will request data.

Graph

public Graph(DataSource dataSource,
             int type)

Constructor that specifies a DataSource and the type of DataDirector that this Graph will use.

Parameters:

dataSource - The DataSource from which this graph will request data.

type - A constant that represents the type of data director that dataSource implements. Constants are listed in the See Also section

See Also:

DDT_CUBE, DDT_RELATIONAL

Graph

public Graph(ErrorHandler errorHandler)

Constructor that specifies a ErrorHandler.

Parameters:

errorHandler - The ErrorHandler to use.

Method Detail

resetToDefault

public void resetToDefault()

Deprecated. As of 1.7.0.12, replaced by resetToDefault(int)

The resetToDefault method that takes an int gives you control over how much and how far to reset values. To replicate the behavior of this deprecated method, pass RESET_EVERYTHING to the resetToDefault(int) method.

Overrides:

resetToDefault in class Dataview

resetToDefault

public void resetToDefault(int reset)

Resets properties of this Graph to their default values. The reset parameter determines whether to reset only the properties or to reset the properties and remove registered listeners and callbacks.

This method is helpful when you want to reuse a Graph rather than instantiate a new one.

Overrides:

resetToDefault in class Dataview

Parameters:

reset - A constant that indicates how much to reset. Valid constants are listed in the See Also section. If you pass an invalid value or RESET_NONE, then this method logs a message with the error handler and does not change any properties.

See Also:

Dataview.RESET_XML_PROPERTIES, Dataview.RESET_EVERYTHING

setVersion

public boolean setVersion(java.lang.String version)

Sets the Graph to use default values of the specified version.

Parameters:

version - The graph version to which the properties should be reset.

Returns:

false if version passed to this method is not valid.

cleanUp

public void cleanUp()

Clears the memory of the graph. Call this method to start over with a fresh graph.

Overrides:

cleanUp in class Dataview

addMouseMotionListener

public void addMouseMotionListener(java.awt.event.MouseMotionListener l)

Adds a mouse motion listener to this graph. This method adds a standard awt listener. To respond to mouse motions on a graph, it is easier to add a ViewMouseMotionListener to the controller for this graph view. The ViewMouseMotionEvent class includes information about the component over which a mouse moves.

Overrides:

addMouseMotionListener in class java.awt.Component

Parameters:

l - The awt mouse motion listener to add.

See Also:

ViewMouseMotionListener, Controller.addViewMouseMotionListener(oracle.dss.dataView.ViewMouseMotionListener)

removeMouseMotionListener

public void removeMouseMotionListener(java.awt.event.MouseMotionListener l)

Removes a mouse motion listener from this graph. This method removes a standard awt mouse motion listener from the list of registered listeners for this graph.

Overrides:

removeMouseMotionListener in class java.awt.Component

Parameters:

l - The mouse motion listener to remove.

addMouseListener

public void addMouseListener(java.awt.event.MouseListener l)

Adds a mouse listener to this graph. This method adds a standard awt listener. To respond to mouse events on a graph, it is easier to add a ViewMouseListener to the controller for this graph view. The ViewMouseEvent class includes information about the component that has been clicked with the mouse.

Overrides:

addMouseListener in class java.awt.Component

Parameters:

l - The awt mouse listener to add.

See Also:

ViewMouseListener, ViewMouseEvent, Controller.addViewMouseListener(oracle.dss.dataView.ViewMouseListener)

removeMouseListener

public void removeMouseListener(java.awt.event.MouseListener l)

Removes a mouse listener from this graph. This method removes a standard awt mouse listener from the list of registered listeners for this graph.

Overrides:

removeMouseListener in class java.awt.Component

Parameters:

l - The mouse listener to remove.

addKeyListener

public void addKeyListener(java.awt.event.KeyListener l)

Adds a key listener to this graph. This method adds a standard awt listener. To respond to keyboard events on a graph, it is easier to add a ViewKeyListener to the controller for this graph view. The ViewKeyEvent class includes information about the component that was selected when the key was pressed.

Overrides:

addKeyListener in class java.awt.Component

Parameters:

l - The awt key listener to add.

See Also:

ViewKeyListener, ViewKeyEvent, Controller.addViewKeyListener(oracle.dss.dataView.ViewKeyListener)

removeKeyListener

public void removeKeyListener(java.awt.event.KeyListener l)

Removes a key listener from this graph. This method removes a standard awt key listener from the list of registered listeners for this graph.

Overrides:

removeKeyListener in class java.awt.Component

Parameters:

l - The key listener to remove.

addAlertListener

public void addAlertListener(AlertListener l)

Adds an alert listener to this graph. If you register an alert listener with the graph, the graph sends events to the listener if there is a problem rendering the graph. For example, in automatically arranging the markers and text in the legend, the graph must truncate the legend text, it sends an AlertEvent to the alert listener.

Parameters:

l - The alert listener to add.

removeAlertListener

public void removeAlertListener(AlertListener l)

Removes an alert listener from this graph. This method removes a alert listener from the list of registered listeners for this graph.

Parameters:

l - The alert listener to remove.

exportToJPEG

public void exportToJPEG(java.io.OutputStream os,
                         int quality)

Exports a snapshot of the page that is currently displayed to a JPEG file.

Parameters:

os - The OutputStream that specifies the location and name of the JPEG file.

quality - The JPEG quality. Valid values are from 0 (worst quality) to 100 (good quality).

exportToGIF

public void exportToGIF(java.io.OutputStream os)

Exports a snapshot of the page that is currently displayed to the GIF file.

Before it exports to GIF, this method calls the DataAccess.forceFetch method to fetch all of the data on the current logical page.

Parameters:

os - The OutputStream that specifies the location and name of the GIF file.

exportToGIFWithException

public void exportToGIFWithException(java.io.OutputStream os)
                              throws java.io.IOException,
                                     java.lang.Exception

Exports a snapshot of the page that is currently displayed to the GIF file.

Before it exports to GIF, this method calls the DataAccess.forceFetch method to fetch all of the data on the current logical page.

Parameters:

os - The OutputStream that specifies the location and name of the GIF file.

Throws:

IOException - If an error occurs in reading the OutputStream.

Exception - If any other error occurs while exporting to GIF.

exportToPNG

public void exportToPNG(java.io.OutputStream os)

Exports a snapshot of the page that is currently displayed to the PNG file.

Before it exports to PNG, this method calls the DataAccess.forceFetch method to fetch all of the data on the current logical page. This method scales font sizes in the exported file based on the value of the ScaleFontSizeForGIF property.

Parameters:

os - The OutputStream that specifies the location and name of the PNG file.

See Also:

exportToPNGWithException(java.io.OutputStream), setScaleFontSizeForGIF(int)

exportToPNGWithException

public void exportToPNGWithException(java.io.OutputStream os)
                              throws java.io.IOException,
                                     java.lang.Exception

Exports a snapshot of the page that is currently displayed to the PNG file.

Before it exports to PNG, this method calls the DataAccess.forceFetch method to fetch all of the data on the current logical page. This method scales font sizes in the exported file based on the value of the ScaleFontSizeForGIF property.

Parameters:

os - The OutputStream that specifies the location and name of the PNG file.

Throws:

IOException - If an error occurs in reading the OutputStream.

Exception - If any other error occurs while exporting to PNG.

See Also:

exportToPNG(java.io.OutputStream), setScaleFontSizeForGIF(int)

isO1AxisSupported

public boolean isO1AxisSupported()

Indicates whether the current graph type has an ordinal axis. An ordinal axis is the axis that shows group titles rather than a scaled set of values. For example, a bar, line, point, or area graph has ordinal axes, normally across the bottom of the plot area. Scatter graphs and bubble graphs do not have an ordinal axis. Instead, the axis across the bottom of the plot area is an X1Axis, which shows a scale of data values. Also, graphs such as a pie graph or a ring graph do not have ordinal axes.

Returns:

true if the current graph type has an ordinal axis, false if not.

getGraphController

public GraphController getGraphController()

Retrieves the controller for this graph. In the Model-View-Controller architecture, the controller is responsible for attending to user gestures, such as mouse clicks.

Returns:

The GraphController for this graph.

getGraphFormatManager

public GraphFormatManager getGraphFormatManager()

Retrieves the format manager that the graph uses. The format manager is responsible for the format of the numbers that are displayed in the graph. For example, the ViewFormat object from the the format manager determines whether a number appears as a plain number or as currency.

Returns:

The FormatManager for this graph.

See Also:

ViewFormat

getGraphStyleManager

public GraphStyleManager getGraphStyleManager()

Retrieves the style manager that this graph uses. The style manager is responsible for the format of the paging control.

Returns:

The GraphStyleManager for this graph.

getGraphModel

public GraphModel getGraphModel()

Retrieves the model that this graph uses. In the Model-View-Controller architecture, the model is responsible for handling the data that is displayed in a view. In the full BI Beans set, the DataSource is the "big" model. The model that this method returns interacts with the DataSource, retrieving data and having the data formatted so that the view can display it.

Returns:

The GraphModel that this graph uses.

getSelectedObject

public ComponentHandle getSelectedObject()

Retrieves the selected component. This method retrieves a handle for the graph component that has most recently selected by a user. It returns a concrete subclass of the ComponentHandle class.

The subclass that is returned depends on the component that is selected. For example, an AreaMarker represents a series of data, so if an AreaMarker is selected, this method returns a SeriesComponentHandle. If a TwoDMarker (a bar in a bar graph) is selected, then this method returns a DataComponentHandle, because a TwoDMarker represents a data value that belongs in both a series (such as May 1999) and a group (such as Shoes).

Specified by:

getSelectedObject in interface UIDataview

Overrides:

getSelectedObject in class Dataview

Returns:

The handle for the selected component.

setDataSource

public void setDataSource(DataSource ds)

Specifies the data source for this graph. This method specifies the DataSource that will feed data to this graph. If you do not use the Graph(DataSource) method to create the graph, then you must call this method to specify the data that appears in the graph.

Overrides:

setDataSource in class Dataview

Parameters:

ds - The DataSource for this graph to use.

selectObject

public boolean selectObject(ComponentHandle id)

Selects a graph component.

Overrides:

selectObject in class Dataview

Parameters:

id - The handle of the component that you want to select. This should be a concrete subclass of the ComponentHandle class.

Returns:

true if the component is successfully selected, false, if not.

getGraphTypeConverter

public GraphTypeConverter getGraphTypeConverter()

Retrieves the GraphTypeConverter that this graph uses. The GraphTypeConverter translates the base graph types for a user interface (UI). For example, the default UI for this graph exposes a point graph type. Internally, this is really a line graph without the lines. The GraphTypeConverter maintains the information about the UI version of the graph and the Perspective for Java version.

This method returns null until the graph user interface instantiates a GraphTypeConverterAdapter for the graph.

Specified by:

getGraphTypeConverter in interface UIGraph

Returns:

The GraphTypeConverter that this graph uses.

setGraphTypeConverter

public void setGraphTypeConverter(GraphTypeConverter converter)

Specifies the GraphTypeConverter for the graph type to use. The GraphTypeConverter translates the base graph types for a user interface. For example, the default user interface for this graph exposes a point graph type. Internally, this is really a line graph without the lines. The GraphTypeConverter maintains the information about the internal graph types and the graph types that are exposed in the user interface.

The default user interface for the graph sets a default GraphTypeConverter. Call this method only if you add types or subtypes to the GraphTypeConverterAdapter, or if you remove types and subtypes from the GraphTypeConverterAdapter.

Specified by:

setGraphTypeConverter in interface UIGraph

Parameters:

converter - The GraphTypeConverter for this graph to use.

setLocale

public void setLocale(java.util.Locale loc)

Specifies the Locale for this Graph.

Overrides:

setLocale in class Dataview

Parameters:

loc - The Locale for this Graph.

setTimeZone

public void setTimeZone(java.util.TimeZone tz)

Specifies the TimeZone for this graph. Set the TimeZone to have the graph format dates according to a time zone other than the default time zone. The graph uses the TimeZone to format dates when the group axis displays time data.

Parameters:

tz - The time zone for this graph to use when it formats dates.

getTimeZone

public java.util.TimeZone getTimeZone()

Retrieves the TimeZone object this graph uses to format time data on the group axis.

Returns:

The time zone that this graph uses when it formats dates, or null if no time zone has been set. When this method returns null, the graph uses the default time zone to format time data.

getGroupSize

public int getGroupSize(int type)

Retrieves the number of columns or rows that comprise a group in a specified graph type.

The return value of the Graph.isDataRowShownAsASeries method determines whether the value that this method returns is the number of columns or rows. When DataRowShownAsASeries is true, then this method returns the number of columns that the graph type requires in a group. When DataRowShownAsASeries is false, then this method returns the number of rows in a group.

Most graph types have only one column or row in each group, but several graph types have more than one. For example, in a scatter graph in which rows are shown as series, each group has two columns of information -- one column that determines the distance of the marker along the X-axis, and one column that determines the distance along the Y-axis. In a bubble graph, each group has three columns (or rows, if rows are shown as groups) -- one for the X-axis value, one for the Y-axis value, and one for the size of the bubble. Stock graphs also have multiple columns in a group (or multiple rows, if rows are shown as groups).

Parameters:

type - A constant that represents the graph type that you want to know about. The constants are the valid constants for the GraphType property.

Returns:

The size of a group in the specified graph type. The size is the number of columns, if data rows are shown as series. If data rows are shown as groups, then the return is the number of rows.

See Also:

setGraphType(int), isDataRowShownAsASeries()

getMinimumGroups

public int getMinimumGroups(int type)

Retrieves the minimum number of groups that a graph type requires. For example, an area graph requires at least two groups, in order to define the area marker.

This method returns the number of groups that graph type requires, given the default properties for the graph type. For example, in a line graph, the LineDataLineDisplayed property is true by default. When the LineDataLineDisplayed property is true, then the line graph requires two groups, to define the end points of the group. If LineDataLineDisplayed is false, then the graph is a point graph, and actually only one column is required. Because the lines are displayed by default, this method returns 2 for line graphs.

Parameters:

type - The type of graph whose minimum groups you want to know. The constants are the constants for the GraphType property.

Returns:

The minimum number of groups in the specified graph type.

See Also:

setGraphType(int)

getMinimumSeries

public int getMinimumSeries(int type)

Retrieves the minimum number of series that a graph type requires. For example, an dual-Y graph requires at least two series, one for the Y1-axis, and one for the Y2-axis.

Parameters:

type - The type of graph whose minimum series you want to know. The constants are the constants for the GraphType property.

Returns:

The minimum number of series in the specified graph type.

See Also:

setGraphType(int)

createExceptionalRiser

public ExceptionalRiser createExceptionalRiser(int series,
                                               int group)

Creates an ExceptionalRiser. An ExceptionalRiser is a data marker that does not share series-related properties with the rest of the markers in the series. For example, in a bar graph, all the bars in a series have the same fill color. You would call this method if you wanted to have one of the markers in the series have a different color. The series and group parameters identify the marker that you want to be different.

Parameters:

series - The series of the marker that you want to be different. For a selected marker, you can pass the return value from DataComponentHandle.getSeries.

group - The group of the marker that you want to be different. For a selected marker, you can pass the return value from DataComponentHandle.getGroup.

Returns:

An ExceptionalRiser for the specified marker, or null if the graph type does not support exceptional risers.

See Also:

DataComponentHandle

destroyAllExceptionalRisers

public void destroyAllExceptionalRisers()

Destroys all ExceptionalRiser components in this graph. An ExceptionalRiser is a data marker that does not share series-related properties with the rest of the markers in the series. For example, in a bar graph, a bar that has a color that is different from the color of the other bars in the series has an ExceptionalRiser. This method destroys all exceptional risers, forcing each marker in this graph to look like the other markers in its series.

You can have any number of exceptional risers in a graph. However, to destroy one exceptional riser, you must destroy them all.

See Also:

ExceptionalRiser

getAutomaticComponentPlacement

public int getAutomaticComponentPlacement()

Deprecated. As of 2.6.0.12, replaced by getAutoLayout()

The getAutoLayout method returns information about when the graph automatically sets properties to lay out graph components.

Returns:

A constant that represents when the automatic placement of components occurs. Constants are listed in the See Also section.

See Also:

ACP_ALWAYS, ACP_NEVER

setAutomaticComponentPlacement

public void setAutomaticComponentPlacement(int placement)

Deprecated. As of 2.6.0.12, replaced by setAutoLayout(int)

Use the setAutoLayout method to specify when the graph sets properties to lay out graph components. setAutomaticComponentPlacement(AL_ALWAYS) maps to setAutoLayout(AL_AS_NEEDED).

Parameters:

placement - A constant that represents when to have the graph place components. Constants are listed in the See Also section.

See Also:

ACP_ALWAYS, ACP_NEVER, AL_AS_NEEDED

setAutoLayout

public void setAutoLayout(int auto)

Specifies when the graph automatically places and sizes its components. Use this primarily to have the graph consider the number of series in a graph and the size of series labels and then determine the best size and location for the graph legend.

When the graph determines the size and location of its components, it temporarily sets component properties. These temporary settings are not available to application code. If you want to tweak the appearance of the graph after it has been automatically laid out, then set AutoLayout to AL_NEVER and call the doAutoLayout method.

If you set this property to any value other than AL_NEVER, then you should also ensure that MouseMovingEnabled is set to false.

The default value of AutoLayout is AL_ALWAYS. The default value of MouseMovingEnabled is false.

Parameters:

auto - A constant that represents when the graph should automatically determine the size and placement of components. Valid constants are listed in the See Also section.

See Also:

AL_ALWAYS, AL_AS_NEEDED, AL_NEVER, doAutoLayout(int), setMouseMovingEnabled(boolean)

getAutoLayout

public int getAutoLayout()

Retrieves information about when the graph automatically places and sizes its components.

Specified by:

getAutoLayout in interface UIGraph

Returns:

A constant that represents when the graph automatically places and sizes its components. Constants are listed in the See Also section.

See Also:

AL_ALWAYS, AL_AS_NEEDED, AL_NEVER

doAutoLayout

public void doAutoLayout(int level)

Automatically places and sizes graph components once. Calling this method has the same effect as calling setAutoLayout(AL_ALWAYS), except that this method adjusts the layout only once, for the current data and layout, instead of making adjustments for data changes.

If you want to limit the strategies that this method can use in setting layout, then pass Graph.HONOR_PROPERTIES to this method, after setting the text rotation, legend position, or tick label skipping options that you want. This method sets the properties for automatic text rotation, legend position, and tick label skipping to their manual settings. For any calls after the first call to this method, you should either reset these properties as you want, or pass Graph.RESET_PROPERTIES as the level.

Before calling this method, set the AutoLayout to AL_NEVER.

This method sets the following properties of the Graph:

• DisplaySeries -- Set to 0
• LegendSeriesCount -- Set to the number of series whose labels fit within the legend area
• LegendSeriesStart -- Set to 0
• LegendScrollbarPresence -- Set to SP_NEVER
• FrameSizeAutomatic -- Set to true

This method sets the following properties of the LegendArea component:

• AutomaticPlacement -- Set to BaseGraphComponent.AP_NEVER
• MarkersPerRowAutomatic -- Set to false
• LegendMarkersPerRow -- Set as needed
• LegendTextPosition -- Set to LTP_ON_RIGHT
• LegendOrientation -- Set as needed
• Rect -- Set as needed

This method sets the following properties of the O1TickLabel component:

• TickLabelSkipMode -- Set to BaseGraphComponent.TLS_MANUAL
• TickLabelSkipCount -- Set as needed only if level is Graph.RESET_PROPERTIES or if TickLabelSkipMode is TLS_AUTOMATIC.
• TickLabelSkipFirst -- Set as needed only if
• level is Graph.RESET_PROPERTIES or if TickLabelSkipMode is TLS_AUTOMATIC.
• TickLabelStaggered -- Set as needed
• TextRotation -- Set as needed only if level is Graph.RESET_PROPERTIES
• AutomaticRotation -- Set as needed only if level is Graph.RESET_PROPERTIES
• HorizontalAlignment -- Set as needed

This method also does the following:

• Sets the Rect property of the PlotArea to make room in the graph for the legend and O1TickLabel components
• .
• Sets the Rect properties of the GraphTitle, GraphSubtitle, and GraphFootnote components, to place the components and to make the Rect just big enough to contain the text.
• Sets the MaxSize property of the LegendMarker to 11 pixels
• May set the WordWrap property of the LegendText component, to allow wrapping of the legend text

Parameters:

level - A constant that specifies the level of control to give to the automatic layout code. Pass Graph.RESET_PROPERTIES to give the automatic layout code more latitude, Graph.HONOR_PROPERTIES to limit the automatic layout.

See Also:

HONOR_PROPERTIES, RESET_PROPERTIES, setDisplaySeries(int), setLegendSeriesCount(int), setLegendSeriesStart(int), setLegendScrollbarPresence(int), setFrameSizeAutomatic(boolean), BaseFrame.setRect(java.awt.Rectangle), LegendMarker.setMaxSize(int), LegendArea.setAutomaticPlacement(int), LegendArea.setMarkersPerRowAutomatic(boolean), LegendArea.setLegendMarkersPerRow(int), LegendArea.setLegendTextPosition(int), LegendArea.setLegendOrientation(int), LegendArea.setRect(java.awt.Rectangle), O1TickLabel.setTickLabelStaggered(boolean), O1TickLabel.setTickLabelSkipMode(int), O1TickLabel.setTickLabelSkipCount(int), O1TickLabel.setTickLabelSkipFirst(int), O1TickLabel.setTextRotation(int), O1TickLabel.setAutomaticRotation(int), BaseTickLabel.setHorizontalAlignment(int), GraphBaseTitle#setRect

setColorMode

public void setColorMode(int mode)

Specifies whether markers of the same color comprise a group of data or a series of data. Set this property to COLOR_BY_GROUP when you have a single series of data and you want each marker to be a different color.

This property has no effect when GraphType is THREED_SURFACE.

The default value is COLOR_BY_SERIES.

Parameters:

mode - A constant that represents whether to render series in the same color or groups in the same color.

See Also:

COLOR_BY_SERIES, COLOR_BY_GROUP

getColorMode

public int getColorMode()

Indicates whether markers of the same color comprise a group of data or a series of data. This property has no effect when GraphType is THREED_SURFACE.

The default value for ColorMode is COLOR_BY_SERIES.

Returns:

A constant that indicates what markers of the same color mean.

See Also:

COLOR_BY_SERIES, COLOR_BY_GROUP

getDataDirectorType

public int getDataDirectorType()

Retrieves the the type of the current DataDirector, either a cube data director, for multidimensional data, or a relational data director, for relational data.

Returns:

A constant that represents the type of data director. Constants are listed in the See Also section.

See Also:

DDT_CUBE, DDT_RELATIONAL, DataDirector

setDataDirectorType

public void setDataDirectorType(int type)

Specifies the the type of DataDirector, either a cube data director, for multidimensional data, or a relational data director, for relational data.

Parameters:

type - A constant that represents the type of data director. Constants are listed in the See Also section.

See Also:

DDT_CUBE, DDT_RELATIONAL, DataDirector

isDataRowShownAsASeries

public boolean isDataRowShownAsASeries()

Indicates whether rows of data appear as series or as groups. Perspective for Java (PFJ) arranges data in terms of series and groups. This method indicates the way that data from the DataSource is translated to PFJ. For example, in a pie graph, series labels appear in the graph legend, and group labels appear under each pie. When data rows are shown as PFJ series, the labels for the data rows appear in the graph legend. When data rows are not shown as PFJ series, but rather as PFJ groups, the row labels appear under each pie, and the column labels appear in the graph legend. return true if data rows are shown as series, false if data rows are shown as groups.

Specified by:

isDataRowShownAsASeries in interface UIGraph

Following copied from interface: oracle.dss.graph.UIGraph

Returns:

true if data rows are shown as series, false if data rows are shown as groups.

setDataRowShownAsASeries

public void setDataRowShownAsASeries(boolean yesNo)

Specifies whether to display data rows as series or as groups. Perspective for Java (PFJ) arranges data in terms of series and groups. This method indicates the way that data from the DataSource is translated to PFJ. For example, in a pie graph, series labels appear in the graph legend, and group labels appear under each pie. When data rows are shown as PFJ series, the labels for the data rows appear in the graph legend. When data rows are not shown as PFJ series, but rather as PFJ groups, the row labels appear under each pie, and the column labels appear in the graph legend.

Specified by:

setDataRowShownAsASeries in interface UIGraph

Parameters:

yesNo - true to have data rows shown as PFJ series (and data columns shown as groups), false to have data rows shown as PFJ groups (and data columns shown as series).

getDepthAngle

public int getDepthAngle()

Retrieves the angle that implies depth on a bar, line, or area graph. This method returns the angle that determines how much we see of the sides and tops of markers and of the plot area.

With values under 90, the graph seems to face to our left. With values from 91 to 180, the graph seems to face to our right.

When values are close to 90, we see more of the top of the markers and less of their sides. When values are close to 0 or 180, we see less of the top of the markers and less of their sides.

The default value is 45.

Returns:

The size of the angle in degrees.

setDepthAngle

public void setDepthAngle(int angle)

Specifies the angle that implies depth on a bar, line, or area graph. This method sets the angle that determines how much we see of the sides and tops of markers and of the plot area.

With values under 90, the graph seems to face to our left. With values from 91 to 180, the graph seems to face to our right.

When values are close to 90, we see more of the top of the markers and less of their sides. When values are close to 0 or 180, we see less of the top of the markers and less of their sides.

The default value is 45.

Parameters:

angle - The size of the angle, in degrees. Valid values are from zero to 180. When you pass an invalid value, then the graph does not change the DepthAngle value. It logs a message to the error handler.

getDepthRadius

public int getDepthRadius()

Retrieves the depth of a bar, line, or area graph. This method indicates how deep a bar, line, or area graph appears to be. When this method returns zero, the graph appears flat.

Returns:

The depth of the graph. Possible values are zero to 100.

setDepthRadius

public void setDepthRadius(int depth)

Specifies how deep a bar, line, or area graph should appear to be.

Parameters:

depth - The depth that you want the graph to appear to have. Valid values are zero (a flat graph) to 100 (maximum depth). If you pass an invalid value, the graph does not set the DepthRadius property. It logs a message to the error handler.

getDisplayGroups

public int getDisplayGroups()

Retrieves the number of groups that this graph currently displays.

Returns:

The number of groups that this graph displays. Zero indicates that all the groups in the data are displayed.

setDisplayGroups

public void setDisplayGroups(int maxGroup)

Specifies the number of groups to display in this graph. Use this method, with the setScrollBarPresenceGroups method, to allow scrolling in this graph, when data rows are shown as series.

Parameters:

maxGroup - The number of groups to display at one time in the graph. To show all groups, pass 0. The maximum number of groups that you can display is the amount that is returned by Graph.getDisplayGroupsLimit.

See Also:

setDataRowShownAsASeries(boolean), setScrollbarPresenceGroups(int), getDisplayGroupsLimit()

getDisplayGroupsLimit

public int getDisplayGroupsLimit()

Retrieves the maximum value allowed for the DisplayGroups property. This method identifies a maximum value for the setDisplayGroups method. If the return value from this method is smaller than the return value from getDisplayGroups, then the graph uses the return value from this method.

Returns:

The maximum value to honor in a call to setDisplayGroups.

See Also:

getDisplayGroups(), setDisplayGroups(int)

setDisplayGroupsLimit

public void setDisplayGroupsLimit(int maxDisplayGroups)

Specifies the maximum value allowed for the DisplayGroups property. This method sets a maximum value to honor in a call to the setDisplayGroups method. If the value passed in setDisplayGroups is greater than the value that you specify in this method, the graph uses the value from this method.

By using this method, you can provide UI to let users set the number of groups to show at a time, and you can protect them from ill effects that might occur if they choose too high a value.

Returns:

The maximum value to honor in a call to setDisplayGroups. The value can be any positive integer up to and including 10,000,000.

See Also:

setDisplayGroups(int)

getDisplaySeries

public int getDisplaySeries()

Retrieves the number of series that this graph currently displays.

Returns:

The number of series that this graph displays. Zero indicates that all the series in the data are displayed.

setDisplaySeries

public void setDisplaySeries(int maxSeries)

Specifies the number of series to display in this graph.

Parameters:

maxSeries - The number of series to display at one time in the graph. To show all series, pass 0. The maximum number of series that you can display is the amount that is returned by Graph.getDisplaySeriesLimit.

See Also:

setDisplaySeriesLimit(int)

getDisplaySeriesLimit

public int getDisplaySeriesLimit()

Retrieves the maximum value allowed for the DisplaySeries property. This method indicates the maximum value that the graph honors in a call to the setDisplaySeries method. If the value passed in setDisplaySeries is greater than the value this method returns, the graph uses the value from this method.

Returns:

The maximum value that is honored in a call to setDisplaySeries.

See Also:

setDisplaySeries(int)

setDisplaySeriesLimit

public void setDisplaySeriesLimit(int maxDisplaySeries)

Specifies the maximum value allowed for the DisplaySeries property. This method sets a maximum value to honor in a call to the setDisplaySeries method. If the value passed in setDisplaySeries is greater than the value that you specify in this method, the graph uses the value from this method.

Parameters:

maxDisplaySeries - The maximum value to honor in a call to setDisplaySeries.

See Also:

setDisplaySeries(int)

isFitToContainer

public boolean isFitToContainer()

Indicates whether the graph automatically resizes itself to fit its container. When this method returns false, the graph uses the ImageSize property to determine its size. If the graph is larger than the container, then only part of the graph is visible.

Returns:

true if the graph automatically resizes to fit its container, false if it does not.

See Also:

setImageSize(java.awt.Dimension)

setFitToContainer

public void setFitToContainer(boolean fitToContainer)

Specifies whether the graph resizes itself automatically to fit its container. Setting this property to false is helpful when you want to design a graph that has size constraints. For example, when you design a graph for a portlet, you may want to see the graph only at the size it will be in the portlet.

If you set this property to false, then set the ImageSize property to set the size of the graph.

Parameters:

fitToContainer - true to have the graph automatically resize when the container changes size, false to have the graph remain the same size.

See Also:

setImageSize(java.awt.Dimension)

isFrameSizeAutomatic

public boolean isFrameSizeAutomatic()

Indicates whether the plot area or pie frame is automatically resized when the graph type changes.

Returns:

true if the frame size changes automatically when the graph type changes, false if it does not.

setFrameSizeAutomatic

public void setFrameSizeAutomatic(boolean isAuto)

Specifies whether the plot area or pie frame is automatically resized when the graph type changes.

Parameters:

isAuto - true to have the frame size change automatically, false to prevent automatic resizing.

getGraphType

public int getGraphType()

Retrieves the current graph type for this graph. The constants begin with the following:

• Bar graphs: BAR_
• Line graphs: LINE_
• Area graphs: AREA_
• Pie graphs: PIE_
• Ring (doughnut) graphs: RING_
• Scatter graphs: SCATTER_
• Bubble graphs: BUBBLE_
• Stock market graphs: STOCK_
• Radar graphs: RADAR_
• Polar graphs: POLAR_
• 3-D graphs: THREED_

A point graph, as exposed in the default UI, is a line graph in which getLineDataLineDisplayed returns false. A combination graph is a bar graph in which getMarkerType for one or more series returns anything other than MT_DEFAULT.

Specified by:

getGraphType in interface UIGraph

Returns:

A constant that represents the current graph type.

See Also:

setGraphType(int), isLineDataLineDisplayed(), Series.getMarkerType(int)

setGraphType

public void setGraphType(int type)

Specifies the graph type for this graph. The constants begin with the following:

• Bar graphs: BAR_
• Line graphs: LINE_
• Area graphs: AREA_
• Pie graphs: PIE_
• Ring (doughnut) graphs: RING_
• Scatter graphs: SCATTER_
• Bubble graphs: BUBBLE_
• Stock market graphs: STOCK_
• Radar graphs: RADAR_
• Polar graphs: POLAR_
• 3-D graphs: THREED_

A point graph, as exposed in the default UI, is a line graph in which isLineDataLineDisplayed returns false. A combination graph is a bar graph in which getMarkerType for one or more series returns anything other than MT_DEFAULT.

Specified by:

setGraphType in interface UIGraph

Parameters:

type - A constant that represents the graph type for this graph.

See Also:

BAR_VERT_CLUST, BAR_VERT_CLUST2Y, BAR_VERT_CLUST_SPLIT2Y, BAR_VERT_STACK, BAR_VERT_STACK2Y, BAR_VERT_STACK_SPLIT2Y, BAR_VERT_PERCENT, BAR_HORIZ_CLUST, BAR_HORIZ_CLUST_2Y, BAR_HORIZ_CLUST_SPLIT2Y, BAR_HORIZ_STACK, BAR_HORIZ_STACK_2Y, BAR_HORIZ_STACK_SPLIT2Y, AREA_VERT_ABS, AREA_VERT_ABS_SPLIT2Y, AREA_VERT_STACK, AREA_VERT_STACK_SPLIT2Y, AREA_VERT_PERCENT, LINE_VERT_ABS, LINE_VERT_ABS_2Y, LINE_VERT_ABS_SPLIT2Y, LINE_VERT_STACK, LINE_VERT_STACK_2Y, LINE_VERT_STACK_SPLIT2Y, LINE_VERT_PERCENT, RADAR_LINE, PIE, PIE_MULTI, RING, RING_MULTI, PARETO, PIE_BAR, RING_BAR, SCATTER, SCATTER_2Y, POLAR, BUBBLE, BUBBLE_2Y, STOCK_OHLC_CANDLE, STOCK_OHLC_CANDLE_VOLUME, STOCK_HILO_CLOSE, STOCK_HILO_CLOSE_VOLUME, THREED_BAR, THREED_CUBE, THREED_AREA_SERIES, THREED_RIBBON_SERIES, THREED_SURFACE, isLineDataLineDisplayed(), Series.getMarkerType(int)

getGroupTooltipLabelType

public int getGroupTooltipLabelType()

Retrieves the type of information about groups that this graph displays in tooltips. The information can be the dimension name, the dimension name and the dimension member, or neither. The default value for GroupTooltipLabelType is TLT_MEMBER.

Specified by:

getGroupTooltipLabelType in interface UIGraph

Returns:

A constant that represents the type of information that the graph displays for groups. Constants are listed in the See Also section.

See Also:

TLT_DIM_MEMBER, TLT_MEMBER, TLT_NONE

setGroupTooltipLabelType

public void setGroupTooltipLabelType(int type)

Specifies the type of information about groups that this graph displays in tooltips. The information can be the dimension name, the dimension name and the dimension member, or neither. The default value for GroupTooltipLabelType is TLT_MEMBER.

Specified by:

setGroupTooltipLabelType in interface UIGraph

Parameters:

type - A constant that represents the type of information that the graph should display for groups. Constants are listed in the See Also section.

See Also:

TLT_DIM_MEMBER, TLT_MEMBER, TLT_NONE

getImageSize

public java.awt.Dimension getImageSize()

Retrieves the size of this graph.

Returns:

The size of the graph, in a Dimension object.

setImageSize

public void setImageSize(java.awt.Dimension d)

Specifies a size for this graph. This property serves two purposes. It specifies the size of the image that is created from this graph when you export the graph to a PNG, GIF, or JPEG file. It also determines the size of the graph in an applet or application, when the FitToContainer property is set to false.

Parameters:

d - The size to make the graph.

See Also:

setFitToContainer(boolean), exportToGIF(java.io.OutputStream), exportToGIFWithException(java.io.OutputStream), exportToJPEG(java.io.OutputStream, int), exportToPNG(java.io.OutputStream), exportToPNGWithException(java.io.OutputStream)

getDefaultImageSize

public java.awt.Dimension getDefaultImageSize()

Retrieves the default size of this graph. Normally, you use this method when you create GIF files and ScaleFontSizeForGIF is set to something other than TEXT_COMPONENTS_NONE.

Returns:

The default size of the graph.

See Also:

setScaleFontSizeForGIF(int)

setDefaultImageSize

public void setDefaultImageSize(java.awt.Dimension d)

Specifies a default size for this graph. Call this method before you call exportToGIF or exportToGIFWithException, to set the default size of the GIF file. Setting this property has no effect when ScaleFontSizeForGIF is set to TEXT_COMPONENTS_NONE.

When this property takes effect, then the font size ratio is calculated as ImageSize/defaultImageSize. The default value of the default image size is (400,400).

Parameters:

d - The default size of the graph.

See Also:

exportToGIF(java.io.OutputStream), exportToGIFWithException(java.io.OutputStream), setScaleFontSizeForGIF(int)

isLineDataLineDisplayed

public boolean isLineDataLineDisplayed()

Indicates whether data lines appear in a line graph.

Specified by:

isLineDataLineDisplayed in interface UIGraph

Returns:

true if a line graph displays lines, false if the line graph does not display lines.

See Also:

setMarkerDisplayed(boolean)

setLineDataLineDisplayed

public void setLineDataLineDisplayed(boolean yesNo)

Specifies whether data lines appear in a line graph. If you set this property to false, then you should make sure that the MarkerDisplayed property is set to true. If both properties are false, then the graph will not display data.

Specified by:

setLineDataLineDisplayed in interface UIGraph

Parameters:

yesNo - true to display lines, false not to display them.

See Also:

setMarkerDisplayed(boolean)

isGraphicAntialiasing

public boolean isGraphicAntialiasing()

Indicates whether lines appear in a graph as smooth or more jagged.

Returns:

true if a line in a graph appears smooth, false if the line in a graph appears more jagged.

setGraphicAntialiasing

public void setGraphicAntialiasing(boolean yesNo)

Specifies whether lines in a graph appear more smooth or more jagged.

Parameters:

yesNo - true for a smooth line, false for a more jagged line.

isTextAntialiasing

public boolean isTextAntialiasing()

Indicates whether text appears in a graph as smooth or more jagged.

Returns:

true if text in a graph appears smooth, false if text in a graph appears more jagged.

setTextAntialiasing

public void setTextAntialiasing(boolean yesNo)

Specifies whether text in a graph appears more smooth or more jagged.

Parameters:

yesNo - true for smooth text, false for more jagged text.

isMarkerDisplayed

public boolean isMarkerDisplayed()

Indicates whether data markers appear in a line graph.

Specified by:

isMarkerDisplayed in interface UIGraph

Returns:

true if the line graph displays data markers, false if it does not.

See Also:

DataMarker

setMarkerDisplayed

public void setMarkerDisplayed(boolean yesNo)

Specifies whether data markers appear in a line graph. If you set this property to true, then you should also make sure that the MarkerShape property for each series in the graph is not set to BaseGraphComponent.MS_NONE.

If you set this property to false, then you should be sure to set the LineDataLineDisplayed property to true.

Specified by:

setMarkerDisplayed in interface UIGraph

Parameters:

yesNo - true to display data markers, false to hide data markers.

See Also:

setLineDataLineDisplayed(boolean), DataMarker, Series.setMarkerShape(int, int), BaseGraphComponent.MS_NONE

isMarkerShapeInLegend

public boolean isMarkerShapeInLegend()

Indicates whether legend markers are shaped like their corresponding data markers or 2-D markers.

Returns:

true if legend markers are shaped like the data markers or 2-D markers in the same series, false if all the legend markers are square.

See Also:

DataMarker, TwoDMarker, Series.setMarkerShape(int, int)

setMarkerShapeInLegend

public void setMarkerShapeInLegend(boolean yesNo)

Specifies whether legend markers are shaped like their corresponding data markers or 2-D markers.

Parameters:

yesNo - true to have legend markers shaped like the data markers or 2-D markers in the same series, false to have all the legend markers remain square.

See Also:

DataMarker, TwoDMarker, Series.setMarkerShape(int, int)

getMarkerTooltipType

public int getMarkerTooltipType()

Indicates the type of information that this graph displays in tooltips for markers. The information can be the value that the marker represents, the percent value (for pie graphs), the cumulative value (for stacked graphs), text that identifies the group or series, or a combination of information, such as the value, the group, and the series. Constants start with MTT_.

The default value for MarkerTooltipType is MTT_VALUES.

If MarkerTooltipType includes MTT_TEXT, then the content of the text is specified in the SeriesTooltipLabelType and GroupTooltipLabelType properties.

Specified by:

getMarkerTooltipType in interface UIGraph

Returns:

A constant that represents the type of information that the graph displays for markers. The constant can be a combination of constants that have been combined using a bitwise OR (|).

See Also:

MTT_TEXT, MTT_VALUES, MTT_NONE, MTT_PERCENT_VAL, MTT_CUM_VAL, getGroupTooltipLabelType(), getSeriesTooltipLabelType()

setMarkerTooltipType

public void setMarkerTooltipType(int type)

Specifies the type of information that this graph displays in tooltips for markers. The information can be the value that the marker represents, the percent value (for pie graphs), the cumulative value (for stacked graphs), text that identifies the group or series, or a combination of information, such as the value, the group, and the series. Constants start with MTT_.

The default value for MarkerTooltipType is MTT_VALUES.

If you set MarkerTooltipType to include MTT_TEXT, then the content of the text is specified by the setSeriesTooltipLabelType and setGroupTooltipLabelType methods.

Specified by:

setMarkerTooltipType in interface UIGraph

Parameters:

type - A constant that represents the type of information that the graph should display for markers. Except for MTT_NONE, the constants can be combined by using a bitwise OR (|).

See Also:

MTT_TEXT, MTT_VALUES, MTT_NONE, MTT_PERCENT_VAL, MTT_CUM_VAL, setGroupTooltipLabelType(int), setSeriesTooltipLabelType(int)

isMouseMovingEnabled

public boolean isMouseMovingEnabled()

Indicates whether the selected component can be moved and resized with the mouse.

Returns:

true if the component can be moved and resized with the mouse, false if not.

setMouseMovingEnabled

public void setMouseMovingEnabled(boolean yesNo)

Specifies whether a selected component can be moved and resized with the mouse.

If you set this property to true, then you should set AutoLayout to AL_NEVER. If this property is true while AutoLayout is AL_ALWAYS, then users can select components, but when they try to move or resize components, the components will snap back to their original size and location. If this property is true while AutoLayout is AL_AS_NEEDED, then users may be able to move and resize some elements of the graph. If they cause components to overlap or to exceed their boundaries, then automatic layout will take place, likely undoing the change the user made.

Parameters:

yesNo - true to allow mouse moving and resizing, false to prevent it.

See Also:

setAutoLayout(int), doAutoLayout(int)

isFontSizeAbsolute

public boolean isFontSizeAbsolute()

Indicates whether the font size is absolute or proportional to the size of the graph.

Returns:

true if the font size is absolute, false if the font size changes with the size of the graph.

setFontSizeAbsolute

public void setFontSizeAbsolute(boolean yesNo)

Specifies whether to use absolute font sizes or sizes that are proportional to the size of the graph.

Parameters:

yesNo - true to use absolute font sizes, false to use font sizes that change with the size of the graph.

setFontName

public void setFontName(java.lang.String name)

Specifies the font name for all of the components of this graph.

Parameters:

name - The name of the font to use for text components.

isParetoBarsConnected

public boolean isParetoBarsConnected()

Indicates whether pareto bars are connected.

Returns:

true if bars are connected, false if space appears between the bars.

setParetoBarsConnected

public void setParetoBarsConnected(boolean connected)

Specifies whether the pareto bars are connected to each other.

Parameters:

connected - true to join the bars, false to have space appear between the bars.

getPieDepth

public int getPieDepth()

Retrieves the depth of a pie in a pie graph. Also applies to ring graphs. When this method returns zero, the pie or ring appears flat.

Returns:

The depth of the pie or ring. Possible values are zero to 100.

setPieDepth

public void setPieDepth(int depth)

Specifies how deep a pie in a pie graph should be. Also applies to ring graphs.

Parameters:

depth - The depth that you want the pie or ring to appear to have. Valid values are zero (a flat graph) to 100 (maximum depth).

getPieRotation

public int getPieRotation()

Retrieves the amount that a pie or ring is rotated in a pie graph. By default, the slice that represents the first series starts at 12:00. This method retrieves the number of degrees counterclockwise by which the pie is rotated. For example, when this method returns 90, the first series starts at 3:00.

This method applies to all pies or rings in the graph.

Returns:

The number of degrees of rotation. Possible values are zero to 359.

setPieRotation

public void setPieRotation(int degrees)

Specifies the amount that a pie is rotated in a pie graph. Also applies to ring graphs. By default, the slice that represents the first series starts at 12:00. This method retrieves the number of degrees clockwise by which the pie is rotated. For example, when this method returns 90, the first series starts at 3:00.

This method applies to all pies or rings in this graph.

Parameters:

degrees - The number of degrees clockwise to rotate the pie. Valid values are zero to 359.

getPieTilt

public int getPieTilt()

Retrieves the amount that a pie or ring appears to be tilted. This method indicates how much a pie or ring appears to tilt away from us. This method applies to all the pies or rings in this graph.

Returns:

The amount by which the pie appears to tilt. Possible values are 0 (the pie appears upright) to 100 (maximum tilt).

setPieTilt

public void setPieTilt(int tilt)

Specifies the amount to tilt a pie or ring. This method indicates how much a pie or ring appears to tilt away from us. This method applies to all the pies or rings in this graph.

Returns:

The amount by which the pie appears to tilt. Possible values are 0 (the pie appears upright) to 100 (maximum tilt).

getPresentationHeight

public int getPresentationHeight()

Retrieves the height of this graph in pixels.

Overrides:

getPresentationHeight in class Dataview

Returns:

The height of this graph in pixels

getPresentationWidth

public int getPresentationWidth()

Retrieves the width of the graph in pixels.

Overrides:

getPresentationWidth in class Dataview

Returns:

The width of this graph in pixels.

isScatterDataLineDisplayed

public boolean isScatterDataLineDisplayed()

Indicates whether data lines appear on a scatter graph. When this graph has a scatter type and this method returns true, the data markers on this graph are connected by data lines.

Returns:

true if data lines appear when this graph is a scatter graph, false if data lines do not appear.

See Also:

DataLine, DataMarker

setScatterDataLineDisplayed

public void setScatterDataLineDisplayed(boolean yesNo)

Specifies whether data lines appear on a scatter graph. When this graph has a scatter type and you pass true to this method, the data markers on this graph are connected by data lines.

Parameters:

yesNo - true to display data lines, false to hide data lines.

See Also:

DataLine, DataMarker

getSeriesObjectCount

public int getSeriesObjectCount()

Retrieves the number of series that this graph stores properties for. The graph stores properties, such as colors, for a number of series. Beyond that number, the graph repeats series properties. For example, if this method returns 4, then:

• Series 5 has the same color as series 1
• Series 6 has the same color as series 2
• Series 7 has the same color as series 3
• and so on

Specified by:

getSeriesObjectCount in interface UIGraph

Returns:

The number of series that this graph stores properties for before it repeats properties.

See Also:

Series

setSeriesObjectCount

public void setSeriesObjectCount(int count)

Specifies the number of series that this graph stores properties for. The graph stores properties, such as colors, for a number of series. Beyond that number, the graph repeats series properties. For example, if you pass 4 to this method, then:

• Series 5 has the same color as series 1
• Series 6 has the same color as series 2
• Series 7 has the same color as series 3
• and so on

Parameters:

count - The number of series that this graph should store properties for before it repeats properties. Valid values are 1 - Graph.SERIESOBJECTCOUNTLIMIT.

See Also:

Series

getSeriesTooltipLabelType

public int getSeriesTooltipLabelType()

Retrieves the type of information about series that this graph displays in tooltips. The information can be the dimension name, the dimension name and the dimension member, or neither. Constants start with TLT_. The default value for SeriesTooltipLabelType is TLT_MEMBER.

In order for the series labels to be displayed, the MarkerTooltipType property must be set to include text.

Specified by:

getSeriesTooltipLabelType in interface UIGraph

Returns:

A constant that represents the type of information that the graph displays for series.

See Also:

TLT_MEMBER, TLT_DIM_MEMBER, TLT_NONE, setMarkerTooltipType(int)

setSeriesTooltipLabelType

public void setSeriesTooltipLabelType(int type)

Specifies the type of information about series that this graph displays in tooltips. The information can be the dimension name, the dimension name and the dimension member, or neither. Constants start with TLT_. The default value for SeriesTooltipLabelType is TLT_MEMBER.

In order for the series labels to be displayed, the MarkerTooltipType property must be set to include text.

Specified by:

setSeriesTooltipLabelType in interface UIGraph

Parameters:

type - A constant that represents the type of information that the graph should display for series.

See Also:

TLT_MEMBER, TLT_DIM_MEMBER, TLT_NONE, setMarkerTooltipType(int)

getScrollbarPresenceGroups

public int getScrollbarPresenceGroups()

Retrieves the circumstances under which scrollbars for groups appear on this graph. Scrollbars can appear always, never, or only when the number of groups that can be displayed in the graph is greater than the value returned from the getDisplayGroups method. Constants start with SP_.

Returns:

A constant that indicates when this graph displays scrollbars for groups.

See Also:

getDisplayGroups(), setDisplayGroups(int)

setScrollbarPresenceGroups

public void setScrollbarPresenceGroups(int scroll)

Specifies the circumstances under which scrollbars for groups appear on this graph. Scrollbars can appear always, never, or only when the number of groups that can be displayed in the graph is greater than the value returned from the getDisplayGroups method. Constants start with SP_.

Parameters:

scroll - A constant that indicates when to have this graph graph display scrollbars for groups.

See Also:

getDisplayGroups(), setDisplayGroups(int)

getScrollbarPresenceSeries

public int getScrollbarPresenceSeries()

Retrieves the circumstances under which scrollbars for series appear on this graph. Scrollbars can appear always, never, or only when the number of series that can be displayed in the graph is greater than the value returned from the getDisplaySeries method.

Returns:

A constant that indicates when this graph displays scrollbars for series. Constants are listed in the See Also section.

See Also:

SP_ALWAYS, SP_NEVER, SP_AS_NEEDED, getDisplaySeries(), setDisplaySeries(int)

setScrollbarPresenceSeries

public void setScrollbarPresenceSeries(int scroll)

Specifies the circumstances under which scrollbars for series appear on this graph. Scrollbars can appear always, never, or only when the number of series that can be displayed in the graph is greater than the value returned from the getDisplaySeries method.

Parameters:

scroll - A constant that indicates when to have this graph display scrollbars for series. Constants are listed in the See Also section.

See Also:

SP_ALWAYS, SP_NEVER, SP_AS_NEEDED, getDisplaySeries(), setDisplaySeries(int)

getStartGroup

public int getStartGroup()

Retrieves the first group that this graph currently displays.

Returns:

The index of the first group that is displayed. The index is zero-based.

setStartGroup

public void setStartGroup(int group)

Specifies the first group to display in this graph. This method has an effect only when the getDisplayGroups method returns a value greater than zero, that is, when this graph does not display all groups of data.

Parameters:

group - The index of the first group to display in this graph. This index is zero-based. Valid values are from zero to Graph.GROUPANDSERIESLIMIT.

See Also:

getDisplayGroups(), setDisplayGroups(int)

getStartColumn

public int getStartColumn()

Deprecated. As of 2.6.0.27, replaced by getStartGroup() or by getStartSeries().

Retrieves the first column of data that this graph currently displays.

Overrides:

getStartColumn in class Dataview

Returns:

The index of the first column that is displayed. The index is zero-based.

setStartColumn

public void setStartColumn(int column)

Deprecated. As of 2.2.0.14, replaced by setStartGroup(int) or by setStartSeries(int)

In some graph types, a group contains more than one column or row of data. For example, in a scatter graph, when DataRowShownAsASeries is true, then a group encompasses two columns of data.

If DataRowShownAsASeries is set to true, then call setStartGroup to start with a group other than the first group.

If DataRowShownAsASeries is set to false, then call setStartSeries to start with a series other than the first series.

Overrides:

setStartColumn in class Dataview

Following copied from class: oracle.dss.dataView.Dataview

Parameters:

c - The first column of data to display.

getStartSeries

public int getStartSeries()

Retrieves the first series that this graph currently displays.

Returns:

The index of the first series that is displayed. The index is zero-based.

setStartSeries

public void setStartSeries(int series)

Specifies the first series to display in this graph. This method has an effect only when the getDisplaySeries method returns a value greater than zero, that is, when this graph does not display all groups of data.

Parameters:

group - The index of the first series to display in this graph. This index is zero-based. Valid values are from zero to Graph.GROUPANDSERIESLIMIT.

See Also:

getDisplaySeries(), setDisplaySeries(int)

getStartRow

public int getStartRow()

Deprecated. As of 2.6.0.27, replaced by getStartSeries() or by getStartGroup().

Retrieves the first row of data that this graph currently displays.

Overrides:

getStartRow in class Dataview

Returns:

The index of the first row that is displayed. The index is zero-based.

setStartRow

public void setStartRow(int row)

Deprecated. As of 2.2.0.14, replaced by setStartSeries(int) or by setStartGroup(int)

In some graph types, a group contains more than one column or row of data. For example, in a scatter graph, when DataRowShownAsASeries is false, then a group encompasses two rows of data.

If DataRowShownAsASeries is set to false, then call setStartGroup to start with a group other than the first group.

If DataRowShownAsASeries is set to true, then call setStartSeries to start with a series other than the first series.

Overrides:

setStartRow in class Dataview

Following copied from class: oracle.dss.dataView.Dataview

Parameters:

r - The first row of data to display.

getToolTipDelay

public int getToolTipDelay()

Retrieves the amount of time before tooltips appear. The time is the number of milliseconds between the time that the mouse moves over a graph component and the time that the tooltip appears.

Returns:

The number of milliseconds before tooltips appear.

setToolTipDelay

public void setToolTipDelay(int delay)

Specifies the amount of time before tooltips appear. The time is the number of milliseconds between the time that the mouse moves over a graph component and the time that the tooltip appears.

Parameters:

delay - The number of milliseconds to wait before displaying the tooltip.

isHorizontal

public boolean isHorizontal()

Indicates whether the graph has a horizontal graph type. In a horizontal graph, the O1Axis and its tick labels are vertical. Otherwise, they are horizontal. The plot area panel in the default UI calls this method in order to translate "horizontal" and "vertical" for the end user.

Specified by:

isHorizontal in interface UIGraph

Returns:

true if the graph is horizontal, false if it is vertical.

getCustomToolTipCallback

public CustomToolTipCallback getCustomToolTipCallback()

Retrieves the CustomToolTipCallback that this Graph uses to get text for tooltips.

Returns:

The CustomToolTipCallback that provides tooltips for this Graph. Returns null if no CustomToolTipCallback has been set.

setCustomToolTipCallback

public void setCustomToolTipCallback(CustomToolTipCallback callback)

Specifies the CustomToolTipCallback that will provide tooltip text to this Graph.

Parameters:

callback - The CustomToolTipCallback that this Graph should call for tooltip text.

getDataErrorTextCallback

public DataErrorTextCallback getDataErrorTextCallback()

Retrieves the DataErrorTextCallback that this Graph uses to get text for the data error message. If this method returns null, then the graph uses default text.

Returns:

The DataErrorTextCallback that provides data error text for this Graph. Returns null if no DataErrorTextCallback has been set.

setDataErrorTextCallback

public void setDataErrorTextCallback(DataErrorTextCallback callback)

Specifies the DataErrorTextCallback that will provide data error text to this Graph. If you do not set a custom text callback, then the graph uses default text when there is not enough data to display a graph.

Parameters:

callback - The DataErrorTextCallback that this Graph should call for data error text.

See Also:

setDataErrorFont(java.awt.Font)

getAreaMarker

public AreaMarker getAreaMarker()

Retrieves the AreaMarker component for this graph.

Returns:

The AreaMarker for this graph.

See Also:

getSeries()

getConnector

public Connector getConnector()

Retrieves the Connector component for this graph.

Returns:

The Connector component for this graph.

getDataLine

public DataLine getDataLine()

Retrieves the DataLine component for this graph.

Returns:

The DataLine component for this graph.

See Also:

getSeries()

getDataMarker

public DataMarker getDataMarker()

Retrieves the DataMarkercomponent for this graph.

Returns:

The DataMarkercomponent for this graph.

See Also:

getSeries()

getGraphBackground

public GraphBackground getGraphBackground()

Retrieves the GraphBackground component for this graph.

Returns:

The GraphBackground component for this graph.

getFootnote

public Titles getFootnote()

Retrieves the GraphFootnote component for this graph.

Returns:

The GraphFootnote component for this graph.

getLegendArea

public LegendArea getLegendArea()

Retrieves the LegendArea component for this graph.

Returns:

The LegendArea component for this graph.

getLegendMarker

public LegendMarker getLegendMarker()

Retrieves the LegendMarker component for this graph.

Returns:

the LegendMarker component for this graph.

getLegendText

public LegendText getLegendText()

Retrieves the LegendText component for this graph.

Returns:

The LegendText component for this graph.

getFitline

public Fitline getFitline()

Retrieves the Fitline component for this graph.

Returns:

The Fitline component for this graph.

getMarkerText

public MarkerText getMarkerText()

Retrieves the MarkerText component for this graph.

Returns:

The MarkerText component for this graph.

getO1Axis

public O1Axis getO1Axis()

Retrieves the O1Axis component for this graph.

Returns:

The O1Axis component for this graph.

getO1MajorTick

public O1MajorTick getO1MajorTick()

Retrieves the O1MajorTick component for this graph.

Returns:

the O1MajorTick component for this graph.

getO1TickLabel

public O1TickLabel getO1TickLabel()

Retrieves the O1TickLabel component for this graph.

Returns:

The O1TickLabel component for this graph.

getO1Title

public O1Title getO1Title()

Retrieves the 01Title component for this graph.

Returns:

the 01Title component for this graph.

getPieFeeler

public PieFeeler getPieFeeler()

Retrieves the PieFeeler component for this graph.

Returns:

The PieFeeler component for this graph.

getPieFrame

public PieFrame getPieFrame()

Retrieves the PieFrame component for this graph.

Returns:

The PieFrame component for this graph.

getPieLabel

public PieLabel getPieLabel()

Retrieves the PieLabel component for this graph.

Returns:

The PieLabel component for this graph.

getPlotArea

public PlotArea getPlotArea()

Retrives the PlotArea component for this graph.

Returns:

The PlotArea component for this graph.

getQuadrantLine

public QuadrantLine getQuadrantLine()

Retrieves the QuadrantLine component for this graph.

Returns:

The QuadrantLine component for this graph.

getRingTotalLabel

public RingTotalLabel getRingTotalLabel()

Retrieves the RingTotalLabel component for this graph.

Returns:

The RingTotalLabel component for this graph.

getSeries

public Series getSeries()

Retrieves the Series component for this graph.

Returns:

The Series component for this graph.

getSlice

public Slice getSlice()

Retrieves the Slice component for this graph.

Returns:

The Slice component for this graph.

getSliceLabel

public SliceLabel getSliceLabel()

Retrieves the SliceLabel component for this graph.

Returns:

The SliceLabel component for this graph.

getStockMarker

public StockMarker getStockMarker()

Retrieves the StockMarker component for this graph.

Returns:

the StockMarker component for this graph.

getParetoLine

public UIParetoLine getParetoLine()

Retrieves the implementation of the UIParetoLine interface for this graph.

Specified by:

getParetoLine in interface UIGraph

Returns:

The UIParetoLine. You should program against this interface. Do not cast it to the implementation.

getSubtitle

public Titles getSubtitle()

Retrieves the GraphSubtitle component for this graph.

Returns:

the GraphSubtitle component for this graph.

get3DFloor

public ThreeDFloor get3DFloor()

Retrieves the ThreeDFloor component for this graph.

Returns:

The ThreeDFloor component for this graph.

get3DLeftWall

public ThreeDLeftWall get3DLeftWall()

Retrieves the ThreeDLeftWall component for this graph.

Returns:

The ThreeDLeftWall component for this graph.

get3DRightWall

public ThreeDRightWall get3DRightWall()

Retrieves the ThreeDRightWall component for this graph.

Returns:

The ThreeDRightWall component for this graph.

get3DMarker

public ThreeDMarker get3DMarker()

Retrieves the ThreeDMarker component for this graph.

Returns:

The ThreeDMarker component for this graph.

get3DViewMatrix

public ThreeDViewMatrix get3DViewMatrix()

Retrieves the ThreeDViewMatrix component for this graph.

Returns:

The ThreeDViewMatrix component for this graph.

getSplitDivider

public SplitDivider getSplitDivider()

Retrieves the SplitDivider component for this graph.

Returns:

The SplitDivider component for this graph.

getTitle

public Titles getTitle()

Retrieves the GraphTitle component for this graph.

Returns:

The GraphTitle component for this graph.

get2DMarker

public TwoDMarker get2DMarker()

Retrieves the TwoDMarker component for this graph.

Returns:

the TwoDMarker component for this graph.

getVolumeMarker

public VolumeMarker getVolumeMarker()

Retrieves the VolumeMarker component for this graph.

Returns:

the VolumeMarker component for this graph.

getX1Axis

public X1Axis getX1Axis()

Retrieves the X1Axis component for this graph.

Returns:

the X1Axis component for this graph.

getX1MajorTick

public X1MajorTick getX1MajorTick()

Retrieves the X1MajorTick component for this graph.

Returns:

the X1MajorTick component for this graph.

getX1TickLabel

public X1TickLabel getX1TickLabel()

Retrieves the X1TickLabel component for this graph.

Returns:

The X1TickLabel component for this graph.

getX1Title

public X1Title getX1Title()

Retrieves the X1Title component for this graph.

Returns:

the X1Title component for this graph.

getXPanelGrid

public XPanelGrid getXPanelGrid()

Retrieves the XPanelGrid component for this graph.

Returns:

The XPanelGrid component for this graph.

getY1Axis

public Y1Axis getY1Axis()

Retrieves the Y1Axis component for this graph.

Returns:

The Y1Axis component for this graph.

getY1MajorTick

public Y1MajorTick getY1MajorTick()

Retrieves the Y1MajorTick component for this graph.

Returns:

the Y1MajorTick component for this graph.

getY1TickLabel

public Y1TickLabel getY1TickLabel()

Retrieves the Y1TickLabel component for this graph.

Returns:

The Y1TickLabel component for this graph.

getY1Title

public Y1Title getY1Title()

Retrieves the Y1Title component for this graph.

Returns:

the Y1Title component for this graph.

getY1ZeroLine

public Y1ZeroLine getY1ZeroLine()

Retrieves the Y1ZeroLine component for this graph.

Returns:

The Y1Title component for this graph.

getY2Axis

public Y2Axis getY2Axis()

Retrieves the Y2Axis component for this graph.

Returns:

The Y2Axis component for this graph.

getY2MajorTick

public Y2MajorTick getY2MajorTick()

Retrieves the Y2MajorTick component for this graph.

Returns:

the Y2MajorTick component for this graph.

getY1BaseLine

public Y1BaseLine getY1BaseLine()

Retrieves the Y1BaseLine component for this graph.

Returns:

The Y1BaseLine component for this graph.

getY2BaseLine

public Y2BaseLine getY2BaseLine()

Retrieves the Y2BaseLine component for this graph.

Returns:

The Y2BaseLine component for this graph.

getX1ReferenceLine

public X1ReferenceLine getX1ReferenceLine()

Retrieves the X1ReferenceLine component for this graph.

Returns:

The X1ReferenceLine component for this graph.

getY1ReferenceLine

public Y1ReferenceLine getY1ReferenceLine()

Retrieves the Y1ReferenceLine component for this graph.

Returns:

The Y1ReferenceLine component for this graph.

getY2ReferenceLine

public Y2ReferenceLine getY2ReferenceLine()

Retrieves the Y2ReferenceLine component for this graph.

Returns:

The Y2ReferenceLine component for this graph.

getReferenceLineMarker

public ReferenceLineMarker getReferenceLineMarker()

Retrieves the ReferenceLineMarker component for this graph.

Returns:

The ReferenceLineMarker component for this graph.

getReferenceLineText

public ReferenceLineText getReferenceLineText()

Retrieves the ReferenceLineText component for this graph.

Returns:

The ReferenceLineText component for this graph.

getY2TickLabel

public Y2TickLabel getY2TickLabel()

Retrieves the Y2TickLabel component for this graph.

Returns:

The Y2TickLabel component for this graph.

getY2Title

public Y2Title getY2Title()

Retrieves the Y2Title component for this graph.

Returns:

The Y2Title component for this graph.

getY2ZeroLine

public Y2ZeroLine getY2ZeroLine()

Retrieves the Y2ZeroLine component for this graph.

Returns:

The Y2ZeroLine component for this graph.

getY3DMarkerGrid

public Y3DMarkerGrid getY3DMarkerGrid()

Retrieves the Y3DMarkerGrid component for this graph.

Returns:

The Y3DMarkerGrid component for this graph.

getYPanelGrid

public YPanelGrid getYPanelGrid()

Retrieves the YPanelGrid component for this graph.

Returns:

The YPanelGrid component for this graph.

getZPanelGrid

public ZPanelGrid getZPanelGrid()

Retrieves the ZPanelGrid component for this graph.

Returns:

The ZPanelGrid component for this graph.

getZTickLabel

public ZTickLabel getZTickLabel()

Retrieves the ZTickLabel component for this graph.

Returns:

The ZTickLabel component for this graph.

getZTitle

public ZTitle getZTitle()

Retrieves the ZTitle component for this graph.

Returns:

The ZTitle component for this graph.

setXML

public boolean setXML(java.lang.String xmlString,
                      boolean reset)
               throws BIIOException,
BISAXException,
BIParseException

Deprecated. As of 1.7.0.12, replaced by setXML(String, int)

The setXML method that takes an int for the reset parameter allows you to specify how much and how far to reset the view before you apply XML.

Throws:

BIIOException - If an error occurs in reading xmlString.

BISAXException - If a general SAX exception occurs in parsing the XML.

BIParseException - If the XML syntax is not correct, or if the XML is not valid according to the DTD that is specified in the XML.

setXML

public boolean setXML(java.lang.String xmlString,
                      int reset)
               throws BIIOException,
BISAXException,
BIParseException

Applies XML to this Graph, from a String. This method reads the XML from xmlString and applies its attribute settings to this Graph. The reset parameter determines how much of the Graph to reset before applying XML. In general, you can:

• Apply the XML to the current Graph without resetting anything to default values
• Reset property values only, leaving registered listeners and callbacks
• Reset property values and remove any listeners and callbacks that have been registered with this Graph

Resetting returns property values in the Graph to the default values for the version that is specified in the XML.

Overrides:

setXML in class Dataview

Parameters:

xmlString - The XML to apply to this Graph.

reset - A constant that indicates how much and how far to reset the view before applying XML. Valid constants appear in the See Also section. If you pass an invalid constant, then this method logs a message with the error handler and does not reset any property values.

Returns:

true if the XML is successfully applied to this Graph, false if an IO exception occurs.

Throws:

BIIOException - If an error occurs in reading xmlString.

BISAXException - If a general SAX exception occurs in parsing the XML.

BIParseException - If the XML syntax is not correct, or if the XML is not valid according to the DTD that is specified in the XML.

See Also:

Dataview.RESET_NONE, Dataview.RESET_XML_PROPERTIES, Dataview.RESET_EVERYTHING

readXML

public boolean readXML(java.io.InputStream stream,
                       boolean reset)
                throws BIIOException,
BISAXException,
BIParseException

Deprecated. As of 1.7.0.12, replaced by readXML(InputStream, int)

The readXML method that takes an int for the reset parameter allows you to specify how much and how far to reset the view before you apply XML.

Throws:

BIIOException - If an error occurs in reading xmlString.

BISAXException - If a general SAX exception occurs in parsing the XML.

BIParseException - If the XML syntax is not correct, or if the XML is not valid according to the DTD that is specified in the XML.

readXML

public boolean readXML(java.io.InputStream stream,
                       int reset)
                throws BIIOException,
BISAXException,
BIParseException

Applies XML to this Graph, from a String. This method reads the XML from xmlString and applies its attribute settings to this Graph. The reset parameter determines how much of the Graph to reset before applying XML. In general, you can:

• Apply the XML to the current Graph without resetting anything to default values
• Reset property values only, leaving registered listeners and callbacks
• Reset property values and remove any listeners and callbacks that have been registered with this Graph

Resetting returns property values in the Graph to the default values for the version that is specified in the XML.

Overrides:

readXML in class Dataview

Parameters:

stream - The XML to apply to this Graph.

reset - A constant that indicates how much and how far to reset the view before applying XML. Valid constants appear in the See Also section. If you pass an invalid constant, then this method logs a message with the error handler and does not reset any property values.

Returns:

true if the XML is successfully applied to this Graph, false if an IO exception occurs.

Throws:

BIIOException - If an error occurs in reading xmlString.

BISAXException - If a general SAX exception occurs in parsing the XML.

BIParseException - If the XML syntax is not correct, or if the XML is not valid according to the DTD that is specified in the XML.

See Also:

Dataview.RESET_NONE, Dataview.RESET_XML_PROPERTIES, Dataview.RESET_EVERYTHING

getImagemapEnumeration

public java.util.Enumeration getImagemapEnumeration(int filter)

Retrieves the enumeration of specific kinds of components that are currently in use and visible on the graph. The constants for filter are defined in this class, and begin with MAP_. The enumeration provides an ImagemapComponent object for each graph component.

Each ImagemapComponent object contains the ComponentHandle and the Polygon for that graph component. The ComponentHandle contains information about the component, such as its series and group. The Polygon contains information about the component's position on the graph.

Parameters:

filter - The kinds of graph components that you want to enumerate.

Returns:

The enumeration of the specified kinds of graph components.

See Also:

MAP_ALL, MAP_DATA, MAP_DATATEXT, MAP_LABELS, MAP_LEGEND, MAP_ORDINALLABELS, MAP_TITLES, ImagemapComponent

writeImagemapXML

public void writeImagemapXML(java.io.OutputStream os,
                             int filter)

Writes an XML representation of information about specific kinds of components that are currently in use and visible on the graph. The kinds of information that this method writes are the series (if applicable), the group (if applicable) and the placement of the component or components. The constants for filter are defined in this class and begin with MAP_.

Parameters:

os - The output stream where XML will be written.

filter - The kinds of graph components whose information you want to write in XML.

See Also:

getImagemapEnumeration(int), MAP_ALL, MAP_DATA, MAP_DATATEXT, MAP_LABELS, MAP_LEGEND, MAP_ORDINALLABELS, MAP_TITLES

writeImagemapXML

public void writeImagemapXML(java.io.PrintWriter out,
                             int filter)

Writes an XML representation of information about specific kinds of components that are currently in use and visible on the graph. The kinds of information that this method writes are the series (if applicable), the group (if applicable) and the placement of the component or components. The constants for filter are defined in this class and begin with MAP_.

Parameters:

out - The print writer where XML will be written.

filter - The kinds of graph components whose information you want to write in XML.

See Also:

getImagemapEnumeration(int), MAP_ALL, MAP_DATA, MAP_DATATEXT, MAP_LABELS, MAP_LEGEND, MAP_ORDINALLABELS, MAP_TITLES

setScaleFontSizeForGIF

public void setScaleFontSizeForGIF(int scale)

Specifies which text components should be resized when the graph is scaled to a different size for output to a graphic file, such as GIF file.

Parameters:

mask - A constant that represents the set of components to scale with the graph. Valid constants are listed in the See Also section.

See Also:

TEXT_COMPONENTS_ALL, TEXT_COMPONENTS_NONE

getScaleFontSizeForGIF

public int getScaleFontSizeForGIF()

Retrieves which text components should be resized when the graph is scaled to a different size for output to a graphic file, such as a GIF file.

Returns:

A constant that represents which text components should be resized when the Graph is scaled to a different size for GIF output. Valid constants are listed in the See Also section.

See Also:

TEXT_COMPONENTS_ALL, TEXT_COMPONENTS_NONE

setPieBarSeries

public void setPieBarSeries(int series)

Specifies the series for which the bar shows detail, in a pie-bar or ring-bar graph. The pie is rotated so that the series specified in this method is closest to the bar.

Parameters:

series - The index of the series for which you want to show detail. Valid values range from 0 to one less than the number of series in the data for this graph. You can find the maximum value by subtracting 1 from the return value of the getSeriesObjectCount method. If you pass an invalid value, then this method logs a message to the error handler and does not change the series.

See Also:

getSeriesObjectCount()

getPieBarSeries

public int getPieBarSeries()

Retrieves the index of series for which the bar shows detail, in a pie-bar or ring-bar graph.

Returns:

The index of series for which the bar shows detail. Indexes begin at 0.

convertGraphTypeToString

public static java.lang.String convertGraphTypeToString(int value)

Generates a String representation of a graph type constant. This method takes a graph type constant and produces a String that is appropriate to use as an attribute value when you use the BI Beans persistence service and search for graphs that have a particular graph type.

For example:

 //pmMyFolder is the PersistenceManager for MyFolder
 BasicAttributes _attrs = new BasicAttributes();
 _attrs.put(PSRConstants.Attributes.OBJECT_TYPE, PSRConstants.GRAPH);
 _attrs.put(Graph.GRAPH_TYPE, Graph.convertGraphTypeToString(Graph.BAR_VERT_CLUST));

Parameters:

value - The graph type constant that you want to convert.

Returns:

A String for the graph type.

setXMLAsString

public boolean setXMLAsString(java.lang.String xml)
                       throws BIPersistenceException

Specifies the XML representation of this Graph. The persistence service calls this method when the view is restored from the BI Beans Catalog. This method does not reset any properties before applying the XML to this Graph.

Application developers should not call this method. To load XML from a file, call setXML or readXML.

Overrides:

setXMLAsString in class Dataview

Parameters:

xml - The XML representation of the view.

Returns:

true if the XML was successfully set, false if not.

Throws:

BIPersistenceException - If a problem occurs in setting the XML.

See Also:

readXML(java.io.InputStream, boolean), setXML(java.lang.String, boolean)

setTabularData

public boolean setTabularData(java.util.List tableRows)

Specifies data for the Graph, from a table of data. Use this method to provide data row-by-row, from a file of tab-delimited or comma-separated values, or from a JDBC ResultSet.

When you use this method, you extract values from the file or ResultSet, organize them, and then pass them all in one call to this method. The graph creates a grid of data from the data that you pass in, and it uses this grid to populate itself.

For each data value in the table or result set, you construct an array of three Objects:

• The object at index 0 is the label for the column, in the grid that the graph constructs, in which the data item belongs. This is normally a String. If the graph has a time axis, then this should be a Java Date. Column labels appear as group labels in the graph, unless DataRowShownAsASeries is false.
• The object at index 1 is the label for the row, in the grid that the graph constructs, in which the data item belongs. This is normally a String. Row labels appear as series labels in the graph (usually in the legend), unless DataRowShownAsASeries is false. In this case, if the graph has a time axis, then this should be a Java Date.
• The object at index 2 is the data value, usually a Double.

You add each Object array to a List (normally an ArrayList or a Vector). You pass the complete List to this method.

The following table shows a set of data to pass to the graph through this method:

Boston	Bowties	97300
Boston	Neckties	413812
Cleveland	Bowties	48025
Cleveland	Neckties	298511

The Object arrays would look like this, if you want the types of ties to appear in the legend (assuming that data rows in the grid represent series):

 Object[] tableRow1 = {"Boston", "Bowties", new Double(97300)};
 Object[] tableRow2 = {"Boston", "Neckties", new Double(413812)};
 Object[] tableRow3 = {"Cleveland", "Bowties", new Double(48025)};
 Object[] tableRow4 = {"Cleveland", "Neckties", new Double(298511)};

 // add the arrays to a List
 ArrayList data = new ArrayList();
 data.add(tableRow1);
 data.add(tableRow2);
 data.add(tableRow3);
 data.add(tableRow4);

 // pass the List to this method
 graph.setTabularData(data);

The grid that this method constructs and feeds to the graph looks like this:

	Boston	Cleveland
Bowties	97300	48025
Neckties	413812	298511

Note that the data is not interactive. If you want users to be able to rotate or drill, you will have to provide a way for them to express that intention, and you must call this method again to display the rearranged data.

Parameters:

tableRows - List of data to plot in the graph.

Returns:

true if data is successfully set on the graph, false if there is a data problem.

See Also:

isDataRowShownAsASeries()

getColumnCount

public int getColumnCount()
                   throws EdgeOutOfRangeException

Retrieves the number of columns of data that this graph displays.

Specified by:

getColumnCount in interface UIGraph

Returns:

The number of data columns that this graph displays.

Throws:

EdgeOutOfRangeException - If the data source does not support the the column edge.

See Also:

isDataRowShownAsASeries()

getRowCount

public int getRowCount()
                throws EdgeOutOfRangeException

Retrieves the number of rows of data that this graph displays.

Specified by:

getRowCount in interface UIGraph

Returns:

The number of data rows that this graph displays.

Throws:

EdgeOutOfRangeException - If the data source does not support the row edge.

See Also:

isDataRowShownAsASeries()

getDataAccessSliceLabel

public java.lang.Object getDataAccessSliceLabel(int edge,
                                                int slice,
                                                java.lang.String type)
                                         throws EdgeOutOfRangeException,
SliceOutOfRangeException

Retrieves the label for the data slice in the DataAccess for this graph. The UI calls this method to get information about the series when it displays the plot area panel.

Specified by:

getDataAccessSliceLabel in interface UIGraph

Parameters:

edge - The edge that you want labels for. The oracle.dss.graph.gui.Series class calls this with DataAccess.ROW_EDGE.

slice - The slice of data that you want labels for.

type - The type of data that you want from the DataAccess. oracle.dss.graph.gui.Series calls this method with MetadataMap.METADATA_LONGLABEL as the type.

Returns:

The label for the specified slice of data.

Throws:

EdgeOutOfRangeException - If edge is not a valid edge.

SliceOutOfRangeException - If slice is not a valid slice.

See Also:

DataAccess.getSliceLabel(int, int, java.lang.String)

beginAxisChanges

public void beginAxisChanges()

Prevents calculation of axis values while the user interface panel sets axis scaling properties. The ValueAxis class calls this method before it applies the settings of axis scaling options.

Specified by:

beginAxisChanges in interface UIGraph

See Also:

ValueAxis

endAxisChanges

public void endAxisChanges()

Re-enables calculation of axis values after the user interface panel sets axis scaling properties. The ValueAxis class calls this method after it applies the settings of axis scaling options.

Specified by:

endAxisChanges in interface UIGraph

See Also:

ValueAxis

setSwapAllowed

public void setSwapAllowed(boolean swap)

Specifies whether users can swap page items in this view. When SwapAllowed is true, then users can click the two page items that they want to swap, in order to swap the items. The view will then ask the data source to perform a pivot of type DataDirector.PIVOT_SWAP.

When SwapAllowed is false, then users must move the two page items separately, and the view will ask for two separate pivot actions of type DataDirector.PIVOT_MOVE_BEFORE or DataDirector.PIVOT_MOVE_AFTER. By default, swapping is disabled.

Overrides:

setSwapAllowed in class Dataview

Parameters:

swap - true to enable swapping, false to disable it.

See Also:

isSwapAllowed(), DataDirector

isSwapAllowed

public boolean isSwapAllowed()

Indicates whether swapping is allowed in this view. When this method returns true, then users can swap items by clicking the two items. When this method returns false, then users must move each item separately.

Overrides:

isSwapAllowed in class Dataview

Returns:

true if swapping is enabled, false if it is not.

See Also:

setSwapAllowed(boolean)

isGroupSeriesTooltipSupported

public boolean isGroupSeriesTooltipSupported(int edge)

Indicates whether group or series option (depending on the edge passed in) is supported in the tooltips. If it is, then the PlotArea panel enables the appropriate checkbox. If it is not, then the checkbox is disabled. This method works for the row edge and the column edge only.

Application developers should not need to call this method.

Specified by:

isGroupSeriesTooltipSupported in interface UIGraph

Parameters:

edge - DataDirector.ROW_EDGE for the row edge, or DataDirector.COLUMN_EDGE for the column edge.

Returns:

true If the the option is supported false If the option is not supported and the checkbox should be disabled.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.ROW_EDGE

getDataFilter

public DataFilter getDataFilter()

Retrieves an implementation of the DataFilter interface.

Specified by:

getDataFilter in interface UIGraph

Returns:

The DataFilter that specifies how much of the DataAccess to display in this graph.

setMaxBarWidth

public void setMaxBarWidth(int width)

Specifies the maximum width of a bar, in virtual coordinate units. The maximum width applies to bars in bar, area, line, combination, and stock graphs. The default value is 2000.

Parameters:

width - The maximum width for bars in this graph, in virtual coordinate units. Pass -1 to remove limits on the widths of bars. Any other value less than 1 is invalid. If you pass an invalid value, then this method logs an error with the error handler and does not set the MaxBarWidth property.

getMaxBarWidth

public int getMaxBarWidth()

Retrieves the maximum width of bar in this graph, in virtual coordinates. The maximum width applies to bars in bar, area, line, combination, and stock graphs. The default value is 2000. A value of -1 means that there is no maximum limit on bar width.

Returns:

The maximum width of a bar, in virtual coordinate units.

setDrillDimension

public void setDrillDimension(java.lang.String dim)

Specifies the name of a dimension that should be used when a drill operation is ambiguous. If the component from which a user initiates a drill operation represents the specified dimension, then the dimension will be drilled.

Parameters:

dim - The name of the dimension to drill.

getDrillDimension

public java.lang.String getDrillDimension()

Retrieves the name of the dimension that will be drilled when a drill operation is ambiguous.

Returns:

The name of the dimension that will be drilled.

getMaxTickLabelAutoFontSize

public int getMaxTickLabelAutoFontSize()

Retrieves the maximum font size for tick labels that are automatically sized to fit in this graph. The effect of this property appears only when the FontSizeAbsolute property for the tick label component is set to false, and the TextFittingAutomatic is set to true.

Returns:

The maximum font size for autofit tick labels, in virtual coordinate units.

See Also:

getMinTickLabelAutoFontSize(), setMaxTickLabelAutoFontSize(int), setMinTickLabelAutoFontSize(int), BaseLegendText.getMaxAutoFontSize(), BaseLegendText.getMinAutoFontSize(), BaseLegendText.setMaxAutoFontSize(int), BaseLegendText.setMinAutoFontSize(int)

setMaxTickLabelAutoFontSize

public void setMaxTickLabelAutoFontSize(int size)

Specifies the maximum font size for tick labels that are automatically sized to fit in this graph. The effect of this property appears only when the FontSizeAbsolute property for the tick label component is set to false, and the TextFittingAutomatic is set to true.

Parameters:

size - The maximum font size for autofit tick labels, in virtual coordinate units. Valid values are from 1 to 16000. If you pass an invalid value, then this method logs a message with the error handler and does not change the value of the property.

See Also:

getMaxTickLabelAutoFontSize(), getMinTickLabelAutoFontSize(), setMinTickLabelAutoFontSize(int), BaseLegendText.getMaxAutoFontSize(), BaseLegendText.getMinAutoFontSize(), BaseLegendText.setMaxAutoFontSize(int), BaseLegendText.setMinAutoFontSize(int)

getMinTickLabelAutoFontSize

public int getMinTickLabelAutoFontSize()

Retrieves the minimum font size for tick labels that are automatically sized to fit in this graph. The effect of this property appears only when the FontSizeAbsolute property for the tick label component is set to false, and the TextFittingAutomatic is set to true.

Returns:

The minimum font size for autofit tick labels, in virtual coordinate units.

See Also:

getMaxTickLabelAutoFontSize(), setMaxTickLabelAutoFontSize(int), setMinTickLabelAutoFontSize(int), BaseLegendText.getMaxAutoFontSize(), BaseLegendText.getMinAutoFontSize(), BaseLegendText.setMaxAutoFontSize(int), BaseLegendText.setMinAutoFontSize(int)

setMinTickLabelAutoFontSize

public void setMinTickLabelAutoFontSize(int size)

Specifies the minimum font size for tick labels that are automatically sized to fit in this graph. The effect of this property appears only when the FontSizeAbsolute property for the tick label component is set to false, and the TextFittingAutomatic is set to true.

Parameters:

size - The minimum font size for autofit tick labels, in virtual coordinate units. Valid values are from 1 to 16000. If you pass an invalid value, then this method logs a message with the error handler and does not change the value of the property.

See Also:

getMaxTickLabelAutoFontSize(), getMinTickLabelAutoFontSize(), setMaxTickLabelAutoFontSize(int), BaseLegendText.getMaxAutoFontSize(), BaseLegendText.getMinAutoFontSize(), BaseLegendText.setMaxAutoFontSize(int), BaseLegendText.setMinAutoFontSize(int)

getLegendSeriesCount

public int getLegendSeriesCount()

Retrieves the number of series that are represented in the legend, independent of the number that the graph displays. The DisplaySeries property takes precedence over this property. Automatic graph layout ignores this property. The doAutoLayout method sets this property to the number of series that appear in the legend.

Returns:

The number of series that are represented in the legend.

See Also:

setLegendScrollbarPresence(int), setDisplaySeries(int), setAutoLayout(int), doAutoLayout(int)

setLegendSeriesCount

public void setLegendSeriesCount(int count)

Specifies the number of series to show in the legend, independent of the number of series that the graph displays. The default value is 20.

Use this method, with the setLegendScrollbarPresence method, to make the legend scrollable.

HTML-client graphs do not support scrollable legends. Do not call this method in a thin graph.

Automatic graph layout ignores this property. The doAutoLayout method sets it to the number of series that appear in the legend.

Parameters:

count - The number of series to show in the legend. Pass 0 to show all series that the graph displays. If you pass a value less than 0, then this message logs a message with the error handler and does not set the property.

See Also:

setLegendScrollbarPresence(int), setAutoLayout(int), doAutoLayout(int)

getLegendSeriesStart

public int getLegendSeriesStart()

Retrieve the index of the first series that appears in the legend, independent of the first series that the graph displays. This property has an effect only when LegendSeriesCount is set to show a subset of the total number of series, and DisplaySeries is set to show all the series.

Automatic graph layout ignores this property. The doAutoLayout method sets it to 0.

Returns:

The index of the first series that appears in the legend. The first series is series 0.

See Also:

setLegendSeriesCount(int), setDisplaySeries(int), setLegendScrollbarPresence(int), setAutoLayout(int), doAutoLayout(int)

setLegendSeriesStart

public void setLegendSeriesStart(int start)

Specifies the index of the first series that appears in the legend, independent of the first series that the graph displays. This property has an effect only when LegendSeriesCount is set to show a subset of the total number of series, and DisplaySeries is set to show all the series.

If you make the legend scrollable, and users scroll through the legend, then the graph automatically sets this property.

HTML-client graphs do not support scrollable legends. Do not call this method in a thin graph.

Automatic graph layout ignores this property. The doAutoLayout method sets it to 0.

Parameters:

start - The index of the first series to display in the legend. Valid values are from zero to GROUPANDSERIESLIMIT. If you pass an invalid value, then this method logs an error with the error handler and does not set the property.

See Also:

GROUPANDSERIESLIMIT, setLegendSeriesCount(int), setDisplaySeries(int), setLegendScrollbarPresence(int), setAutoLayout(int), doAutoLayout(int)

getLegendScrollbarPresence

public int getLegendScrollbarPresence()

Retrieves the circumstances under which a scrollbar appears for the legend of this graph. This property, with the LegendSeriesCount property, work to make the legend scrollable. The ScrollbarPresenceSeries property takes precedence over this property.

HTML-client graphs do not support scrollable legends. The default value is SP_AS_NEEDED.

Automatic graph layout ignores this property. The doAutoLayout method sets it to SP_NEVER.

Returns:

A constant that specifies when the legend scrollbar appears. Valid values begin with SP_ and are listed in the See Also section.

See Also:

SP_ALWAYS, SP_NEVER, SP_AS_NEEDED, setScrollbarPresenceSeries(int), setLegendSeriesCount(int), setAutoLayout(int), doAutoLayout(int)

setLegendScrollbarPresence

public void setLegendScrollbarPresence(int presence)

Specifies the circumstances under which a scrollbar appears for the legend of this graph. Use this property, with the LegendSeriesCount property, to make the legend scrollable. The ScrollbarPresenceSeries property takes precedence over this property.

HTML-client graphs do not support scrollable legends. In a thin graph, you should all this method to set the property to SP_NEVER. The default value is SP_AS_NEEDED.

Automatic graph layout ignores this property. The doAutoLayout method sets it to SP_NEVER.

Parameters:

presence - A constant that specifies when to display a scrollbar in the legend. Valid values begin with SP_ and are listed in the See Also section. If you pass an invalid value, then this method logs an error with the error handler and does not set the property.

See Also:

SP_ALWAYS, SP_NEVER, SP_AS_NEEDED, setScrollbarPresenceSeries(int), setLegendSeriesCount(int), setAutoLayout(int), doAutoLayout(int)

calculatePlacement

public void calculatePlacement()

Forces the graph to perform a complete calculation of its elements. Call this method if you need to get image map information before the graph is rendered, or if you need to get property values that are normally calculated as the graph renders itself. For example, the graph calculates automatic axis scaling values as it renders itself. Call this method if you need such information before the graph is rendered.

getViewType

public int getViewType()

Retrieves the specific type of subclass of this Dataview. This method returns Dataview.VIEW_TYPE_GRAPH.

Specified by:

getViewType in interface UIDataview

Overrides:

getViewType in class Dataview

Returns:

The constant Dataview.VIEW_TYPE_GRAPH

See Also:

Dataview.VIEW_TYPE_GRAPH

getDataErrorFont

public java.awt.Font getDataErrorFont()

Retrieves the font for the message that indicates that there is not enough data to draw the graph. When the data that has been specified for a graph is not sufficient to display a graph, a message appears instead of the graph. This method returns the font that is used for that message.

Returns:

The font used for the "not enough data" message.

setDataErrorFont

public void setDataErrorFont(java.awt.Font font)

Specifies the font for the message that indicates that there is not enough data to draw the graph. When the data that has been specified for a graph is not sufficient to display a graph, a message appears instead of the graph. This method specifies the font that is used for that message.

Parameters:

font - The font to use for the "not enough data" message.

See Also:

setDataErrorTextCallback(oracle.dss.graph.DataErrorTextCallback)