offapi/com/sun/star/chart/XChartDocument.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
  20
  21
  22  module com {  module sun {  module star {  module chart {
  23
  24
  25 /** manages the chart document.
  26
  27     @see XDiagram
  28     @see XChartData
  29  */
  30 published interface XChartDocument: com::sun::star::frame::XModel
  31 {
  32
  33     /** @returns
  34             the shape of the main title of the chart document.
  35
  36         @see ChartTitle
  37      */
  38     com::sun::star::drawing::XShape getTitle();
  39
  40
  41     /** @returns
  42             the shape of the subtitle of the chart document.
  43
  44        <p>Usually the subtitle is smaller than the main title by
  45        default.  And it is most commonly placed below the main title
  46        by default.</p>
  47
  48         @see ChartTitle
  49      */
  50     com::sun::star::drawing::XShape getSubTitle();
  51
  52
  53     /** @returns
  54             the shape of the legend of the chart document.
  55
  56         @see ChartLegend
  57      */
  58     com::sun::star::drawing::XShape getLegend();
  59
  60
  61     /** @returns
  62             the properties of the background area of the chart document.
  63
  64         <p>The area's extent is equal to the document size.  If you
  65         want to access properties of the background area of the
  66         diagram, in which the actual data is represented, you have to
  67         change the chart wall which you get from the
  68         X3DDisplay.</p>
  69
  70         @see ChartArea
  71         @see X3DDisplay
  72      */
  73     com::sun::star::beans::XPropertySet getArea();
  74
  75
  76     /** @returns
  77             the diagram of the chart document.
  78
  79         @see Diagram
  80      */
  81     com::sun::star::chart::XDiagram getDiagram();
  82
  83
  84     /** sets the diagram for the chart document.
  85
  86         <p>Setting a new diagram implicitly disposes the previous
  87         diagram.</p>
  88
  89         @param xDiagram
  90             the new diagram that should be set for the chart.  To
  91             create such a diagram component, you can use the
  92             com::sun::star::lang::XMultiServiceFactory,
  93             which should be implemented by an
  94             XChartDocument.
  95      */
  96     void setDiagram( [in] com::sun::star::chart::XDiagram xDiagram );
  97
  98
  99     /** @returns
 100             the data of the chart.
 101
 102         <p>The returned object supports interface XChartDataArray
 103         which can be used to access the concrete data.</p>
 104
 105         <p>Since OOo 3.3 the returned object also supports interface XComplexDescriptionAccess
 106         which can be used to access complex hierarchical axis descriptions.</p>
 107
 108         <p>Since OOo 3.4 the returned object also supports interface XDateCategories.</p>
 109
 110         @see XChartData
 111         @see XChartDataArray
 112         @see XComplexDescriptionAccess
 113         @see XDateCategories
 114      */
 115     com::sun::star::chart::XChartData getData();
 116
 117
 118     /** attaches data to the chart.
 119
 120         <p>The given object needs to support interface XChartDataArray.</p>
 121
 122         <p>Since OOo 3.3 if the given object might support interface XComplexDescriptionAccess
 123         which allows to set complex hierarchical axis descriptions.</p>
 124
 125         <p>Since OOo 3.4 if the given object might support interface XDateCategories
 126         which allows to set date values as x values for category charts.</p>
 127
 128         <p>The given data is copied before it is applied to the chart.
 129         So changing xData after this call will have no effect on the chart.</p>
 130
 131         @see XChartData
 132         @see XChartDataArray
 133         @see XComplexDescriptionAccess
 134         @see XDateCategories
 135
 136         @param xData
 137             the object that provides the new data.
 138      */
 139     void attachData( [in] com::sun::star::chart::XChartData xData );
 140
 141 };
 142
 143
 144 }; }; }; };
 145
 146 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */