offapi/com/sun/star/chart/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
  21  module com {  module sun {  module star {  module chart {
  22
  23
  24 /** manages the diagram of the chart document.
  25
  26     @see XChartDocument
  27  */
  28 published interface XDiagram: com::sun::star::drawing::XShape
  29 {
  30
  31     /** @returns
  32             a string representing the diagram type. This string
  33             contains the fully qualified name of the corresponding
  34             service.
  35      */
  36     string getDiagramType();
  37
  38
  39     /** @returns
  40             the properties of the specified data row (series).
  41
  42         @param nRow
  43             the index of the series (0-based)
  44
  45         @see ChartDataRowProperties
  46      */
  47     com::sun::star::beans::XPropertySet getDataRowProperties( [in] long nRow )
  48         raises( com::sun::star::lang::IndexOutOfBoundsException );
  49
  50
  51     /** @returns
  52             the properties of the specified data point.
  53
  54         @param nCol
  55             the index of the data point of a series (0-based).
  56         @param nRow
  57             the index of a series (0-based).
  58
  59         @see ChartDataPointProperties
  60      */
  61     com::sun::star::beans::XPropertySet getDataPointProperties( [in] long nCol,
  62                                                                 [in] long nRow )
  63         raises( com::sun::star::lang::IndexOutOfBoundsException );
  64
  65 };
  66
  67
  68 }; }; }; };
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */