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:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, DataviewAttributes, DataviewCommon, DataviewConstants, ExportableGraph, GraphAttribute, ModelListener, ThickDataview, UIDataview, UIView, GraphConstants, ThickGraph, UIGraphType, oracle.dss.presutil.CommonViewAttributes, ComponentTypeConverter, ErrorHandlerCallback, PagingControlAttributes, oracle.dss.util.persistence.CatLinkNode, oracle.dss.util.persistence.CatNode, oracle.dss.util.persistence.contract.AggregableContract, oracle.dss.util.persistence.contract.CustomXMLContract, oracle.dss.util.persistence.contract.OptionalContract, oracle.dss.util.persistence.Persistable, oracle.dss.util.persistence.SimplePersistable, oracle.dss.util.persistence.StringXMLizable

public class Graph
extends Dataview
implements DataviewAttributes, ExportableGraph, GraphConstants, UIGraphType, ThickGraph, UIDataview, GraphAttribute

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

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Nested classes/interfaces inherited from interface oracle.dss.graph.GraphConstants

GraphConstants.AnnotationLocation, GraphConstants.AnnotationPosition, GraphConstants.BubbleMarkerSizing, GraphConstants.DataSelection, GraphConstants.FormFactor, GraphConstants.InteractiveSliceBehavior, GraphConstants.InteractivityBehavior, GraphConstants.Markers, GraphConstants.MinorGridStepType, GraphConstants.ScatterLineType

Field Summary

static java.lang.String	GRAPH_TYPE The graph type attribute for searches.
static java.lang.String	GRAPH_XML_VERSION_NUMBER
protected GraphTypeConverter	m_converter
protected GraphController	m_graphController
protected GraphModel	m_graphModel
protected java.awt.Image	m_offscreenImage
protected PFJ	m_pfj
protected boolean	m_printOrPreviewMode
protected SampleDataSource	m_sampleDataSource

Fields inherited from class oracle.dss.dataView.Dataview

a_description, a_localName, a_name, a_pagingControlVisible, a_swapAllowed, a_version, above_title, below_title, boundSupport, d_description, d_localName, d_name, d_pagingControlVisible, d_swapAllowed, footnotePanel, listenerList, m_attrs, m_bSuperCalled, m_commonDataview, m_context, m_customColorsEnabled, m_dataviewFootnote, m_dataViewFormatSupported, m_dataviewSubtitle, m_dataviewTitle, m_method_readXML, m_method_resetToDefault, m_method_setpagingcontrolposition, m_method_setViewStyle, m_method_setXML, m_stopRepaints, m_tokenSubstitution, MAX_TEXTFIELD_CHARS, pagingControl, printOrPreviewMode, propertyChangeListenerList, subcomponent, titlePanel, undoSupport, vetoableChangeListenerList, vetoSupport

Fields inherited from class javax.swing.JComponent

accessibleContext, TOOL_TIP_TEXT_KEY, ui, 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 oracle.dss.graph.GraphConstants

ADA_ACCESSIBILITY, ADA_OFF, AL_ALWAYS, AL_AS_NEEDED, AL_NEVER, ALERT, ALL, ALL_PROPERTIES_MODE, ANNOTATION, AREA_HORIZ_ABS, AREA_HORIZ_ABS_SPLIT2Y, AREA_HORIZ_PERCENT, AREA_HORIZ_STACK, AREA_HORIZ_STACK_SPLIT2Y, AREA_VERT_ABS, AREA_VERT_ABS_SPLIT2Y, AREA_VERT_PERCENT, AREA_VERT_STACK, AREA_VERT_STACK_SPLIT2Y, AREAMARKER, AUTOMATIC, BACKGROUND, BAR_HORIZ_CLUST, BAR_HORIZ_CLUST_2Y, BAR_HORIZ_CLUST_SPLIT2Y, BAR_HORIZ_PERCENT, BAR_HORIZ_STACK, BAR_HORIZ_STACK_2Y, BAR_HORIZ_STACK_SPLIT2Y, bar_shape_cylinder, BAR_SHAPE_CYLINDER, bar_shape_diamond, BAR_SHAPE_DIAMOND, bar_shape_rectangle, BAR_SHAPE_RECTANGLE, bar_shape_triangle, BAR_SHAPE_TRIANGLE, BAR_VERT_CLUST, BAR_VERT_CLUST_SPLIT2Y, BAR_VERT_CLUST2Y, BAR_VERT_FLOAT_STACK, BAR_VERT_PERCENT, BAR_VERT_STACK, BAR_VERT_STACK_SPLIT2Y, BAR_VERT_STACK2Y, BP_ALWAYS, BP_NEVER, BUBBLE, BUBBLE_2Y, BUBBLE_LABELS, BUBBLE_LABELS_2Y, CL_AUTO_GRADIENT, CL_NONE, CL_TITLE_SEPARATOR, CL_TITLES_SIDEBYSIDE, COLOR_BY_GROUP, COLOR_BY_SERIES, COMBINATION_VERT_ABS, COMBINATION_VERT_ABS_2Y, CONNECTOR, CSS_PROPERTIES_MODE, CTAI_AUTOMATIC, CTAI_DAY, CTAI_HOUR, CTAI_MINUTE, CTAI_MONTH, CTAI_SECOND, CTAI_YEAR, DATALINE, DATAMARKER, DAY, DAY_OF_MONTH, DAY_OF_WEEK, DAY_OF_WEEK_ABBR, DAY_OF_WEEK_NUMBER, DAY_SINGLE_LETTER, DDT_CUBE, DDT_RELATIONAL, DMT_DEFAULT, DMT_DESKTOP, DMT_EXCEL, DRILLMARKER, DRILLTEXT, FITLINE, FUNNEL, FUNNELFRAME, FUNNELSLICE, FUNNELSLICELABEL, GRAPH, GRAPH_END, GRAPH_MARGIN, GROUPANDSERIESLIMIT, HIST_HORIZ, HIST_VERT, HONOR_PROPERTIES, HOUR, HOUR_MINUTE, HOUR_MINUTE_SECOND, HOUR24, HOUR24_MINUTE, HOUR24_MINUTE_SECOND, HS_MAX, HS_NO_RESCALE, HS_OFF, HS_RESCALE, LAYER_LEGENDMARKER, LAYER_LEGENDTEXT, LEGEND_LABEL_VIRT_SPACING, LEGEND_MARGIN_SPACING_HORZ, LEGEND_MARGIN_SPACING_VIRT, LEGEND_MARKER_MARGIN, LEGENDAREA, LEGENDMARKER, LEGENDTEXT, LEGENDTITLE, LINE_HORIZ_ABS, LINE_HORIZ_ABS_2Y, LINE_HORIZ_ABS_SPLIT2Y, LINE_HORIZ_PERCENT, LINE_HORIZ_STACK, LINE_HORIZ_STACK_2Y, LINE_HORIZ_STACK_SPLIT2Y, LINE_SELECT_POINT, LINE_VERT_ABS, LINE_VERT_ABS_2Y, LINE_VERT_ABS_SPLIT2Y, LINE_VERT_PERCENT, LINE_VERT_STACK, LINE_VERT_STACK_2Y, LINE_VERT_STACK_SPLIT2Y, LS_AUTO, LS_NONE, MA_NONE, MA_SCROLL_ZOOM, MA_SELECT, MARKERTEXT, MONTH, MONTH_LONG, MONTH_NUMBER, MONTH_SHORT, MONTH_SINGLE_LETTER, msil_false, MSIL_FALSE, msil_square, MSIL_SQUARE, msil_true, MSIL_TRUE, MTT_CUM_VAL, MTT_NONE, MTT_PERCENT_VAL, MTT_PERCENT_VAL_TEXT, MTT_PERCENT_VAL_VALUES, MTT_PERCENT_VAL_VALUES_TEXT, MTT_TEXT, MTT_VALUES, MTT_VALUES_TEXT, NONE, O1AXIS, O1DRILLLABEL, O1MAJORTICK, O1TICKLABEL, O1TITLE, PARETO, PARETOLINE, PARETOMARKER, PIE, PIE_BAR, PIE_MULTI, PIE_MULTI_PROP, PIEFEELER, PIEFRAME, PIELABEL, PLOTAREA, POLAR, POLAR_2Y, QUADRANTLINE, QUARTER, QUARTER_LONG, QUARTER_SHORT, QUARTER_SINGLE_LETTER, RADAR_AREA, RADAR_LINE, RADAR_LINE_2Y, RB_DIM, RB_HIGHLIGHT, RB_MAX, RB_NONE, REFERENCEOBJECT, REFERENCEOBJECTMARKER, REFERENCEOBJECTTEXT, RESET_PROPERTIES, RING, RING_BAR, RING_MULTI, RING_MULTI_PROP, RINGTOTALLABEL, ro_display_always, RO_DISPLAY_ALWAYS, ro_display_automatic, RO_DISPLAY_AUTOMATIC, ro_display_never, RO_DISPLAY_NEVER, SCATTER, SCATTER_2Y, SCATTER_LABELS, SCATTER_LABELS_2Y, SE_AUTO_GRADIENT, SE_GRADIENT, SE_NONE, SE_PATTERN, SERIES, SERIESOBJECTCOUNTLIMIT, show_all, SHOW_ALL, show_none, SHOW_NONE, SLICE, SLICELABEL, smt_all, SMT_ALL, SMT_AREAS, smt_areas_bars, SMT_AREAS_BARS, smt_bars, SMT_BARS, SMT_LINES, SP_ALWAYS, SP_ALWAYS_BP_NEVER, SP_AS_NEEDED, SP_HIDDEN, SP_NEVER, SP_RESERVED, SPECTRAL, SPLITDIVIDER, STOCK_2Y, STOCK_CANDLE, STOCK_CANDLE_VOLUME, STOCK_HILO, STOCK_HILO_2Y, STOCK_HILO_CLOSE, STOCK_HILO_CLOSE_SPLIT2Y, STOCK_HILO_CLOSE_VOLUME, STOCK_HILO_CLOSE2Y, STOCK_HILO_SPLIT2Y, STOCK_HILO_VOLUME, STOCK_OHLC_CANDLE, STOCK_OHLC_CANDLE_VOLUME, STOCK_OPEN_HILO_CLOSE, STOCK_SPLIT_2Y, STOCK_VOLUME, STOCKMARKER, STYLE_PROPERTIES_MODE, SVG_MODE_BASIC, SVG_MODE_DATA_SCROLLING, SVG_MODE_DATA_ZOOMING, SVG_MODE_DRILLING, SVG_MODE_FONT_EMBEDDING, SVG_MODE_FULL, SVG_MODE_METADATA, SVG_MODE_NO_HEADER, SVG_MODE_SHAPE_ATTRIBUTES, SVG_MODE_TIME_AXIS_EVENT, SVG_MODE_TOOLTIPS, TAT_DEFAULT, TAT_DEFAULT_STRICT, TAT_IRREGULAR, TAT_IRREGULAR_STRICT, TAT_MIXED_FREQUENCY, TAT_MIXED_FREQUENCY_STRICT, TAT_OFF, TEMP_PROPERTIES_MODE, TEXT_COMPONENTS_ALL, TEXT_COMPONENTS_NONE, THREED_AREA_GROUP, THREED_AREA_SERIES, THREED_BAR, THREED_CUBE, THREED_DIAMOND, THREED_END, THREED_OCTAGON, THREED_PYRAMID, THREED_RIBBON_GROUP, THREED_RIBBON_SERIES, THREED_START, THREED_SURFACE, THREED_SURFACE_HONEYCOMB, THREED_SURFACE_SIDES, THREEDFLOOR, THREEDLEFTWALL, THREEDMARKER, THREEDRIGHTWALL, THRESHOLDOBJECTCOUNTLIMIT, TIME, TIMESELECTOR, TLT_DIM_MEMBER, TLT_MEMBER, TLT_NONE, TOKEN_ACTUAL_VALUE, TOKEN_CLOSE_VALUE, TOKEN_CUMULATIVE_PERCENTAGE_VALUE, TOKEN_CUMULATIVE_STACKED_VALUE, TOKEN_GROUP_LABEL, TOKEN_HIGH_VALUE, TOKEN_LOW_VALUE, TOKEN_NEW_LINE, TOKEN_OPEN_VALUE, TOKEN_PIE_PERCENTAGE_VALUE, TOKEN_PIE_SLICE_VALUE, TOKEN_SERIES_LABEL, TOKEN_TARGET_VALUE, TOKEN_VOLUME_VALUE, TOKEN_X_VALUE, TOKEN_Y_VALUE, TOKEN_Z_VALUE, TOOLTIP, TRM_EXPLICIT, TRM_OFF, TRM_RELATIVE_FIRST, TRM_RELATIVE_LAST, TWODMARKER, UNDEFINED, UNDEFINEDTYPE, USER_PROPERTIES_MODE, VOLUMEMARKER, X1AXIS, X1MAJORTICK, X1MINORTICK, X1REFERENCELINE, X1TICKLABEL, X1TITLE, XPANELGRID, XTICKLBL, XVALUE, Y1AXIS, Y1MAJORTICK, Y1MINORTICK, Y1REFERENCELINE, Y1TICKLABEL, Y1TICKLBL, Y1TITLE, Y1VALUE, Y1ZEROLINE, Y2AXIS, Y2MAJORTICK, Y2MINORTICK, Y2REFERENCELINE, Y2TICKLABEL, Y2TICKLBL, Y2TITLE, Y2VALUE, Y2ZEROLINE, Y3DMARKERGRID, YEAR, YEAR_LONG, YEAR_LONG_WITH_COMMA, YEAR_LONG_WITH_GROUPING_SEPARATOR, YEAR_SHORT, YEAR_SHORT_WITH_APOSTROPHE, YPANELGRID, ZD_BOTH_AXES, ZD_XAXIS_ONLY, ZD_YAXIS_ONLY, ZDRILLLABEL, ZPANELGRID, ZS_DELAYED_SCROLL, ZS_LIVE_RESIZE_EVENT, ZS_LIVE_SCROLL, ZS_LIVE_SCROLL_EVENT, ZTICKLABEL, ZTITLE, ZVALUE

