/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: ChartStatistics.idl,v $
 *
 *  $Revision: 1.9 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-07 22:10:53 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_chart_ChartStatistics_idl__
#define __com_sun_star_chart_ChartStatistics_idl__

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

#ifndef __com_sun_star_chart_ChartErrorCategory_idl__
#include <com/sun/star/chart/ChartErrorCategory.idl>
#endif

#ifndef __com_sun_star_chart_ChartErrorIndicatorType_idl__
#include <com/sun/star/chart/ChartErrorIndicatorType.idl>
#endif

#ifndef __com_sun_star_chart_ChartRegressionCurveType_idl__
#include <com/sun/star/chart/ChartRegressionCurveType.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module chart {

//=============================================================================

/** offers statistical properties for the data in the chart. It is
    available for a single data row and for the whole diagram.
 */
published service ChartStatistics
{
    interface com::sun::star::beans::XPropertySet;

    //-------------------------------------------------------------------------

    /** specifies the lower limit of the error range of a
        data row.

        <p>this setting is effective if the
        <member>ChartStatistics::ErrorCategory</member> is set to
        <member>ChartErrorCategory::CONSTANT_VALUE</member>.</p>

        @see ConstantErrorHigh
        @see ErrorCategory
     */
    [property] double ConstantErrorLow;

    //-------------------------------------------------------------------------

    /** specifies the upper limit of the error range of a
        data row.

        <p>this setting is effective if the
        <member>ChartStatistics::ErrorCategory</member> is set to
        <member>ChartErrorCategory::CONSTANT_VALUE</member>.</p>

        @see ConstantErrorLow
        @see ErrorCategory
     */
    [property] double ConstantErrorHigh;

    //-------------------------------------------------------------------------

    /** determines if the mean value for a data row is
        displayed as a line.
     */
    [property] boolean MeanValue;

    //-------------------------------------------------------------------------

    /** determines the type of error to indicate.

        @see ChartErrorCategory
        @see PercentageError
        @see ErrorMargin
        @see ConstantErrorLow
        @see ConstantErrorHigh
        @see ErrorIndicator
     */
    [property] com::sun::star::chart::ChartErrorCategory ErrorCategory;

    //-------------------------------------------------------------------------

    /** specifies the percentage that is used to display error bars.

        <p>The length of the error indicators is calculated for each
        data point by taking the given percentatge of its value.</p>

        <p>this setting is effective if the
        <member>ChartStatistics::ErrorCategory</member> is set to
        <member>ChartErrorCategory::PERCENT</member>.</p>

        @see ErrorCategory
     */
    [property] double PercentageError;

    //-------------------------------------------------------------------------

    /** specifies the percentage for the margin of errors.

        <p>The length of the error indicators is calculated by taking
        the percentage given of the largest data point value.</p>

        <p>this setting is effective if the
        <member>ChartStatistics::ErrorCategory</member> is set to
        <member>ChartErrorCategory::ERROR_MARGIN</member>.</p>

        @see ErrorCategory
     */
    [property] double ErrorMargin;

    //-------------------------------------------------------------------------

    /** determines how the error is indicated.

        <p>You can enable indicators pointing up, down or both.</p>

        @see ErrorCategory
     */
    [property] com::sun::star::chart::ChartErrorIndicatorType ErrorIndicator;

    //-------------------------------------------------------------------------

    /** determines a type of regression for the data row values.

        @see ChartRegressionCurveType
     */
    [property] com::sun::star::chart::ChartRegressionCurveType RegressionCurves;

};

//=============================================================================

}; }; }; };

#endif
