Oracle Fusion Middleware Data Visualization Tools Tag Reference for Oracle ADF Faces
11g Release 2 (11.1.2.0.0)

E17490-01

<dvt:comboGraph>

dvt:comboGraph comboGraph combo graph

UIComponent class: oracle.adf.view.faces.bi.component.graph.UIGraph
Component type: oracle.dss.adf.graph.Graph (comboGraph)

Overview

Use the <dvt:comboGraph> tag to create an ADF data visualization combination graph. A combination graph is one in which data is represented as combination of bar, line, or area markers. A <dvt:comboGraph> tag supports 2 subtypes -

The <dvt:comboGraph> tag provides a complete set of attributes and child tags required to create any combination graph. Use the graph's "subType" attribute to specify the graph type. One of the most commonly useful child tags is the <dvt:series> tag. Use a set of <dvt:series> tags, within a <dvt:seriesSet> tag, to change bar, line or area colors, for instance.

The Graph's layout is dominated by five major components: title, subtitle, footnote, legendArea, and plotArea. The plotArea plots the data and is always rendered, but the other four components are optional, and can be placed in different locations within the graph. Within the area allocated to the whole graph, space is first allocated to the titles, if present. The title and the subtitle are displayed side by side at the top of the graph by default, and the footnote is displayed at the bottom of the graph. Space is next allocated for the legendArea, which displays the marker color and label associated with each series. It can be positioned in one of four locations: left, right, top and bottom. The legend can use as much as 40% of the graph space. The plotArea and its labels occupy the remaining space.

Data Model

Use the data binding dialogs to bind the simple graph tags to a data control, which is typically based on a rowset (see data binding documentation for details). Another common way to provide data for the graph is to use the "tabularData" attribute to create a grid. This requires use of a backing or managed bean.

The graph requires a simple grid of numeric data points to plot a graph. The grid's row and column labels are used to identify components within the graph. By default, the rows appear as the series and the columns appear as the groups. In a combination graph type every marker may have a different requirement for minimal number of groups. For example, a dataline requires at least two groups (group being a single column in this case) of data because a line segment requires at least two points to define it. An area marker has the same requirement, being line with the area underneath it filled in. A bar can be drawn with just one data point. Combination graphs need at least two series to show different data markers.

Series

The rows in the grid usually appear as the series in a combination graph. The graph legend identifies each series in the graph, with a labeled symbol that shows color and other appropriate attributes. Use a set of <dvt:series> tags, within a <dvt:seriesSet> tag, to change bar or line colors, for instance. The <dvt:seriesSet> tag contains attributes that change the default attributes for all series. The <dvt:seriesSet> tag also contains the <dvt:series> tags that override attributes for individual series. Commonly used series attributes are - color, lineWidth (change dataline width on a Line graph), marker type (change Marker to either bar, line, or area), assignedToY2 (change axis assignment on a Dual-Y graph), markerShape, etc.

Here is an example of a Combo graph with a <dvt:seriesSet> tag that defines default marker type bar for all series. The <dvt:series> child tag overrides this marker type to area for the first series in the graph. -

                <dvt:comboGraph id="comboGraph1" subType="COMBINATION_VERT_ABS">
                  <dvt:seriesSet defaultMarkerType="MT_BAR">
                    <dvt:series index="0" markerType="MT_AREA"/>
                  </dvt:seriesSet>
                </dvt:comboGraph>
        

SeriesEffect

Use the graph's "seriesEffect" attribute to add predefined gradient effects on series related components such as bars, areas, and 3D datalines.

Series highlighting

Use the graph's "seriesRolloverBehavior" attribute to turn on highlighting behavior when the cursor moves over a series marker or a series-specific legend component.

MarkerText

The markerText tag defines if and where the marker text should appear in relation to series markers. Use the attribute "markerTextPlace" to specify the location of the text.

Titles

The title and the subtitle, if present, are displayed side by side at the top of the graph by default. Use the graph's "customLayout" attribute to change this default setting. The footnote, if present, is displayed at the bottom of the graph.

Legend

The legend displays the marker and associated color of each series. It also displays the legend title and lists any reference objects that are present. The legend can be positioned in one of four different locations: left, right, top and bottom. Use the attribute "alongGraphEdge" to attach it to the edge of the graph. The legend can be removed with the "rendered" attribute.

PlotArea and Axes

Combination graphs plot the data within the plotArea. The plotArea integrates the axes and the data markers. Generally the horizontal axis is an ordinal/category axis (o1Axis), which shows categories like cities or products. This axis can be a time axis if a graph is displaying dates (instance of java.util.Date). The primary vertical axis is a data axis (y1Axis). Dual-Y graphs typically also display the y2Axis. Each axis, whether ordinal or data, has tick labels and an axis title associated with it. The y1Axis is associated with y1TickLabel and y1Title, for instance. See related component tags for detail.

Number Formatting

DVT combination graph supports number formatting on its Y1 and Y2 axis tick labels as well as for marker text that appear on the data markers. Users can customize the number formatting by adding <af:convertNumber> to the <dvt:y1TickLabel>, <dvt:y2TickLabel>,<dvt:y1Format>, and <dvt:y2Format> tags. The following is an example of how to configure these tags:

            <dvt:comboGraph value="#{binding.dataModel}">
               <dvt:markerText>
                 <dvt:y1Format>
                     <af:convertNumber pattern="#{appPrefs.markerTextPattern}" />
                 </dvt:y1Format>
                </dvt:markerText>
                <dvt:y1TickLabel>
                     <af:convertNumber pattern="#{appPrefs.tickLabelPattern}" />
                </dvt:y1TickLabel>
             </dvt:comboGraph>
            

Automatic Scaling and Precision

Graph automatically determines the scale ( e.g. 4K ) and precision ( e.g. show 2 decimal points - 0.25 ) based on the values that are being displayed. This automatic formatting still occurs when <af:convertNumber> is specified. The graph tags that support <af:convertNumber> child tags ( e.g. <dvt:y1TickLabel>, <dvt:y1Format>, ...) also have scaling and autoPrecision attributes that can be used to control graph's automatic number formatting. By default, scaling="auto" means graph will auto-calculate the scale. For example, 40,000 will be formatted as "40K". By default, autoPrecision="on" means that graph will auto-calculate the precision of the number. For example, 0.230546 will be displayed as "0.23". If the autoPrecision is 'on' then all of the <af:convertNumber> fraction digit settings ( e.g. min/maxFractionDigits or pattern) are ignored.

Categorical attributes formatting

Graph typically uses categorical attributes ( e.g. product, geography, year, etc. ) on an ordinal axis and for the marker tooltips. To specify how categorical attributes should be formatted, an application needs to specify <dvt:attributeFormat> tag for each categorical attribute to be formatted. The <dvt:attributeFormat> tag needs to identify the categorical attribute that is being formatted by name as well as specify a converter to use when formatting the attribute. For example,

            <dvt:comboGraph value="#{bindings.EmpView1.graphModel}" subType="COMBINATION_VERT_ABS">
                      <dvt:attributeFormat id="af1" name="Hiredate">
                          <af:convertDateTime pattern = "yyyy-MM-dd hh:mm:ss a"  timeZone="US/Pacific"/>
                      </dvt:attributeFormat>
             </dvt:comboGraph>
            

The name of the categorical attribute is the name of the attribute/layer that was added to the Graph DataModel. The Graph model can be set declaratively by updating the pagedef. Here is the associated view pagedef for the above graph:

             <graph IterBinding="EmpView1Iterator" id="EmpView1"
                       xmlns="http://xmlns.oracle.com/adfm/dvt" type="COMBINATION_VERT_ABS">
                <graphDataMap leafOnly="true">
                    <series>
                      <data>
                         <item value="Bonus"/>
                      </data>
                    </series>
                    <groups>
                       <item value="Hiredate"/>
                    </groups>
                </graphDataMap>
             </graph>
            

Configuring Date Formatting

If there is a single categorical Date attribute being displayed on the O1Axis, then Graph displays a TimeAxis instead of the typical O1 / Ordinal Axis. The TimeAxis will show dates in a hierarchical format as opposed to as a single label on an O1 Axis ( e.g. June 27, 2001 ). To show a single label on the O1 Axis, the TimeAxis should be turned off ( e.g. timeAxisType="TAT_OFF" ) and a <dvt:attributeFormat> should be used to specify the date format.

Time Axis

The graph displays a time axis when dates (object type java.util.Date) are specified for the column labels. Several timeXXX attributes are defined on the graph tag to customize the time axis. The child tag timeAxisDateFormat controls the format in which the time axis labels are displayed.

Time Selector

Use the <dvt:timeSelector> tag to activate the graph's TimeSelector feature, which allows an end user to select a time range on a time axis. This is typically used in master-detail graphs where the selected time range in the master graph drives the content of a detail graph, table, or other component. A backing or managed bean is required to use this feature.

Graph Size

The default graph size is 300 pixels tall by 400 pixels wide. Change this using the "inlineStyle" attribute. Set inlineStyle="width:500px; height:350px;", for instance, to change the graph size to 350 pixels tall by 500 pixels wide. The width and the height can also be specified in percent. Use percent for height only when the graph is added to an explicitly sized container or one that manages layout, otherwise graph will behave differently for different browsers. Use the "dynamicResize" attribute to resize the graph based on its container size.

Animation

Several graph types support animation. Animate the graph during initial rendering using the attribute "animationOnDisplay". The graph can also be animated when the data changes using the attribute "animationOnDataChange". Use the attribute "animationDuration" to specify the animation duration. The indicator colors for increase and decrease in the data value are specified by attributes "animationUpColor" and "animationDownColor", respectively.

