Oracle Fusion Middleware Data Visualization Tools Tag Reference for Oracle ADF Faces
12c (12.1.2)
E23187-01

<dvt:legend>

dvt:legend legend legend

UIComponent class: oracle.adf.view.faces.bi.component.legend.UILegend
Component type: oracle.dss.adf.legend.Legend

The legend displays a panel which contains descriptive text for style information from its source components. It can display multiple sections of marker and label pairs, supporting custom title headers and declarative control over the ordering of such sections. The legend can contain <dvt:legendSection> or <dvt:showLegendGroup> tags. Use the <dvt:legendSection> tag to associate the legend with a source to generate its items.

Supported Parent Components

Thematic Map

Define the legend as a child of the thematic map component. Add <dvt:legendSection> children to the legend in order to enable integration with data on the thematic map. See the "Legend" section of <dvt:thematicMap> for specific examples.

Layout Behavior

Within its parent component, the legend uses the maxWidth property to determine its width. If the legend content is wider than the maxWidth specified, legend will be capped at its maxWidth. If the content is smaller than the maxWidth, the legend will shrink its width to fit its content. The legend height is determined by the height of its content. Use the noWrap property to enable and disable text wrapping. If noWrap is true, any text longer than the maxWidth will truncate.

Relationship with other tags

The <dvt:legend> 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.

Supported Facets

Name Description
separator Defining the "separator" facet with a child <af:separator> will add separators between child legend sections.

Attributes

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 String Only EL Binding reference to store the UILegend component
disclosed boolean Yes Default Value: true

Determines if the legend is expanded or collapsed on initial display. This setting only applies when display="showHide". Valid values are:
  • "true" - (default) The legend is expanded on initial display
  • "false" - The legend is collapsed on initial display
display String Yes Valid Values: showHide, fixed
Default Value: showHide

Determines the display behavior of the legend. Valid values are:
  • "showHide" - (default) Creates a legend that can be shown and hidden using a disclosure button.
  • "fixed" - Creates a legend that is fixed in place and cannot be shown or hidden.
id String Yes The identifier for the component
label String Yes The optional title text for the legend.
maxWidth String Yes Determines the maximum width in px or % that the legend can occupy. Percentages are based on the width of the parent component. If the legend content width is less than the maximum width, the legend will shrink to fit its content.
noWrap boolean Yes Default Value: true

Determines if text which goes beyond the legend width will truncate or wrap. Valid values are:
  • "true" - (default) Text is truncated
  • "false" - Text is wrapped and flows to new lines
rendered boolean Yes Default Value: true

Specifies whether the component is rendered. The default value is true.