offapi/com/sun/star/chart2/XCoordinateSystem.idl

   1 #ifndef com_sun_star_chart2_XCoordinateSystem_idl
   2 #define com_sun_star_chart2_XCoordinateSystem_idl
   3
   4 #ifndef __com_sun_star_uno_XInterface_idl__
   5 #include <com/sun/star/uno/XInterface.idl>
   6 #endif
   7
   8 #ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
   9 #include <com/sun/star/lang/IndexOutOfBoundsException.idl>
  10 #endif
  11
  12 #include <com/sun/star/chart2/XAxis.idl>
  13
  14 module com
  15 {
  16 module sun
  17 {
  18 module star
  19 {
  20 module chart2
  21 {
  22
  23 /**
  24 */
  25
  26 interface XCoordinateSystem : ::com::sun::star::uno::XInterface
  27 {
  28     /** the dimension of the coordinate-system.
  29      */
  30     long getDimension();
  31
  32     /** identifies the type of coordinate system (e.g. cartesian, polar ...)
  33     */
  34     string getCoordinateSystemType();
  35
  36     /** return a service name from which the view component for this coordinate system can be created
  37     */
  38     string getViewServiceName();
  39
  40     /** The dimension says wether it is a x, y or z axis.
  41         The index says wether it is a primary or a secondary axis.
  42         Use nIndex == 0 for a primary axis.
  43      */
  44     void setAxisByDimension( [in] long nDimension,
  45                               [in] XAxis xAxis,
  46                               [in] long nIndex )
  47         raises( com::sun::star::lang::IndexOutOfBoundsException );
  48
  49     /** The dimension says wether it is a x, y or z axis.
  50         The index indicates wether it is a primary or a secondary axis or maybe more in future.
  51         Use nIndex == 0 for a primary axis.
  52         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.
  53         An IndexOutOfBoundsException will be thrown if nDimension is lower than 0 or greater than the value returned by getDimension()
  54         and/or if nIndex is lower 0 or greater than the value returned by getMaxAxisIndexByDimension(nDimension).
  55      */
  56     XAxis getAxisByDimension( [in] long nDimension, [in] long nIndex )
  57         raises( com::sun::star::lang::IndexOutOfBoundsException );
  58
  59     /** In one dimension there could be several axes to enable main and secondary axis and maybe more in future.
  60         This method returns the maximum index at which an axis exists for the given dimension.
  61         It is allowed that some indexes inbetween do not have an axis.
  62     /*/
  63     long getMaximumAxisIndexByDimension( [in] long nDimension )
  64         raises( com::sun::star::lang::IndexOutOfBoundsException );
  65 };
  66
  67 } ; // chart2
  68 } ; // com
  69 } ; // sun
  70 } ; // star
  71
  72
  73 #endif