Oracle Fusion Middleware Data Visualization Tools Tag Reference for Oracle ADF Faces 11g Release 1 (11.1.1.7.0) E12418-09 |
UIComponent class: oracle.adf.view.faces.bi.component.graph.UIGraph
Component type: oracle.dss.adf.graph.Graph (radarGraph)
Use the radarGraph tag to create an ADF radar graph. This tag has a minimal set of properties to support common functionality for this graph type. The following child tags can be specified on this tag.
This component can have the following children: alertSet, attributeFormat, background, graphFootnote, graphPlotArea, graphSubtitle, graphTitle, legendArea, legendText, legendTitle, markerText, o1Axis, o1MajorTick, o1TickLabel, referenceObjectSet, seriesSet , shapeAttributesSet, y1Axis, y1BaseLine, y1MajorTick, y1TickLabel.
The following example shows XML for a radarGraph tag.
<dvt:radarGraph imageWidth="300" imageHeight="300" imageFormat="FLASH" title="Graph"
partialTriggers="b2" partialSubmit="true" value ="#{sampleGraph.graphDataModel}"/>
The af:showPopupBehavior tag can be used within the <dvt:seriesSet> to display popups for data objects within the graph. Only the "click" and "mouseHover" trigger types are supported. When using hover popups, it is recommended that tooltips be disabled, since having multiple types of hover feedback can be confusing to the user.
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:
In attachment mode, the graph will be displayed in HTML5 or PNG, depending on the browser being used. Limited client interactivity, such as tooltips, is available. The following features are not supported in attachment mode:
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 events might include the width of a column that supported client-side resizing. |
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. |
multiSelectContextMenu | popup component containing the context menu that will be shown on right click when multiple data objects are selected. The af:popup must contain an af:menu to display the context menu. This facet supports only a single child component. |
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. |
animationDuration | int | Yes | Specifies the animation duration in milliseconds. The default value is 1000. |
animationOnDataChange | int | Yes | Valid Values: none, activeData, auto, alphaFade, conveyorFromLeft, conveyorFromRight, cubeToLeft, cubeToRight, flipLeft, flipRight, slideToLeft, slideToRight, transitionToLeft, transitionToRight, zoom Specifies the type of animation to apply on data change. Valid values are:
|
animationOnDisplay | int | Yes | Valid Values: none, auto, alphaFade, conveyorFromLeft, conveyorFromRight, cubeToLeft, cubeToRight, flipLeft, flipRight, slideToLeft, slideToRight, transitionToLeft, transitionToRight, zoom Specifies the type of animation to apply when the component is initially displayed. Valid values are:
|
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: |
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 -
|
contentDelivery | String | Yes | Valid Values: whenAvailable, lazy, immediate 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:
|
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. |
dataErrorTextCallback | oracle.dss.graph.DataErrorTextCallback | Yes | Specifies callback 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. |
dataSelection | String | Yes | Valid Values: none, single, multiple Determines the data selection mode for the graph. Valid values are:
|
drillingEnabled | boolean | Yes | Indicates whether drilling is enabled. |
dynamicResize | String | Yes | Valid Values: FIXED_SIZE, DYNAMIC_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 | 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 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:
|
hideAndShowBehavior | String | Yes | Valid Values: none, withRescale, withoutRescale 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:
|
id | String | Yes | Specifies the identifier for the component |
imageFormat | int | Yes | Valid Values: HTML5, FLASH, PNG, PNG_STAMPED, AUTO This attribute is deprecated. Use the oracle.adf.view.rich.dvt.DEFAULT_IMAGE_FORMAT context parameter instead. The component will use the specified default if possible, falling back to alternate output formats as needed based on the client browser. |
imageHeight | int | Yes | 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 | 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:
|
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 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:
|
partialSubmit | boolean | Yes | Deprecated. It is not useful anymore.
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. |
renderImagemap | boolean | Yes | Indicates whether an image map should be rendered for a PNG image. The default value is true. |
rendered | boolean | Yes | Specifies whether the component is rendered. |
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 Determines the series effect that is used for a graph. Valid values are:
|
seriesRolloverBehavior | int | Yes | Valid Values: RB_NONE, RB_DIM, RB_HIGHLIGHT Specifies the behavior when the mouse rolls over one bar in a series. Valid values are:
|
seriesTooltipLabelType | int | Yes | Valid Values: TLT_MEMBER, TLT_DIM_MEMBER, TLT_NONE Specifies series information in a tooltip. Valid values are as follows:
|
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:
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. |
styleRuleBundle | java.util.Vector | Yes | Specifies a vector of oracle.dss.rules.RuleBundle objects that specify different colors based on data values or characteristics. For example, a styleRuleBundle might contain a stoplight rule that sets the following colors:
The following example refers to a style rule bundle called myRuleBundle that is stored in the backing bean SampleGraph: |
subType | String | Yes |
Specifies the type of graph. 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:
|
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 Specifies the type or types of visualEffect to apply. Valid values are:
|