Alerts

Use a <dvt:alert> tag for the graph to define an additional data point that needs to be highlighted with a separate symbol, such as for an error or warning. Wrap all <dvt:alert> tags in a <dvt:alertSet> tag.

Annotations

Use a <dvt:annotation> tag to provide an annotation for a specific data point. Multiple annotations can be defined for a single data point. Wrap all <dvt:annotation> tags in a <dvt:annotatinSet> tag.

ReferenceObject

Use the <dvt:referenceObject> tag to create either a reference line or a reference area. The reference object can be associated with any data axis or series. Multiple reference objects can be associated with a single series or an axis. Use the attribute "location" to specify whether the referenceObject should displayed in the front or the back of the data markers. Use graph's "referenceObjectDisplay" attributes to specify when the referenceObject would be displayed: the value "RO_AUTOMATIC" displays it only when the mouse hovers over the component with which the referenceObject is defined. Wrap all <dvt:referenceObject> tags in a <dvt:referenceObjectSet> tag.

Interactivity

Use the shapeAttributes tag to specify interactivity on an individual graph component. A backing or managed bean is required to use this feature.

Here is an example of a 2D marker using a clickListener to display data value :

            <dvt:comboGraph >
                 <dvt:shapeAttributesSet>
                  <dvt:shapeAttributes component="GRAPH_TWODMARKER" clickable="true" clickListener="#{clickListener.processClick}"/>
                 </dvt:shapeAttributesSet>
                </dvt:comboGraph>
        

The "processClick" method in the backing bean will look like:

        public void processClick(ClickEvent event) {   
                ComponentHandle handle = event.getComponentHandle();
                if (handle instanceof DataComponentHandle) {
                        DataComponentHandle dhandle = (DataComponentHandle)handle;
                        System.out.println("Data value: " + dhandle.getValue(DataComponentHandle.UNFORMATTED_VALUE).toString());
                }
        }
        

Wrap all <dvt:shapeAttributes> tags in a <dvt:shapeAttributesSet> tag.

Context Menus

Context menus can be defined by using any of the context menu facets that are defined on the graph. The "bodyContextMenu" facet specifies a context menu that is displayed on any non-selectable object within the component. The "contextMenu" facet specifies a context menu that is displayed on any selectable object within the graph. The "multiSelectContextMenu" facet specifies a context menu that is displayed when multiple objects are selected. Each facet supports only a single child component. Selection must be enabled and supported for the specific graph type in order for an object to be considered selectable. Context Menus are currently only supported in Flash.

Due to technical limitations when using the Flash rendering format, the context menu contents are currently displayed using the Flash Player's context menu. This imposes several limitations defined by the Flash Player:

Additionally, since Flash's request for context menu items is a synchronous call, so a server request to evaluate EL is not possible when the context menu is invoked. To provide context menus that vary by selected object, the menus will be pre-fetched if the context menu popup uses contentDelivery="lazyUncached". For context menus that may vary by state, this means that any EL expressions within the menu definition will be called repeatedly at render time, with different selection and currency states. When using these context menus that are pre-fetched, the application must be aware of the following:

Tooltips

Tooltips are useful to display identification and or detail information for data markers. They can be very useful in smaller graphs without enough space to display markerText. Use attributes "markerTooltipType", "seriesTooltipLabelType", and "groupTooltipLabelType" to customize tooltip content. The graph automatically displays tooltips for components like title, subtitle, footnote, legendText, and annotations when their text is truncated. There is no option to change this behavior.

Zoom and Scroll

Give end users the ability to zoom in on and scroll through a data set that may be too large or complex to fit comfortably within the area allocated to the graph using the "zoomDirection" attribute. Zoom and scroll may be enabled for horizontal and or vertical axes. The "scrollbarPresenceGroups" attribute provides control over when a scroll bar appears for the group axis: the horizontal axis in Bar graphs, for instance. The "scrollbarPresenceX1", "scrollbarPresenceY1", and "scrollbarPresenceY2" attributes control the appearance of scroll bars for the various data axes.

Font

The <dvt:graphFont> tag is used for font formatting. Text color, style, size, and font name can be specified using this tag. This tag is used as a child tag for any of the graph's text component tags. All text component tags have other formatting attributes like horizontal and vertical alignment, text string, and whether or not the text should be rendered.

SpecialEffects

Use the <dvt:specialEffects> tag to specify gradient effects on many graph subcomponents. This tag must be defined as a child tag of the component tag and is not available for any text components. Note that the "seriesEffect" attribute setting always overrides the special effects settings.

Relationship with other tags

The <dvt:comboGraph> tag can have the following child tags:

