UIComponent class: oracle.adf.view.faces.bi.component.graph.UIGraph
Component type: oracle.dss.adf.graph.Graph
Use the graph tag to create an ADF data visualization graph. This tag is sufficient to produce a graph but you can also specify custom settings for many components by including any of the child tags of the graph tag.
The Graph component can have the following children annotationSet, alertSet, o1Title, x1Title, y1Title, y2Title, y1BaseLine, y2BaseLine, x1Axis, y1Axis, y2Axis, x1TickLabel, y1TickLabel, y2TickLabel, legendArea, legendTitle, legendText, o1MajorTick, x1MajorTick, y1MajorTick, y2MajorTick, markerText, o1Axis, o1TickLabel, graphPlotArea, graphPieFrame, slice, sliceLabel, pieLabel, pieFeeler, stockMarker, volumeMarker, background, paretoLine, paretoMarker, referenceObjectSet, seriesSet, timeAxisDateFormat, graphTitle, graphSubtitle, graphFootnote, shapeAttributesSet.
The following example shows XML for a graph tag.
<dvt:graph drillingEnabled="false" barShape="CYLINDER" threeDEffect="true"
seriesTooltipLabelType="TLT_MEMBER" groupTooltipLabelType="TLT_MEMBER"
markerTooltipType="MTT_VALUES_TEXT" lineDataLineDisplayed="true" markerDisplayed="false"
graphicAntialiasing="false" textAntialiasing="false" seriesEffect="SE_NONE"
seriesObjectCount="30" graphType="BAR_VERT_CLUST2Y"
alignTickMarks="true" imageHeight="450" imageWidth="450" imageFormat="PNG"
stylePath="/oracle/dss/graph/styles/glass.xml" otherProperties="#{sampleGraph.otherProps}"
value ="#{sampleGraph.graphDataModel}" seriesRolloverBehavior="RB_DIM"
drillRequestingListener="#{sampleGraph.drillRequesting}"
drillRequestedListener="#{sampleGraph.drillRequested}"
drillAction ="drillAct" partialTriggers="b2" partialSubmit="true"/>
| Type | Phases | Description |
|---|---|---|
| oracle.adf.view.faces.bi.event.ClickEvent | Apply Request Values | The ClickEvent is delivered when the component is clicked. |
| oracle.adf.view.faces.bi.event.DrillEvent | Invoke Application | The drill requested event is delivered after a drill operation is executed. |
| oracle.adf.view.faces.bi.event.TimeSelectorEvent | Apply Request Values | The time selector event is delivered after the time selector is moved |
| oracle.adf.view.faces.bi.event.TimeAxisEvent | Apply Request Values | The time axis event is delivered when the plot area of a time axis graph is clicked |
| oracle.adf.view.faces.bi.event.ZoomAndScrollEvent | Apply Request Values | The zoom and scroll event is delivered when the axis is zoomed or scrolled |
| 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 |
|---|---|---|---|
| alignTickMarks | boolean | Yes |
Indicates whether the tick marks on the y1-Axis and on the y2-Axis should align for dual-y graphs. Valid values are:
|
| 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:
|
| animationOnDataChange | String | Yes |
Specifies the type of data change animation to apply. Valid values are:
|
| animationOnDisplay | String | Yes |
Specifies the type of initial rendering effect to apply. Valid values are:
|
| animationUpColor | String | Yes | Specifies the color used to indicate that a data value has increased. Enter values in RGB hexadecimal. |
| annotationsVisibility | String | Yes |
Controls whether annotations are displayed for a graph. Valid values are the following:
|
| 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. |
| barShape | String | Yes |
Shape of bars in a bar graph. Valid values are the following:
|
| 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: |
| 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. |
| continuousTimeAxisInterval | String | Yes |
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:
|
| customLayout | String | Yes |
Specifies custom layout information when the graph automatically places and sizes its components. Valid values are:
|
| customToolTipCallback | oracle.dss.graph.CustomToolTipCallback | Yes | Specifies a callback(implementation of oracle.dss.graph.CustomToolTipCallback) for overriding the tool tips that the Graph provides by default. Only EL is supported. |
| customizationId | String | Yes | The id used to locate this component when applying persistent customizations. Components without a customizationId set can not save customizations to the persistent store. Instead, any customizations will at most only apply to the current Session. Each customizationId must be unique in the document. |
| dataErrorTextCallback | oracle.dss.graph.DataErrorTextCallback | Yes | Specifies callback(implementation of oracle.dss.graph.DataErrorTextCallback) for overriding the error message that the Graph displays when it is not provided with enough data to draw a graph. Only EL is supported. |
| drillAction | String | Yes | a method reference to a drill action |
| drillRequestedListener | String | Yes | a method reference to a drill requested listener |
| drillRequestingListener | String | Yes | a method reference to a drill requesting listener |
| 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. |
| explicitTimeRangeEnd | 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. |
| explicitTimeRangeStart | 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. |
| 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. |
| fontURLMap | java.util.Map | Yes | Provides a mapping of font names and font swf file URLs in the form of a java.util.Map object. This map should have the font names as the keys, and the font urls as the values. |
| graphType | String | Yes |
Specifies the type of graph. Valid values are:
|
| graphicAntialiasing | boolean | Yes |
Specifies whether lines in a graph should appear smooth. Valid values are "true" (default) and "false". |
| groupTooltipLabelType | String | Yes |
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:
|
| id | String | No | the identifier for the component. The identifier must follow a subset of the syntax allowed in HTML:
|
| imageFormat | String | Yes |
Format of graph image. Valid values are:
|
| imageHeight | int | Yes | Specifies the height of the graph image in pixels. |
| imageSource | String | Yes | Specifies the URI for an image file that was generated by the application. For example, an application might have exported to PNG and stored the image on the server previously. |
| 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 |
| lineDataLineDisplayed | boolean | Yes |
Specifies whether data lines appear in a line graph. Valid values are:
Note: Do not set both this property and markerDisplayed to "false". |
| markerDisplayed | boolean | Yes |
Indicates whether markers or data lines appear in a line graph. Valid values are:
Note: Do not set both this attribute and lineDataLineDisplayed to "false". |
| markerTooltipType | String | Yes |
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:
Note: To display series tooltip labels for a graph, you must set markerTooltipType to a value that includes text. |
| noDataErrorText | String | Yes | Specifies error text to display when graph has no data. |
| otherProperties | String | Yes |
Specifies an XML string that contains settings for graph properties that are not exposed in the graph ADF tag or its child tags. For example, the following code specifies an XML string "otherProps" that is located in the SampleGraph backing bean: |
| partialSubmit | boolean | Yes |
Indicates whether an action can be performed through a partial page submit. Valid values are:
|
| 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. |
| relativeTimeRange | String | 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. |
| renderImagemap | boolean | Yes | Indicates whether an image map should be rendered for a PNG image. Valid values are true (default) or false. |
| rendered | boolean | Yes | Specifies whether the component is rendered |
| scrollbarPresenceGroups | String | Yes |
Specifies when a scrollbar is present for groups. Valid values are as follows:
|
| scrollbarPresenceX1 | String | Yes |
Specifies when the X-axis has a scrollbar. Valid values are:
|
| scrollbarPresenceY1 | String | Yes |
Specifies when the Y1-axis has a scrollbar. Valid values are:
|
| scrollbarPresenceY2 | String | Yes |
Specifies when the Y2-axis has a scrollbar. Valid values are:
|
| seriesEffect | String | Yes |
Determines the series effect that is used for a graph. Valid values are:
|
| seriesObjectCount | int | Yes |
Specifies the number of series for which this graph displays separate properties (such as color) before repeating. The graph stores properties for a specific number of series. Beyond that number, the graph repeats series properties. Default value is "11". For example, if seriesObjectCount is "4", then: |
| seriesReferenceObjectDisplay | String | Yes |
Controls whether reference lines related to a series should be displayed when the mouse hovers over a data series. Valid values are the following:
|
| seriesRolloverBehavior | String | Yes |
Specifies the behavior when the mouse rolls over one bar in a series. Valid value are:
|
| seriesTooltipLabelType | String | Yes |
Specifies series information in a tooltip. Valid values are as follows:
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. |
| 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. |
| stylePath | 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:
To specify a custom style, enter the entire path to the xml file. For example: /text/myStyle.xml. |
| styleRuleBundle | String | Yes |
Specifies a vector of
The following example refers to a style rule bundle called myRuleBundle that is stored in the backing bean SampleGraph: |
| svgFontEmbedding | String | Yes |
Indicates whether fonts should be embedded directly in the generated SVG. This attribute offers one way to avoid inconsistencies between fonts available on the middle tier and fonts available on the client. Valid values are:
|
| 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:
|
| textAntialiasing | boolean | Yes | Indicates that the text in a graph should be smooth. Valid values are true or false. Default value is false. |
| threeDEffect | boolean | Yes |
Indicates whether a graph appears to have depth. Valid values are "true" and "false". Default value is "false". |
| timeAxisListener | String | Yes | a method reference to a timeAxisListener |
| timeAxisType | String | Yes |
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:
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:
Valid values are as follows:
|
| timeRangeMode | String | Yes |
Time range mode on a time axis. RelativeTimeRange, explicitTimeRangeStart and explicitTimeRangeEnd are related properties.
|
| timeSelectorListener | String | Yes | a method reference to a timeSelectorListener |
| timeZone | java.util.TimeZone | Yes |
Specifies a method reference that returns an instance of |
| tokenSubstitution | oracle.dss.dataView.TokenSubstitution | Yes | Defines methods that allow you to substitute text for a token in a String. |
| 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:
|
| x1ReferenceObjectDisplay | String | Yes |
Controls whether refernce lines appear for the x-axis. Valid values are the following:
|
| y1ReferenceObjectDisplay | String | Yes |
Controls whether refernce lines appear for the y1-axis. Valid values are the following:
|
| y2ReferenceObjectDisplay | String | Yes |
Controls whether refernce lines appear for the y2-axis. Valid values are the following:
|
| zoomAndScrollListener | String | Yes | a method reference to a zoomAndScrollListener |
| zoomDirection | String | Yes |
Specifies on which axis or axes zooming is allowed. Valid values are:
|