summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/table/XTablePivotCharts.idl
blob: acdd1f59a03f5e8f3ec9cf5b8553b09b7054bb98 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

#ifndef __com_sun_star_table_XTablePivotCharts_idl__
#define __com_sun_star_table_XTablePivotCharts_idl__

#include <com/sun/star/container/XNameAccess.idl>
#include <com/sun/star/awt/Rectangle.idl>

module com {  module sun {  module star {  module table {

/** provides methods to access pivot charts via name and to insert
    and remove pivot charts.

    @since LibreOffice 5.4
 */
interface XTablePivotCharts: com::sun::star::container::XNameAccess
{
    /** creates a pivot chart and adds it to the collection.

        @param aName
            is the name of the chart. This name is used to reference the
            chart in the collection.

        @param aRect
            contains the rectangular location of the chart within the table
            (in 1/100th mm).

        @param aPivotTableName
            the name of the pivot table (data pilot) to associate the pivot chart with
     */
    void addNewByName(
            [in] string aName,
            [in] com::sun::star::awt::Rectangle aRect,
            [in] string aPivotTableName);

    /** removes a pivot chart from the collection.

        @param aName
            is the name of the chart to remove.
     */
    void removeByName([in] string aName);
};

}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */