Difference between revisions of "Grouping Functions"

From JRiverWiki
Jump to: navigation, search
(Created page with "{{function type page}} The expression language is largely used to evaluate one file at a time. The grammar implies that something like {{monospace|Field(Artist)}} should...")
 
(11 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
{{incomplete}}
 
{{function type page}}
 
{{function type page}}
  
 
The [[expression language]] is largely used to evaluate one file at a time.  The grammar implies that something like {{monospace|Field(Artist)}} should get the Artist value for the current file being evaluated. Grouping Functions are a special class of functions that operate on a group of files, instead of on individual files.  A simple example would be a function to count the number of artists in the current group.
 
The [[expression language]] is largely used to evaluate one file at a time.  The grammar implies that something like {{monospace|Field(Artist)}} should get the Artist value for the current file being evaluated. Grouping Functions are a special class of functions that operate on a group of files, instead of on individual files.  A simple example would be a function to count the number of artists in the current group.
  
Grouping Functions may only be used in relevant areas (most notably Categories and the [[Tag Action Window]]) where Media Center displays groups of files, and not to individual file listings (such as an expression column in a File Details View).
+
Grouping Functions may only be used in relevant areas where Media Center displays groups of files (most notably in [[Categories]] and the [[Tag Action Window]]), and not to individual file listings (such as an expression column in a File Details View).
  
=== <span id="NAME">NAME(&hellip;)</span> ===
+
=== <span id="GroupCount">GroupCount(&hellip;)</span> ===
: SUMMARY
+
: Counts the members of a specified group (in a category or field).
  
 
{{function description box
 
{{function description box
| name=NAME
+
| name=GroupCount
| arguments=ARGUMENTS
+
| arguments=field
 
| description=
 
| description=
DESCRIPTION
+
{{argument optional|field|current grouping}}
 +
 
 +
GroupCount() can be used to count the members of a group of files.
 +
 
 
| examples=
 
| examples=
'''{{monospace|EXAMPLE1}}'''
+
'''Example Threads:'''
: EXAMPLETEXT
+
* [http://yabb.jriver.com/interact/index.php?topic=81766.msg564453#msg564453 Matt introduces Grouping Functions]
'''{{monospace|EXAMPLE2}}'''
+
* [http://yabb.jriver.com/interact/index.php?topic=94848.msg663421#msg663421 Use field names, not field values (square bracket notation)]
: EXAMPLETEXT
 
'''{{monospace|EXAMPLE3}}'''
 
: EXAMPLETEXT
 
'''{{monospace|EXAMPLE4}}'''
 
: EXAMPLETEXT
 
 
}}
 
}}
  
<pre>
+
=== <span id="GroupSummary">GroupSummary(&hellip;)</span> ===
To insert a table of arguments in the DESCRIPTION, use:
+
: Summarises the members of a specified group (in a category or field).
{{subst:argument table preset}}
+
 
</pre>
+
{{function description box
 +
| name=GroupSummary
 +
| arguments=field
 +
| description=
 +
{{argument optional|field|current grouping}}
 +
 
 +
Smartly summarizes the members of a specified group (mode, mean, min, max, etc as is most logical for that grouping).
 +
| examples=
 +
'''Example Threads:'''
 +
: [http://yabb.jriver.com/interact/index.php?topic=81766.msg564453#msg564453 Matt introduces Grouping Functions]
 +
: [http://yabb.jriver.com/interact/index.php?topic=94848.msg663421#msg663421 Use field names, not field values (square bracket notation)]
 +
}}

Revision as of 23:44, 24 September 2019

This article is a incomplete. It is missing detail about critical functions, or contains a number of red links. You can help the JRiver Wiki by expanding it.

The expression language is largely used to evaluate one file at a time. The grammar implies that something like Field(Artist) should get the Artist value for the current file being evaluated. Grouping Functions are a special class of functions that operate on a group of files, instead of on individual files. A simple example would be a function to count the number of artists in the current group.

Grouping Functions may only be used in relevant areas where Media Center displays groups of files (most notably in Categories and the Tag Action Window), and not to individual file listings (such as an expression column in a File Details View).

GroupCount(…)

Counts the members of a specified group (in a category or field).
Description GroupCount(field)
  • Argument field is optional (defaults to current grouping).

GroupCount() can be used to count the members of a group of files.

Examples Example Threads:

GroupSummary(…)

Summarises the members of a specified group (in a category or field).
Description GroupSummary(field)
  • Argument field is optional (defaults to current grouping).

Smartly summarizes the members of a specified group (mode, mean, min, max, etc as is most logical for that grouping).

Examples Example Threads:
Matt introduces Grouping Functions
Use field names, not field values (square bracket notation)