Fields inherited from interface oracle.dss.dataView.DataviewConstants

AD_ALPHA_FADE, AD_AUTO, AD_CONVEYOR_FROM_LEFT, AD_CONVEYOR_FROM_RIGHT, AD_CUBE_TO_LEFT, AD_CUBE_TO_RIGHT, AD_FLIP_LEFT, AD_FLIP_RIGHT, AD_MAX, AD_MIN, AD_NONE, AD_SLIDE_TO_LEFT, AD_SLIDE_TO_RIGHT, AD_TRANSITION_TO_LEFT, AD_TRANSITION_TO_RIGHT, AD_ZOOM, ADC_ALPHA_FADE, ADC_AUTO, ADC_CONVEYOR_FROM_LEFT, ADC_CONVEYOR_FROM_RIGHT, ADC_CUBE_TO_LEFT, ADC_CUBE_TO_RIGHT, ADC_FLIP_LEFT, ADC_FLIP_RIGHT, ADC_MAX, ADC_MIN, ADC_NONE, ADC_ON, ADC_SLIDE_TO_LEFT, ADC_SLIDE_TO_RIGHT, ADC_TRANSITION_TO_LEFT, ADC_TRANSITION_TO_RIGHT, ADC_ZOOM, AI_ALL, AI_MAX, AI_MIN, AI_NONE, ANIMATION_DOWN_COLOR, ANIMATION_DURATION, ANIMATION_INDICATORS, ANIMATION_ON_DATA_CHANGE, ANIMATION_ON_DISPLAY, ANIMATION_UP_COLOR, DATAVIEW_END, DATAVIEW_FOOTNOTE, DATAVIEW_FOOTNOTE_NAME, DATAVIEW_SUBTITLE, DATAVIEW_SUBTITLE_NAME, DATAVIEW_TITLE, DATAVIEW_TITLE_NAME, DEFAULT_ZOOM_FACTOR, FOOTNOTE, FOOTNOTE_NAME, FORMAT_MANAGER_NAME, FT_COLOR, FT_GRADIENT, FT_PATTERN, FT_TEXTURE, GD_CUSTOM_LINEAR, GD_CUSTOM_RADIAL, GD_DIAGONAL_135, GD_DIAGONAL_45, GD_DOWN, GD_RADIAL, GD_RADIAL_BOTTOM_LEFT, GD_RADIAL_BOTTOM_RIGHT, GD_RADIAL_OFF_CENTER, GD_RADIAL_TOP_LEFT, GD_RADIAL_TOP_RIGHT, GD_RIGHT, LAP_BOTTOM, LAP_LEFT, LAP_RIGHT, LAP_TOP, MAP_ALL, MAP_DATA, MAP_DATATEXT, MAP_LABELS, MAP_LEGEND, MAP_ORDINALLABELS, MAP_TITLES, PAGE_CONTROL, page_header, PAGE_HEADER, PAGE_HEADER_NAME, PAGE_ITEM, PAGE_ITEM_NAME, PAGING_COMPONENT_NAME, PAGING_CONTROL_ABOVE_TITLES, PAGING_CONTROL_BELOW_TITLES, PAGING_CONTROL_EAST_OF_VIEW, PAGING_CONTROL_SOUTH_OF_VIEW, PAGING_CONTROL_WEST_OF_VIEW, RESET_EVERYTHING, RESET_EVERYTHING_CUSTOM, RESET_EVERYTHING_NOT_DATASOURCE, RESET_EVERYTHING_ORIGINAL, RESET_MAX, RESET_MIN, RESET_NONE, RESET_XML_PROPERTIES, RESET_XML_PROPERTIES_CUSTOM, RESET_XML_PROPERTIES_ORIGINAL, STYLE_MANAGER_NAME, SUBTITLE, SUBTITLE_NAME, TITLE, TITLE_NAME, TOOLTIP_NAME, VE_AUTO, VE_BEVEL, VE_GLOW, VE_MAX, VE_MIN, VE_NONE, VE_SFX_MAX, VE_SFX_MIN, VE_SHADOW, VIEW_FORMAT_NAME, VIEW_STYLE_NAME, VIEW_TYPE_CROSSTAB, VIEW_TYPE_GAUGE, VIEW_TYPE_GRAPH, VIEW_TYPE_PAGINGCONTROL, VIEW_TYPE_TABLE, VISUAL_EFFECTS

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	applyFontSizes(float ratio)
void	applySampleData()
protected void	applyStyle(CustomStyle style, int reset, boolean isStyleDefault)
void	applyViewFormat(ComponentHandle componentHandle, ViewFormat viewFormat)
void	applyViewStyle(ComponentHandle componentHandle, ViewStyle viewStyle) Applies a ViewStyle to a page item.
void	beginAxisChanges() Deprecated. As of 4.0, no replacement as there is no need to call this method anymore
void	calculatePlacement() Forces the graph to perform a complete calculation of its elements.
void	cleanUp() Clears the memory of the view.
static int	convertGraphTypeToInt(java.lang.String string)
static java.lang.String	convertGraphTypeToString(int value) Generates a String representation of a graph type constant.
Alert	createAlert(java.lang.Object xValue, java.lang.Object yValue) Creates and returns a new Alert.
Annotation	createAnnotation(int series, int group) Creates and returns a new Annotation.
ExceptionalRiser	createExceptionalRiser(int series, int group) Creates an ExceptionalRiser.
CustomStyle	createGraphStyle()
protected void	createPagingControl()
ReferenceObject	createReferenceObject() Creates and returns a new ReferenceObject.
CustomStyle	createStyle()
void	destroyAllExceptionalRisers() Destroys all ExceptionalRiser components in this graph.
void	destroyReferenceObject(int id) Destroys the ReferenceObject given its ID.
void	destroyReferenceObjects(int component) Destroys the ReferenceObjects of the specified graph.
void	doAutoLayout(int level) Automatically places and sizes graph components once.
void	drawImage(java.awt.Image image, int x, int y, java.awt.Graphics g)
void	editStyle(CustomStyle style)
void	endAxisChanges() Deprecated. As of 4.0, no replacement as there is no need to call this method anymore
void	endExport()
boolean	exportGraphToStream(java.io.OutputStream out)
void	exportToFlash(java.io.OutputStream os, boolean renderDynamic, boolean showDrawing) Delegates the work to CommonGraph by passing the outputstream associated with the flash file to be written and a flag indicating if it will be a static or a dynamic rendering
void	exportToGIF(java.io.OutputStream os) Adds the specified focus listener to the graph.
void	exportToGIFWithException(java.io.OutputStream os) Exports a snapshot of the page that is currently displayed to the GIF 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.
void	exportToSVG(java.io.OutputStream os, int mode, java.lang.String charEnc) Exports a snapshot of the page that is currently displayed to the SVG file.
void	exportToSVG(java.io.Writer writer, int mode, java.lang.String charEnc) Exports a snapshot of the page that is currently displayed to the SVG file.
void	exportToSVGWithException(java.io.OutputStream os, int mode, java.lang.String charEnc) Exports a snapshot of the page that is currently displayed to the SVG file.
void	exportToSVGWithException(java.io.Writer writer, int mode, java.lang.String charEnc) Exports a snapshot of the page that is currently displayed to the SVG file.
protected void	firePrintBegin(java.lang.Object source)
protected void	firePrintEnd(java.lang.Object source)
protected void	firePropertyChange(java.lang.Object obj, java.lang.String propName, java.lang.Object oldValue, java.lang.Object newValue)
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.
Alert	getAlert(int index) Return alert with the specified index.
java.lang.String	getAlternativeText(ComponentHandle handle)
int	getAnnotationsVisibility() returns current visibility for Annotations
AreaMarker	getAreaMarker() Retrieves the AreaMarker component for this graph.
int	getAutoLayout() Retrieves information about when the graph automatically places and sizes its components.
int	getBarShape() Get the shape of bars in a bar graph.
CustomStyle	getBaseStyle()
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.
CommonGraph	getCommonGraph()
ViewFormat	getComponentViewFormat(ComponentHandle componentHandle)
ViewStyle	getComponentViewStyle(ComponentHandle componentHandle) Retrieves the ViewStyle for a selected component.
Connector	getConnector() Retrieves the Connector component for this graph.
int	getContinuousTimeAxisInterval() Retrieves the interval along the continuous time axis.
int	getCustomLayout() Retrieves custom layout information about when the graph automatically places and sizes its components.
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() Deprecated. As of 4.0.0.11, no replacement
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.
int	getDataModelType()
DataviewCommon	getDataviewCommon()
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.
int[]	getDrillParameters(ComponentHandle handle)
protected boolean	getDrillState(int edge, int slice)
java.util.Date	getExplicitTimeRangeEnd() Retrieves the explicit time range end date.
java.util.Date	getExplicitTimeRangeStart() Retrieves the explicit time range start date.
Fitline	getFitline() Retrieves the Fitline component for this graph.
oracle.dss.presutil.FontMetricsResolver	getFontMetricsResolver()
Titles	getFootnote() Retrieves the GraphFootnote component for this graph.
FunnelFrame	getFunnelFrame() Retrieves the FunnelFrame component for this graph.
double	getFunnelHeightRatio()
double	getFunnelRotateAngle()
double	getFunnelViewAngle()
GraphBackground	getGraphBackground() Retrieves the GraphBackground component for this graph.
ComponentHandle	getGraphComponentHandle(oracle.dss.graph.pfj.TDGMouseState mouseState)
ComponentHandle	getGraphComponentHandle(oracle.dss.graph.pfj.TDGMouseState mouseState, boolean useDeadZone)
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.
java.lang.String	getIntlString(java.lang.String key)
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.
LegendTitle	getLegendTitle() Retrieves the LegendTitle component for this graph.
int	getMarkerShapeInLegend() Indicates whether legend markers are shaped like their corresponding data markers or 2-D markers.
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.
ViewStyle	getMetadataStyle(java.lang.Object metaData, ViewStyle initStyle, int edge, int depth, int index)
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.
int	getMouseActions()
java.lang.String	getNoDataErrorText() Get the error text to display when graph has no data.
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.
protected oracle.dss.util.xml.ObjectNode	getObjectNode(boolean allProperties)
ViewStyle	getPagingControlViewStyle()
oracle.dss.util.xml.ObjectNode	getPagingControlXML(boolean allProperties)
UIParetoLine	getParetoLine() Retrieves the implementation of the UIParetoLine interface for this graph.
ParetoMarker	getParetoMarker() Retrieves the ParetoMarker component for this graph.
oracle.dss.util.persistence.PersistableAttributes	getPersistableAttributes(oracle.dss.util.persistence.PersistableAttributes oldAttrs) Retrieves the attributes of this Dataview, for searching.
PFJ	getPFJ()
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.
ReferenceObject	getReferenceObject(int id) Return ReferenceObject with the specified ID.
int	getReferenceObjectDisplay(int component) Indicates when the reference objects for a given component should be displayed.
ReferenceObjectMarker	getReferenceObjectMarker() Retrieves the ReferenceObjectMarker component for this graph.
java.util.List	getReferenceObjects(int component) Returns a list of reference objects that belong to a specific graph.
ReferenceObjectText	getReferenceObjectText() Retrieves the ReferenceObjectText component for this graph.
long	getRelativeTimeRange() Retrieves the relative time range in milliseconds.
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 or PNG 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	getSeriesEffect() Retrieves the current effect on the series.
int	getSeriesObjectCount() Retrieves the number of series that this graph stores properties for.
int	getSeriesRolloverBehavior() Get the rollover behavior for series in the graph.
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.
CustomStyle	getStyle()
java.lang.String	getStylePath() Retrieves the path name for the current style.
java.lang.String	getStyleXML()
Titles	getSubtitle() Retrieves the GraphSubtitle component for this graph.
oracle.dss.graph.pfj.ThickPFJ	getThickPFJ()
Threshold	getThreshold() Retrieves the Threshold component for this graph.
int	getThresholdObjectCount() Retrieves the number of thresholds that this graph stores properties for.
TickLabelCallback	getTickLabelCallback(int axisID) Retrieves the TickLabelCallback that has been set for customizing tick labels.
java.lang.String	getTimeAxisDateFormat(int element) Retrieves the format for a date element on the time axis.
int	getTimeAxisType() Retrieves the type of time axis to plot.
int	getTimeRangeMode() Retrieves the time range mode.
TimeSelector	getTimeSelector() Retrieves the TimeSelector 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.
UISeriesColor	getUISeriesColor() Retrieves an object that provides access to the color for a series.
UIThresholdColor	getUIThresholdColor() Retrieves an object that provides access to the color for a threshold.
UndefinedComponent	getUndefinedComponent()
java.lang.String	getVersion()
int	getViewType() Retrieves the specific type of subclass of this Dataview.
protected DataviewXML	getViewXML()
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.
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.
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.
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.
int	getZoomDirection()
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	is3DEffect()
boolean	isAlignTickMarks() Retrieves whether Y1Axis and Y2Axis tick marks are aligned.
boolean	isDataRowShownAsASeries() Deprecated. There is no replacement method for this. Application developers are responsible to create the relevant data set.
boolean	isDrillingSupported()
boolean	isDualY() Indicates whether the graph type is a dual-Y graph type.
boolean	isExcelOrDeskTop()
boolean	isExporting()
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	isGroup3DPanels()
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() Deprecated. As of 11.1.1.0.10, replaced by getMarkerShapeInLegend().
protected boolean	isMetadataDateSpanSupported()
protected boolean	isMetadataDrillParentDateSpanSupported()
protected boolean	isMetadataDrillParentDateSupported()
protected boolean	isMetadataDrillSupported()
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.
protected boolean	isPie(int graphType)
boolean	isPrintOrPreviewMode()
boolean	isScatterDataLineDisplayed() Indicates whether data lines appear on a scatter graph.
protected boolean	isStyleOverrideFlag(int attrID)
boolean	isSwapAllowed() Indicates whether swapping is allowed in this view.
boolean	isTextAntialiasing() Indicates whether text appears in a graph as smooth or more jagged.
void	loadCompleted()
protected void	metadataLabelTypeChanged()
void	modelDataAvailable(DataAvailableEvent e) Inform view of changes to the data availability.
void	modelDataChanged(DataChangedEvent e) Inform view of changes to the actual data or metadata.
void	modelWaitDataAvailable(WaitDataAvailableEvent e) Inform view that a lazy data fetch has been completed.
void	notEnoughData(NotEnoughData neData)
void	paint(java.awt.Graphics g)
protected void	processAlertEvent(int eventID)
boolean	readXML(java.io.InputStream stream, int reset) Applies XML to this Graph, from a String.
protected void	refreshData()
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	resetEverything(int reset)
protected void	resetFontSizes()
void	resetSuper(int reset, java.lang.String version)
void	resetToDefault(int reset) Resets properties of this Graph to their default values.
void	resetXMLProps()
protected void	saveDrillState()
boolean	selectObject(ComponentHandle id) Selects a graph component.
void	set3DEffect(boolean yesNo)
void	setAlignTickMarks(boolean align) Specifies whether the tick marks on Y1Axis and Y2Axis should align in case of Dual-Y Graphs.
void	setAnnotationsVisibility(int visibility) Specify visibility for Annotations
void	setAutoLayout(int auto) Specifies when the graph automatically places and sizes its components.
void	setBackgroundTransparent(boolean transparent)
void	setBarShape(int shape) Set the shape of bars in a bar graph.
void	setBaseStyle(CustomStyle baseStyle)
void	setColorMode(int mode) Specifies whether markers of the same color comprise a group of data or a series of data.
void	setContext()
void	setContinuousTimeAxisInterval(int interval) Specifies the interval along the continuous time axis.
void	setCustomLayout(int type)
void	setCustomToolTipCallback(CustomToolTipCallback callback) Specifies the CustomToolTipCallback that will provide tooltip text to this Graph.
void	setDataDirector(DataDirector dd)
void	setDataDirectorType(int type) Deprecated. As of 4.0.0.11, no replacement
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	setDataModelType(int dataModelType)
void	setDataRowShownAsASeries(boolean yesNo) Deprecated. There is no replacement method for this. Application developers are responsible to create the relevant data set.
void	setDataSource(DataSource ds) Specifies the data source for this graph.
protected void	setDataUnformattedSupported(boolean supported)
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	setDirty(boolean yesNo)
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	setDrillingEnabled(boolean b) Specifies whether drilling is allowed in this view.
void	setEnabled(boolean yesNo) Specifies whether this Dataview is enabled.
void	setExplicitTimeRangeEnd(java.util.Date date) Specifies the explicit time range end date for a time axis.
void	setExplicitTimeRangeStart(java.util.Date date) Specifies the explicit time range start date for a time axis.
void	setFontMetricsResolver(oracle.dss.presutil.FontMetricsResolver resolver)
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	setFunnelHeightRatio(double heightRatio)
void	setFunnelRotateAngle(double rotateAngle)
void	setFunnelViewAngle(double viewAngle)
void	setGraphController(GraphController graphController)
void	setGraphFormatManager(GraphFormatManager m)
void	setGraphicAntialiasing(boolean yesNo) Specifies whether lines in a graph appear more smooth or more jagged.
void	setGraphModel(GraphModel graphModel)
void	setGraphStyleManager(GraphStyleManager m)
void	setGraphType(int type) Specifies the graph type for this graph.
void	setGraphTypeConverter(GraphTypeConverter converter) Specifies the GraphTypeConverter for the graph type to use.
boolean	setGridData(java.lang.Object[] columnLabels, java.lang.Object[] rowLabels, java.lang.Object[][] data)
void	setGroup3DPanels(boolean yesNo)
void	setGroupTooltipLabelType(int type) Specifies the type of information about groups that this graph displays in tooltips.
void	setImageSize(java.awt.Dimension d) Specifies the size of the image that is created from this graph when you export the graph to a PNG or GIF file.
protected void	setLayerMetaLongLabelSupported(boolean supported)
protected void	setLayerMetaMediumLabelSupported(boolean supported)
protected void	setLayerMetaNameSupported(boolean supported)
protected void	setLayerMetaShortLabelSupported(boolean supported)
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) Deprecated. As of 11.1.1.0.10, replaced by setMarkerShapeInLegend(int).
void	setMarkerShapeInLegend(int markerShapeInLegend) 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.
protected void	setMetadataDateSpanSupported(boolean supported)
protected void	setMetadataDateSupported(boolean supported)
protected void	setMetadataDrillParentDateSpanSupported(boolean supported)
protected void	setMetadataDrillParentDateSupported(boolean supported)
protected void	setMetadataDrillSupported(boolean supported)
protected void	setMetadataLongLabelSupported(boolean supported)
protected void	setMetadataMediumLabelSupported(boolean supported)
protected void	setMetadataShortLabelSupported(boolean supported)
protected void	setMetadataValueSupported(boolean supported)
void	setMinTickLabelAutoFontSize(int size) Specifies the minimum font size for tick labels that are automatically sized to fit in this graph.
void	setMouseActions(int actions)
void	setMouseMovingEnabled(boolean yesNo) Specifies whether a selected component can be moved and resized with the mouse.
void	setNoDataErrorText(java.lang.String text) Set the error text to display when graph has no data.
void	setPagingControlXML(oracle.dss.util.xml.ObjectNode pagingControl, java.lang.String version, int reset)
void	setParetoBarsConnected(boolean connected) Specifies whether the pareto bars are connected to each other.
void	setPersistableComponents(oracle.dss.util.persistence.AggregateInfo[] persistables)
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	setPrintOrPreviewMode(boolean bool)
void	setReferenceObjectDisplay(int component, int display) Specifies when to display the reference objects for a given graph component.
void	setRelativeTimeRange(long time) Specifies the relative time range in milliseconds for time axis.
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 a GIF or PNG 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	setSeriesEffect(int effect) Sets the specified series effect on the graph.
void	setSeriesObjectCount(int count) Specifies the number of series that this graph stores properties for.
void	setSeriesRolloverBehavior(int behavior) Set the rollover behavior for series in the graph.
void	setSeriesTooltipLabelType(int type) Specifies the type of information about series that this graph displays in tooltips.
void	setStandardShape(boolean standardShape) Setter method for standard shape and width
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	setStyle(CustomStyle style)
void	setStylePath(java.lang.String stylePath) Applies a style to this graph based on the specified XML file.
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	setThresholdObjectCount(int count) Specifies the number of thresholds that this graph stores properties for.
void	setTickLabelCallback(TickLabelCallback callback, int axisID) Specifies a TickLabelCallback to use for customizing tick labels.
void	setTimeAxisDateFormat(int element, java.lang.String format) Specifies the format for a date element on the time axis.
void	setTimeAxisType(int timeAxis) Specifies the type of time axis to plot.
void	setTimeRangeMode(int mode) Specifies the time range mode on a time axis.
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.
protected void	setXML(oracle.dss.util.xml.ObjectNode node, int reset)
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	setZoomDirection(int axes)
boolean	startExport()
void	updatePageItems()
protected void	updateResourceBundle()
void	updateStyle(CustomStyle style)
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, addSubcomponent, addVetoableChangeListener, addViewFocusListener, addViewKeyListener, addViewListener, addViewMouseListener, addViewMouseMotionListener, clearPropertyOverrideFlag, clearStyleModified, clearWaitDataForAllRows, convertComponentTypeToInteger, convertComponentTypeToString, copyAdornment, createFootnote, createPropertyOverrideFlags, createTitles, dataFormatChanged, dataStyleChanged, getComponentFromID, getController, getDataDirector, getDataSource, getDataviewFootnote, getDataviewSubtitle, getDataviewTitle, getDescription, getErrorHandler, getFontList, getHTMLPagingControlWidth, getIntlString, getLayerMetadataLabelType, getLayerMetadataLabelType, getLocale, getLocalName, getMemberMetadataLabelType, getMemberMetadataLabelType, getModel, getName, getNameFromID, getObjectNode, getPagingControl, getPagingControlPosition, getPersistableComponents, getPhysicalComponents, getPopupManager, getRolloverTextManager, getStyleXML, getSubcomponent, getSubcomponent, getTokenSubstitution, getWaitData, getWaitDataForRow, getXML, getXMLAsString, getZoomFactor, initialize, isCustomColorsEnabled, isDataUnavailable, isDataUnformattedSupported, isDataViewFormatSupported, isDrillingEnabled, isHTMLPagingControlAutosubmit, isJavaComponent, isLayerMetadataLabelTypeSupported, isLayerMetaLongLabelSupported, isLayerMetaMediumLabelSupported, isLayerMetaNameSupported, isLayerMetaShortLabelSupported, isLayerMetaViewStyleSupported, isLoadingDataSourceFromPersistence, isMemberMetadataLabelTypeSupported, isMetadataLongLabelSupported, isMetadataMediumLabelSupported, isMetadataShortLabelSupported, isMetadataValueSupported, isMetadataViewStyleSupported, isPagingControlVisible, isPropertyOverrideFlag, isStyleModified, isStyleOverrideMode, isUserOverrideMode, isXMLValidated, metadataStyleChanged, positionPagingControl, removeControllerListener, removeDataListener, removeErrorHandler, removeListeners, removePropertyChangeListener, removeVetoableChangeListener, removeViewFocusListener, removeViewKeyListener, removeViewListener, removeViewMouseListener, removeViewMouseMotionListener, resetToDefault, scaleFont, setCommonDataview, setController, setCustomColorsEnabled, setDescription, setHTMLPagingControlAutosubmit, setHTMLPagingControlWidth, setLayerMetadataLabelType, setLayerMetadataLabelType, setLayerMetaViewStyleSupported, setLoadingDataSourceFromPersistence, setLocalName, setMemberMetadataLabelType, setMemberMetadataLabelType, setMetadataViewStyleSupported, setModel, setName, setPagingControlPosition, setPagingControlVisible, setPersistableAttributes, setPopupManager, setPropertyOverrideFlags, setRolloverTextManager, setStyleOverrideMode, setStyleXML, setTokenSubstitution, setUserOverrideMode, setWaitDataForRow, setXML, setXMLValidated, updatePagingControlStyles, writeXML

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeMouseWheelListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocation, setLocation, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.dss.dataView.ExportableGraph

getPagingControlPosition, isPagingControlVisible

Methods inherited from interface oracle.dss.dataView.ThickDataview

getDataviewFootnote, getDataviewSubtitle, getDataviewTitle, isEnabled, isShowing, repaint

Methods inherited from interface oracle.dss.dataView.DataviewAttributes

getHTMLPagingControlWidth, getLayerMetadataLabelType, getMemberMetadataLabelType, getPagingControlPosition, isDrillingEnabled, isHTMLPagingControlAutosubmit, isPagingControlVisible, setHTMLPagingControlAutosubmit, setHTMLPagingControlWidth, setLayerMetadataLabelType, setMemberMetadataLabelType, setPagingControlPosition

Methods inherited from interface oracle.dss.presutil.CommonViewAttributes

getDescription, getLocalName, getName, setDescription, setLocalName, setName

Methods inherited from interface oracle.dss.dataView.UIDataview

getDataviewFootnote, getDataviewSubtitle, getDataviewTitle, getTokenSubstitution, setTokenSubstitution

Methods inherited from interface oracle.dss.util.PagingControlAttributes

isPagingControlVisible, setPagingControlVisible

Methods inherited from interface oracle.dss.dataView.UIView

addControllerListener, getLocale, getModel, isCustomColorsEnabled, removeControllerListener, setCustomColorsEnabled

Methods inherited from interface oracle.dss.dataView.DataviewCommon

repaint

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), Constant Field Values

GRAPH_XML_VERSION_NUMBER

public static final java.lang.String GRAPH_XML_VERSION_NUMBER

See Also:

Constant Field Values

For internal use only. Application developers should not use this

m_pfj

protected PFJ m_pfj

For internal use only. Application developers should not use this

m_graphModel

protected GraphModel m_graphModel

For internal use only. Application developers should not use this

m_graphController

protected GraphController m_graphController

For internal use only. Application developers should not use this

m_sampleDataSource

protected SampleDataSource m_sampleDataSource

For internal use only. Application developers should not use this

m_converter

protected GraphTypeConverter m_converter

For internal use only. Application developers should not use this

m_offscreenImage

protected java.awt.Image m_offscreenImage

For internal use only. Application developers should not use this

m_printOrPreviewMode

protected boolean m_printOrPreviewMode

For internal use only. Application developers should not use this

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:

GraphConstants.DDT_CUBE, GraphConstants.DDT_RELATIONAL

