Oracle Fusion Middleware Data Visualization Tools Tag Reference for Oracle ADF Faces 11g Release 2 (11.1.2.3.0) E17490-04 |
UIComponent class: oracle.adf.view.faces.bi.component.thematicMap.UIAreaLayer
Component type: oracle.dss.adf.thematicMap.AreaLayer
The areaLayer is a child of the thematicMap and is used to customize which layers from the built-in basemap get displayed. Each areaLayer tag points to a layer from the basemap, i.e. "states" or "counties", and only the layers for which an areaLayer is present will get rendered. Data then gets associated with a basemap layer by nesting the appropriate data layer within an areaLayer.
Not only do the areaLayer tags provide context for what is in the basemap, but they also allow developers to customize base layer behavior at runtime such as label display and styles. Use the labelDisplay, labelType, and labelStyle attributes to customize the appearance of the default region labels provided by the basemap.
By default, each region in a base map areaLayer displays a label if the label fits inside the region (labelDisplay="auto"). When a region label does not fit inside the region, it is not displayed unless leader lines determining the alternate label location are provided for that region in the basemap. Out of the built-in basemaps, only the USA map provides leader lines.
An areaLayer can be used as a drop target. To make an areaLayer a drop target, the application developer simply needs to add an <af:dropTarget> as its child.
Example:
<dvt:areaLayer id="areaLayer" layer="states"> <af:dropTarget actions="COPY" dropListener="#{TestDropHandler.handleCollectionFireDrop}"> <af:dataFlavor flavorClass="java.util.Collection"/> </af:dropTarget> </dvt:areaLayer>
<!--This creates a US map with states and counties, with data added to the states layer--> <dvt:thematicMap id="map" basemap="usa"> <dvt:areaLayer id="al1" layer="states"> <!--associate data with the states layer--> <dvt:areaDataLayer id="adl1" value=" " var=" " ...> ... </dvt:areaDataLayer> </dvt:areaLayer> <dvt:areaLayer id="al2" layer="counties"/> </dvt:thematicMap>
The <dvt:areaLayer> tag can have the following children:
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. |
Name | Type | Supports EL? | Description |
---|---|---|---|
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.UIAreaLayer | 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. |
id | String | Yes | the identifier for the component |
labelDisplay | String | Yes | Valid Values: on, off, auto Determines how built-in basemap labels for this layer should be displayed. Valid values are:
|
labelStyle | String | Yes | The font style for labels on this layer. Accepts font-related CSS attributes like font-name, font-weight, font-size, color, etc. |
labelType | String | Yes | Valid Values: short, long Determines which of the built-in basemap labels to display. Valid values are:
|
layer | String | Yes |
Name of a layer from the built-in basemap. Allowable values depends on the basemap specified in the thematicMap tag. The available layers for each basemap are listed below:
|
rendered | boolean | Yes | Specifies whether the component is rendered. The default value is true. |
styleClass | String | Yes | Sets a CSS style class to use for this component. |