Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

service DataPilotSourceDimension
Description
represents a dimension in a data pilot source.

A dimension is equivalent to a column of a cell range in a spreadsheet used for a data pilot field.

In more complex data sources, a dimension may contain several hierarchies, which consolidate items of a complex data type, called levels.

Example: In a database, a column contains date values. This column will be a dimension of the data pilot source. One hierarchy may contain the 3 levels year, month, day. Another hierarchy may contain the 2 levels year and week number.

See also
DataPilotSource, DataPilotTable

Exported Interfaces - Summary
::com::sun::star::container::XNamed

provides access to the name of the dimension, i.e. used in collections.

XHierarchiesSupplier

provides access to the collection of hierarchies of this dimension.

::com::sun::star::util::XCloneable

supports duplicating the dimension. (details)

::com::sun::star::beans::XPropertySet

provides access to the properties.

Properties' Summary
[ readonly ] ::com::sun::star::container::XNamed
Original
returns the name of the dimension from which this dimension was cloned, or NULL if it was not cloned.  
[ readonly ] boolean
IsDataLayoutDimension
contains true if this is the dimension used to layout the different data dimensions.  
DataPilotFieldOrientation
Orientation
specifies where the dimension is used.  
long
Position
specifies the position of the dimension within its orientation.  
GeneralFunction
Function
specifies how data are aggregated.  
long
UsedHierarchy
specifies which hierarchy of the dimension is used.  
sequence< TableFilterField >
Filter
specifies which values are used.  
[ readonly ] long
Flags
[ OPTIONAL ]
contains flags that control the usage of the dimension.  
Exported Interfaces - Details
::com::sun::star::container::XNamed
Description
provides access to the name of the dimension, i.e. used in collections.
XHierarchiesSupplier
Description
provides access to the collection of hierarchies of this dimension.
::com::sun::star::util::XCloneable
Description
supports duplicating the dimension.

A dimension may be used several times in a data pilot table, i.e. as row field and data field.

::com::sun::star::beans::XPropertySet
Description
provides access to the properties.
Properties' Details
Original
[ readonly ] ::com::sun::star::container::XNamed Original;
Description
returns the name of the dimension from which this dimension was cloned, or NULL if it was not cloned.
IsDataLayoutDimension
[ readonly ] boolean IsDataLayoutDimension;
Description
contains true if this is the dimension used to layout the different data dimensions.
Orientation
DataPilotFieldOrientation Orientation;
Description
specifies where the dimension is used.
Position
long Position;
Description
specifies the position of the dimension within its orientation.
Function
GeneralFunction Function;
Description
specifies how data are aggregated.
UsedHierarchy
long UsedHierarchy;
Description
specifies which hierarchy of the dimension is used.
See also
DataPilotSourceHierarchies
Filter
sequence< TableFilterField > Filter;
Description
specifies which values are used.
Flags
[ readonly ] long Flags;
Usage Restrictions
optional
Description
contains flags that control the usage of the dimension.
See also
DimensionFlags

 
Top of Page

Apache Software Foundation

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

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, 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.