Variable: org-columns-summary-types

org-columns-summary-types is a customizable variable defined in org-colview.el.gz.

Value

nil

Documentation

Alist between operators and summarize functions.

Each association follows the pattern (LABEL . SUMMARIZE), or (LABEL SUMMARIZE COLLECT) where

  LABEL is a string used in #+COLUMNS definition describing the
  summary type. It can contain any character but "}". It is
  case-sensitive.

  SUMMARIZE is a function called with two arguments. The first
  argument is a non-empty list of values, as non-empty strings.
  The second one is a format string or nil. It has to return
  a string summarizing the list of values.

  COLLECT is a function called with one argument, a property
  name. It is called in the context of a headline and must
  return the collected property, or the empty string. You can
  use this to only collect a property if a related conditional
  properties is set, e.g., to return VACATION_DAYS only if
  CONFIRMED is true.

Note that the return value can become one value for a higher-order summary, so the function is expected to handle its own output.

Types defined in this variable take precedence over those defined in org-columns-summary-types-default, which see.

This variable was added, or its default value changed, in Org version
9.0.

Source Code

;; Defined in /usr/src/emacs/lisp/org/org-colview.el.gz
(defcustom org-columns-summary-types nil
  "Alist between operators and summarize functions.

Each association follows the pattern (LABEL . SUMMARIZE),
or (LABEL SUMMARIZE COLLECT) where

  LABEL is a string used in #+COLUMNS definition describing the
  summary type.  It can contain any character but \"}\".  It is
  case-sensitive.

  SUMMARIZE is a function called with two arguments.  The first
  argument is a non-empty list of values, as non-empty strings.
  The second one is a format string or nil.  It has to return
  a string summarizing the list of values.

  COLLECT is a function called with one argument, a property
  name.  It is called in the context of a headline and must
  return the collected property, or the empty string.  You can
  use this to only collect a property if a related conditional
  properties is set, e.g., to return VACATION_DAYS only if
  CONFIRMED is true.

Note that the return value can become one value for a higher-order
summary, so the function is expected to handle its own output.

Types defined in this variable take precedence over those defined
in `org-columns-summary-types-default', which see."
  :group 'org-properties
  :version "26.1"
  :package-version '(Org . "9.0")
  :type '(alist :key-type (string :tag "       Label")
		:value-type
		(choice (function :tag "Summarize")
			(list :tag "Collect and summarize"
			      (function :tag "Summarize")
			      (function :tag "Collect")))))