Graph

public Graph(ErrorHandler errorHandler)

Constructor that specifies a ErrorHandler.

Parameters:

errorHandler - The ErrorHandler to use.

Method Detail

createPagingControl

protected void createPagingControl()

For internal use only. Application developers should not use this

Overriden in ThinGraph

firePropertyChange

protected void firePropertyChange(java.lang.Object obj,
                                  java.lang.String propName,
                                  java.lang.Object oldValue,
                                  java.lang.Object newValue)

Specified by:

firePropertyChange in class Dataview

Parameters:

obj - the Object which has the getter/setter for this property

propName - String: the name of the property (minus get/set)

oldValue - Object: the previous value of the property

newValue - Object: the new value of the property

For internal use only. Application developers should not use this

Handle a property change for the entire bean.

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:

DataviewConstants.RESET_XML_PROPERTIES, DataviewConstants.RESET_EVERYTHING, oracle.dss.dataView.Dataview#RESET_EVERYTHING_BUT_DATASOURCE

resetEverything

public void resetEverything(int reset)

Specified by:

resetEverything in interface ThickDataview

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.

For internal use only. Application developers should not use this

Reset the properties of the Graph to their default values for the specified Graph XML version. If the version is invalid, then default values for the latest Graph XML version are used.

resetSuper

public void resetSuper(int reset,
                       java.lang.String version)

Specified by:

resetSuper in interface ThickDataview

Parameters:

version - the Graph XML version number, as stored in XML

For internal use only. Application developers should not use this

Reset the properties of the Graph to their default values for the specified Graph XML version. If the version is invalid, then default values for the latest Graph XML version are used.

resetXMLProps

public void resetXMLProps()

Specified by:

resetXMLProps in interface ThickDataview

Parameters:

version - the Graph XML version number, as stored in XML

For internal use only. Application developers should not use this

Reset the properties of the Graph to their default values for the specified Graph XML version. If the version is invalid, then default values for the latest Graph XML version are used.

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.

getVersion

public java.lang.String getVersion()

Specified by:

getVersion in interface ThickDataview

Specified by:

getVersion in class Dataview

Returns:

String The XML version that this view is using

For internal use only. Application developers should not use this

gets the values of the current XML version.

cleanUp

public void cleanUp()

Clears the memory of the view. Call this method when you no longer need this view.

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, ViewController.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, ViewController.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, ViewController.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.

exportToGIF

public void exportToGIF(java.io.OutputStream os)

Adds the specified focus listener to the graph.

Parameters:

l - The focus listener that you want to add.

l - The focus listener that you want to rremove.

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

See Also:

exportToPNG(java.io.OutputStream)

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.

The GIF file is limited to 256 colors. Exporting to PNG produces a higher-quality image.

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.

java.io.IOException

java.lang.Exception

See Also:

exportToPNGWithException(java.io.OutputStream)

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. Depending on the value of the ScaleFontSizeForGIF property, this method may scale font sizes in the exported file.

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. Depending on the value of the ScaleFontSizeForGIF property, this method may scale font sizes in the exported file.

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.

java.io.IOException

java.lang.Exception

See Also:

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

exportToSVG

public void exportToSVG(java.io.OutputStream os,
                        int mode,
                        java.lang.String charEnc)

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

Before it exports to SVG, this method calls the DataAccess.forceFetch method to fetch all of the data on the current logical page. Depending on the value of the ScaleFontSizeForGIF property, this method may scale font sizes in the exported file.

Parameters:

os - The OutputStream to write SVG to.

mode - specifies what to include in SVG; constants are defined in this class and begin with SVG_MODE_

charEnc - character encoding to use for SVG

See Also:

setScaleFontSizeForGIF(int)

exportToFlash

public void exportToFlash(java.io.OutputStream os,
                          boolean renderDynamic,
                          boolean showDrawing)

Delegates the work to CommonGraph by passing the outputstream associated with the flash file to be written and a flag indicating if it will be a static or a dynamic rendering

Parameters:

os - the outputstream associated with the flash file

renderDynamic - Flag indicating if the rendering is dynamic or static. For static charts, the value is false.

showDrawing - Only applicable for static charts and indicates if the drawing of the chart should be shown.

exportToSVGWithException

public void exportToSVGWithException(java.io.OutputStream os,
                                     int mode,
                                     java.lang.String charEnc)
                              throws java.io.IOException,
                                     java.lang.Exception

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

Before it exports to SVG, this method calls the DataAccess.forceFetch method to fetch all of the data on the current logical page. Depending on the value of the ScaleFontSizeForGIF property, this method may scale font sizes in the exported file.

Parameters:

os - The OutputStream to write SVG to.

mode - specifies what to include in SVG; constants are defined in this class and begin with SVG_MODE_

charEnc - character encoding to use for SVG

Throws:

java.io.IOException - if there was a problem writing to the stream

java.lang.Exception - if another problem occurred

See Also:

setScaleFontSizeForGIF(int)

exportToSVG

public void exportToSVG(java.io.Writer writer,
                        int mode,
                        java.lang.String charEnc)

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

Before it exports to SVG, this method calls the DataAccess.forceFetch method to fetch all of the data on the current logical page. Depending on the value of the ScaleFontSizeForGIF property, this method may scale font sizes in the exported file.

Parameters:

writer - The Writer to write SVG to.

mode - specifies what to include in SVG; constants are defined in this class and begin with SVG_MODE_

charEnc - character encoding to use for SVG

See Also:

setScaleFontSizeForGIF(int)

exportToSVGWithException

public void exportToSVGWithException(java.io.Writer writer,
                                     int mode,
                                     java.lang.String charEnc)
                              throws java.io.IOException,
                                     java.lang.Exception

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

Before it exports to SVG, this method calls the DataAccess.forceFetch method to fetch all of the data on the current logical page. Depending on the value of the ScaleFontSizeForGIF property, this method may scale font sizes in the exported file.

Parameters:

writer - The Writer to write SVG to.

mode - specifies what to include in SVG; constants are defined in this class and begin with SVG_MODE_

charEnc - character encoding to use for SVG

Throws:

java.io.IOException - if there was a problem writing to the writer

java.lang.Exception - if another problem occurred

See Also:

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.

getGraphComponentHandle

public ComponentHandle getGraphComponentHandle(oracle.dss.graph.pfj.TDGMouseState mouseState)

Parameters:

mouseState - Instance of class TDGMouseState contains the information about the graph component on which the mouse is currently present

Returns:

ComponentHandle subcomponent information in the graph

For internal use only. Application developers should not use this

This method creates an instance of ComponentHandle with identification information for the Graph Component, based on the information obtained from TDGMouseState. GraphControllerAdapter calls this method in the PerspectiveEvent method.

getGraphComponentHandle

public ComponentHandle getGraphComponentHandle(oracle.dss.graph.pfj.TDGMouseState mouseState,
                                               boolean useDeadZone)

Parameters:

mouseState - Instance of class TDGMouseState contains the information about the graph component on which the mouse is currently present

useDeadZone - Specifies whether dead zone information should be retrieved from the TDGMouseState instance

Returns:

ComponentHandle subcomponent information in the graph

For internal use only. Application developers should not use this

This method creates an instance of ComponentHandle with identification information for the Graph Component, based on the information obtained from TDGMouseState. GraphControllerAdapter calls this method in the PerspectiveEvent method.

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.

setGraphController

public void setGraphController(GraphController graphController)

Parameters:

graphController - The controller for this graph to use.

For internal use only. Application developers should not use this

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

Application developers normally do not need to call this method. Call it only if you are providing your own implementation of the GraphController interface, rather than using the default BI Beans GraphController.

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

setGraphFormatManager

public void setGraphFormatManager(GraphFormatManager m)

Parameters:

m - The FormatManager for the graph to use.

See Also:

ViewFormat

For internal use only. Application developers should not use this

Specifies the format manager for the graph to use. 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.

By default, the graph model creates an instance of the GraphRuleFormatter for the graph to use. Application developers do not need to call this method unless they want to replace the default graph manager.

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.

setGraphStyleManager

public void setGraphStyleManager(GraphStyleManager m)

Parameters:

m - The GraphStyleManager for the graph to use.

For internal use only. Application developers should not use this

Specifies the style manager for the graph to use. The style manager is responsible for the format of the PagingComponent.

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.

setGraphModel

public void setGraphModel(GraphModel graphModel)

Parameters:

graphModel - The GraphModel for this graph to use.

For internal use only. Application developers should not use this

Specifies the model for this graph. 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.

Application developers normally do not need to call this method. Call it only if you are providing your own implementation of the GraphModel interface, rather than using the default BI Beans GraphModel.

getPFJ

public PFJ getPFJ()

Returns:

the instance of PFJ

For internal use only. Application developers should not use this

Restricted for use by internal DSS JavaBeans and Walden code. Get the underlying PFJ instance for the graph.

getCommonGraph

public CommonGraph getCommonGraph()

Returns:

instance of CommonGraph

For internal use only. Application developers should not use this

Get the CommonGraph instance maintained by this Graph.

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 UIView

Specified by:

getSelectedObject in class Dataview

Returns:

The handle for the selected component.

modelDataChanged

public void modelDataChanged(DataChangedEvent e)

Description copied from interface: ModelListener

Inform view of changes to the actual data or metadata. This method is called by the ModelAdapter in response to data changes. Application developers do not need to call it.

Specified by:

modelDataChanged in interface ModelListener

Overrides:

modelDataChanged in class Dataview

Parameters:

e - information about the data change.

See Also:

ModelAdapter

For internal use only. Application developers should not use this

Inform view of changes to the actual data or metadata. Restricted to use by dataView code.

modelDataAvailable

public void modelDataAvailable(DataAvailableEvent e)

Description copied from interface: ModelListener

Inform view of changes to the data availability. This method is called by the ModelAdapter in response to data availability changes. Application developers do not need to call it.

Specified by:

modelDataAvailable in interface ModelListener

Overrides:

modelDataAvailable in class Dataview

Parameters:

e - information about the data availability

See Also:

ModelAdapter

For internal use only. Application developers should not use this

Inform view of changes to the data availability.

refreshData

protected void refreshData()

Specified by:

refreshData in class Dataview

For internal use only. Application developers should not use this

Refreshes the graph display.

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.

Specified by:

setDataSource in interface DataviewCommon

Specified by:

setDataSource in interface ThickDataview

Overrides:

setDataSource in class Dataview

Parameters:

ds - The DataSource for this graph to use.

setDataDirector

public void setDataDirector(DataDirector dd)

Overrides:

setDataDirector in class Dataview

Parameters:

dd - The data director for this view.

For internal use only. Application developers should not use this

Specifies the data director for this view. The data director is the part of the data source that manipulates data.

selectObject

public boolean selectObject(ComponentHandle id)

Selects a graph component.

Specified by:

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.

setEnabled

public void setEnabled(boolean yesNo)

Description copied from class: Dataview

Specifies whether this Dataview is enabled. When a Dataview is disabled, it is visible, but users cannot operate on the Dataview.

Specified by:

setEnabled in interface ThickDataview

Overrides:

setEnabled in class Dataview

Parameters:

yesNo - a boolean specifying whether to enable the component (true), or disable the component (false)

For internal use only. Application developers should not use this

enable or disable the Graph

setStandardShape

public void setStandardShape(boolean standardShape)

Setter method for standard shape and width

getGraphTypeConverter

public GraphTypeConverter getGraphTypeConverter()

Retrieves the GraphTypeConverter that this graph uses. The GraphTypeConverter translates the base graph types for a user interface (UI). 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.

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.

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

setCustomLayout

public void setCustomLayout(int type)

Parameters:

auto - A constant that represents custom layout attribute Valid constants are listed in the See Also section.

See Also:

GraphConstants.CL_TITLES_SIDEBYSIDE, GraphConstants.CL_TITLE_SEPARATOR, GraphConstants.CL_AUTO_GRADIENT

For internal use only. Application developers should not use this

Specifies custom layout information when the graph automatically places and sizes its components.

getCustomLayout

public int getCustomLayout()

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

Returns:

A constant that represents custom layout attribute. Constants are listed in the See Also section.

See Also:

GraphConstants.CL_TITLES_SIDEBYSIDE, GraphConstants.CL_TITLE_SEPARATOR, GraphConstants.CL_AUTO_GRADIENT

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:

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

getAutoLayout

public int getAutoLayout()

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

Returns:

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

See Also:

GraphConstants.AL_ALWAYS, GraphConstants.AL_AS_NEEDED, GraphConstants.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:

GraphConstants.HONOR_PROPERTIES, GraphConstants.RESET_PROPERTIES, setDisplaySeries(int), setLegendSeriesCount(int), setLegendSeriesStart(int), setLegendScrollbarPresence(int), setFrameSizeAutomatic(boolean), BaseFrame.setRect(java.awt.Rectangle), LegendMarker#setMaxSize, 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), O1TickLabel.setHorizontalAlignment(int), BaseGraphTitle.setRect(java.awt.Rectangle)

getBarShape

public int getBarShape()

Get the shape of bars in a bar graph. The default is BAR_SHAPE_RECTANGLE.

Returns:

the shape of bars in a bar graph

See Also:

GraphConstants.BAR_SHAPE_RECTANGLE, GraphConstants.BAR_SHAPE_CYLINDER, GraphConstants.BAR_SHAPE_TRIANGLE, GraphConstants.BAR_SHAPE_DIAMOND

setBarShape

public void setBarShape(int shape)

Set the shape of bars in a bar graph. The default is BAR_SHAPE_RECTANGLE.

Parameters:

shape - the shape of bars in a bar graph

See Also:

GraphConstants.BAR_SHAPE_RECTANGLE, GraphConstants.BAR_SHAPE_CYLINDER, GraphConstants.BAR_SHAPE_TRIANGLE, GraphConstants.BAR_SHAPE_DIAMOND

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:

GraphConstants.COLOR_BY_SERIES, GraphConstants.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:

GraphConstants.COLOR_BY_SERIES, GraphConstants.COLOR_BY_GROUP

getDataDirectorType

public int getDataDirectorType()

Deprecated. As of 4.0.0.11, no replacement

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:

GraphConstants.DDT_CUBE, GraphConstants.DDT_RELATIONAL, DataDirector

setDataDirectorType

public void setDataDirectorType(int type)

Deprecated. As of 4.0.0.11, no replacement

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:

GraphConstants.DDT_CUBE, GraphConstants.DDT_RELATIONAL, DataDirector

isDataRowShownAsASeries

@Deprecated
public boolean isDataRowShownAsASeries()

Deprecated. There is no replacement method for this. Application developers are responsible to create the relevant data set.

For internal use only. Application developers should not use this

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.

setDataRowShownAsASeries

@Deprecated
public void setDataRowShownAsASeries(boolean yesNo)

Deprecated. There is no replacement method for this. Application developers are responsible to create the relevant data set.

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).

For internal use only. Application developers should not use this

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.

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.

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)

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 UIGraphType

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 UIGraphType

Parameters:

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

See Also:

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

setTimeAxisType

public void setTimeAxisType(int timeAxis)

Specifies the type of time axis to plot. The constants are TAT_DEFAULT, TAT_IRREGULAR, TAT_MIXED_FREQUENCY and TAT_OFF. The default value is TAT_DEFAULT.

Parameters:

timeAxis - the constant for the time axis type.

getTimeAxisType

public int getTimeAxisType()

Retrieves the type of time axis to plot.

Returns:

the constant for the time axis type.

setContinuousTimeAxisInterval

public void setContinuousTimeAxisInterval(int interval)

Specifies the interval along the continuous time axis. The applications should set this property if they need to override the automatically calculated value. The constants are CTAI_AUTOMATIC, CTAI_YEAR, CTAI_MONTH, CTAI_DAY, CTAI_HOUR, CTAI_MINUTE and CTAI_SECOND. The default is CTAI_AUTOMATIC.

Parameters:

interval - the constant for the time axis type.

See Also:

GraphConstants.TAT_DEFAULT, GraphConstants.TAT_IRREGULAR, GraphConstants.TAT_MIXED_FREQUENCY, GraphConstants.TAT_DEFAULT_STRICT, GraphConstants.TAT_IRREGULAR_STRICT, GraphConstants.TAT_MIXED_FREQUENCY_STRICT, GraphConstants.TAT_OFF

getContinuousTimeAxisInterval

public int getContinuousTimeAxisInterval()

Retrieves the interval along the continuous time axis.

Returns:

the constant for the continuous time axis interval.

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.

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:

GraphConstants.TLT_DIM_MEMBER, GraphConstants.TLT_MEMBER, GraphConstants.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.

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:

GraphConstants.TLT_DIM_MEMBER, GraphConstants.TLT_MEMBER, GraphConstants.TLT_NONE

getImageSize

public java.awt.Dimension getImageSize()

Retrieves the size of this graph.

Specified by:

getImageSize in interface ExportableGraph

Returns:

The size of the graph, in a Dimension object.

setImageSize

public void setImageSize(java.awt.Dimension d)

Specifies the size of the image that is created from this graph when you export the graph to a PNG or GIF file.

Parameters:

d - The size to make the graph.

See Also:

exportToGIF(java.io.OutputStream), exportToGIFWithException(java.io.OutputStream), 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.

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 the graph sets the MarkerDisplayed property to true.

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.

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.

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()

Deprecated. As of 11.1.1.0.10, replaced by getMarkerShapeInLegend().

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)

For internal use only. Application developers should not use this

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

setMarkerShapeInLegend

public void setMarkerShapeInLegend(boolean yesNo)

Deprecated. As of 11.1.1.0.10, replaced by setMarkerShapeInLegend(int).

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)

For internal use only. Application developers should not use this

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

getMarkerShapeInLegend

public int getMarkerShapeInLegend()

Indicates whether legend markers are shaped like their corresponding data markers or 2-D markers. Constants are defined in GraphConstants and begin with MSIL_.

Returns:

constant indicating marker shape in legend

See Also:

DataMarker, TwoDMarker, GraphConstants.MSIL_FALSE, GraphConstants.MSIL_TRUE, GraphConstants.MSIL_SQUARE, Series.setMarkerShape(int, int)

setMarkerShapeInLegend

public void setMarkerShapeInLegend(int markerShapeInLegend)

Specifies whether legend markers are shaped like their corresponding data markers or 2-D markers. Constants are defined in GraphConstants and begin with MSIL_.

Parameters:

markerShapeInLegend - constant indicating marker shape in legend

See Also:

DataMarker, TwoDMarker, GraphConstants.MSIL_FALSE, GraphConstants.MSIL_TRUE, GraphConstants.MSIL_SQUARE, 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.

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:

GraphConstants.MTT_TEXT, GraphConstants.MTT_VALUES, GraphConstants.MTT_NONE, GraphConstants.MTT_PERCENT_VAL, GraphConstants.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.

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:

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

getMouseActions

public int getMouseActions()

Returns:

an integer that is the type of actions that can be performed on the graph with the mouse

For internal use only. Application developers should not use this

gets the type of actions that can be performed on the graph with the mouse

setMouseActions

public void setMouseActions(int actions)

Parameters:

actions - an integer that specifies the type of actions that can be performed on the graph with the mouse. Legal value are one of the following constants: Graph.MA_NONE no actions enabled Graph.MA_SELECT can select Graph component objects Graph.MA_SCROLL_ZOOM can drag a rectangle in the PlotArea to initiate Scrolling and Zooming

For internal use only. Application developers should not use this

sets the type of actions that can be performed on the graph with the mouse

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)

setAlignTickMarks

public void setAlignTickMarks(boolean align)

Specifies whether the tick marks on Y1Axis and Y2Axis should align in case of Dual-Y Graphs. The default value is true which means tick marks on Y1Axis and Y2Axis are aligned. When the value is false, the Y1Axis and Y2Axis are scaled independent of each other.

Parameters:

align - true to align Y1Axis and Y2Axis tick marks, false to scale Y1Axis and Y2Axis independently.

isAlignTickMarks

public boolean isAlignTickMarks()

Retrieves whether Y1Axis and Y2Axis tick marks are aligned.

Returns:

true if Y1Axis and Y2Axis tick marks are aligned. false if Y1Axis and Y2Axis tick marks are not aligned, Y1Axis and Y2Axis are scaled independently.

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.

getPresentationHeight

public int getPresentationHeight()

Retrieves the height of this graph in pixels.

Specified by:

getPresentationHeight in class Dataview

Returns:

The height of this graph in pixels

getPresentationWidth

public int getPresentationWidth()

Retrieves the width of the graph in pixels.

Specified by:

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

getSeriesEffect

public int getSeriesEffect()

Retrieves the current effect on the series. Setting a gradient as a series effect makes the data markers look more polished.

Returns:

An constant that represents the current series effect. Valid constants are listed in the See Also section.

See Also:

GraphConstants.SE_NONE, GraphConstants.SE_GRADIENT, GraphConstants.SE_AUTO_GRADIENT

setSeriesEffect

public void setSeriesEffect(int effect)

Sets the specified series effect on the graph. Setting this property to SE_GRADIENT sets a special gradient on data markers to make them look more polished. This disables interaction with the SFX of the Series object and turns on graphic antialiasing. When this property is set to SE_NONE, the markers appear flat, you can set SFX properties and objects, and graphic antialiasing is turned off.

Parameters:

effect - A constant that represents the series effect. Valid constants are listed in the See Also section .

See Also:

GraphConstants.SE_NONE, GraphConstants.SE_GRADIENT, GraphConstants.SE_AUTO_GRADIENT, setGraphicAntialiasing(boolean), SFX, Series

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 GraphAttribute

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

setThresholdObjectCount

public void setThresholdObjectCount(int count)

Specifies the number of thresholds that this graph stores properties for. The graph stores properties, such as colors, for a number of thresholds.

Parameters:

count - the number of thresholds that this graph should store properties for. Valid values are 1 to Graph.THRESHOLDOBJECTCOUNTLIMIT.

See Also:

Threshold

getThresholdObjectCount

public int getThresholdObjectCount()

Retrieves the number of thresholds that this graph stores properties for. The graph stores properties, such as colors, for a number of thresholds.

Returns:

the number of thresholds that this graph stores properties for

See Also:

Threshold

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.

Returns:

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

See Also:

GraphConstants.TLT_MEMBER, GraphConstants.TLT_DIM_MEMBER, GraphConstants.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.

Parameters:

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

See Also:

GraphConstants.TLT_MEMBER, GraphConstants.TLT_DIM_MEMBER, GraphConstants.TLT_NONE, setMarkerTooltipType(int)

setSeriesRolloverBehavior

public void setSeriesRolloverBehavior(int behavior)

Set the rollover behavior for series in the graph.

Parameters:

behavior - The behavior for rollover of the series. Constants are defined in GraphConstants and begin with RB_.

See Also:

GraphConstants.RB_NONE, GraphConstants.RB_HIGHLIGHT, GraphConstants.RB_DIM, GraphConstants#RB_HIGHLIGHT_DIM

getSeriesRolloverBehavior

public int getSeriesRolloverBehavior()

Get the rollover behavior for series in the graph.

Returns:

int The behavior for rollover of the series. Constants are defined in GraphConstants and begin with RB_.

See Also:

GraphConstants.RB_NONE, GraphConstants.RB_HIGHLIGHT, GraphConstants.RB_DIM, GraphConstants#RB_HIGHLIGHT_DIM

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:

GraphConstants.SP_ALWAYS, GraphConstants.SP_NEVER, GraphConstants.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:

GraphConstants.SP_ALWAYS, GraphConstants.SP_NEVER, GraphConstants.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.

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.

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.

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.

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.

getZoomDirection

public int getZoomDirection()

Returns:

A constant that describes which axes can be zoomed. Constants are listed in the See Also section.

See Also:

GraphConstants.ZD_XAXIS_ONLY, GraphConstants.ZD_YAXIS_ONLY, GraphConstants.ZD_BOTH_AXES

For internal use only. Application developers should not use this

Retrieves information about the axis on which this graph can be zoomed.

setZoomDirection

public void setZoomDirection(int axes)

Parameters:

axes - A constant that describes which axes to allow zooming on. Constants are listed in the See Also section.

See Also:

GraphConstants.ZD_XAXIS_ONLY, GraphConstants.ZD_YAXIS_ONLY, GraphConstants.ZD_BOTH_AXES

For internal use only. Application developers should not use this

Specifies axes on which this graph can be zoomed.

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.

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.

getLegendTitle

public LegendTitle getLegendTitle()

Retrieves the LegendTitle component for this graph.

Returns:

The LegendTitle 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.

getFunnelFrame

public FunnelFrame getFunnelFrame()

Retrieves the FunnelFrame component for this graph.

Returns:

the FunnelFrame component for this graph

getFunnelViewAngle

public double getFunnelViewAngle()

Returns:

the current view angle for a funnel chart

For internal use only. Application developers should not use this

Retrieves the current view angle for a funnel chart.

setFunnelViewAngle

public void setFunnelViewAngle(double viewAngle)

Parameters:

viewAngle - the view angle for a funnel chart

For internal use only. Application developers should not use this

Sets the view angle to be used to render a funnel chart. The value can vary from 0 to 360 degree. The default value is 30 degree.

getFunnelRotateAngle

public double getFunnelRotateAngle()

For internal use only. Application developers should not use this

Retrieves the funnel rotate angle.

setFunnelRotateAngle

public void setFunnelRotateAngle(double rotateAngle)

For internal use only. Application developers should not use this

Sets the funnel rotate angle. By setting this angle different than the view angle, the funnel can be rotated from 0 to 360 degrees.

getFunnelHeightRatio

public double getFunnelHeightRatio()

Returns:

the left to right surface height ratio for a funnel chart

For internal use only. Application developers should not use this

Retrieves the ratio of the left surface height to the right surface height for a funnel chart.

setFunnelHeightRatio

public void setFunnelHeightRatio(double heightRatio)

Parameters:

heightRatio - the left to right surface height ratio for a funnel chart

For internal use only. Application developers should not use this

Sets the ratio of the left surface height to the right surface height for a funnel chart. The default ratio is 2/3.

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.

getUISeriesColor

public UISeriesColor getUISeriesColor()

Description copied from interface: GraphAttribute

Retrieves an object that provides access to the color for a series.

Specified by:

getUISeriesColor in interface GraphAttribute

Returns:

The UISeriesColor implementation that stores the colors for the series in this graph.

For internal use only. Application developers should not use this

Retrieves the UISeriesColor that specifies the color of the series in this graph.

getUIThresholdColor

public UIThresholdColor getUIThresholdColor()

Description copied from interface: GraphAttribute

Retrieves an object that provides access to the color for a threshold.

Specified by:

getUIThresholdColor in interface GraphAttribute

Returns:

the UIThresholdColor implementation that stores the colors for the thresholds in this graph

For internal use only. Application developers should not use this

Retrieves the UIThresholdColor that specifies the color of the thresholds in this graph.

getThreshold

public Threshold getThreshold()

Retrieves the Threshold component for this graph.

Returns:

the Threshold 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.

Returns:

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

