summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/chart2/XDataSeries.idl
blob: 7af8cdd00acfc073396defd20cf4e210a0abdd86 (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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
/* -*- 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/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef com_sun_star_chart2_XDataSeries_idl
#define com_sun_star_chart2_XDataSeries_idl

#include <com/sun/star/beans/XPropertySet.idl>
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/lang/IndexOutOfBoundsException.idl>

module com
{
module sun
{
module star
{
module chart2
{

/** A data series represents the object that has all the knowledge to
    be rendered as a visual data series.
 */
interface XDataSeries : ::com::sun::star::uno::XInterface
{
    /** @returns
            the element at the specified index.

        @param nIndex
            specifies the index of the data point within the series. The first index is 0.

        @throws com::sun::star::lang::IndexOutOfBoundsException
            if the index is not valid.
     */
    ::com::sun::star::beans::XPropertySet getDataPointByIndex( [in] long nIndex )
        raises( ::com::sun::star::lang::IndexOutOfBoundsException );

    /** the formatting of the specified data point is cleared

        @param nIndex
            specifies the index of the data point within the series. The first index is 0.
     */
    void resetDataPoint( [in] long nIndex );

    /** all data point formatting are cleared
     */
    void resetAllDataPoints();
};

} ; // chart2
} ; // com
} ; // sun
} ; // star


#endif

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