Oracle Fusion Middleware Data Visualization Tools Tag Reference for Oracle ADF Faces 11g Release 1 (11.1.1.7.1) E12418-10 |
UIComponent class: oracle.adf.view.faces.bi.component.attributeGroups.UIAttributeGroups
Component type: oracle.dss.adf.attributeGroups.AttributeGroups
The attributeGroups tags are used to generate stylistic attribute values such as colors or shapes based on categorical bucketing of a data set. Given the column in the model to group by, the attributeGroups can produce style values for each unique value ("group") in the data.
The type of stylistic attribute to produce values for can be specified using the type property on the attributeGroups tag. The currently supported types are: color, shape, pattern, opacity, scaleX, and scaleY. These can be combined in a space-delimited list to generate multiple stylistic attributes for each unique data value.
The default style values that get generated are defined using skinning keys. Each attributeGroups type has a default ramp defined in the skin, and these can be customized by setting the index-based selectors to the desired values. For example:
af|dvt-attributeGroups::shape1 { -tr-shape: square; } af|dvt-attributeGroups::shape2 { -tr-shape: circle; }
The style values can also be specified through the tags, by using <f:attribute> child tags to define the styles. In this case, the name attribute specifies the attributeGroups type being overridden and the index of the override, and the value attribute specifies the overridden value. For example, to override the first color of the ramp, an <f:attribute> tags with name="color1" and value="#FF0000" would be used. When <f:attribute> tags are used, they are used instead of, not in addition to, the style definition from the skinning keys.
The attributeGroups tag has child "rule" tags that can be used to override the values provided by the attributeGroups. There are two types of rules:
This is an example of how attributeGroups can be used with the Thematic Map component:
<dvt:thematicMap id="map" basemap="usa"> <dvt:areaLayer id="al1" layer="states"> <dvt:areaDataLayer id="adl1" value="#{bean.model}" var="row" ...> <dvt:areaLocation id="al1" name="#{row.name}"> <!--Each stamped marker gets assigned a color and shape from the attributeGroups--> <dvt:marker id="m1"> <dvt:attributeGroups id="ag1" type="shape color" value="#{row.category}"/> </dvt:marker> </dvt:areaLocation> </dvt:areaDataLayer> </dvt:areaLayer> </dvt:thematicMap>
The <dvt:attributeGroups> 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 events 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. |
attributeType | String | Yes | Valid Values: discrete, continuous Default Value: discrete The attribute type for which to generate values. Valid values are:
Only the color attribute is currently supported when using continuous attributes. |
binding | oracle.adf.view.faces.bi.component.attributeGroups.UIAttributeGroups | 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 |
label | String | Yes | A text label for use in the legend |
maxLabel | String | Yes |
The label for the maximum bounds of the component. This value only applies when the attributeType is set to "continuous". If no value is specified, the maximum value is used instead. |
maxValue | Object | Yes | The maximum bounds of this component. This value only applies when the attributeType is set to "continuous". If no value is specified, the maximum data value is used instead. |
minLabel | String | Yes |
The label for the minimum bounds of the component. This value only applies when the attributeType is set to "continuous". If no value is specified, the minimum value is used instead. |
minValue | Object | Yes | The minimum bounds of this component. This value only applies when the attributeType is set to "continuous". If no value is specified, the minimum data value is used instead. |
rendered | boolean | Yes | Default Value: true whether the component is rendered. When set to false, no output will be delivered for this component (the component will not in any way be rendered, and cannot be made visible on the client). If you want to change a component's rendered attribute from false to true using PPR, set the partialTrigger attribute of its parent component so the parent refreshes and in turn will render this component. |
type | String | Yes |
A space-delimited list of stylistic attribute types to generate values for. Valid values are:
The valid types may vary depending on the parent of the attributeGroups tag. |
value | String | Yes | The value from the data model to group by |