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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_chart_Diagram_idl__
  20 #define __com_sun_star_chart_Diagram_idl__
  21
  22 #include <com/sun/star/chart/XDiagram.idl>
  23 #include <com/sun/star/chart/XAxisSupplier.idl>
  24 #include <com/sun/star/chart/XDiagramPositioning.idl>
  25
  26 #include <com/sun/star/chart/XSecondAxisTitleSupplier.idl>
  27 #include <com/sun/star/beans/XPropertySet.idl>
  28
  29 #include <com/sun/star/chart/ChartDataRowSource.idl>
  30
  31 #include <com/sun/star/xml/UserDefinedAttributesSupplier.idl>
  32
  33
  34  module com {  module sun {  module star {  module chart {
  35
  36
  37 /** the base service for the diagram of the chart document.
  38
  39     <p>The diagram is the object that contains the actual plot.</p>
  40
  41     <p>Different Diagram Types, e.g., PieDiagram or
  42     LineDiagram, can be instantiated by the
  43     com::sun::star::lang::XMultiServiceFactory of
  44     the XChartDocument.</p>
  45
  46  */
  47 published service Diagram
  48 {
  49
  50     interface com::sun::star::chart::XDiagram;
  51
  52     /** Provides easier access to the differnet axes and their sub elements.
  53         @since OOo 3.4
  54     */
  55     [optional] interface com::sun::star::chart::XAxisSupplier;
  56
  57     /** Provides access to the titles of the secondary X axis and Y axis.
  58         @since OOo 3.0
  59      */
  60     [optional] interface com::sun::star::chart::XSecondAxisTitleSupplier;
  61
  62     /**
  63     @since OOo 3.3
  64      */
  65     [optional] interface com::sun::star::chart::XDiagramPositioning;
  66
  67
  68     /** If this property is `TRUE` the position is calculated by the application automatically.
  69         Setting this property to false will have no effect. Instead use the interface com::sun::star::drawing::XShape
  70         to set a concrete position (note com::sun::star::chart::XDiagram is derived from com::sun::star::drawing::XShape).
  71      */
  72     [optional, property] boolean AutomaticPosition;
  73
  74
  75     /** If this property is `TRUE` the size is calculated by the application automatically.
  76         Setting this property to false will have no effect. Instead use the interface com::sun::star::drawing::XShape
  77         to set a concrete size (note com::sun::star::chart::XDiagram is derived from com::sun::star::drawing::XShape).
  78      */
  79     [optional, property] boolean AutomaticSize;
  80
  81
  82     interface com::sun::star::beans::XPropertySet;
  83
  84
  85     /** If a Diagram may be stored as XML file, this
  86         service should be supported in order to preserve unparsed XML
  87         attributes.
  88
  89     @since OOo 1.1.2
  90      */
  91     [optional] service com::sun::star::xml::UserDefinedAttributesSupplier;
  92
  93
  94     /** determines if the data for a data row is contained in the
  95         columns or in the rows of the data array.
  96
  97         @see ChartDataRowSource
  98         @see ChartDataArray
  99      */
 100     [property] com::sun::star::chart::ChartDataRowSource DataRowSource;
 101
 102
 103     /** specifies how the caption of data points is displayed.
 104
 105         @see ChartDataCaption
 106      */
 107     [property] long DataCaption;
 108
 109
 110     /** specifies how empty or invalid cells in the provided data should be handled when displayed
 111
 112         @see MissingValueTreatment
 113      */
 114     [optional, property] long MissingValueTreatment;
 115
 116 };
 117
 118
 119 }; }; }; };
 120
 121 #endif
 122
 123 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */