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