getParetoMarker

public ParetoMarker getParetoMarker()

Retrieves the ParetoMarker component for this graph.

Returns:

The ParetoMarker component for this graph.

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.

getTimeSelector

public TimeSelector getTimeSelector()

Retrieves the TimeSelector component for this graph.

Returns:

The TimeSelector 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.

getAlert

public Alert getAlert(int index)

Return alert with the specified index.

Parameters:

index - index of the alert that needs to be retrieved

Returns:

A reference to the Alert at the specifed index

createAlert

public Alert createAlert(java.lang.Object xValue,
                         java.lang.Object yValue)

Creates and returns a new Alert.

Returns:

A Alert that could be associated with a datapoint

createAnnotation

public Annotation createAnnotation(int series,
                                   int group)

Creates and returns a new Annotation.

Returns:

A Annotation that could be associated with the given Series and group

setAnnotationsVisibility

public void setAnnotationsVisibility(int visibility)

Specify visibility for Annotations

Parameters:

visibility - an integer indicating visibility for Annotations

getAnnotationsVisibility

public int getAnnotationsVisibility()

returns current visibility for Annotations

Returns:

an integer indicating visibility for Annotations

createReferenceObject

public ReferenceObject createReferenceObject()

Creates and returns a new ReferenceObject. Use this object to specify reference lines or reference areas for a graph. By default, a reference object is associated with the Y1Axis. Use the setAssociation property of this component to re-associate the object with another axis or with a series.

Note: You cannot delete individual reference objects of a graph. You can only destroy all reference objects for a specific graph.

Returns:

A ReferenceObject that could be associated with either an axis or a series

See Also:

destroyReferenceObjects(int), getReferenceObjects(int)

getReferenceObject

public ReferenceObject getReferenceObject(int id)

Return ReferenceObject with the specified ID.

Parameters:

id - ID of the reference object that needs to be removed.

Returns:

A reference to the ReferenceObject of the specifed ID

getReferenceObjects

public java.util.List getReferenceObjects(int component)

Returns a list of reference objects that belong to a specific graph. Each reference object specifies a reference line or reference area for a graph.

Parameters:

Component - ID of the graph whose reference objects you want to retrieve.

Returns:

An ArrayList of ReferenceObject objects for the specified graph

See Also:

GraphConstants.Y1AXIS, GraphConstants.Y2AXIS, GraphConstants.X1AXIS, GraphConstants.SERIES, GraphConstants.ALL

destroyReferenceObject

public void destroyReferenceObject(int id)

Destroys the ReferenceObject given its ID.

Parameters:

id - ID of the reference object that needs to be removed.

destroyReferenceObjects

public void destroyReferenceObjects(int component)

Destroys the ReferenceObjects of the specified graph.

Parameters:

Component - ID of the graph whose reference objects need to be removed.

See Also:

GraphConstants.Y1AXIS, GraphConstants.Y2AXIS, GraphConstants.X1AXIS, GraphConstants.SERIES, GraphConstants.ALL

getReferenceObjectDisplay

public int getReferenceObjectDisplay(int component)

Indicates when the reference objects for a given component should be displayed. By default display value will be DISPLAY_ALWAYS.

Parameters:

Component - ID of the graph whose reference objects you want to display.

Returns:

A constant that indicates when to display the reference object.

See Also:

#DISPLAY_NEVER, #DISPLAY_ALWAYS, #DISPLAY_AUTOMATIC

setReferenceObjectDisplay

public void setReferenceObjectDisplay(int component,
                                      int display)

Specifies when to display the reference objects for a given graph component. By default display value will be DISPLAY_ALWAYS.

Parameters:

Component - ID of the graph whose reference objects you want to display.

display - A constant that indicates when to display the reference object.

See Also:

#DISPLAY_NEVER, #DISPLAY_ALWAYS, #DISPLAY_AUTOMATIC

getReferenceObjectMarker

public ReferenceObjectMarker getReferenceObjectMarker()

Retrieves the ReferenceObjectMarker component for this graph.

Returns:

The ReferenceObjectMarker component for this graph.

getReferenceObjectText

public ReferenceObjectText getReferenceObjectText()

Retrieves the ReferenceObjectText component for this graph.

Returns:

The ReferenceObjectText 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.

setTickLabelCallback

public void setTickLabelCallback(TickLabelCallback callback,
                                 int axisID)

Specifies a TickLabelCallback to use for customizing tick labels. By default, no callback is set.

Parameters:

callback - The TickLabelCallback for customized tick labels.

axisID - A constant that represents the axis whose tick labels the callback customizes. Valid constants are listed in the See Also section.

See Also:

GraphConstants.X1TICKLABEL, GraphConstants.Y1TICKLABEL, GraphConstants.Y2TICKLABEL

getTickLabelCallback

public TickLabelCallback getTickLabelCallback(int axisID)

Retrieves the TickLabelCallback that has been set for customizing tick labels.

Parameters:

axisID - A constant that represents the axis whose labels the callback customizes.

Returns:

The callback for customized tick labels, or null if no callback has been set.

See Also:

GraphConstants.X1TICKLABEL, GraphConstants.Y1TICKLABEL, GraphConstants.Y2TICKLABEL

getUndefinedComponent

public UndefinedComponent getUndefinedComponent()

Returns:

the ComponentNotDefined object

For internal use only. Application developers should not use this

gets the not defined component.

setXML

public boolean setXML(java.lang.String xmlString,
                      int reset)
               throws oracle.dss.util.xml.BIIOException,
                      oracle.dss.util.xml.BISAXException,
                      oracle.dss.util.xml.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.

Specified by:

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.

oracle.dss.util.xml.BIIOException - If an error occurs in reading xmlString.

oracle.dss.util.xml.BISAXException - If a general SAX exception occurs in parsing the XML.

oracle.dss.util.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:

DataviewConstants.RESET_NONE, DataviewConstants.RESET_XML_PROPERTIES, DataviewConstants.RESET_EVERYTHING, #RESET_EVERYTHING_BUT_DATASOURCE

readXML

public boolean readXML(java.io.InputStream stream,
                       int reset)
                throws oracle.dss.util.xml.BIIOException,
                       oracle.dss.util.xml.BISAXException,
                       oracle.dss.util.xml.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.

Specified by:

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.

oracle.dss.util.xml.BIIOException - If an error occurs in reading xmlString.

oracle.dss.util.xml.BISAXException - If a general SAX exception occurs in parsing the XML.

oracle.dss.util.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:

DataviewConstants.RESET_NONE, DataviewConstants.RESET_XML_PROPERTIES, DataviewConstants.RESET_EVERYTHING, #RESET_EVERYTHING_BUT_DATASOURCE

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:

DataviewConstants.MAP_ALL, DataviewConstants.MAP_DATA, DataviewConstants.MAP_DATATEXT, DataviewConstants.MAP_LABELS, DataviewConstants.MAP_LEGEND, DataviewConstants.MAP_ORDINALLABELS, DataviewConstants.MAP_TITLES, se

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), DataviewConstants.MAP_ALL, DataviewConstants.MAP_DATA, DataviewConstants.MAP_DATATEXT, DataviewConstants.MAP_LABELS, DataviewConstants.MAP_LEGEND, DataviewConstants.MAP_ORDINALLABELS, DataviewConstants.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), DataviewConstants.MAP_ALL, DataviewConstants.MAP_DATA, DataviewConstants.MAP_DATATEXT, DataviewConstants.MAP_LABELS, DataviewConstants.MAP_LEGEND, DataviewConstants.MAP_ORDINALLABELS, DataviewConstants.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 a GIF or PNG 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:

GraphConstants.TEXT_COMPONENTS_ALL, GraphConstants.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 or PNG 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:

GraphConstants.TEXT_COMPONENTS_ALL, GraphConstants.TEXT_COMPONENTS_NONE

setBackgroundTransparent

public void setBackgroundTransparent(boolean transparent)

Specified by:

setBackgroundTransparent in interface ThickDataview

Parameters:

transparent - true to make the graph background transparent, otherwise false

For internal use only. Application developers should not use this

Sets the transparency of the graph background depending on the boolean argument passed.

processAlertEvent

protected void processAlertEvent(int eventID)

drawImage

public void drawImage(java.awt.Image image,
                      int x,
                      int y,
                      java.awt.Graphics g)

For internal use only. Application developers should not use this

paint

public void paint(java.awt.Graphics g)

Overrides:

paint in class javax.swing.JComponent

For internal use only. Application developers should not use this

Override to show the offscreen image when printing or previewing

modelWaitDataAvailable

public void modelWaitDataAvailable(WaitDataAvailableEvent e)

Description copied from interface: ModelListener

Inform view that a lazy data fetch has been completed. This method is called by the ModelAdapter in response to the completion of a lazy data fetch. Application developers do not need to call it.

Specified by:

modelWaitDataAvailable in interface ModelListener

Overrides:

modelWaitDataAvailable in class Dataview

Parameters:

e - Information about the fetch.

For internal use only. Application developers should not use this

Responds to the completion of a time-consuming data fetch. When fetching data will take a long time, the graph displays a message until the data fetch is completed. When all of the data is fetched, then the model calls this method. This method then clears the message and displays the data.

Application developers do not need to call this method.

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.

isDualY

public boolean isDualY()

Indicates whether the graph type is a dual-Y graph type. Dual-Y graphs are graphs that have a Y2-axis. Graph types whose constants have "2Y" have a Y2-axis. Pareto graphs and stock graphs that include volume also have a Y2-axis.

Returns:

true if the graph has a Y2-axis, false if it does not.

See Also:

setGraphType(int)

setPrintOrPreviewMode

public void setPrintOrPreviewMode(boolean bool)

For internal use only. Application developers should not use this

Sets whether table is in print or print preview mode. When in print or preview mode, offscreen image is displayed. This is used by GraphPrinter class.

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.

convertGraphTypeToInt

public static int convertGraphTypeToInt(java.lang.String string)

For internal use only. Application developers should not use this

Converts Graph type String constants to Integer constants. This is used by get/setXML().

isPrintOrPreviewMode

public boolean isPrintOrPreviewMode()

Specified by:

isPrintOrPreviewMode in class Dataview

For internal use only. Application developers should not use this

Indicates whether print or preview is happening.

updatePageItems

public void updatePageItems()

Specified by:

updatePageItems in interface ThickDataview

For internal use only. Application developers should not use this

applyViewFormat

public void applyViewFormat(ComponentHandle componentHandle,
                            ViewFormat viewFormat)

Specified by:

applyViewFormat in interface GraphAttribute

For internal use only. Application developers should not use this

getComponentViewFormat

public ViewFormat getComponentViewFormat(ComponentHandle componentHandle)

Specified by:

getComponentViewFormat in interface GraphAttribute

For internal use only. Application developers should not use this

firePrintBegin

protected void firePrintBegin(java.lang.Object source)

Overrides:

firePrintBegin in class Dataview

Parameters:

source - source of the event.

For internal use only. Application developers should not use this

This is called by GraphPrinter.java. This does nothing but calls super class method. This reason for having this is- superclass method is protected and GraphPrinter cannot directly access that method.

firePrintEnd

protected void firePrintEnd(java.lang.Object source)

Overrides:

firePrintEnd in class Dataview

Parameters:

source - source of the event.

For internal use only. Application developers should not use this

This is called by GraphPrinter.java. This does nothing but calls super class method. This reason for having this is- superclass method is protected and GraphPrinter cannot directly access that method.

updateResourceBundle

protected void updateResourceBundle()

For internal use only. Application developers should not use this

setContext

public void setContext()

Specified by:

setContext in class Dataview

For internal use only. Application developers should not use this

set the context

getViewXML

protected DataviewXML getViewXML()

Specified by:

getViewXML in class Dataview

For internal use only. Application developers should not use this

getObjectNode

protected oracle.dss.util.xml.ObjectNode getObjectNode(boolean allProperties)

Specified by:

getObjectNode in class Dataview

For internal use only. Application developers should not use this

getPagingControlXML

public oracle.dss.util.xml.ObjectNode getPagingControlXML(boolean allProperties)

Specified by:

getPagingControlXML in interface ThickDataview

For internal use only. Application developers should not use this

setPagingControlXML

public void setPagingControlXML(oracle.dss.util.xml.ObjectNode pagingControl,
                                java.lang.String version,
                                int reset)

Specified by:

setPagingControlXML in interface ThickDataview

setXML

protected void setXML(oracle.dss.util.xml.ObjectNode node,
                      int reset)

For internal use only. Application developers should not use this

setXMLAsString

public boolean setXMLAsString(java.lang.String xml)
                       throws oracle.dss.util.persistence.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.

Specified by:

setXMLAsString in interface oracle.dss.util.persistence.StringXMLizable

Specified by:

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.

oracle.dss.util.persistence.BIPersistenceException - If a problem occurs in setting the XML.

See Also:

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

setPersistableComponents

public void setPersistableComponents(oracle.dss.util.persistence.AggregateInfo[] persistables)

Specified by:

setPersistableComponents in interface oracle.dss.util.persistence.contract.AggregableContract

Overrides:

setPersistableComponents in class Dataview

Parameters:

aggregates - a AggregateInfo[] value that represents the components to assign to the graph.

For internal use only. Application developers should not use this

Specifies the components associated with the graph

getPersistableAttributes

public oracle.dss.util.persistence.PersistableAttributes getPersistableAttributes(oracle.dss.util.persistence.PersistableAttributes oldAttrs)

Description copied from class: Dataview

Retrieves the attributes of this Dataview, for searching. This method adds the attributes that this Dataview defines to the attributes that the application has specified. The attributes are used by the persistence service, when users search the repository for components that have particular attribute values.

