<dvt:gauge>

dvt:gauge gauge gauge

UIComponent class: oracle.adf.view.faces.bi.component.gauge.UIGauge
Component type: oracle.dss.adf.gauge.Gauge

Use the gauge tag to create an ADF gauge. The attributes on this tag are sufficient to produce a gauge but you can also specify custom settings for many components by including any of the gauge child tags.

Relationship with other tags

The gauge can have the following child tags:

Example

The following example shows XML for a gauge tag.
<dvt:gauge id="foo2" value ="#{sampleGauge.gaugeDataModel}"
gaugeType="STATUSMETER" imageFormat="FLASH"
imageHeight="350" imageWidth="250"
gaugeSetAlignment="GSA_RIGHT" gaugeSetColumnCount="2"
gaugeSetDirection="GSD_ACROSS"
partialTriggers="gaugeTypes2" partialSubmit="true">
</dvt:gauge>

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

Attributes

Name Type Supports EL? Description
angleExtent int Yes Specifies the angular extent of the dial gauge.
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 an instance of the component. This component must be of type UIGauge. For example, to store an instance of the gauge component from the SampleGauge class, use the following code: binding="#{sampleGauge.gauge}"
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 data is fetched with page load or after page load. Valid values are lazy (default) and immediate. A value of "lazy" here means that data is fetched after the initial page load.
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_TITLE_SEPARATOR - Display title separator under the topLabel
  • CL_OUTER_FRAME - Display the outer frame with shadow effect around the entire gauge.
customShapesPath String Yes Specifies the path to the Custom Shapes definition file. This feature is currently under development.
customizationId String Yes The customizationId is 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.
drillingEnabled boolean Yes Specifies whether drilling is enabled in a gauge. This attribute is always set to "false" because drilling is not yet supported in the gauge.
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.
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.
gaugeSetAlignment String Yes

Determines where gauges appear within a gauge set. Valid values are as follows:

  • GSA_BOTTOM - Calculates available space and optimal gauge size to allow for alignment to the bottom of the gauge set.
  • GSA_BOTTOMLEFT - Calculates available space and optimal gauge size to allow for alignment to the bottom left corner of the gauge set.
  • GSA_BOTTOMRIGHT - Calculates available space and optimal gauge size to allow for alignment to the bottom right corner of the gauge set.
  • GSA_CENTER - Calculates available space and optimal gauge size to allow for alignment in the center of the gauge set.
  • GSA_LEFT - Calculates available space and optimal gauge size to allow for alignment to the left side of the gauge set.
  • GSA_NONE - (Default) Divides available space in the gauge set among all the gauges equally.
  • GSA_RIGHT - Calculates available space and optimal gauge size to allow for alignment to the right side of the gauge set.
  • GSA_TOPLEFT - Calculates available space and optimal gauge size to allow for alignment to the top left corner of the gauge set.
  • GSA_TOP - Calculates available space and optimal gauge size to allow for alignment to the top of the gauge set.
  • GSA_TOPRIGHT - Calculates available space and optimal gauge size to allow for alignment to the top right corner of the gauge set.
gaugeSetColumnCount String Yes

Specifies the number of columns to display in a gauge set. Valid values are:

  • 0 - All gauges appear in a single row. This setting produces as many columns as there are gauges.
  • -1 - (Default) Data source specifies the number of columns and rows.
  • Integer other than 0,-1 - The number of columns in which gauges are to be displayed. For example, the value "3" causes gauges to be displayed in 3 columns.
gaugeSetDirection String Yes

Direction for processing the gauges in a gauge set. Valid values are:

  • GSD_ACROSS - (Default) Specifies that the layout of the gauges is from left to right, then top to bottom.
  • GSD_DOWN - Specifies that the layout of the gauges is from top to bottom, then left to right.
gaugeType String Yes

Specifies the type of gauge. Valid values are:

  • DIAL - (Default) Depicts an N-degree circular shaped gauge (currently only 180 degree half-circle gauge is supported).
  • LED - Graphically depicts a key measurement as defined by a key performance indicator (KPI). Also gives a quick assessment of any metric by generalizing the metric to a specific value range.
  • STATUSMETER - A horizontal bar which indicates the progress of a task or the level of some measurement.
  • VERTICALSTATUSMETER - A vertical bar which indicates the progress of a task or the level of some measurement.
graphicAntialiasing boolean Yes Specifies whether or not antialiasing will be used to smooth outlines of graphic areas. Valid values are true (default) or false.
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.
  • SVG - SVG 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 gauge set in pixels. The default height is 200 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. This provides a base from which to load the image.
imageWidth int Yes Specifies the width of the gauge set in pixels. The default width is 200 pixels.
inlineStyle String Yes Style of the outer element of the component
ledStyle String Yes

Specifies the kind of LED gauge. Valid values are:

  • LS_DOT - (Default) A circle with a fill or gradient equal to that of the threshold section in which the metric falls.
  • LS_ARROW - General shape indicating good (up arrow), fair (right-pointing arrow), and poor (down arrow). Arrow color defers to defined threshold colors or their defaults.
  • LS_TRIANGLE - General shape indicating good (up triangle), fair (right-pointing triangle), and poor (down triangle). Triangle color defers to defined threshold colors or their defaults.
  • LS_RECTANGLE - Rectangular shape that fills according to the threshold section in which the metric falls.
  • LS_CUSTOM - Lets developers use their own images when displaying LED gauges. Requires the setting of the gauge's ledStyleCallback attribute to specify the desired custom image.
ledStyleCallback oracle.dss.gauge.LEDStyleCallback Yes Specifies code that defines a custom LED style. Code for the callback is usually stored in a backing bean for the gauge. For example: ledStyleCallback="{sampleGauge.myStyleCallback}"
maxValue double Yes Specifies the greatest value on the gauge scale/axis. This will be calculated automatically if it is not specified.
minValue double Yes Specifies the lowest value on the gauge scale/axis. This will be calculated automatically if it is not specified.
otherProperties String Yes Specifies settings for other properties in the form on an XML string. For example, this attribute could be used to set SFX properties such as gradientDirection.
partialSubmit boolean Yes Specifies whether an action should be performed through a partial page submit. Valid values are "true" (default) and "false".
partialTriggers String Yes Specifies 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 Specifies whether an image map (PNG) should be rendered. Valid values are "true" (Default) or "false".
rendered boolean Yes Specifies whether the component is rendered.
shortDesc String Yes Short description of the gauge. Useful in the screen reader mode.
specularHighlight String Yes Specifies whether the crescent shaped highlight is displayed for LS_DOT LED gauges. Valid values are SH_ON (Default) or SH_OFF.
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.
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:

  • SVG_FONT_EMBEDDING_NONE - Do not embed fonts in the generated SVG.
  • SVG_FONT_EMBEDDING_ALL - (Default) Embed all fonts in the generated SVG. This option requires additional processing and significantly increases the size of the SVG file.
tabularData java.util.List Yes Provides a tabular data set to a gauge in the form of a java.util.List object.
textAntialiasing boolean Yes Specifies whether or not antialiasing will be used to smooth text characters. Valid values are true or false (default).
thresholdDialStyle String Yes

The style for threshold dial gauges. Valid values are:

  • TDS_PIE_FILL - Fills the entire plot area of a dial gauge.
  • TDS_RING_FILL - Fills only the ring portion of a dial gauge.
  • TDS_SEGMENTS - (Default) Fills the outer portion of a dial gauge in segments.
value String Yes The gauge data model, which must be an instance of DataModel. Alternatively this attribute can take a number (represented as either a Java.lang.Number object or a String) which will be set as the metric value.
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.