<dvt:pivotTable>

UIComponent class: oracle.adf.view.faces.bi.component.pivotTable.UIPivotTable
Component type: oracle.dss.adf.pivotTable.PivotTable

The Pivot Table supports the display of multiple nested attributes on a row and column header. In addition, the Pivot Table supports the ability to dynamically change the layout of the attributes displayed in the row or column headers via drag and drop pivoting.

Pivot Table Model

The Pivot Table component uses a model to display and interact with data. The specific model class to use is oracle.adf.view.faces.bi.model.pivotTable.PivotTableModel. When linking a PivotTable and a Graph to the same data is required, the Pivot Table model can be an instance of oracle.adf.view.faces.bi.model.DataModel.

Setting Width and Height

The inlineStyle attribute can be used to specify a Pivot Table's width and height. For example, inlineStyle="width:600px;height:400px" or inlineStyle="width:100%;height:400px".

Customizing Cell Content

In order to customize header cell content, either set HeaderFormat or HeaderFormatManager attributes. In order to customize data cell content, either set DataFormat or DataFormatManager attributes. The HeaderFormatManager and DataFormatManager attributes are provided for applications that would like to provide custom state saving for the application's Pivot Table formatting rules. To specify cell content customizations, the HeaderFormat/HeaderFormatManager/DataFormat/DataFormatManager attributes return instances of oracle.dss.adf.view.faces.bi.component.pivotTable.CellFormat. CellFormat instances allow the specification of the following:

a converter, javax.faces.convert.Converter, which is used to perform number/date/text formatting of a cell raw value
a CSS style, which is used to change the CSS style of a cell
a CSS text style, which is used to change the CSS style of a cell's text
a new raw value, which is used to change the cell's underlying value that was returned from the data model
a list of oracle.dss.adf.view.faces.bi.component.pivotTable.CellImages which can be used to put custom icons in data cells only

Events