Specified by:

getPersistableAttributes in interface oracle.dss.util.persistence.SimplePersistable

Specified by:

getPersistableAttributes in class Dataview

Parameters:

attrs - a PersistableAttributes value that represents the searchable attributes set by the user application.

Returns:

PersistableAttributes which represent the searchable properties of the graph (the ones passed into the method augmented by graph-specific properties).

For internal use only. Application developers should not use this

Reterun a structure consisting of PeristableAttibutes (i.e. search attributes associated with this graph) which are used for searching for this graph in the database.

loadCompleted

public void loadCompleted()
                   throws oracle.dss.util.persistence.BIPersistenceException

Throws:

oracle.dss.util.persistence.BIPersistenceException

For internal use only. Application developers should not use this

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()

applySampleData

public void applySampleData()

For internal use only. Application developers should not use this

This method sets sample data on the graph that is designed to provide a a meaningful sample graph. The data applied is dependent on graph type because several graph types have very specific data requirements. Other graph types simply look better with specific data sets. This method is called in order to produce sample graph images in our Styles and Layout UI panels.

setGridData

public boolean setGridData(java.lang.Object[] columnLabels,
                           java.lang.Object[] rowLabels,
                           java.lang.Object[][] data)

Parameters:

columnLabels - labels for the columns of data; typically Strings

rowLabels - labels for the rows of data; typically Strings

data - values to be plotted in the graph, indexed first by column, then by row; typically Doubles and Date in case of TimeSeries graphs

Returns:

true if data is successfully set on the graph, false otherwise

For internal use only. Application developers should not use this

Set data on the Graph. Data is provided in grid form, where the number of rows and columns are known ahead of time.

getColumnCount

public int getColumnCount()
                   throws EdgeOutOfRangeException

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

Returns:

The number of data columns that this graph displays.

Throws:

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

EdgeOutOfRangeException

See Also:

isDataRowShownAsASeries()

getRowCount

public int getRowCount()
                throws EdgeOutOfRangeException

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

Returns:

The number of data rows that this graph displays.

Throws:

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

EdgeOutOfRangeException

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.

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.

EdgeOutOfRangeException

SliceOutOfRangeException

See Also:

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

setMetadataDrillSupported

protected void setMetadataDrillSupported(boolean supported)

For internal use only. Application developers should not use this

set the flag for METADATA_DRILLSTATE type true or false

isMetadataDrillSupported

protected boolean isMetadataDrillSupported()

Returns:

true if METADATA_DRILLSTATE is supported, else false

For internal use only. Application developers should not use this

setDataUnformattedSupported

protected void setDataUnformattedSupported(boolean supported)

Overrides:

setDataUnformattedSupported in class Dataview

For internal use only. Application developers should not use this

set DATA_UNFORMATTED type to true or false

setMetadataLongLabelSupported

protected void setMetadataLongLabelSupported(boolean supported)

Overrides:

setMetadataLongLabelSupported in class Dataview

For internal use only. Application developers should not use this

set METADATA_LONGLABEL type to true or false

setMetadataMediumLabelSupported

protected void setMetadataMediumLabelSupported(boolean supported)

Overrides:

setMetadataMediumLabelSupported in class Dataview

For internal use only. Application developers should not use this

set flag for METADATA_MEDIUMLABEL type to true or false

setMetadataShortLabelSupported

protected void setMetadataShortLabelSupported(boolean supported)

Overrides:

setMetadataShortLabelSupported in class Dataview

For internal use only. Application developers should not use this

set METADATA_SHORTLABEL type to true or false

setMetadataValueSupported

protected void setMetadataValueSupported(boolean supported)

Overrides:

setMetadataValueSupported in class Dataview

For internal use only. Application developers should not use this

set METADATA_VALUE type to true or false

setMetadataDrillParentDateSupported

protected void setMetadataDrillParentDateSupported(boolean supported)

For internal use only. Application developers should not use this

set the flag for METADATA_DRILL_PARENT_DATE type true or false

isMetadataDrillParentDateSupported

protected boolean isMetadataDrillParentDateSupported()

For internal use only. Application developers should not use this

set the flag for METADATA_DRILL_PARENT_DATE type true or false

setMetadataDrillParentDateSpanSupported

protected void setMetadataDrillParentDateSpanSupported(boolean supported)

For internal use only. Application developers should not use this

set the flag for METADATA_DRILL_PARENT_DATESPAN type true or false

isMetadataDrillParentDateSpanSupported

protected boolean isMetadataDrillParentDateSpanSupported()

For internal use only. Application developers should not use this

set the flag for METADATA_DRILL_PARENT_DATESPAN type true or false

setMetadataDateSupported

protected void setMetadataDateSupported(boolean supported)

For internal use only. Application developers should not use this

set the flag for METADATA_DATE type true or false

setMetadataDateSpanSupported

protected void setMetadataDateSpanSupported(boolean supported)

For internal use only. Application developers should not use this

set the flag for METADATA_DATESPAN type true or false

isMetadataDateSpanSupported

protected boolean isMetadataDateSpanSupported()

For internal use only. Application developers should not use this

set the flag for METADATA_DATESPAN type true or false

setLayerMetaMediumLabelSupported

protected void setLayerMetaMediumLabelSupported(boolean supported)

Overrides:

setLayerMetaMediumLabelSupported in class Dataview

For internal use only. Application developers should not use this

set flag for LAYER_METADATA_MEDIUMLABEL type to true or false

setLayerMetaShortLabelSupported

protected void setLayerMetaShortLabelSupported(boolean supported)

Overrides:

setLayerMetaShortLabelSupported in class Dataview

For internal use only. Application developers should not use this

set LAYER_METADATA_SHORTLABEL type to true or false

setLayerMetaNameSupported

protected void setLayerMetaNameSupported(boolean supported)

Overrides:

setLayerMetaNameSupported in class Dataview

For internal use only. Application developers should not use this

set LAYER_METADATA_NAME type to true or false

metadataLabelTypeChanged

protected void metadataLabelTypeChanged()

Overrides:

metadataLabelTypeChanged in class Dataview

For internal use only. Application developers should not use this

Update the view after the metadata label type has changed.

beginAxisChanges

public void beginAxisChanges()

Deprecated. As of 4.0, no replacement as there is no need to call this method anymore

Prevents calculation of axis values while the user interface panel sets axis scaling properties.

endAxisChanges

public void endAxisChanges()

Deprecated. As of 4.0, no replacement as there is no need to call this method anymore

Re-enables calculation of axis values after the user interface panel sets axis scaling properties.

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.

Specified by:

setSwapAllowed in interface ThickDataview

Specified by:

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.

Specified by:

isSwapAllowed in interface ThickDataview

Specified by:

isSwapAllowed in class Dataview

Returns:

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

See Also:

setSwapAllowed(boolean)

setLayerMetaLongLabelSupported

protected void setLayerMetaLongLabelSupported(boolean supported)

Overrides:

setLayerMetaLongLabelSupported in class Dataview

For internal use only. Application developers should not use this

set the flag for LAYER_METADATA_LONGLABEL type true or false

notEnoughData

public void notEnoughData(NotEnoughData neData)

Parameters:

neData - Information about the insufficient data condition.

For internal use only. Application developers should not use this

Constructs the message that is displayed, instead of the graph, when there is not enough data to display the graph. This method is called by the GraphControllerAdapter when there is insufficient data to display the graph. Application developers do not need to call this method.

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.

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.

Returns:

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

isStyleOverrideFlag

protected boolean isStyleOverrideFlag(int attrID)

For internal use only. Application developers should not use this

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.

setDrillingEnabled

public void setDrillingEnabled(boolean b)

Specifies whether drilling is allowed in this view. Drilling is enabled by default.

Specified by:

setDrillingEnabled in interface DataviewAttributes

Overrides:

setDrillingEnabled in class Dataview

Parameters:

b - true to enable drilling; false to disable drilling.

saveDrillState

protected void saveDrillState()

For internal use only. Application developers should not use this

saves the drill state for the Row and Column edge

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:

GraphConstants.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:

GraphConstants.SP_ALWAYS, GraphConstants.SP_NEVER, GraphConstants.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:

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

isGroup3DPanels

public boolean isGroup3DPanels()

Returns:

true if all of the panels are treated as one object, false if the panels are treated as individual objects.

For internal use only. Application developers should not use this

Indicates whether all of the 3-D panels are treated as one object.

setGroup3DPanels

public void setGroup3DPanels(boolean yesNo)

Parameters:

yesNo - true to treat all of the 3D panels as one object, false to treat them as individual objects.

For internal use only. Application developers should not use this

Specifies whether all of the 3-D panels are treated as one object.

setExplicitTimeRangeStart

public void setExplicitTimeRangeStart(java.util.Date date)

Specifies the explicit time range start date for a time axis. On a time axis, you can specify an explicit time range to show up on the time axis using the following methods. setExplicitTimeRangeStart(Date date) setExplicitTimeRangeEnd(Date date) setTimeRangeMode(TRM_EXPLICIT) You have to set all the three methods for the explicit time range to take effect. The underlying engine calculates and sets DisplayGroups and StartGroup properties in case of a regular time axis. Suppose the time axis is showing Jan 2000 to Dec 2000. You can set an explicit time range March 2000 - June 2000. Then the the time axis only shows March 2000 - June 2000.

Parameters:

date - explicit time range start date.

getExplicitTimeRangeStart

public java.util.Date getExplicitTimeRangeStart()

Retrieves the explicit time range start date.

Returns:

the explicit time range start date.

setExplicitTimeRangeEnd

public void setExplicitTimeRangeEnd(java.util.Date date)

Specifies the explicit time range end date for a time axis. On a time axis, you can specify an explicit time range to show up on the time axis using the following methods. setExplicitTimeRangeStart(Date date) setExplicitTimeRangeEnd(Date date) setTimeRangeMode(TRM_EXPLICIT) You have to set all the three methods for the explicit time range to take effect. The underlying engine calculates and sets DisplayGroups and StartGroup properties in case of a regular time axis. Suppose the time axis is showing Jan 2000 to Dec 2000. You can set an explicit time range March 2000 - June 2000. Then the the time axis only shows March 2000 - June 2000.

Parameters:

date - explicit time range end date.

getExplicitTimeRangeEnd

public java.util.Date getExplicitTimeRangeEnd()

Retrieves the explicit time range end date.

Returns:

the explicit time range end date.

setTimeRangeMode

public void setTimeRangeMode(int mode)

Specifies the time range mode on a time axis. Valid constants are TRM_OFF, TRM_RELATIVE_LAST, TRM_RELATIVE_FIRST and TRM_EXPLICIT. The default is TRM_OFF which means show all the data on the time axis. TRM_RELATIVE_LAST and TRM_RELATIVE_FIRST are used for setting relative time on the time axis such as 'last seven days' or 'first seven months'. Relative time range from the last data point or from the first data point can be set on the time axis using the following API. setTimeRangeMode(int mode) //set to TRM_RELATIVE_LAST or TRM_RELATIVE_FIRST setRelativeTimeRange(long time) //relative time in milli seconds Suppose the time axis is showing Jan 2 - Jan 14 and we want to see last 7 days(Jan 8 -Jan 14), then the following properties must be set. setTimeRangeMode(TRM_RELATIVE_LAST) setRelativeTimeRange( 7 days in milliseconds) TRM_EXPLICIT is used for setting explicit time range. On a time axis, you can specify an explicit time range to show up on the time axis using the following methods. setExplicitTimeRangeStart(Date date) setExplicitTimeRangeEnd(Date date) setTimeRangeMode(TRM_EXPLICIT) You have to set all the three methods for the explicit time range to take effect. Suppose the time axis is showing Jan 2000 to Dec 2000. You can set an explicit time range March 2000 - June 2000. Then the the time axis only shows March 2000 - June 2000.

Parameters:

mode - the time range mode.

getTimeRangeMode

public int getTimeRangeMode()

Retrieves the time range mode. Valid constants are TRM_OFF, TRM_RELATIVE_LAST, TRM_RELATIVE_FIRST and TRM_EXPLICIT. Default is TRM_OFF.

setRelativeTimeRange

public void setRelativeTimeRange(long time)

Specifies the relative time range in milliseconds for time axis. Relative time range from the last data point or from the first data point can be set on the time axis using the following API. setTimeRangeMode(int mode) //set to TRM_RELATIVE_LAST or TRM_RELATIVE_FIRST setRelativeTimeRange(long time) //relative time in milli seconds The time in milliseconds must be a positive number. The underlying engine calculates and sets DisplayGroups and StartGroup properties in case of a regular time axis. Suppose the time axis is showing Jan 2 - Jan 14 and we want to see last 7 days(Jan 8 -Jan 14), then the following properties must be set. setTimeRangeMode(TRM_RELATIVE_LAST) setRelativeTimeRange( 7 days in milliseconds)

getRelativeTimeRange

public long getRelativeTimeRange()

Retrieves the relative time range in milliseconds.

Returns:

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.

getComponentViewStyle

public ViewStyle getComponentViewStyle(ComponentHandle componentHandle)

Description copied from interface: GraphAttribute

Retrieves the ViewStyle for a selected component. The graph supports a ViewStyle for page items only.

Specified by:

getComponentViewStyle in interface GraphAttribute

Parameters:

componentHandle - The ComponentHandle for the component whose ViewStyle you want. Implementers should screen for the PageItemComponentHandle.

Returns:

The ViewStyle for page items.

See Also:

PageItemComponentHandle

For internal use only. Application developers should not use this

applyViewStyle

