offapi/com/sun/star/chart2/XDiagram.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_chart2_XDiagram_idl
  20 #define com_sun_star_chart2_XDiagram_idl
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/beans/XPropertySet.idl>
  24 #include <com/sun/star/beans/PropertyValue.idl>
  25 #include <com/sun/star/chart2/XLegend.idl>
  26 #include <com/sun/star/chart2/XColorScheme.idl>
  27 #include <com/sun/star/chart2/data/XDataSource.idl>
  28 #include <com/sun/star/chart2/data/XLabeledDataSequence.idl>
  29
  30 module com
  31 {
  32 module sun
  33 {
  34 module star
  35 {
  36 module chart2
  37 {
  38
  39 interface XDiagram : ::com::sun::star::uno::XInterface
  40 {
  41     /** returns the property set that determines the visual appearance
  42         of the wall.
  43
  44         <p>The wall is the area behind the union of all
  45         coordinate systems used in a diagram.</p>
  46      */
  47     com::sun::star::beans::XPropertySet getWall();
  48
  49     /** returns the property set that determines the visual appearance
  50         of the floor if any.
  51
  52         <p>The floor is the bottom of a 3D diagram.
  53         For a 2D diagram NULL is returned.</p>
  54      */
  55     com::sun::star::beans::XPropertySet getFloor();
  56
  57     /** returns the legend, which may represent data series and other
  58         information about a diagram in a separate box.
  59      */
  60     XLegend getLegend();
  61
  62     /** sets a new legend.
  63      */
  64     void setLegend( [in] XLegend xLegend );
  65
  66     /** returns an XColorScheme that defines the default
  67         colors for data series (or data points) in the diagram.
  68      */
  69     XColorScheme   getDefaultColorScheme();
  70
  71     /** sets an XColorScheme that defines the default
  72         colors for data series (or data points) in the diagram.
  73      */
  74     void setDefaultColorScheme( [in] XColorScheme xColorScheme );
  75
  76     /** sets new data to the diagram.
  77
  78         @param xDataSource
  79             This data source will be interpreted in a chart-type
  80             specific way and the DataSeries found in
  81             <code>xDiagram</code> will be adapted to the new data.
  82             Missing data series will be created and unused ones will
  83             be deleted.
  84
  85         @param aArguments
  86             Arguments tells how to slice the given data.
  87
  88             <p>For standard parameters that may be used, see the
  89             service StandardDiagramCreationParameters.
  90             </p>
  91      */
  92     void setDiagramData( [in] com::sun::star::chart2::data::XDataSource xDataSource,
  93         [in] sequence< com::sun::star::beans::PropertyValue > aArguments );
  94 };
  95
  96 } ; // chart2
  97 } ; // com
  98 } ; // sun
  99 } ; // star
 100
 101 #endif
 102
 103 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */