Oracle Fusion Middleware Data Visualization Tools Tag Reference for Oracle ADF Faces
11g Release 2 (11.1.2.4.0)
E17490-05

<dvt:area>

UIComponent class: oracle.adf.view.faces.bi.component.thematicMap.UIArea
Component type: oracle.dss.adf.thematicMap.Area

An area is used to stamp out stylistic attributes such as colors and patterns onto the geographical areas of the map.

Label Customization

Label text and styles can be specified on the area tag, which will override the default region labels provided by the basemap. The value attribute is used to specify the text of the label, and the labelDisplay and lableStyle attributes can be used to customize the appearance of these labels. When labelDisplay="on" then the provided label value and labelStyle will override the label coming in from the areaLayer.

Number Formatting

The Thematic Map supports formatting of the area labels specified in the value attribute. This can be done either by adding an <af:convertNumber> as a child of <dvt:area> or by specifying a converter via EL directly on the <dvt:area> tag. If the value is numeric, then the properties of the given converter will be used to format the number appropriately. For example:

       <!--This uses a converter from the backing bean to convert the value-->
       <dvt:area id="a1" labelDisplay="on" value="#{mapBean.value}" converter="#{mapBean.myConverter}"/>

       <!--This uses the child convertNumber tag to convert the value-->
       <dvt:area id="a2" labelDisplay="on" value="#{mapBean.value}" >
         <af:convertNumber id="cn1" type="currency"/>
       </dvt:area>

If both a converter and a child af:convertNumber tag are specified, then the properties of the child tag take precedence.

Drag and Drop

An Area can be used as a drag source. To make an area a drag source, the application developer simply needs to add an <af:dragSource> as its child.
Example:

<dvt:area id="area" fillColor="#{tmapTargetActualBean.colorObj}" 
             shortDesc="#{tmapTargetActualBean.tooltip}">
  <af:dragSource actions="COPY" discriminant="DnDDemoModel"/>             
</dvt:area>

Attribute Groups

The <dvt:attributeGroups> tag can be used as a child of dvt:area. Instead of specifying fillColor, pattern, or opacity directly on the area tag, developers can use attributeGroups with type = "color", "pattern", or "opacity" to get these attributes automatically generated based on categorical bucketing of the data set. If any of these attributes are specified both in the area tag and within the attributeGroups type, then the style generated by the attributeGroups will take precedence.

Relationship with other tags

The <dvt:area> tag can have the following children:

Screen Shot(s)

No image.

Events

Type	Phases	Description
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.

Attributes

Name	Type	Supports EL?	Description
action	javax.el.MethodExpression	Yes	A reference to an action method sent by the component, or the static outcome of an action.
actionListener	javax.faces.el.MethodBinding	Only EL	A method reference to an action listener
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	oracle.adf.view.faces.bi.component.thematicMap.UIArea	Only EL	an EL reference that will store the component instance on a bean. This can be used to give programmatic access to a component from a backing bean, or to move creation of the component to a backing bean.
converter	javax.faces.convert.Converter	Yes	A converter object
destination	String	Yes	The URI this component references
fillColor	String	Yes	Specifies the fill color of the areas of the map. Valid values are RGB hexadecimal.
fillPattern	String	Yes	Specifies the built-in pattern used to fill the areas of the map. Valid values are: "smallDiagonalLeft" "smallChecker" "smallDiagonalRight" "smallTriangle" "smallCrosshatch" "smallDiamond" "largeDiagonalLeft" "largeChecker" "largeDiagonalRight" "largeTriangle" "largeCrosshatch" "largeDiamond" The pattern is drawn with a white background, and the foreground color is taken from the fillColor attribute.
id	String	Yes	the identifier for the component
labelDisplay	String	Yes	Valid Values: on, off Determines how labels associated with this area should be displayed. Valid values are: "on" - Display the label provided in the value attribute in place of the built-in basemap labels. "off" - (default) Do not display the label provided in the value attribute
labelStyle	String	Yes	The font style for labels associated with this area. Accepts font-related CSS attributes like font-name, font-weight, font-size, color, etc.
opacity	double	Yes	Specifies the opacity of the fill color of the areas of the map. Valid values are from 0.0 - 1.0, where 0.0 is transparent and 1.0 is opaque.
rendered	boolean	Yes	Specifies whether the component is rendered. The default value is true.
shortDesc	String	Yes	The short description of this component. This is used to customize the text that displays in the area's tooltip.
value	String	Yes	The value of the component. When labelDisplay="on", this value will be used as the text label for this area stamp. The provided label value will override the label coming in from the areaLayer