offapi/com/sun/star/chart/Diagram.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_chart_Diagram_idl__
  28 #define __com_sun_star_chart_Diagram_idl__
  29
  30 #ifndef __com_sun_star_chart_XDiagram_idl__
  31 #include <com/sun/star/chart/XDiagram.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_chart_XDiagramPositioning_idl__
  35 #include <com/sun/star/chart/XDiagramPositioning.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_chart_XSecondAxisTitleSupplier_idl__
  39 #include <com/sun/star/chart/XSecondAxisTitleSupplier.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_beans_XPropertySet_idl__
  43 #include <com/sun/star/beans/XPropertySet.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_chart_ChartDataRowSource_idl__
  47 #include <com/sun/star/chart/ChartDataRowSource.idl>
  48 #endif
  49
  50 #ifndef _com_sun_star_xml_UserDefinedAttributeSupplier_idl_
  51 #include <com/sun/star/xml/UserDefinedAttributeSupplier.idl>
  52 #endif
  53
  54 //=============================================================================
  55
  56  module com {  module sun {  module star {  module chart {
  57
  58 //=============================================================================
  59
  60 /** the base service for the diagram of the chart document.
  61
  62     <p>The diagram is the object that contains the actual plot.</p>
  63
  64     <p>Different Diagram Types, e.g., <type>PieDiagram</type> or
  65     <type>LineDiagram</type>, can be instantiated by the
  66     <type scope="com::sun::star::lang">XMultiServiceFactory</type> of
  67     the <type>XChartDocument</type>.</p>
  68
  69  */
  70 published service Diagram
  71 {
  72
  73     interface com::sun::star::chart::XDiagram;
  74
  75     /** Provides access to the titles of the secondary X axis and Y axis.
  76
  77         @since OOo 3.0
  78      */
  79     [optional] interface com::sun::star::chart::XSecondAxisTitleSupplier;
  80
  81     /**
  82     @since OOo 3.3
  83      */
  84     [optional] interface com::sun::star::chart::XDiagramPositioning;
  85
  86     //-------------------------------------------------------------------------
  87
  88     /** If this property is <TRUE/> the position is calculated by the application automatically.
  89         Setting this property to false will have no effect. Instead use the interface <type scope="com::sun::star::drawing">XShape</type>
  90         to set a concrete position (note <type scope="com::sun::star::chart">XDiagram</type> is derived from <type scope="com::sun::star::drawing">XShape</type>).
  91      */
  92     [optional, property] boolean AutomaticPosition;
  93
  94     //-------------------------------------------------------------------------
  95
  96     /** If this property is <TRUE/> the size is calculated by the application automatically.
  97         Setting this property to false will have no effect. Instead use the interface <type scope="com::sun::star::drawing">XShape</type>
  98         to set a concrete size (note <type scope="com::sun::star::chart">XDiagram</type> is derived from <type scope="com::sun::star::drawing">XShape</type>).
  99      */
 100     [optional, property] boolean AutomaticSize;
 101
 102     //-------------------------------------------------------------------------
 103
 104     interface com::sun::star::beans::XPropertySet;
 105
 106     //-------------------------------------------------------------------------
 107
 108     /** If a <type>Diagram</type> may be stored as XML file, this
 109         service should be supported in order to preserve unparsed XML
 110         attributes.
 111
 112     @since OOo 1.1.2
 113      */
 114     [optional] service com::sun::star::xml::UserDefinedAttributeSupplier;
 115
 116     //-------------------------------------------------------------------------
 117
 118     /** determines if the data for a data row is contained in the
 119         columns or in the rows of the data array.
 120
 121         @see ChartDataRowSource
 122         @see ChartDataArray
 123      */
 124     [property] com::sun::star::chart::ChartDataRowSource DataRowSource;
 125
 126     //-------------------------------------------------------------------------
 127
 128     /** specifies how the caption of data points is displayed.
 129
 130         @see ChartDataCaption
 131      */
 132     [property] long DataCaption;
 133
 134     //-------------------------------------------------------------------------
 135
 136     /** specifies how empty or invalid cells in the provided data should be handled when displayed
 137
 138         @see MissingValueTreatment
 139      */
 140     [optional, property] long MissingValueTreatment;
 141
 142 };
 143
 144 //=============================================================================
 145
 146 }; }; }; };
 147
 148 #endif