English:

The Free and Open Productivity Suite
Help us Help the World

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: sheet ::

unpublished interface XDataPilotTable2
Base Interfaces
XDataPilotTable2XDataPilotTable

XDataPilotTable
(referenced interface's summary:)
provides methods to control a data pilot table which has already been created.
Usage Restrictions
not published
Description
additional methods to extend XDataPilotTable. XDataPilotTable2 extends the old XDataPilotTable interface with additional methods.
Since
OOo 3.0
See also
XDataPilotTable

Methods' Summary
getDrillDownData When the address of a cell within the result area is given, XDataPilotTable2::getDrillDownData returns its drill-down output table that includes only those rows that contribute to the value of that cell.  
getPositionData Given a cell address, it returns the information about that cell. The type of information returned depends upon whether the cell is within the result area or column/row header area.  
insertDrillDownSheet  
getOutputRangeByType  
Methods' Details
getDrillDownData
sequence< sequence< any > >
getDrillDownData( [in] ::com::sun::star::table::CellAddress  aAddr );

Description
When the address of a cell within the result area is given, XDataPilotTable2::getDrillDownData returns its drill-down output table that includes only those rows that contribute to the value of that cell.
Parameter aAddr
cell address within the result area of a DataPilot table.
Returns
drill-down output as 2-dimensional sequence, including the header row.
See also
? (no identifier found)
XDataPilotTable2::insertDrillDownSheet
getPositionData
DataPilotTablePositionData
getPositionData( [in] ::com::sun::star::table::CellAddress  aAddr );

Description
Given a cell address, it returns the information about that cell. The type of information returned depends upon whether the cell is within the result area or column/row header area.
Parameter aAddr
address of the cell whose information is to be returned.
Returns
DataPilotTablePositionData which contains the position type and the information for that cell position.
See also
DataPilotTablePositionData, DataPilotTableHeaderData, DataPilotTableResultData
insertDrillDownSheet
void
insertDrillDownSheet( [in] ::com::sun::star::table::CellAddress  aAddr );

Description

This method inserts a new sheet to display the drill-down data for a specified result cell. A drill-down data for a result cell consists of a subset of rows from the original data source that contribute to the value displayed in that cell.

The new sheet is always inserted to the immediate left of the current sheet where the DataPilot table is. Note that when the drill-down data is empty, no new sheet is inserted.

Parameter aAddr
address of a result cell
Returns
void
getOutputRangeByType
::com::sun::star::table::CellRangeAddress
getOutputRangeByType( [in] long  nType )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description

This method returns a different output range of a DataPilot table per specified output range type.

Returns
::com::sun::star::table::CellRangeAddress depicting the range specified. See DataPilotOutputRangeType for a set of possible output range types.
See also
DataPilotOutputRangeType
Top of Page

Logo ApacheCon Europe 2014

Apache Feather

Copyright & License | Privacy | Website Feedback | Contact Us | Donate | Thanks

Apache, the Apache feather logo, and OpenOffice are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.