xref: /trunk/main/offapi/com/sun/star/chart2/XDataSeries.idl (revision d1766043)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef com_sun_star_chart2_XDataSeries_idl
#define com_sun_star_chart2_XDataSeries_idl

// #include <com/sun/star/chart2/XCoordinateSystem.idl>

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
#endif

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::IndexOutOfBoundException
			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 formattings are cleared
	 */
    void resetAllDataPoints();
};

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


#endif