offapi/com/sun/star/report/Calculation.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 #ifndef __com_sun_star_report_Calculation_idl__
  20 #define __com_sun_star_report_Calculation_idl__
  21
  22
  23
  24  module com {  module sun {  module star {  module report {
  25
  26
  27 /** Specifies how to calculate a value.
  28     @see XFormattedField
  29  */
  30 constants Calculation
  31 {
  32
  33     /** returns the average of a field.
  34      */
  35     const short NONE = 0;
  36
  37     /** returns the average of a field.
  38      */
  39     const short AVERAGE = 1;
  40
  41     /** returns the correlation of two fields.
  42      */
  43     const short CORRELATION = 2;
  44
  45     /** counts the number of values, from the field.
  46     */
  47     const short COUNT = 3;
  48
  49     /** returns the measure of the linear relation between paired variables.
  50     */
  51     const short COVARIANCE = 4;
  52
  53     /** returns the number of none repeating values, from the field.
  54     */
  55     const short DISTINCTCOUNT = 5;
  56
  57     /** returns the largest value from the field.
  58     */
  59     const short MAXIMUM = 6;
  60
  61     /** returns the middle value in a sequence of numeric values.
  62     */
  63     const short MEDIAN = 7;
  64
  65     /** returns the smallest value from the field.
  66     */
  67     const short MINIMUM = 8;
  68
  69     /** returns the most frequently returning value from the field.
  70     */
  71     const short MODE = 9;
  72
  73     /** returns the Nth largest value from the field.
  74     */
  75     const short NTHLARGEST = 10;
  76
  77     /** returns the Nth most commonly occurring value from the field.
  78     */
  79     const short NTHMOSTFREQUENT = 11;
  80
  81     /** returns the Nth smallest value from the field.
  82     */
  83     const short NTHSMALLEST = 12;
  84
  85     /** returns as a percentage of the grand total summary.
  86     */
  87     const short PERCENTAGE = 13;
  88
  89     /** returns the value for a specified percentile in a Number or Currency field.
  90     */
  91     const short PERCENTILE = 14;
  92
  93     /** returns how much each value in the field deviate from the mean or average value for that field.
  94     */
  95     const short POPSTANDARDDEVIATION = 15;
  96
  97     /** returns the square of the standard deviation.
  98     */
  99     const short POPVARIANCE = 16;
 100
 101     /** returns the sample standard deviation for the field.
 102     */
 103     const short SAMPLESTANDARDDEVIATION = 17;
 104
 105     /** returns the sample variance for the field.
 106     */
 107     const short SAMPLEVARIANCE = 18;
 108
 109     /** returns the total of all the values for the field.
 110     */
 111     const short SUM = 19;
 112
 113     /** returns the weighted average for the field.
 114     */
 115     const short WEIGHTEDAVG = 20;
 116 };
 117
 118
 119 }; }; }; };
 120
 121 #endif
 122
 123 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */