dvt:pieGraph pieGraph pie graph

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


Use the <dvt:pieGraph> tag to create an ADF data visualization pie graph. In a Pie Graph one group of data is represented as sections of a circle, making the circle look like a sliced pie. There are many types of pie graphs. Here is a list of subtypes that a <dvt:pieGraph> tag supports -

The <dvt:pieGraph> tag provides a complete set of attributes and child tags required to create any pie graph. Use the Pie 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 slice colors, for instance.

The Graph's layout is dominated by five major components: title, subtitle, footnote, legendArea, and pieFrame. The pieFrame 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 pieFrame 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. A Pie or a Ring graph displays one group of data, each slice representing a different series. This graph type requires one column in the grid, with multiple rows, one for each slice. Multiple Pie or multiple Ring graphs show one pie for each group, or column, of data. Pie graphs can be drawn with just one data point, though such graphs may not be useful. In case of Pie Bar or Ring Bar graphs, each slice represents a series total. The data for one such slice is represented in further detail by a percentage stacked bars.


The rows in the grid usually appear as the series in a 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 slice colors. 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, pieSliceExplode (separate a slice away from the rest of a Pie graph), etc.

Here is an example of a Pie graph with a <dvt:seriesSet> tag that defines default border color for all slices. The <dvt:series> child tag with pieSliceExplode attribute is used to separate first slice away from the rest of the Pie. -

                <dvt:pieGraph id="pieGraph1" subType="PIE">
                  <dvt:seriesSet defaultBorderColor="#336699"">
                    <dvt:series index="0" pieSliceExplode="50">


Use the graph's "seriesEffect" attribute to add predefined gradient effects on slices of the Pie.

Series highlighting

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


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.


The legend displays the marker and associated color of each series. It also displays the legend title. 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.


Pie graphs plot the data within the pieFrame. The pieFrame integrates the slice labels, the slices, and the pie label. The PieFrame is divided into multiple sections when displaying Multiple Pie or Multiple ring graph. The number sections in the frame equal to the number groups in the data. In case of Pie Bar or Ring Bar graphs the pie frame also displays bars with vertical data axis (y1Axis). The y1Axis is associated with y1TickLabel and y1Title

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.


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.


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 slice in a pie graph using a clickListener to display data value :

                <dvt:pieGraph >
                  <dvt:shapeAttributes component="GRAPH_SLICE" clickable="true" clickListener="#{clickListener.processClick}"/>

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.


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 labels. Use attributes "markerTooltipType", "seriesTooltipLabelType", and "groupTooltipLabelType" to customize tooltip content. The graph automatically displays tooltips for components like title, subtitle, footnote, and legendText, when their text is truncated. There is no option to change this behavior.


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.


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:pieGraph> tag can have the following child tags:

<activeDataProperties>, <background>, <graphFootnote>, <graphPieFrame>, <graphSubtitle>, <graphTitle>, <legendArea>, <legendText>, <legendTitle>, <seriesSet >, <shapeAttributesSet>, <slice>, <sliceLabel>, <pieFeeler>, <pieLabel>


Type Phases Description
oracle.adf.view.faces.bi.event.ClickEvent Apply Request Values

An event which indicates that a click action occurred in a component. A ClickEvent is enabled by adding the ClickListener to the graph.

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 events might include the width of a column that supported client-side resizing.


Name Type Supports EL? Description
advancedPropertiesXML String Yes

Specifies path to an XML file that contains settings for graph properties that are not exposed in the pieGraph 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.
animationDuration int Yes Specifies the animation duration in milliseconds.
animationIndicators String Yes

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 String Yes

Specifies the type of data change animation to apply. Valid values are:

  • NONE - Apply no data change animation effects
  • AUTO (Default) - Apply Active Data Service (ADS) data change animation events.
  • ON - Apply Partial Page Refresh (PPR) data change animation events.
animationOnDisplay String Yes

Specifies the type of initial rendering effect to apply. Valid values are:

  • NONE (Default)- Do not show any initial rendering effect
  • AUTO - Apply an initial rendering effect automatically chosen base on graph or gauge type
animationUpColor String Yes Specifies the color used to indicate that a data value has increased. Enter values in RGB hexadecimal.
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
contentDelivery String Yes 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.
drillingEnabled boolean Yes Indicates whether drilling is enabled.
dynamicResize String Yes Specifies whether to resize the component based on its container size. Valid values are FIXED_SIZE (default) and DYNAMIC_RESIZE.
flashDefaultFontLoading String Yes 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.
id String No the identifier for the component. The identifier must follow a subset of the syntax allowed in HTML:
  • Must not be a zero-length String.
  • First character must be an ASCII letter (A-Za-z) or an underscore ('_').
  • Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').
imageFormat String Yes

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 - Generates Flash if a supported Flash player is found on the client.
imageHeight int Yes Specifies the height of the graph image in pixels.
imageWidth int Yes Specifies the width of the graph image in pixels.
inlineStyle String Yes Style of the outer element(enclosing div) of the component
partialSubmit boolean Yes

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.
rendered boolean Yes Specifies whether the component is rendered
seriesEffect String Yes

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 String Yes

Specifies the behavior when the mouse rolls over one bar in a series. Valid value 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.
shortDesc String Yes Specifies the short description of the graph. This is particularly useful in the screen reader mode.
style String Yes

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:

  • PIE - Pie graph
  • PIE_BAR - Pie-Bar graph
  • PIE_MULTI - Multiple pie graph
  • RING - Ring graph
  • RING_BAR - Ring-Bar graph
  • RING_MULTI - Multiple ring 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

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

title String Yes 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 String Yes

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.