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