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 :: chart2 ::

unpublished interface XCoordinateSystem
Usage Restrictions
not published

Methods' Summary
getDimension the dimension of the coordinate-system.  
getCoordinateSystemType identifies the type of coordinate system (e.g. cartesian, polar ...)  
getViewServiceName return a service name from which the view component for this coordinate system can be created  
setAxisByDimension The dimension says wether it is a x, y or z axis. The index says wether it is a primary or a secondary axis. Use nIndex == 0 for a primary axis.  
getAxisByDimension The dimension says wether it is a x, y or z axis. The index indicates wether it is a primary or a secondary axis or maybe more in future. Use nIndex == 0 for a primary axis. An empty Reference will be returned if the given nDimension and nIndex are in the valid range but no axis is set for those values. An IndexOutOfBoundsException will be thrown if nDimension is lower than 0 or greater than the value returned by getDimension() and/or if nIndex is lower 0 or greater than the value returned by getMaxAxisIndexByDimension(nDimension).  
getMaximumAxisIndexByDimension In one dimension there could be several axes to enable main and secondary axis and maybe more in future. This method returns the maximum index at which an axis exists for the given dimension. It is allowed that some indexes inbetween do not have an axis. / 
Methods' Details
getDimension
long
getDimension();

Description
the dimension of the coordinate-system.
getCoordinateSystemType
string
getCoordinateSystemType();

Description
identifies the type of coordinate system (e.g. cartesian, polar ...)
getViewServiceName
string
getViewServiceName();

Description
return a service name from which the view component for this coordinate system can be created
setAxisByDimension
void
setAxisByDimension( [in] long  nDimension,
[in] XAxis  xAxis,
[in] long  nIndex )
raises( ::com::sun::star::lang::IndexOutOfBoundsException );

Description
The dimension says wether it is a x, y or z axis. The index says wether it is a primary or a secondary axis. Use nIndex == 0 for a primary axis.
getAxisByDimension
XAxis
getAxisByDimension( [in] long  nDimension,
[in] long  nIndex )
raises( ::com::sun::star::lang::IndexOutOfBoundsException );

Description
The dimension says wether it is a x, y or z axis. The index indicates wether it is a primary or a secondary axis or maybe more in future. Use nIndex == 0 for a primary axis. An empty Reference will be returned if the given nDimension and nIndex are in the valid range but no axis is set for those values. An IndexOutOfBoundsException will be thrown if nDimension is lower than 0 or greater than the value returned by getDimension() and/or if nIndex is lower 0 or greater than the value returned by getMaxAxisIndexByDimension(nDimension).
getMaximumAxisIndexByDimension
long
getMaximumAxisIndexByDimension( [in] long  nDimension )
raises( ::com::sun::star::lang::IndexOutOfBoundsException );

Description
In one dimension there could be several axes to enable main and secondary axis and maybe more in future. This method returns the maximum index at which an axis exists for the given dimension. It is allowed that some indexes inbetween do not have an axis. /
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.