angular.Array.sum.html

<h1>angular.Array.sum</h1>
<fieldset class="workInProgress"><legend>Work in Progress</legend>
This page is currently being revised. It might be incomplete or contain inaccuracies.</fieldset>
<h2>Description</h2>
<p>This function calculates the sum of all numbers in <code>array</code>. If the <code>expressions</code> is supplied,
it is evaluated once for each element in <code>array</code> and then the sum of these values is returned.</p>

<p>Note: this function is used to augment the Array type in angular expressions. See
<a href="#!angular.Array"><code>angular.Array</code></a> for more info.</p><h2>Usage</h2>
<div ng:non-bindable=""><pre class="brush: js; html-script: true;">angular.Array.sum(array, expression);</pre>
</div>
<h3>Parameters</h3>
<ul class="parameters"><li><code ng:non-bindable="">array – {Array} – </code>
The source array.</li>
<li><code ng:non-bindable="">expression<i>(optional)</i> – {(string|function())} – </code>
Angular expression or a function to be evaluated for each
    element in <code>array</code>. The array element becomes the <code>this</code> during the evaluation.</li>
</ul>
<h3>Returns</h3>
<code ng:non-bindable="">number</code>
– Sum of items in the array.<h2>Example</h2>
<doc:example><doc:source>&lt;table ng:init="invoice= {items:[{qty:10, description:'gadget', cost:9.95}]}"&gt;
  &lt;tr&gt;&lt;th&gt;Qty&lt;/th&gt;&lt;th&gt;Description&lt;/th&gt;&lt;th&gt;Cost&lt;/th&gt;&lt;th&gt;Total&lt;/th&gt;&lt;th&gt;&lt;/th&gt;&lt;/tr&gt;
  &lt;tr ng:repeat="item in invoice.items"&gt;
    &lt;td&gt;&lt;input name="item.qty" value="1" size="4" ng:required ng:validate="integer"&gt;&lt;/td&gt;
   &lt;td&gt;&lt;input name="item.description"&gt;&lt;/td&gt;
     &lt;td&gt;&lt;input name="item.cost" value="0.00" ng:required ng:validate="number" size="6"&gt;&lt;/td&gt;
    &lt;td&gt;{{item.qty * item.cost | currency}}&lt;/td&gt;
    &lt;td&gt;[&lt;a href ng:click="invoice.items.$remove(item)"&gt;X&lt;/a&gt;]&lt;/td&gt;
  &lt;/tr&gt;
  &lt;tr&gt;
    &lt;td&gt;&lt;a href ng:click="invoice.items.$add()"&gt;add item&lt;/a&gt;&lt;/td&gt;
    &lt;td&gt;&lt;/td&gt;
    &lt;td&gt;Total:&lt;/td&gt;
    &lt;td&gt;{{invoice.items.$sum('qty*cost') | currency}}&lt;/td&gt;
  &lt;/tr&gt;
&lt;/table&gt;</doc:source>
<doc:scenario>//TODO: these specs are lame because I had to work around issues #164 and #167
it('should initialize and calculate the totals', function() {
  expect(repeater('.doc-example-live table tr', 'item in invoice.items').count()).toBe(3);
  expect(repeater('.doc-example-live table tr', 'item in invoice.items').row(1)).
    toEqual(['$99.50']);
  expect(binding("invoice.items.$sum('qty*cost')")).toBe('$99.50');
  expect(binding("invoice.items.$sum('qty*cost')")).toBe('$99.50');
});

it('should add an entry and recalculate', function() {
  element('.doc-example a:contains("add item")').click();
  using('.doc-example-live tr:nth-child(3)').input('item.qty').enter('20');
  using('.doc-example-live tr:nth-child(3)').input('item.cost').enter('100');

  expect(repeater('.doc-example-live table tr', 'item in invoice.items').row(2)).
    toEqual(['$2,000.00']);
  expect(binding("invoice.items.$sum('qty*cost')")).toBe('$2,099.50');
});</doc:scenario>
</doc:example>