Skip to main content Link Search Menu Expand Document (external link)

averageOf() : Calculate Average of Property

On this page

Summary

Calculate the arithmetic mean (average) of a specific numeric property across all items in a collection.

Signature 

averageOf(collection, propertyName)

Parameters

Parameter Type Required Description
collection Array/Collection Yes The collection of objects
propertyName String Yes Name of the numeric property to average

Returns

Type: Number (Decimal)

The arithmetic mean of the specified property. Returns null for empty collections.

Examples

Average Price 

<p>Average product price: $</p>

Data:

doc.Params["model"] = new {
    products = new[] {
        new { name = "Widget A", price = 15.50 },
        new { name = "Widget B", price = 22.00 },
        new { name = "Widget C", price = 8.75 }
    }
};

Output:

<p>Average product price: $15.42</p>

Sales Performance 

<h3>Sales Summary</h3>
<p>Average daily sales: $</p>
<p>Total sales: $</p>
<p>Number of days: </p>

Data:

doc.Params["model"] = new {
    dailySales = new[] {
        new { date = "2024-03-01", amount = 1250.00 },
        new { date = "2024-03-02", amount = 1580.50 },
        new { date = "2024-03-03", amount = 1420.00 },
        new { date = "2024-03-04", amount = 1890.25 }
    }
};

Output:

<h3>Sales Summary</h3>
<p>Average daily sales: $1535.19</p>
<p>Total sales: $6140.75</p>
<p>Number of days: 4</p>

Team Statistics 


  <h4></h4>
  <p>Average experience:  years</p>
  <p>Team size:  members</p>

Data:

doc.Params["model"] = new {
    teams = new[] {
        new {
            name = "Development",
            members = new[] {
                new { name = "Alice", yearsExperience = 5 },
                new { name = "Bob", yearsExperience = 3 },
                new { name = "Charlie", yearsExperience = 7 }
            }
        },
        new {
            name = "Design",
            members = new[] {
                new { name = "Diana", yearsExperience = 4 },
                new { name = "Eve", yearsExperience = 6 }
            }
        }
    }
};

Output:

<h4>Development</h4>
<p>Average experience: 5.0 years</p>
<p>Team size: 3 members</p>
<h4>Design</h4>
<p>Average experience: 5.0 years</p>
<p>Team size: 2 members</p>

Performance Benchmarks 

<h3>Server Performance</h3>
<p>Average CPU usage: %</p>
<p>Average memory usage: %</p>
<p>Peak CPU: %</p>

Data:

doc.Params["model"] = new {
    servers = new[] {
        new { name = "Server-01", cpuUsage = 45, memoryUsage = 62 },
        new { name = "Server-02", cpuUsage = 52, memoryUsage = 58 },
        new { name = "Server-03", cpuUsage = 38, memoryUsage = 71 }
    }
};

Output:

<h3>Server Performance</h3>
<p>Average CPU usage: 45.0%</p>
<p>Average memory usage: 63.7%</p>
<p>Peak CPU: 52%</p>

Notes

  • Returns null for empty or null collections
  • Property must exist on all items and be numeric
  • More concise than average(collect(collection, 'property'))
  • Result is a decimal (use round() for formatting)
  • Case-sensitive property names
  • Useful for:
    • Price analysis
    • Performance metrics
    • Statistical reports
    • Quality scores
    • Resource utilization
  • For simple numeric arrays, use average() instead
  • Consider median() for datasets with outliers
  • Formula: sum of property values divided by count

See Also