public void applyViewStyle(ComponentHandle componentHandle,
                           ViewStyle viewStyle)

Description copied from interface: GraphAttribute

Applies a ViewStyle to a page item.

Specified by:

applyViewStyle in interface GraphAttribute

Parameters:

componentHandle - The ComponentHandle for the page item that you want to format.

viewStyle - The ViewStyle that specifies formatting for the page item.

For internal use only. Application developers should not use this

getIntlString

public java.lang.String getIntlString(java.lang.String key)

Specified by:

getIntlString in interface DataviewCommon

Overrides:

getIntlString in class Dataview

Parameters:

key - the String that needs to be translated.

Returns:

the translated String

For internal use only. Application developers should not use this

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 DataviewCommon

Specified by:

getViewType in interface UIView

Specified by:

getViewType in class Dataview

Returns:

The constant Dataview.VIEW_TYPE_GRAPH

See Also:

DataviewConstants.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)

setDataModelType

public void setDataModelType(int dataModelType)

For internal use only. Application developers should not use this

Specifies the data model type for Scatter, Bubble and Stock Graphs. The default is DMT_DEFAULT.

getDataModelType

public int getDataModelType()

For internal use only. Application developers should not use this

Retrieves the data model type for Scatter, Bubble and Stock Graphs.

setTimeAxisDateFormat

public void setTimeAxisDateFormat(int element,
                                  java.lang.String format)

Specifies the format for a date element on the time axis.

Parameters:

element - The date element on the time axis for which to set the format. Valid constants are GraphConstants.YEAR, GraphConstants.MONTH, GraphConstants.DAY, and GraphConstants.TIME.

format - The format for the given date element. Valid constants are listed in the See Also section. Except for NONE and AUTOMATIC, the constant for an element begins with the element constant. For example, constants for month formats begin with MONTH_.

See Also:

GraphConstants.AUTOMATIC, TransferHandler.NONE, GraphConstants.YEAR_LONG, GraphConstants.YEAR_LONG_WITH_COMMA, GraphConstants.YEAR_SHORT, GraphConstants.YEAR_SHORT_WITH_APOSTROPHE, GraphConstants.MONTH_LONG, GraphConstants.MONTH_SHORT, GraphConstants.MONTH_NUMBER, GraphConstants.MONTH_SINGLE_LETTER, GraphConstants.DAY_OF_WEEK_NUMBER, GraphConstants.DAY_OF_WEEK, GraphConstants.DAY_OF_MONTH, GraphConstants.DAY_OF_WEEK_ABBR, GraphConstants.DAY_SINGLE_LETTER, GraphConstants.HOUR, GraphConstants.HOUR24, GraphConstants.HOUR_MINUTE, GraphConstants.HOUR24_MINUTE, GraphConstants.HOUR_MINUTE_SECOND, GraphConstants.HOUR24_MINUTE_SECOND

getTimeAxisDateFormat

public java.lang.String getTimeAxisDateFormat(int element)

Retrieves the format for a date element on the time axis.

Parameters:

element - The date element on the time axis for which to get the format; available constants are GraphConstants.YEAR, GraphConstants.MONTH, GraphConstants.DAY, and GraphConstants.TIME.

Returns:

The format for the specified date element. Valid constants for each element are listed in the See Also section.

See Also:

GraphConstants.AUTOMATIC, TransferHandler.NONE, GraphConstants.YEAR_LONG, GraphConstants.YEAR_LONG_WITH_COMMA, GraphConstants.YEAR_SHORT, GraphConstants.YEAR_SHORT_WITH_APOSTROPHE, GraphConstants.MONTH_LONG, GraphConstants.MONTH_SHORT, GraphConstants.MONTH_NUMBER, GraphConstants.MONTH_SINGLE_LETTER, GraphConstants.DAY_OF_WEEK_NUMBER, GraphConstants.DAY_OF_WEEK, GraphConstants.DAY_OF_MONTH, GraphConstants.DAY_OF_WEEK_ABBR, GraphConstants.DAY_SINGLE_LETTER, GraphConstants.HOUR, GraphConstants.HOUR24, GraphConstants.HOUR_MINUTE, GraphConstants.HOUR24_MINUTE, GraphConstants.HOUR_MINUTE_SECOND, GraphConstants.HOUR24_MINUTE_SECOND

setNoDataErrorText

public void setNoDataErrorText(java.lang.String text)

Set the error text to display when graph has no data. The default value is null. When the value is null or an empty string, graph will display its default translated no data message, "No Data Currently Available".

Parameters:

text - error text

getNoDataErrorText

public java.lang.String getNoDataErrorText()

Get the error text to display when graph has no data. The default value is null. When the value is null or an empty string, graph will display its default translated no data message, "No Data Currently Available".

Returns:

error text

applyFontSizes

public void applyFontSizes(float ratio)

For internal use only. Application developers should not use this

Applies font sizes to the text components based on the ratio passed in.

resetFontSizes

protected void resetFontSizes()

For internal use only. Application developers should not use this

Resets the font sizes of the text components.

setDirty

public void setDirty(boolean yesNo)

Parameters:

yesNo - a boolean isDirty flag of the dataCallback

For internal use only. Application developers should not use this

set the dataCallback's isDirty flag. When the dataCallback is dirty, the data will be read again and reformatted, next time the graph is redrawn

setFontMetricsResolver

public void setFontMetricsResolver(oracle.dss.presutil.FontMetricsResolver resolver)

Parameters:

resolver - FontMetricsResolver Graph should use

For internal use only. Application developers should not use this

Set the FontMetricsResolver, which is used to determine font metrics, such as line height and string width. If the given resolver is null, the default FontMetricsResolver will be used. The default FontMetricsResolver returns the same metrics as the FontMetrics class for a given font.

getFontMetricsResolver

public oracle.dss.presutil.FontMetricsResolver getFontMetricsResolver()

Returns:

FontMetricsResolver used by Graph

For internal use only. Application developers should not use this

Get the FontMetricsResolver used by Graph.

getDataviewCommon

public DataviewCommon getDataviewCommon()

Specified by:

getDataviewCommon in interface ExportableGraph

Returns:

view being exported

For internal use only. Application developers should not use this

Get the view being exported.

getMetadataStyle

public ViewStyle getMetadataStyle(java.lang.Object metaData,
                                  ViewStyle initStyle,
                                  int edge,
                                  int depth,
                                  int index)

Specified by:

getMetadataStyle in interface ExportableGraph

Parameters:

metaData - member metadata

initStyle - initial ViewStyle for the member

edge - edge member is on

depth - layer member is in

index - slice member is in

Returns:

resulting ViewStyle for the given member

For internal use only. Application developers should not use this

Get the resulting ViewStyle for the given member.

getPagingControlViewStyle

public ViewStyle getPagingControlViewStyle()

Specified by:

getPagingControlViewStyle in interface ExportableGraph

Returns:

default paging control ViewStyle

For internal use only. Application developers should not use this

Get the default paging control ViewStyle.

startExport

public boolean startExport()

Specified by:

startExport in interface ExportableGraph

Returns:

true if the view can begin exporting, false if not

For internal use only. Application developers should not use this

Inform the view that an export has started.

endExport

public void endExport()

Specified by:

endExport in interface ExportableGraph

For internal use only. Application developers should not use this

Inform the view that an export has ended.

isExporting

public boolean isExporting()

Specified by:

isExporting in interface ExportableGraph

Returns:

true if exporting, false if not

For internal use only. Application developers should not use this

Determine if this view is currently exporting to Excel.

getDrillState

protected boolean getDrillState(int edge,
                                int slice)

For internal use only. Application developers should not use this

retrieves the drill state for the specified edge and slice

isPie

protected boolean isPie(int graphType)

Parameters:

graphType - integer representing the graph type

For internal use only. Application developers should not use this

Determine whether the graph is Pie or Ring graph

isExcelOrDeskTop

public boolean isExcelOrDeskTop()

For internal use only. Application developers should not use this

getThickPFJ

public oracle.dss.graph.pfj.ThickPFJ getThickPFJ()

Specified by:

getThickPFJ in interface ThickGraph

For internal use only. Application developers should not use this

isDrillingSupported

public boolean isDrillingSupported()

Specified by:

isDrillingSupported in interface DataviewAttributes

Overrides:

isDrillingSupported in class Dataview

Returns:

true if drilling is supported, false if drilling is not supported.

For internal use only. Application developers should not use this

Determines whether drill is supported for the current graph type

getDrillParameters

public int[] getDrillParameters(ComponentHandle handle)

For internal use only. Application developers should not use this

Returns drill parameters for a given component The return value will be null if component is not drillable Otherwise, an integer array will be returned, where: index 0 - Edge parameter index 1 - Layer parameter index 2 - Slice parameter

getAlternativeText

public java.lang.String getAlternativeText(ComponentHandle handle)

For internal use only. Application developers should not use this

returns alternative text for drill related components

applyStyle

protected void applyStyle(CustomStyle style,
                          int reset,
                          boolean isStyleDefault)
                   throws oracle.dss.util.xml.BIIOException,
                          oracle.dss.util.xml.BISAXException,
                          oracle.dss.util.xml.BIParseException

Throws:

oracle.dss.util.xml.BIIOException

oracle.dss.util.xml.BISAXException

oracle.dss.util.xml.BIParseException

For internal use only. Application developers should not use this

getStyle

public CustomStyle getStyle()

Returns:

The last style that has been set on this graph.

For internal use only. Application developers should not use this

Retrieves the current style for this graph. This method returns the last style that was set on this graph. Any style property changes that have been made since the style was set are not included in the style that this method returns.

setStyle

public void setStyle(CustomStyle style)
              throws oracle.dss.util.xml.BIIOException,
                     oracle.dss.util.xml.BISAXException,
                     oracle.dss.util.xml.BIParseException

Parameters:

style - The style to set on this graph.

Throws:

oracle.dss.util.xml.BIIOException

oracle.dss.util.xml.BISAXException

oracle.dss.util.xml.BIParseException

For internal use only. Application developers should not use this

Applies a style to this graph.

getStylePath

public java.lang.String getStylePath()

Retrieves the path name for the current style. This method returns the full path name of the XML file that was set on this graph through the setStylePath method.

Returns:

The path for the current style, or null if setStylePath has not been called.

See Also:

setStylePath(java.lang.String)

setStylePath

public void setStylePath(java.lang.String stylePath)
                  throws java.io.IOException,
                         oracle.dss.util.xml.BIIOException,
                         oracle.dss.util.xml.BISAXException,
                         oracle.dss.util.xml.BIParseException

Applies a style to this graph based on the specified XML file. This method also sets the StylePath property.

Graph uses the getResourceAsStream method of its ClassLoader to look for the style XML file. The search order is described in the documentation for java.lang.ClassLoader.

The standard styles are packaged in bipres.jar under /oracle/dss/graph/styles/.

Parameters:

stylePath - The path of the XML to set as a style on this graph.

Throws:

java.io.IOException - If there is a problem loading the specified XML file.

oracle.dss.util.xml.BIIOException - If there is a problem reading the XML file.

oracle.dss.util.xml.BISAXException - If a general SAX exception occurs in parsing the XML.

oracle.dss.util.xml.BIParseException - If the XML syntax is incorrect, or if the XML is not valid according to the DTD that is specified in the XML.

createStyle

public CustomStyle createStyle()

Returns:

The style.

For internal use only. Application developers should not use this

Retrieves a style from the style property settings in this graph. This method collects all of the values of style propertes that have been set since the last time a style has been applied or since the graph was instantiated.

editStyle

public void editStyle(CustomStyle style)
               throws oracle.dss.util.xml.BIIOException,
                      oracle.dss.util.xml.BISAXException,
                      oracle.dss.util.xml.BIParseException

Parameters:

style - The style to edit.

Throws:

oracle.dss.util.xml.BIIOException

oracle.dss.util.xml.BISAXException

oracle.dss.util.xml.BIParseException

See Also:

updateStyle(oracle.dss.util.CustomStyle)

For internal use only. Application developers should not use this

Opens an existing style for editing. To save the edits that you make, call the updateStyle method.

createGraphStyle

public CustomStyle createGraphStyle()

Returns:

The style.

For internal use only. Application developers should not use this

Retrieves a new style from XML properties.

updateStyle

public void updateStyle(CustomStyle style)

Parameters:

style - The style to update.

See Also:

editStyle(oracle.dss.util.CustomStyle)

For internal use only. Application developers should not use this

Updates an existing style. Call this method to save changes to a style that you passed to the editStyle method.

getStyleXML

public java.lang.String getStyleXML()

For internal use only. Application developers should not use this

this method returns null if no property is overridden????

getBaseStyle

public CustomStyle getBaseStyle()

Returns:

The base style for this graph.

For internal use only. Application developers should not use this

Retrieves the base style of this graph.

setBaseStyle

public void setBaseStyle(CustomStyle baseStyle)

Parameters:

style - The base style for this graph.

For internal use only. Application developers should not use this

Specifies the base style for this graph.

set3DEffect

public void set3DEffect(boolean yesNo)

Parameters:

yesNo - true to set 3D effect on.

For internal use only. Application developers should not use this

Specifies whether to set the 3D effect on the graph

is3DEffect

public boolean is3DEffect()

For internal use only. Application developers should not use this

Indicates whether the current graph has 3D effect

exportGraphToStream

public boolean exportGraphToStream(java.io.OutputStream out)

Specified by:

exportGraphToStream in interface ExportableGraph

Parameters:

out - OutputStream object to use in exporting the graph

Returns:

boolean True if the export completed successfully, False otherwise

For internal use only. Application developers should not use this

Called when the graph must be rendered to the provided OutputStream