af:dropTarget, <alertSet>, <annotationSet>, <attributeFormat>, <background>, <graphFootnote>, <graphPlotArea>, <graphSubtitle>, <graphTitle>, <legendArea>, <legendText>, <legendTitle>, <markerText>, <o1Axis>, <o1MajorTick>, <o1TickLabel>, <o1Title>, <referenceObjectSet>, <seriesSet >, <shapeAttributesSet>, <timeAxisDateFormat>, <timeSelector>, <y1Axis>, <y1BaseLine>, <y1MajorTick>, <y1Title>, <y1TickLabel>, <y2Axis>, <y2BaseLine>, <y2MajorTick>, <y2TickLabel>, <y2Title>

Geometry Management

Screen Shot(s)




Events

Type Phases Description
oracle.adf.view.faces.bi.event.ClickEvent Apply Request Values The ClickEvent is delivered when the component is clicked.
org.apache.myfaces.trinidad.event.AttributeChangeEvent Invoke Application,
Apply Request Values
Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change event might include the width of a column that supported client-side resizing.

Supported Facets

Name Description
bodyContextMenu popup component containing the context menu that will be shown on right click on any non-selectable object within the component. The af:popup must contain an af:menu to display the context menu. This facet supports only a single child component.
contextMenu popup component containing the context menu that will be shown on right click of any selectable data object within the component. The af:popup must contain an af:menu to display the context menu. This facet supports only a single child component.

Attributes

Name Type Supports EL? Description
advancedPropertiesXML String Yes

This attribute is deprecated. The UIComponent APIs should be used instead. Specifies path to an XML file that contains settings for graph properties that are not exposed in the areaGraph tag.
For example, /myfiles/graph.xml
Path from web application root must be provided.

