LibreOffice
LibreOffice 7.2 SDK API Reference
Public Member Functions | List of all members
XDataPilotDescriptor Interface Referencepublished

provides access to the layout settings of a data pilot table. More...

import"XDataPilotDescriptor.idl";

Inheritance diagram for XDataPilotDescriptor:
XNamed XInterface DataPilotDescriptor DataPilotTable

Public Member Functions

string getTag ()
 returns an additional string stored in the data pilot table. More...
 
void setTag ([in] string aTag)
 sets an additional string stored in the data pilot table. More...
 
com::sun::star::table::CellRangeAddress getSourceRange ()
 returns the cell range containing the data for the data pilot table. More...
 
void setSourceRange ([in] com::sun::star::table::CellRangeAddress aSourceRange)
 sets the cell range containing the data for the data pilot table. More...
 
com::sun::star::sheet::XSheetFilterDescriptor getFilterDescriptor ()
 returns the filter descriptor specifying which data from the source cell range are used for the data pilot table. More...
 
com::sun::star::container::XIndexAccess getDataPilotFields ()
 returns the collection of all the data pilot fields. More...
 
com::sun::star::container::XIndexAccess getColumnFields ()
 returns the collection of the data pilot fields used as column fields. More...
 
com::sun::star::container::XIndexAccess getRowFields ()
 returns the collection of the data pilot fields used as row fields. More...
 
com::sun::star::container::XIndexAccess getPageFields ()
 returns the collection of the data pilot fields used as page fields. More...
 
com::sun::star::container::XIndexAccess getDataFields ()
 returns the collection of the data pilot fields used as data fields. More...
 
com::sun::star::container::XIndexAccess getHiddenFields ()
 returns the collection of the data pilot fields not used as column, row, page, or data fields. More...
 
- Public Member Functions inherited from XNamed
string getName ()
 
void setName ([in] string aName)
 sets the programmatic name of the object. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

provides access to the layout settings of a data pilot table.

This interface extends the interface com::sun::star::container::XNamed which provides access to the name of the data pilot table used e.g. in collections.

See also
com::sun::star::sheet::DataPilotDescriptor
com::sun::star::sheet::DataPilotTable

Member Function Documentation

◆ getColumnFields()

returns the collection of the data pilot fields used as column fields.

See also
com::sun::star::sheet::DataPilotFields

◆ getDataFields()

returns the collection of the data pilot fields used as data fields.

See also
com::sun::star::sheet::DataPilotFields

◆ getDataPilotFields()

returns the collection of all the data pilot fields.

◆ getFilterDescriptor()

returns the filter descriptor specifying which data from the source cell range are used for the data pilot table.

◆ getHiddenFields()

returns the collection of the data pilot fields not used as column, row, page, or data fields.

See also
com::sun::star::sheet::DataPilotFields

◆ getPageFields()

returns the collection of the data pilot fields used as page fields.

See also
com::sun::star::sheet::DataPilotFields

◆ getRowFields()

returns the collection of the data pilot fields used as row fields.

See also
com::sun::star::sheet::DataPilotFields

◆ getSourceRange()

returns the cell range containing the data for the data pilot table.

◆ getTag()

string getTag ( )

returns an additional string stored in the data pilot table.

◆ setSourceRange()

void setSourceRange ( [in] com::sun::star::table::CellRangeAddress  aSourceRange)

sets the cell range containing the data for the data pilot table.

◆ setTag()

void setTag ( [in] string  aTag)

sets an additional string stored in the data pilot table.


The documentation for this interface was generated from the following file: