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

<dvt:treemap>

dvt:treemap treemap treemap

UIComponent class: oracle.adf.view.faces.bi.component.treemap.UITreemap
Component type: oracle.dss.adf.treemap.Treemap

Treemaps are used to display hierarchical data across two dimensions, represented by the size and color of the treemap nodes.

Screen Shot(s)


Treemap

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
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.treemap.UITreemap Only EL

Specifies a binding reference to store a specific instance of UITreemap from a backing bean. Set this attribute only to access code in a backing bean. For example, to reference a treemap component in the sample managed bean, use the following code: binding="#{sample.treemap}"
contentDelivery String Yes Valid Values: whenAvailable, lazy, immediate
Default Value: whenAvailable

Specifies whether to fetch content with page load or after page load. Valid values are whenAvailable (default), lazy, and immediate.
displayLevelsChildren int Yes Default Value: 2

The number of child levels to display during initial render. This property is 0-based. A value of 0 means that no child levels below the root will be shown; the root itself will be shown. The default value is 2, which means that the root and the first two levels of children will be shown.
dontPersist String[] Yes List of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager". Persistent attributes would still persist to a session.
emptyText String Yes The text of the component when empty.
id String Yes Specifies the identifier for the component
inlineStyle String Yes Style of the outer element (enclosing div) of the component
layout String Yes Valid Values: squarified, sliceAndDiceHorizontal, sliceAndDiceVertical
Default Value: squarified

Specifies the layout of the hierarchy. Valid values are:

  • squarified - (default) Nodes are laid out to be as square as possible. This layout is best for understanding the relative size of the nodes.
  • sliceAndDiceHorizontal - Nodes are first laid out horizontally across the width of the treemap, then vertically across the height of the treemap. This layout is good for animation, since the relative ordering of nodes will remain constant.
  • sliceAndDiceVertical - Nodes are first laid out vertically across the height of the treemap, then horizontally across the width of the treemap. This layout is good for animation, since the relative ordering of nodes will remain constant.
nodeSelection String Yes Valid Values: none, single, multiple
Default Value: multiple

Specifies the selection mode. Valid values are:

  • "none" - no nodes can be selected
  • "single" - a single node can be selected
  • "multiple" - (default) multiple nodes can be selected
partialTriggers String[] Yes 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.
persist String[] Yes List of persistent attributes that are persisting to a registered "Persistent Change Manager". Persistent attributes, by default, always persist to a session.
rendered boolean Yes Default Value: true

Specifies whether the component is rendered.
selectedRowKeys org.apache.myfaces.trinidad.model.RowKeySet Yes The set of selected rows for this component. Each entry in the set is a rowKey.
selectionListener javax.el.MethodExpression Only EL a method reference to a selection listener, the method is invoked when the selected nodes are changed.

        public void nodeSelected(SelectionEvent selectionEvent) {

          UITreemap treemap = (UITreemap) selectionEvent.getSource();
          RowKeySet addedSet = selectionEvent.getAddedSet();
          Iterator i = addedSet.iterator();

          TreeModel model = (TreeModel)treemap.getValue();
          model.setRowKey(i.next());

          Object selectedNode = model.getRowData();
         //then cast the selected node to the tree model specific type
         //in this example, it is a single selection model, so, you only need to get the only rowkey in the selection event

         // note, the selectionEvent is of org.apache.myfaces.trinidad.event.SelectionEvent
         //...
         }
styleClass String Yes Sets a CSS style class to use for this component.
summary String Yes A summary of the component's purpose and structure for user agents rendering to non-visual media (e.g. screen readers).
value String Yes The data model for the treemap - can be an instance of javax.faces.TreeModel
var String Yes Name of the EL variable used to reference each element of this collection. Once this component has completed rendering, this variable is removed (or reverted back to its previous value).
varStatus String Yes Name of the EL variable used to reference the varStatus information. Once this component has completed rendering, this variable is removed (or reverted back to its previous value). The VarStatus provides contextual information about the state of the component to EL expressions. For components that iterate, varStatus also provides loop counter information. Please see the this component's documentation for the specific properties on the varStatus. The common properties on varStatus include:
  • "model" - returns the CollectionModel for this component
  • "index" - returns the zero based row index