Type	Phases	Description
oracle.adf.view.faces.bi.event.DrillEvent	Invoke Application	The drill requested event is delivered after a drill operation is executed.
oracle.adf.view.faces.bi.event.pivotTable.SortEvent	Invoke Application	The sort event is delivered when the pivot table is sorted.
oracle.adf.view.faces.bi.event.pivotTable.CellImageClickEvent	Invoke Application	The click event is delivered when a cell image is clicked.
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.

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.
autoIndent	int	Yes	Specifies how many pixels to indent row labels for each level in a hierarchy. This property specifies the number of pixels to indent each level. The default value is 5.
binding	String	Only EL	binding reference to store the UIPivotTable component
bodyContextMenuId	String	Yes	A search expression to identify the popup component containing the context menu that will be shown within the pivot table body, for clicks outside the selectable regions of the pivot table, such as the row header, column header, or data regions. Expressions are relative to this pivot table component and must account for NamingContainers. You can prepend a single colon to start the search from the root, or multiple colons to move up through the NamingContainers. For example, a leading "::" will search from the parent NamingContainer, ":::" will search from the grandparent NamingContainer, etc.
cellImageClickAction	String	Yes	a method reference to a cell image click action
cellImageClickListener	String	Yes	a method reference to a cell image click listener
columnFetchSize	int	Yes	The number of columns in a data fetch block. The default value is 10.
contentDelivery	String	Yes	Either "lazy" or "immediate". If "lazy", then pivot table's content is fetched after the pivot table is sent to the browser. If "immediate", then the pivot table content is immediately sent to the browser. The default value is "lazy".
contextMenuId	String	Yes	A search expression to identify the popup component containing the context menu that will be shown for clicks within selectable regions of the pivot table, such as the row header, column header, or data regions. Expressions are relative to this pivot table component and must account for NamingContainers. You can prepend a single colon to start the search from the root, or multiple colons to move up through the NamingContainers. For example, a leading "::" will search from the parent NamingContainer, ":::" will search from the grandparent NamingContainer, etc.
customizationId	String	Yes	The id used to locate this component when applying persistent customizations. Components without a customizationId set can not save customizations to the persistent store. Instead, any customizations will at most only apply to the current Session. Each customizationId must be unique in the document.
dataFormat	String	Yes	A MethodExpression that returns a oracle.adf.view.faces.bi.component.pivotTable.CellFormat given a oracle.adf.view.faces.bi.component.pivotTable.DataCellContext
dataFormatManager	String	Yes	an instance of oracle.adf.view.faces.bi.component.pivotTable.DataFormatManager
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.
drillAction	String	Yes	a method reference to a drill action
drillRequestedListener	String	Yes	a method reference to a drill requested listener
drillRequestingListener	String	Yes	a method reference to a drill requesting listener
drillingEnabled	boolean	Yes	Specifies whether drilling is enabled. The default value is true.
emptyText	String	Yes	The text of an empty pivot table. If the text is enclosed in an html tag, it will be formatted. The formatting behavior is similar to outputFormatted component.
headerFormat	String	Yes	A MethodExpression that returns a oracle.adf.view.faces.bi.component.pivotTable.CellFormat given a oracle.adf.view.faces.bi.component.pivotTable.HeaderCellContext
headerFormatManager	String	Yes	an instance of oracle.adf.view.faces.bi.component.pivotTable.HeaderFormatManager
id	String	No	the identifier for the component. The identifier must follow a subset of the syntax allowed in HTML: Must not be a zero-length String. First character must be an ASCII letter (A-Za-z) or an underscore ('_'). Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').
indentEnabled	boolean	Yes	Specifies whether row labels for different levels of a hierarchical layer are indented. The default value is true.
inlineStyle	String	Yes	The inline style of the pivot table's outer DOM element. Can be used to control the size/position of the pivot table.
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.
pivotEnabled	boolean	Yes	Specifies whether pivoting is enabled. The default value is true.
pivotLabelVisible	boolean	Yes	Specifies whether layer/dimension labels are visible on pivot handles. The default value is false.
rendered	boolean	Yes	Specifies whether the component is rendered. The default value is true.
rowFetchSize	int	Yes	The number of rows in a data fetch block. The default value is 25.
selection	String	Yes	an instance of oracle.adf.view.faces.bi.component.pivotTable.Selection
sizing	String	Yes	Valid Values: fixed, auto. Specifies how pivot table's size ( width/height ) is determined. When sizing="fixed", the pivot table is sized based in the width / height CSS properties in its default style or inline style property. When sizing="auto", the height of the pivot table is determined by the size of the content that is being displayed by the pivot table. If the content is smaller than the default size of the pivot table, then the pivot table will shrink. If the content is larger than the default size of the pivot table, the content will grow. To control maximum height / width of the pivot table, the max-height / max-width CSS properties can be specified using pixels in the inlineStyle property of the pivot table, as follows "max-width:400px;max-height:300px". Once the maximum height or width is exceeded, then pivot table will display scrollbars as needed. Please note that when sizing="auto", the pivot table's frame will initially be displayed with the default size of the pivot table ( using the width/height CSS attributes ) and then the pivot table's frame will readjust to fit its contents. This can cause the layout of the page displaying the pivot table to change after the page is initially displayed. The default value is "fixed".
sizingManager	String	Yes	an instance of oracle.adf.view.faces.bi.component.pivotTable.SizingManager
sortListener	String	Yes	a method reference to a sort listener
sortMode	String	Yes	Specifies the sort mode. Options are "grouped", "ungrouped", and "none". The default value is "grouped".
startColumn	int	Yes	The first visible column of data. The default value is 0.
startRow	int	Yes	The first visible row of data. The default value is 0.
statusBarRendered	boolean	Yes	Specifies whether the status bar is rendered.
styleClass	String	Yes	Sets a CSS style class to use for this component.
summary	String	Yes	Sets a summary of this pivot table's purpose and structure for user agents rendering to non-visual media (e.g. screen readers).
value	String	Yes	the data model for the pivot table - can be an instance of oracle.adf.view.faces.bi.model.pivotTable.PivotTableModel or oracle.adf.view.faces.bi.model.DataModel
var	String	Yes	Name of the EL variable used to reference cell data within pivot table DataCell stamps. 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. The common properties on varStatus include: "model" - returns the DataModel for this component "cellIndex" - returns the cell index "cellKey" - returns the cell key "current" - returns the current cell data
visible	boolean	Yes	the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. The default value is true.