animationDownColor String Yes Specifies the color used to indicate that a data value has decreased. Enter values in RGB hexadecimal. The default color is red (#FF3300).
animationDuration int Yes Default Value: 1000

Specifies the animation duration in milliseconds. The default value is 1000.
animationIndicators int Yes Valid Values: NONE, ALL
Default Value: ALL

Specifies the type of data change indicators to show. Valid values are:
  • NONE - Show no data change indicators
  • ALL - (Default) Show all data change indicators
animationOnDataChange int Yes Valid Values: none, activeData, auto, alphaFade, conveyorFromLeft, conveyorFromRight, cubeToLeft, cubeToRight, flipLeft, flipRight, slideToLeft, slideToRight, transitionToLeft, transitionToRight, zoom
Default Value: activeData

Specifies the type of animation to apply on data change. Valid values for animating data objects, such as bars and lines, are:
  • none - Does not apply data change animation effects
  • activeData - (Default) Applies animation for Active Data Service (ADS) data change events.
  • auto - Applies animation for Partial Page Refresh and ADS events.
Animation can also be performed on the entire component, allowing for effects such as slideshow transitions. These animations will be performed on any Partial Page Refresh event, and valid values are:
  • alphaFade
  • conveyorFromLeft
  • conveyorFromRight
  • cubeToLeft
  • cubeToRight
  • flipLeft
  • flipRight
  • slideToLeft
  • slideToRight
  • transitionToLeft
  • transitionToRight
  • zoom
animationOnDisplay int Yes Valid Values: none, auto, alphaFade, conveyorFromLeft, conveyorFromRight, cubeToLeft, cubeToRight, flipLeft, flipRight, slideToLeft, slideToRight, transitionToLeft, transitionToRight, zoom
Default Value: none

Specifies the type of animation to apply when the component is initially displayed. Valid values are:
  • none - (Default) Does not apply any initial rendering effect
  • auto - Applies an initial rendering effect automatically chosen based on the graph type
  • alphaFade
  • conveyorFromLeft
  • conveyorFromRight
  • cubeToLeft
  • cubeToRight
  • flipLeft
  • flipRight
  • slideToLeft
  • slideToRight
  • transitionToLeft
  • transitionToRight
  • zoom
animationUpColor String Yes Specifies the color used to indicate that a data value has increased. Enter values in RGB hexadecimal. The default color is cyan (#0099FF).
attributeChangeListener javax.el.MethodExpression Only EL a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
binding String Only EL

Specifies a binding reference to store a specific instance of UIGraph from a backing bean. Set this attribute only to access code in a backing bean. For example, to reference a graph component in the SampleGraph class, use the following code: binding="#{sampleGraph.graph}"

clickAction String Yes Refers to a backing bean method that performs navigation processing for the graph and returns an outcome String. Or a static outcome String can be specified. The JSF NavigationHandler selects the page to display next by matching the outcome String against the navigation rules in the application configuration resource file. The application writes the Navigation rules.
clickListener String Yes The listener interface for receiving click events on the graph components. Here is an example of clickListener implementation that displays a component name on a click action -
    public void clickListener (ClickEvent event){
        ComponentHandle handle = event.getComponentHandle();
        System.out.println(handle.getName()+" is clicked.");
    }
        
contentDelivery String Yes Valid Values: whenAvailable, lazy, immediate
Default Value: whenAvailable

Specifies whether to fetch content with page load or after page load. Valid values are lazy (default) and immediate.
customLayout String Yes

Specifies custom layout information when the graph automatically places and sizes its components. Valid values are:

  • CL_NONE - Do not use any of the other custom layout attribute values
  • CL_TITLES_SIDEBYSIDE - Display Title and subtitle side by side instead of the subtitle below the title
  • CL_TITLE_SEPARATOR - Display title separator under the titles
customizationId String Yes This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
dataSelection String Yes Valid Values: none, single, multiple
Default Value: none

Determines the data selection mode for the graph. Valid values are:

  • none: no selection
  • single: single selection
  • multiple: multiple selection
drillingEnabled boolean Yes Default Value: false

Indicates whether drilling is enabled.
dynamicResize String Yes Valid Values: FIXED_SIZE, DYNAMIC_SIZE
Default Value: FIXED_SIZE

Specifies whether to resize the component based on its container size. Valid values are FIXED_SIZE (default) and DYNAMIC_RESIZE.
emptyText String Yes Specifies error text to display when graph has no data.
flashDefaultFontLoading int Yes Default Value: FLASH_DEFAULT_FONT_LOADING_ALL

Specifies whether default fonts are loaded in FLASH from the middle tier. Valid values are FLASH_DEFAULT_FONT_LOADING_ALL or FLASH_DEFAULT_FONT_LOADING_NONE. The default value is FLASH_DEFAULT_FONT_LOADING_ALL.
groupTooltipLabelType int Yes Valid Values: TLT_MEMBER, TLT_DIM_MEMBER, TLT_NONE
Default Value: TLT_MEMBER

Specifies whether group information for a graph appears in tooltips and, if so, identifies the kind of group information that appears in tooltips. Valid values are:
  • TLT_NONE - No group information appears in tooltips.
  • TLT_MEMBER - (Default) Only the dimension member for a group appears in tooltips.
  • TLT_DIM_MEMBER - Both dimension name and dimension member for a group are displayed in tooltips.
hideAndShowBehavior String Yes Valid Values: none, withRescale, withoutRescale
Default Value: none

Specifies the hide and show behavior in the graph. If the behavior is not "none", clicking on the legendText or legendMarker will hide the corresponding series. Note that the last series will not be hidden. Valid values are:

  • none (Default) - no hide and show behavior used
  • withRescale - rescales the graph after hiding a series
  • withoutRescale - does not rescale the graph after hiding a series
id String Yes Specifies the identifier for the component
imageFormat int Yes Valid Values: FLASH, PNG, PNG_STAMPED, AUTO
Default Value: FLASH

Specifies the format of graph image. Valid values are:

  • PNG - PNG image format.
  • FLASH - (Default) FLASH image format.
  • PNG_STAMPED - PNG image with no javascript. This must be used when using graph in ADF table cells via stamping.
  • AUTO - (Deprecated) Use the flash-player-usage ADF configuration parameter instead.
imageHeight int Yes Default Value: 300

This attribute is deprecated. Use inlineStyle attribute to specify the image width and height instead. For examples: inlineStyle = "width:500px; height:350px;".

The default height is 300 pixels.

imageWidth int Yes Default Value: 400

This attribute is deprecated. Use inlineStyle attribute to specify the image width and height instead. For examples: inlineStyle = "width:500px; height:350px;".

The default width is 400 pixels.

inlineStyle String Yes Style of the outer element(enclosing div) of the component
markerTooltipTemplate String Yes Provides a declarative way to customize the tooltips that appear on the graph. By setting the markerTooltipTemplate attribute to a tokenized string, an application can quickly format all the marker tooltips. This feature is a more performant alternative to the customTooltipCallback, since tokens can be sent to the client instead of preconstructed tooltip strings. This reduces the graph payload significantly, especially for large datasets.

The markerTooltipTemplate attribute accepts a String that may contain any number of a set of predefined tokens. When the tooltips are generated, the tokens are replaced with the information corresponding to each marker. Valid tokens are:

  • NEW_LINE - inserts a new line
  • SERIES_LABEL - the series label for the series of this marker
  • GROUP_LABEL - the group label for the group of this marker
  • X_VALUE - the X value of a scatter or bubble marker
  • Y_VALUE - the Y value of this marker (if this marker has a y value)
  • Z_VALUE - the Z value (bubble size) of a bubble marker
  • PIE_VALUE - the value of a pie slice
  • PIE_PERCENT - pie slice percentage value
  • ACTUAL_VALUE - the actual value for a funnel slice
  • TARGET_VALUE - the target value for a funnel slice
  • HIGH_VALUE - the high value for a stock marker
  • LOW_VALUE - the low value for a stock marker
  • CLOSE_VALUE - the close value for a stock marker
  • OPEN_VALUE - the open value for a stock marker
  • VOLUME_VALUE - the volume value for a stock volume marker
  • CUM_VALUE - the cumulative stacked value for a stacked graph
  • CUM_PERCENT - the cumulative percentage value for a stacked percent graph, pareto graph
markerTooltipType int Yes Valid Values: MTT_NONE, MTT_VALUES, MTT_CUM_VAL, MTT_PERCENT_VAL, MTT_TEXT, MTT_PERCENT_VAL_VALUES, MTT_PERCENT_VAL_TEXT, MTT_PERCENT_VAL_VALUES_TEXT, MTT_VALUES_TEXT
Default Value: MTT_VALUES

Specifies whether tooltips are displayed for markers and, if so, identifies the kind of information that appears in the tooltips. Valid values for marker tooltips are:
  • MTT_NONE - Displays no tooltips for markers.
  • MTT_CUM_VAL - Displays the cumulative data value (stacked graphs only).
  • MTT_PERCENT_VAL - Displays the percentage data value (pie slice only).
  • MTT_PERCENT_VAL_TEXT - Displays the percentage data value (pie slice only) and text identification such as "January, Shoes".
  • MTT_PERCENT_VAL_VALUES - Displays the percentage data value (pie slice only) and data value or values.
  • MTT_PERCENT_VAL_VALUES_TEXT - Displays the percentage data value (pie slice only), data value or values, and text identification information such as "January, Shoes".
  • MTT_TEXT - Displays text identification such as "January, Shoes".
  • MTT_VALUES - (Default) Displays data value or values.
  • MTT_VALUES_TEXT - Displays data value or values and text identification such as "January, Shoes".
Note: To display series tooltip labels for a graph, you must set markerTooltipType to a value that includes text.
o1AxisTitle String Yes This attribute is deprecated. Use the child tag o1Title and its text attribute instead. Use to specify the text of the horizontal axis title.
partialSubmit boolean Yes Default Value: true

Deprecated. It is not useful anymore.

Indicates whether an action can be performed through a partial page submit. Valid values are:

  • "true" - (Default) Partial page submit is allowed.
  • "false" - No partial page submit.
partialTriggers String[] Yes the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.
renderImagemap boolean Yes Default Value: true

Indicates whether an image map should be rendered for a PNG image. The default value is true.
rendered boolean Yes Default Value: true

Specifies whether the component is rendered.
scrollListener javax.el.MethodExpression Only EL The listener interface for receiving scroll events on the graph. The event triggers when an axis of a graph is scrolled. Here is an example of scrollListener implementation that displays the range of the Y1 Axis and the O1 Axis -
    public void scrollListener (ScrollEvent event){
        double zoomMin = event.getAxisMin(ScrollEvent.Y1AXIS);
        double zoomMax = event.getAxisMax(ScrollEvent.Y1AXIS);
        int groupStart = event.getAxisStartGroup(ScrollEvent.O1AXIS);
        int groupCount = event.getAxisGroupCount(ScrollEvent.O1AXIS); 
        System.out.println("Y1 Axis has a range from "+Double.toString(zoomMin)+" to "+Double.toString(zoomMax));
        System.out.println("O1 Axis has starting group index of "+Integer.toString(groupStart)+", and a group count of "+Integer.toString(groupCount));
    }
        
selectionListener String Yes The listener interface for receiving selection events on the graph.
seriesEffect String Yes Valid Values: SE_NONE, SE_GRADIENT, SE_AUTO_GRADIENT
Default Value: SE_AUTO_GRADIENT

Determines the series effect that is used for a graph. Valid values are:

  • SE_NONE - No series effect is used for the graph. This value causes markers to appear flat and sets the graphicAntialiasing attribute to "false".
  • SE_GRADIENT - Sets a special gradient on data markers to make them look more polished and sets graphicAntialiasing to "true".
  • SE_AUTO_GRADIENT - (Default) Works similar to SE_GRADIENT except in the case of a large dataset. If the graph displays a large dataset, then the gradient is not displayed in data markers so that peformance is improved.
seriesRolloverBehavior int Yes Valid Values: RB_NONE, RB_DIM, RB_HIGHLIGHT
Default Value: RB_NONE

Specifies the behavior when the mouse rolls over one bar in a series. Valid values are:

  • RB_NONE - (Default) No series rollover behavior is enabled.
  • RB_HIGHLIGHT - Highlights all bars in the series when rollover occurs.
  • RB_DIM - Dims all bars in the series when rollover occurs
  • RB_HIGHLIGHT | RB_DIM - Produces both highlighting and dimming of all bars in the series when rollover occurs.
Note: this attribute is not supported for funnel graphs.
seriesTooltipLabelType int Yes Valid Values: TLT_MEMBER, TLT_DIM_MEMBER, TLT_NONE
Default Value: TLT_MEMBER

Specifies series information in a tooltip. Valid values are as follows:
  • TLT_NONE - Displays no series information
  • TLT_MEMBER - (Default) Displays the member label of the series in a tooltip
  • TLT_DIM_MEMBER - Displays the dimension member label of a series in a tooltip
Note: The graph displays series tooltip labels only if markerTooltipType is set to a value that includes text.
shortDesc String Yes Specifies the short description of the graph. This is particularly useful in the screen reader mode.
style String Yes

This attribute is deprecated. Skinning should be used instead. Applies a style to the graph based on the specified XML file. Valid values are the name of a standard graph style or the path of a custom XML file that you want to set as a style for this graph.

Predefined graph styles are:

  • April
  • Autumn
  • Black and White
  • Comet
  • Confetti
  • Default
  • Earth
  • Executive
  • Financial
  • Glass
  • Nautical
  • Projection
  • Regatta
  • Southwest
  • Transparent

To specify a custom style, enter the entire path to the xml file. For example: /text/myStyle.xml.

styleClass String Yes Sets a CSS style class to use for this component. Note that width and height should be set using the inlineStyle property.
subType String Yes

Specifies the type of graph. Valid values are:

  • COMBINATION_VERT_ABS - Absolute vertical combination graph
  • COMBINATION_VERT_ABS_2Y - Absolute 2Y vertical combination graph
tabularData java.util.List Yes

Specifies a list of data that the graph uses to create a grid and populate itself. The List consists of a three-member Object array for each data value to be passed to the graph. The members of each array must be organized as follows:

  • The first member (index 0) is the column label, in the grid, of the data value. This is generally a String. If the graph has a time axis, then this should be a Java Date. Column labels typically identify groups in the graph.
  • The second member (index 1) is the row label, in the grid, of the data value. This is generally a String. Row labels appear as series labels in the graph (usually in the legend).
  • The third member (index 2) is the data value, which is usually a Double.
threeDEffect boolean Yes Default Value: false

Indicates whether a graph appears to have depth. Valid values are "true" and "false" (Default).

timeAxisInterval int Yes Valid Values: CTAI_AUTOMATIC, CTAI_YEAR, CTAI_MONTH, CTAI_DAY, CTAI_HOUR, CTAI_MINUTE, CTAI_SECOND
Default Value: CTAI_AUTOMATIC

Specifies the interval along a continuous time axis only if you want to override the value that the graph calculates automatically. Valid values are as follows:
  • CTAI_AUTOMATIC - (Default) Graph calculates the interval automatically.
  • CTAI_YEAR - Sets the interval to years.
  • CTAI_MONTH - Sets the interval to months.
  • CTAI_DAY - Sets the interval to days.
  • CTAI_HOUR - Sets the interval to hours.
  • CTAI_MINUTE - Sets the interval to minutes.
  • CTAI_SECOND - Sets the interval to seconds.
timeAxisType int Yes Valid Values: TAT_DEFAULT, TAT_IRREGULAR, TAT_MIXED_FREQUENCY, TAT_DEFAULT_STRICT, TAT_IRREGULAR_STRICT, TAT_MIXED_FREQUENCY_STRICT, TAT_OFF
Default Value: TAT_DEFAULT

Indicates the type of time axis data and the expected behavior if requirements for a specific type are not met.

The following types of time axis data are supported:

  • Discrete - Observations are usually spaced at regular intervals.
  • Continuous - Observations occur at any instant of time. There are two types of continuous time axis data:
    • Irregular - Multiple series of data have observations at the same instants of time.
    • Mixed frequency - Each series has observations at different instants of time.

The constants that specify time axis type also indicate the expected behavior when the requirements for a particular time axis type are not met. The following kinds of behavior are possible:

  • Fallback position - For these constants, if the requirements for a time axis type are not met, then the graph degrades gracefully.
  • Strict position - For these constants (which are indicated by the suffix "_STRICT"), if the requrements for a particular time axis type are not met, then an error message is displayed and no fallback position is provided. To provide custom text for the error message, register oracle.dss.graph.DataErrorTextCallback with the UIGraph.

Valid values are as follows:

  • TAT_DEFAULT - (Default) Provides a discrete time axis for bar, line, area, combination, or stock graphs and for all their subtypes, if the following requirements are met: (1) Dates must be on the group edge and (2) dates must occur at regular intervals. The discrete time axis is plotted on the ordinal axis, which is also known as the O1-axis. This constant provides the following fallback position if requirements are not met: Time axis is disabled and all labels are converted to strings.

  • TAT_IRREGULAR - Provides a continuous time axis on the X-axis for bar, line, area, or combination graphs (only for subtypes dual-Y and split). Stacked graphs are not supported. Additional requirements are: (1) Dates must be on the group edge, (2) dates must occur at regular intervals (sorted or unsorted), and (3) Only one dimension (layer) can exist on the group edge, if the data is provided through DataAccess interface. This constant provides the following fallback position if requirements are not met: Dates (if present) are converted to strings, the time axis is disabled, and an AlertEvent is fired to all AlertListeners that are registered with the graph.

  • TAT_MIXED_FREQUENCY - Provides a continuous time axis on the X-axis for bar, line, area, combination, or scatter graphs for subtypes dual-Y and split. Stacked graphs are not allowed. Additional requirements are: (1) Data cells should contain dates, (2) the data to be plotted along the X-axis should be of type Date, and (3) the data to be plotted along the Y-axis must be a number.

  • TAT_DEFAULT_STRICT - Provides discrete time axis as described in TAT_DEFAULT except that no fallback position is available. If requirements are not met, then an error message is displayed.

  • TAT_IRREGULAR_STRICT - Provides continuous time axis as described in TAT_IRREGULAR except that no fallback position is available. If requirements are not met, then an error message is displayed.

  • TAT_MIXED_FREQUENCY_STRICT - Provides continuous time axis as described in TAT_MIXED_FREQUENCY except that no fallback position is available. If requirements are not met, then an error message is displayed.

  • TAT_OFF - Turns off the time axis.

timeRangeEnd java.util.Date Yes Specifies explicit time range end date for the time axis. TimeRangeMode property must be set to TRM_EXPLICIT. Only EL is supported.
timeRangeMode int Yes Valid Values: TRM_OFF, TRM_RELATIVE_LAST, TRM_RELATIVE_FIRST, TRM_EXPLICIT
Default Value: TRM_OFF

Time range mode on a time axis. Valid values are:
  • TRM_OFF - (Default) Show all the data on the time axis.
  • TRM_RELATIVE_LAST - Using relative time range from the last data point. The range can be set using the relativeTimeRange attribute. Suppose the time axis is showing Jan 2 - Jan 14 and we need only the LAST 7 days, then the following properties must be set: relativeTimeRange = (7 days in milliseconds).
  • TRM_RELATIVE_FIRST - The usage is similar to TRM_RELATIVE_LAST. Using relative time range from the first data point. The range can be set using the relativeTimeRange attribute. Suppose the time axis is showing Jan 2 - Jan 14 and we need only the FIRST 7 days, then the following properties must be set: relativeTimeRange = (7 days in milliseconds).
  • TRM_EXPLICIT - 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 attributes: timeRangeStart and timeRangeEnd.

Also see the following related properties: relativeTimeRange, timeRangeStart, and timeRangeEnd.

timeRangeStart java.util.Date Yes Specifies explicit time range start date for the time axis. TimeRangeMode property must be set to TRM_EXPLICIT. Only EL is supported.
timeRelativeRange long Yes Specifies relative time range(in milliseconds) from the last data point or from the first data point on the time axis. timeRangeMode must be set to TRM_RELATIVE_LAST or TRM_RELATIVE_FIRST. Only EL is supported.
timeZone java.util.TimeZone Yes Specifies a method reference that returns an instance of java.util.TimeZone. The graph uses this time zone when it formats dates. The following example refers to the method myTimeZone in the SampleGraph backing bean: timeZone="#{sampleGraph.myTimeZone}"
title String Yes This attribute is deprecated. Use the child tag graphTitle and its text attribute instead. Specifies the text of the title.
value String Yes Specifies the graph's data model. This must be an instance of oracle.adf.view.faces.bi.model.DataModel or oracle.adf.view.faces.bi.model.GraphDataModel
visualEffects int Yes Valid Values: NONE, AUTO
Default Value: AUTO

Specifies the type or types of visualEffect to apply. Valid values are:

  • NONE - Apply no visual effects
  • AUTO (Default) - Apply visual effects automatically based on graph or gauge type.
y1AxisTitle String Yes This attribute is deprecated. Use the child tag y1Title and its text attribute instead. Use to specify the text of the vertical axis title.
zoomListener javax.el.MethodExpression Only EL The listener interface for receiving zoom events on the graph. The event triggers when an axis of a graph is zoomed. Here is an example of zoomListener implementation that displays the range of the Y1 Axis and the O1 Axis -
    public void zoomListener (ZoomEvent event){
        double zoomMin = event.getAxisMin(ZoomEvent.Y1AXIS);
        double zoomMax = event.getAxisMax(ZoomEvent.Y1AXIS);
        int groupStart = event.getAxisStartGroup(ZoomEvent.O1AXIS);
        int groupCount = event.getAxisGroupCount(ZoomEvent.O1AXIS); 
        System.out.println("Y1 Axis has a range from "+Double.toString(zoomMin)+" to "+Double.toString(zoomMax));
        System.out.println("O1 Axis has starting group index of "+Integer.toString(groupStart)+", and a group count of "+Integer.toString(groupCount));
    }