@barchart/portfolio-api-common 1.0.85 → 1.0.90

package/lib/data/PositionSummaryFrame.js

@@ -37,12 +37,13 @@ module.exports = (() => {
 		 * start and end dates.
 		 *
 		 * @public
-		 * @param {Day} startDate
-		 * @param {Day} endDate
+		 * @return {PositionSummaryRange} range
 		 * @return {String}
 		 */
-		describeRange(startDate, endDate) {
-			return this._descriptionCalculator(startDate, endDate);
+		describeRange(range) {
+			console.log('range: ', range);
+
+			return this._descriptionCalculator(range.start, range.end);
 		}
 
 		/**
@@ -226,20 +227,20 @@ module.exports = (() => {
 		return null;
 	}
 
-	function getYearlyRangeDescription(startDate, endDate) {
-		return endDate.year.toString();
+	function getYearlyRangeDescription(start, end) {
+		return end.year.toString();
 	}
 
-	function getQuarterlyRangeDescription(startDate, endDate) {
+	function getQuarterlyRangeDescription(start, end) {
 		return '';
 	}
 
-	function getMonthlyRangeDescription(startDate, endDate) {
+	function getMonthlyRangeDescription(start, end) {
 		return '';
 	}
 
-	function getYearToDateRangeDescription(startDate, endDate) {
-		return `${endDate.year.toString()} YTD`;
+	function getYearToDateRangeDescription(start, end) {
+		return `${end.year.toString()} YTD`;
 	}
 
 	function getFilteredTransactions(transactions) {

package/lib/data/TransactionType.js

@@ -11,6 +11,7 @@ module.exports = (() => {
 	 * @extends {Enum}
 	 * @param {String} code
 	 * @param {String} description
+	 * @param {String} display
 	 * @param {Boolean} purchase
 	 * @param {Boolean} sale
 	 * @param {Boolean} income
@@ -18,15 +19,17 @@ module.exports = (() => {
 	 * @param {Boolean} closing
 	 */
 	class TransactionType extends Enum {
-		constructor(code, description, purchase, sale, income, opening, closing) {
+		constructor(code, description, display, purchase, sale, income, opening, closing) {
 			super(code, description);
 
+			assert.argumentIsRequired(display, 'display', String);
 			assert.argumentIsRequired(purchase, 'purchase', Boolean);
 			assert.argumentIsRequired(sale, 'sale', Boolean);
 			assert.argumentIsRequired(income, 'income', Boolean);
 			assert.argumentIsRequired(opening, 'opening', Boolean);
 			assert.argumentIsRequired(closing, 'closing', Boolean);
 
+			this._display = display;
 			this._purchase = purchase;
 			this._sale = sale;
 			this._income = income;
@@ -34,6 +37,16 @@ module.exports = (() => {
 			this._closing = closing;
 		}
 
+		/**
+		 * A human-readable description of the transaction type.
+		 *
+		 * @public
+		 * @returns {String}
+		 */
+		get display() {
+			return this._display;
+		}
+
 		/**
 		 * Indicates if the transaction was a trade.
 		 *
@@ -299,27 +312,27 @@ module.exports = (() => {
 		}
 	}
 
-	const buy = new TransactionType('B', 'Buy', true, false, false, true,  false);
-	const sell = new TransactionType('S', 'Sell', false, true, false, false, true);
-	const buyShort = new TransactionType('BS', 'Buy To Cover', true, false, false, false, true);
-	const sellShort = new TransactionType('SS', 'Sell Short',  false, true, false, true, false);
-	const dividend = new TransactionType('DV', 'Dividend', false, false, true, false, false);
-	const dividendReinvest = new TransactionType('DX', 'Dividend (Reinvested)', false, false, false, true, false);
-	const dividendStock = new TransactionType('DS', 'Dividend (Stock)', false, false, false, true, false);
-	const split = new TransactionType('SP', 'Split', false, false, false, true, false);
-	const fee = new TransactionType('F', 'Fee', false, false, false, true, false);
-	const feeUnits = new TransactionType('FU', 'Fee', false, false, false, false, false);
-
-	const distributionCash = new TransactionType('DC', 'Distribution (Cash)', false, false, true, false, false);
-	const distributionFund = new TransactionType('DF', 'Distribution (Units)', false, false, false, true, false);
-
-	const deposit = new TransactionType('D', 'Deposit', false, false, false, true, false);
-	const withdrawal = new TransactionType('W', 'Withdrawal', false, false, false, false, true);
-	const debit = new TransactionType('DR', 'Debit', false, false, false, false, true);
-	const credit = new TransactionType('CR', 'Credit', false, false, false, true, false);
-
-	const valuation = new TransactionType('V', 'Valuation', false, false, false, false, false);
-	const income = new TransactionType('I', 'Income', false, false, true, false, false);
+	const buy = new TransactionType('B', 'Buy', 'Buy', true, false, false, true,  false);
+	const sell = new TransactionType('S', 'Sell', 'Sell', false, true, false, false, true);
+	const buyShort = new TransactionType('BS', 'Buy To Cover', 'Buy To Cover', true, false, false, false, true);
+	const sellShort = new TransactionType('SS', 'Sell Short', 'Sell Short', false, true, false, true, false);
+	const dividend = new TransactionType('DV', 'Dividend', 'Dividend', false, false, true, false, false);
+	const dividendReinvest = new TransactionType('DX', 'Dividend (Reinvested)', 'Dividend Reinvest', false, false, false, true, false);
+	const dividendStock = new TransactionType('DS', 'Dividend (Stock)', 'Dividend Stock', false, false, false, true, false);
+	const split = new TransactionType('SP', 'Split', 'Split', false, false, false, true, false);
+	const fee = new TransactionType('F', 'Fee', 'Fee', false, false, false, true, false);
+	const feeUnits = new TransactionType('FU', 'Fee Units', 'Fee', false, false, false, false, false);
+
+	const distributionCash = new TransactionType('DC', 'Distribution (Cash)', 'Cash Distribution', false, false, true, false, false);
+	const distributionFund = new TransactionType('DF', 'Distribution (Units)', 'Unit Distribution', false, false, false, true, false);
+
+	const deposit = new TransactionType('D', 'Deposit', 'Deposit', false, false, false, true, false);
+	const withdrawal = new TransactionType('W', 'Withdrawal', 'Withdrawal', false, false, false, false, true);
+	const debit = new TransactionType('DR', 'Debit', 'Debit', false, false, false, false, true);
+	const credit = new TransactionType('CR', 'Credit', 'Credit', false, false, false, true, false);
+
+	const valuation = new TransactionType('V', 'Valuation', 'Valuation', false, false, false, false, false);
+	const income = new TransactionType('I', 'Income', 'Income', false, false, true, false, false);
 
 	return TransactionType;
 })();

package/lib/formatters/TransactionFormatter.js

@@ -35,9 +35,9 @@ module.exports = (() => {
 
 			const positionMap = {};
 
-			positions.map((p) => positionMap[p.position] = p.instrument);
+			positions.map(p => positionMap[p.position] = p.instrument);
 
-			return transactions.filter((t) => positionMap[t.position]).map((transaction) => {
+			return transactions.filter(t => positionMap[t.position]).map((transaction) => {
 				transaction.instrument = positionMap[transaction.position];
 
 				let formatted = getBasicTransaction(transaction);
@@ -76,7 +76,7 @@ module.exports = (() => {
 	const getBasicTransaction = (t) => {
 		const basic = {
 			date: t.date,
-			type: t.type,
+			type: t.type.display,
 			sequence: t.sequence,
 			instrument: t.instrument
 		};
@@ -98,6 +98,7 @@ module.exports = (() => {
 			total: t.amount
 		};
 	};
+
 	formatters.set(TransactionType.BUY, buySellFormatter);
 	formatters.set(TransactionType.SELL, buySellFormatter);
 	formatters.set(TransactionType.BUY_SHORT, buySellFormatter);

package/lib/processing/PositionContainer.js

@@ -18,12 +18,18 @@ module.exports = (() => {
 	 * @public
 	 */
 	class PositionContainer {
-		constructor(portfolios, positions, summaries, definitions, defaultCurrency, summaryFrameType) {
+		constructor(portfolios, positions, summaries, definitions, defaultCurrency, summaryFrame) {
 			this._definitions = definitions;
 			this._defaultCurrency = defaultCurrency || Currency.CAD;
+			
+			const previousSummaryFrame = summaryFrame || PositionSummaryFrame.YEARLY;
+			const previousSummaryRanges = previousSummaryFrame.getRecentRanges(0);
 
-			this._summaryFrame = summaryFrameType || PositionSummaryFrame.YEARLY;
-			this._summaryRanges = this._summaryFrame.getRecentRanges(1);
+			const currentSummaryFrame = PositionSummaryFrame.YTD;
+			const currentSummaryRange = array.last(currentSummaryFrame.getRecentRanges(0));
+
+			this._summaryDescriptionCurrent = previousSummaryFrame.describeRange(array.last(previousSummaryRanges));
+			this._summaryDescriptionPrevious = currentSummaryFrame.describeRange(currentSummaryRange);
 
 			this._portfolios = portfolios.reduce((map, portfolio) => {
 				map[portfolio.portfolio] = portfolio;
@@ -31,15 +37,25 @@ module.exports = (() => {
 				return map;
 			}, { });
 
-			this._summaries = summaries.reduce((map, summary) => {
-				if (this._summaryFrame === summary.frame) {
+			this._summariesCurrent = summaries.reduce((map, summary) => {
+				if (summary.frame === currentSummaryFrame && currentSummaryRange.start.getIsEqual(summary.start.date) && currentSummaryRange.end.getIsEqual(summary.end.date)) {
+					const key = summary.position;
+
+					map[key] = summary;
+				}
+
+				return map;
+			}, { });
+			
+			this._summariesPrevious = summaries.reduce((map, summary) => {
+				if (summary.frame === previousSummaryFrame) {
 					const key = summary.position;
 
 					if (!map.hasOwnProperty(key)) {
-						map[key] = getSummaryArray(this._summaryRanges);
+						map[key] = getSummaryArray(previousSummaryRanges);
 					}
 
-					const index = this._summaryRanges.findIndex(r => r.start.getIsEqual(summary.start.date) && r.end.getIsEqual(summary.end.date));
+					const index = previousSummaryRanges.findIndex(r => r.start.getIsEqual(summary.start.date) && r.end.getIsEqual(summary.end.date));
 
 					if (!(index < 0)) {
 						map[key][index] = summary;
@@ -53,9 +69,10 @@ module.exports = (() => {
 				const portfolio = this._portfolios[position.portfolio];
 
 				if (position) {
-					const summaries = this._summaries[position.position] || getSummaryArray(this._summaryRanges);
+					const currentSummary = this._summariesCurrent[position.position] || null;
+					const previousSummaries = this._summariesPrevious[position.position] || getSummaryArray(previousSummaryRanges);
 
-					items.push(new PositionItem(portfolio, position, summaries));
+					items.push(new PositionItem(portfolio, position, currentSummary, previousSummaries));
 				}
 
 				return items;
@@ -153,6 +170,10 @@ module.exports = (() => {
 				compositeGroups.forEach((group) => {
 					const child = tree.addChild(group);
 
+					group.registerMarketPercentChangeHandler(() => {
+						this._tree.walk((childGroup) => childGroup.refreshMarketPercent());
+					});
+
 					createGroups(child, group.items, additionalDefinitions);
 				});
 			};
@@ -163,7 +184,25 @@ module.exports = (() => {
 		get defaultCurrency() {
 			return this._defaultCurrency;
 		}
+		
+		getCurrentSummaryDescription() {
+			return this._summaryDescriptionCurrent;
+		}
+		
+		getPreviousSummaryDescription() {
+			return this._summaryDescriptionPrevious;
+		}
+
+		startTransaction(executor) {
+			assert.argumentIsRequired(executor, 'executor', Function);
+
+			this._tree.walk(group => group.setSuspended(true), false, false);
+
+			executor(this);
 
+			this._tree.walk(group => group.setSuspended(false), false, false);
+		}
+		
 		getSymbols() {
 			return Object.keys(this._symbols);
 		}
@@ -190,16 +229,6 @@ module.exports = (() => {
 
 		}
 
-		startTransaction(executor) {
-			assert.argumentIsRequired(executor, 'executor', Function);
-
-			this._tree.walk(group => group.setSuspended(true), false, false);
-
-			executor(this);
-
-			this._tree.walk(group => group.setSuspended(false), false, false);
-		}
-
 		getGroup(keys) {
 			const node = keys.reduce((tree, key) => {
 				tree = tree.findChild(group => group.description === key);

package/lib/processing/PositionGroup.js

@@ -1,6 +1,7 @@
 const assert = require('@barchart/common-js/lang/assert'),
 	Currency = require('@barchart/common-js/lang/Currency'),
 	Decimal = require('@barchart/common-js/lang/Decimal'),
+	Event = require('@barchart/common-js/messaging/Event'),
 	formatter = require('@barchart/common-js/lang/formatter'),
 	is = require('@barchart/common-js/lang/is');
 
@@ -25,6 +26,8 @@ module.exports = (() => {
 			this._excluded = false;
 			this._suspended = false;
 
+			this._marketPercentChangeEvent = new Event(this);
+
 			this._dataFormat = { };
 			this._dataActual = { };
 			
@@ -39,8 +42,8 @@ module.exports = (() => {
 			this._dataActual.marketPercent = null;
 			this._dataActual.unrealizedToday = null;
 			this._dataActual.total = null;
-			this._dataActual.summaryOneTotal = null;
-			this._dataActual.summaryTwoTotal = null;
+			this._dataActual.summaryTotalCurrent = null;
+			this._dataActual.summaryTotalPrevious = null;
 
 			this._dataFormat.currentPrice = null;
 			this._dataFormat.previousPrice = null;
@@ -54,8 +57,8 @@ module.exports = (() => {
 			this._dataFormat.unrealizedTodayNegative = false;
 			this._dataFormat.total = null;
 			this._dataFormat.totalNegative = false;
-			this._dataFormat.summaryOneTotal = null;
-			this._dataFormat.summaryTwoTotal = null;
+			this._dataFormat.summaryTotalCurrent = null;
+			this._dataFormat.summaryTotalPrevious = null;
 
 			this._dataFormat.unrealizedTodayNegative = false;
 
@@ -135,6 +138,14 @@ module.exports = (() => {
 			calculatePriceData(this, null, true);
 		}
 
+		refreshMarketPercent() {
+			calculateMarketPercent(this, true);
+		}
+
+		registerMarketPercentChangeHandler(handler) {
+			this._marketPercentChangeEvent.register(handler);
+		}
+
 		toString() {
 			return '[PositionGroup]';
 		}
@@ -176,29 +187,29 @@ module.exports = (() => {
 			updates.basis = updates.basis.add(item.data.basis);
 			updates.realized = updates.realized.add(item.data.realized);
 			updates.income = updates.income.add(item.data.income);
-			updates.summaryOneTotal = updates.summaryOneTotal.add(item.data.summaryOneTotal);
-			updates.summaryTwoTotal = updates.summaryTwoTotal.add(item.data.summaryTwoTotal);
+			updates.summaryTotalCurrent = updates.summaryTotalCurrent.add(item.data.summaryTotalCurrent);
+			updates.summaryTotalPrevious = updates.summaryTotalPrevious.add(item.data.summaryTotalPrevious);
 
 			return updates;
 		}, {
 			basis: Decimal.ZERO,
 			realized: Decimal.ZERO,
 			income: Decimal.ZERO,
-			summaryOneTotal: Decimal.ZERO,
-			summaryTwoTotal: Decimal.ZERO
+			summaryTotalCurrent: Decimal.ZERO,
+			summaryTotalPrevious: Decimal.ZERO
 		});
 
 		actual.basis = updates.basis;
 		actual.realized = updates.realized;
 		actual.income = updates.income;
-		actual.summaryOneTotal = updates.summaryOneTotal;
-		actual.summaryTwoTotal = updates.summaryTwoTotal;
+		actual.summaryTotalCurrent = updates.summaryTotalCurrent;
+		actual.summaryTotalPrevious = updates.summaryTotalPrevious;
 
 		format.basis = formatCurrency(actual.basis, currency);
 		format.realized = formatCurrency(actual.basis, currency);
 		format.income = formatCurrency(actual.income, currency);
-		format.summaryOneTotal = formatCurrency(updates.summaryOneTotal, currency);
-		format.summaryTwoTotal = formatCurrency(updates.summaryTwoTotal, currency);
+		format.summaryTotalCurrent = formatCurrency(updates.summaryTotalCurrent, currency);
+		format.summaryTotalPrevious = formatCurrency(updates.summaryTotalPrevious, currency);
 	}
 
 	function calculatePriceData(group, item, forceRefresh) {
@@ -252,12 +263,11 @@ module.exports = (() => {
 		}
 
 		actual.market = updates.market;
-		actual.marketPercent = updates.marketPercent;
 		actual.unrealizedToday = updates.unrealizedToday;
 		actual.total = updates.unrealizedToday.add(actual.realized).add(actual.income);
+		
 		format.market = formatCurrency(actual.market, currency);
-		format.marketPercent = formatPercent(actual.marketPercent, 2);
-
+		
 		if (updates.marketDirection.up || updates.marketDirection.down) {
 			format.marketDirection = unchanged;
 			setTimeout(() => format.marketDirection = updates.marketDirection, 0);
@@ -267,10 +277,41 @@ module.exports = (() => {
 		format.unrealizedTodayNegative = actual.unrealizedToday.getIsNegative();
 		format.total = formatCurrency(actual.total, currency);
 		format.totalNegative = actual.total.getIsNegative();
+		
+		calculateMarketPercent(group, false);
 	}
 
-	function calculatePercent() {
+	function calculateMarketPercent(group, silent) {
+		if (group.suspended) {
+			return;
+		}
+
+		const parent = group._parent;
+
+		const actual = group._dataActual;
+		const format = group._dataFormat;
+		
+		let marketPercent;
+		
+		if (parent !== null) {
+			const parentData = parent._dataActual;
+
+			if (parentData.market !== null && !parentData.market.getIsZero()) {
+				marketPercent = actual.market.divide(parentData.market);
+			} else {
+				marketPercent = null;
+			}
+		} else {
+			marketPercent = null;
+		}
 
+		actual.marketPercent = marketPercent;
+		
+		format.marketPercent = formatPercent(actual.marketPercent, 2);
+		
+		if (!silent) {
+			group._marketPercentChangeEvent.fire(group);
+		}
 	}
 
 	const unchanged = { up: false, down: false };

package/lib/processing/PositionItem.js

@@ -1,4 +1,5 @@
-const assert = require('@barchart/common-js/lang/assert'),
+const array = require('@barchart/common-js/lang/array'),
+	assert = require('@barchart/common-js/lang/assert'),
 	Decimal = require('@barchart/common-js/lang/Decimal'),
 	Event = require('@barchart/common-js/messaging/Event'),
 	is = require('@barchart/common-js/lang/is');
@@ -12,10 +13,12 @@ module.exports = (() => {
 	 * @public
 	 */
 	class PositionItem {
-		constructor(portfolio, position, summaries) {
+		constructor(portfolio, position, currentSummary, previousSummaries) {
 			this._portfolio = portfolio;
 			this._position = position;
-			this._summaries = summaries || [ ];
+			
+			this._currentSummary = currentSummary || null;
+			this._previousSummaries = previousSummaries || [ ];
 
 			this._data = { };
 
@@ -32,6 +35,9 @@ module.exports = (() => {
 
 			this._data.realized = null;
 			this._data.income = null;
+			
+			this._data.summaryTotalCurrent = null;
+			this._data.summaryTotalPrevious = null;
 
 			this._excluded = false;
 
@@ -50,8 +56,12 @@ module.exports = (() => {
 			return this._position;
 		}
 
-		get summaries() {
-			return this._summaries;
+		get currentSummary() {
+			return this._currentSummary;
+		}
+		
+		get previousSummaries() {
+			return this._previousSummaries;
 		}
 
 		get data() {
@@ -96,7 +106,7 @@ module.exports = (() => {
 	function calculateStaticData(item) {
 		const position = item.position;
 		const snapshot = item.position.snapshot;
-		const summaries = item.summaries;
+		const previousSummaries = item.previousSummaries;
 
 		const data = item._data;
 
@@ -115,22 +125,8 @@ module.exports = (() => {
 		data.realized = snapshot.gain;
 		data.income = snapshot.income;
 
-		const getSummaryTotal = (index) => {
-			let summaryTotal;
-
-			if (summaries.length > index && summaries[index] !== null) {
-				const period = summaries[index].period;
-
-				summaryTotal = period.realized.add(period.unrealized).add(period.income);
-			} else {
-				summaryTotal = Decimal.ZERO;
-			}
-
-			return summaryTotal;
-		};
-
-		data.summaryOneTotal = getSummaryTotal(0);
-		data.summaryTwoTotal = getSummaryTotal(1);
+		data.summaryTotalCurrent = calculateSummaryTotal(item.currentSummary);
+		data.summaryTotalPrevious = calculateSummaryTotal(array.last(previousSummaries));
 	}
 
 	function calculatePriceData(item, price) {
@@ -183,6 +179,20 @@ module.exports = (() => {
 		data.unrealizedToday = unrealizedToday;
 		data.unrealizedTodayChange = unrealizedTodayChange;
 	}
+	
+	function calculateSummaryTotal(summary) {
+		let returnRef;
+		
+		if (summary) {
+			const period = summary.period;
+
+			returnRef = period.realized.add(period.unrealized).add(period.income);
+		} else {
+			returnRef = Decimal.ZERO;
+		}
+		
+		return returnRef;
+	}
 
 	return PositionItem;
 })();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barchart/portfolio-api-common",
-  "version": "1.0.85",
+  "version": "1.0.90",
   "description": "Common classes used by the Portfolio system",
   "author": {
     "name": "Bryan Ingle",

package/test/SpecRunner.js

@@ -156,12 +156,13 @@ module.exports = (() => {
 		 * start and end dates.
 		 *
 		 * @public
-		 * @param {Day} startDate
-		 * @param {Day} endDate
+		 * @return {PositionSummaryRange} range
 		 * @return {String}
 		 */
-		describeRange(startDate, endDate) {
-			return this._descriptionCalculator(startDate, endDate);
+		describeRange(range) {
+			console.log('range: ', range);
+
+			return this._descriptionCalculator(range.start, range.end);
 		}
 
 		/**
@@ -345,20 +346,20 @@ module.exports = (() => {
 		return null;
 	}
 
-	function getYearlyRangeDescription(startDate, endDate) {
-		return endDate.year.toString();
+	function getYearlyRangeDescription(start, end) {
+		return end.year.toString();
 	}
 
-	function getQuarterlyRangeDescription(startDate, endDate) {
+	function getQuarterlyRangeDescription(start, end) {
 		return '';
 	}
 
-	function getMonthlyRangeDescription(startDate, endDate) {
+	function getMonthlyRangeDescription(start, end) {
 		return '';
 	}
 
-	function getYearToDateRangeDescription(startDate, endDate) {
-		return `${endDate.year.toString()} YTD`;
+	function getYearToDateRangeDescription(start, end) {
+		return `${end.year.toString()} YTD`;
 	}
 
 	function getFilteredTransactions(transactions) {
@@ -388,6 +389,7 @@ module.exports = (() => {
 	 * @extends {Enum}
 	 * @param {String} code
 	 * @param {String} description
+	 * @param {String} display
 	 * @param {Boolean} purchase
 	 * @param {Boolean} sale
 	 * @param {Boolean} income
@@ -395,15 +397,17 @@ module.exports = (() => {
 	 * @param {Boolean} closing
 	 */
 	class TransactionType extends Enum {
-		constructor(code, description, purchase, sale, income, opening, closing) {
+		constructor(code, description, display, purchase, sale, income, opening, closing) {
 			super(code, description);
 
+			assert.argumentIsRequired(display, 'display', String);
 			assert.argumentIsRequired(purchase, 'purchase', Boolean);
 			assert.argumentIsRequired(sale, 'sale', Boolean);
 			assert.argumentIsRequired(income, 'income', Boolean);
 			assert.argumentIsRequired(opening, 'opening', Boolean);
 			assert.argumentIsRequired(closing, 'closing', Boolean);
 
+			this._display = display;
 			this._purchase = purchase;
 			this._sale = sale;
 			this._income = income;
@@ -411,6 +415,16 @@ module.exports = (() => {
 			this._closing = closing;
 		}
 
+		/**
+		 * A human-readable description of the transaction type.
+		 *
+		 * @public
+		 * @returns {String}
+		 */
+		get display() {
+			return this._display;
+		}
+
 		/**
 		 * Indicates if the transaction was a trade.
 		 *
@@ -676,27 +690,27 @@ module.exports = (() => {
 		}
 	}
 
-	const buy = new TransactionType('B', 'Buy', true, false, false, true,  false);
-	const sell = new TransactionType('S', 'Sell', false, true, false, false, true);
-	const buyShort = new TransactionType('BS', 'Buy To Cover', true, false, false, false, true);
-	const sellShort = new TransactionType('SS', 'Sell Short',  false, true, false, true, false);
-	const dividend = new TransactionType('DV', 'Dividend', false, false, true, false, false);
-	const dividendReinvest = new TransactionType('DX', 'Dividend (Reinvested)', false, false, false, true, false);
-	const dividendStock = new TransactionType('DS', 'Dividend (Stock)', false, false, false, true, false);
-	const split = new TransactionType('SP', 'Split', false, false, false, true, false);
-	const fee = new TransactionType('F', 'Fee', false, false, false, true, false);
-	const feeUnits = new TransactionType('FU', 'Fee', false, false, false, false, false);
+	const buy = new TransactionType('B', 'Buy', 'Buy', true, false, false, true,  false);
+	const sell = new TransactionType('S', 'Sell', 'Sell', false, true, false, false, true);
+	const buyShort = new TransactionType('BS', 'Buy To Cover', 'Buy To Cover', true, false, false, false, true);
+	const sellShort = new TransactionType('SS', 'Sell Short', 'Sell Short', false, true, false, true, false);
+	const dividend = new TransactionType('DV', 'Dividend', 'Dividend', false, false, true, false, false);
+	const dividendReinvest = new TransactionType('DX', 'Dividend (Reinvested)', 'Dividend Reinvest', false, false, false, true, false);
+	const dividendStock = new TransactionType('DS', 'Dividend (Stock)', 'Dividend Stock', false, false, false, true, false);
+	const split = new TransactionType('SP', 'Split', 'Split', false, false, false, true, false);
+	const fee = new TransactionType('F', 'Fee', 'Fee', false, false, false, true, false);
+	const feeUnits = new TransactionType('FU', 'Fee Units', 'Fee', false, false, false, false, false);
 
-	const distributionCash = new TransactionType('DC', 'Distribution (Cash)', false, false, true, false, false);
-	const distributionFund = new TransactionType('DF', 'Distribution (Units)', false, false, false, true, false);
+	const distributionCash = new TransactionType('DC', 'Distribution (Cash)', 'Cash Distribution', false, false, true, false, false);
+	const distributionFund = new TransactionType('DF', 'Distribution (Units)', 'Unit Distribution', false, false, false, true, false);
 
-	const deposit = new TransactionType('D', 'Deposit', false, false, false, true, false);
-	const withdrawal = new TransactionType('W', 'Withdrawal', false, false, false, false, true);
-	const debit = new TransactionType('DR', 'Debit', false, false, false, false, true);
-	const credit = new TransactionType('CR', 'Credit', false, false, false, true, false);
+	const deposit = new TransactionType('D', 'Deposit', 'Deposit', false, false, false, true, false);
+	const withdrawal = new TransactionType('W', 'Withdrawal', 'Withdrawal', false, false, false, false, true);
+	const debit = new TransactionType('DR', 'Debit', 'Debit', false, false, false, false, true);
+	const credit = new TransactionType('CR', 'Credit', 'Credit', false, false, false, true, false);
 
-	const valuation = new TransactionType('V', 'Valuation', false, false, false, false, false);
-	const income = new TransactionType('I', 'Income', false, false, true, false, false);
+	const valuation = new TransactionType('V', 'Valuation', 'Valuation', false, false, false, false, false);
+	const income = new TransactionType('I', 'Income', 'Income', false, false, true, false, false);
 
 	return TransactionType;
 })();
@@ -722,12 +736,18 @@ module.exports = (() => {
 	 * @public
 	 */
 	class PositionContainer {
-		constructor(portfolios, positions, summaries, definitions, defaultCurrency, summaryFrameType) {
+		constructor(portfolios, positions, summaries, definitions, defaultCurrency, summaryFrame) {
 			this._definitions = definitions;
 			this._defaultCurrency = defaultCurrency || Currency.CAD;
+			
+			const previousSummaryFrame = summaryFrame || PositionSummaryFrame.YEARLY;
+			const previousSummaryRanges = previousSummaryFrame.getRecentRanges(0);
+
+			const currentSummaryFrame = PositionSummaryFrame.YTD;
+			const currentSummaryRange = array.last(currentSummaryFrame.getRecentRanges(0));
 
-			this._summaryFrame = summaryFrameType || PositionSummaryFrame.YEARLY;
-			this._summaryRanges = this._summaryFrame.getRecentRanges(1);
+			this._summaryDescriptionCurrent = previousSummaryFrame.describeRange(array.last(previousSummaryRanges));
+			this._summaryDescriptionPrevious = currentSummaryFrame.describeRange(currentSummaryRange);
 
 			this._portfolios = portfolios.reduce((map, portfolio) => {
 				map[portfolio.portfolio] = portfolio;
@@ -735,15 +755,25 @@ module.exports = (() => {
 				return map;
 			}, { });
 
-			this._summaries = summaries.reduce((map, summary) => {
-				if (this._summaryFrame === summary.frame) {
+			this._summariesCurrent = summaries.reduce((map, summary) => {
+				if (summary.frame === currentSummaryFrame && currentSummaryRange.start.getIsEqual(summary.start.date) && currentSummaryRange.end.getIsEqual(summary.end.date)) {
+					const key = summary.position;
+
+					map[key] = summary;
+				}
+
+				return map;
+			}, { });
+			
+			this._summariesPrevious = summaries.reduce((map, summary) => {
+				if (summary.frame === previousSummaryFrame) {
 					const key = summary.position;
 
 					if (!map.hasOwnProperty(key)) {
-						map[key] = getSummaryArray(this._summaryRanges);
+						map[key] = getSummaryArray(previousSummaryRanges);
 					}
 
-					const index = this._summaryRanges.findIndex(r => r.start.getIsEqual(summary.start.date) && r.end.getIsEqual(summary.end.date));
+					const index = previousSummaryRanges.findIndex(r => r.start.getIsEqual(summary.start.date) && r.end.getIsEqual(summary.end.date));
 
 					if (!(index < 0)) {
 						map[key][index] = summary;
@@ -757,9 +787,10 @@ module.exports = (() => {
 				const portfolio = this._portfolios[position.portfolio];
 
 				if (position) {
-					const summaries = this._summaries[position.position] || getSummaryArray(this._summaryRanges);
+					const currentSummary = this._summariesCurrent[position.position] || null;
+					const previousSummaries = this._summariesPrevious[position.position] || getSummaryArray(previousSummaryRanges);
 
-					items.push(new PositionItem(portfolio, position, summaries));
+					items.push(new PositionItem(portfolio, position, currentSummary, previousSummaries));
 				}
 
 				return items;
@@ -857,6 +888,10 @@ module.exports = (() => {
 				compositeGroups.forEach((group) => {
 					const child = tree.addChild(group);
 
+					group.registerMarketPercentChangeHandler(() => {
+						this._tree.walk((childGroup) => childGroup.refreshMarketPercent());
+					});
+
 					createGroups(child, group.items, additionalDefinitions);
 				});
 			};
@@ -867,7 +902,25 @@ module.exports = (() => {
 		get defaultCurrency() {
 			return this._defaultCurrency;
 		}
+		
+		getCurrentSummaryDescription() {
+			return this._summaryDescriptionCurrent;
+		}
+		
+		getPreviousSummaryDescription() {
+			return this._summaryDescriptionPrevious;
+		}
+
+		startTransaction(executor) {
+			assert.argumentIsRequired(executor, 'executor', Function);
 
+			this._tree.walk(group => group.setSuspended(true), false, false);
+
+			executor(this);
+
+			this._tree.walk(group => group.setSuspended(false), false, false);
+		}
+		
 		getSymbols() {
 			return Object.keys(this._symbols);
 		}
@@ -894,16 +947,6 @@ module.exports = (() => {
 
 		}
 
-		startTransaction(executor) {
-			assert.argumentIsRequired(executor, 'executor', Function);
-
-			this._tree.walk(group => group.setSuspended(true), false, false);
-
-			executor(this);
-
-			this._tree.walk(group => group.setSuspended(false), false, false);
-		}
-
 		getGroup(keys) {
 			const node = keys.reduce((tree, key) => {
 				tree = tree.findChild(group => group.description === key);
@@ -940,6 +983,7 @@ module.exports = (() => {
 const assert = require('@barchart/common-js/lang/assert'),
 	Currency = require('@barchart/common-js/lang/Currency'),
 	Decimal = require('@barchart/common-js/lang/Decimal'),
+	Event = require('@barchart/common-js/messaging/Event'),
 	formatter = require('@barchart/common-js/lang/formatter'),
 	is = require('@barchart/common-js/lang/is');
 
@@ -964,6 +1008,8 @@ module.exports = (() => {
 			this._excluded = false;
 			this._suspended = false;
 
+			this._marketPercentChangeEvent = new Event(this);
+
 			this._dataFormat = { };
 			this._dataActual = { };
 			
@@ -978,8 +1024,8 @@ module.exports = (() => {
 			this._dataActual.marketPercent = null;
 			this._dataActual.unrealizedToday = null;
 			this._dataActual.total = null;
-			this._dataActual.summaryOneTotal = null;
-			this._dataActual.summaryTwoTotal = null;
+			this._dataActual.summaryTotalCurrent = null;
+			this._dataActual.summaryTotalPrevious = null;
 
 			this._dataFormat.currentPrice = null;
 			this._dataFormat.previousPrice = null;
@@ -993,8 +1039,8 @@ module.exports = (() => {
 			this._dataFormat.unrealizedTodayNegative = false;
 			this._dataFormat.total = null;
 			this._dataFormat.totalNegative = false;
-			this._dataFormat.summaryOneTotal = null;
-			this._dataFormat.summaryTwoTotal = null;
+			this._dataFormat.summaryTotalCurrent = null;
+			this._dataFormat.summaryTotalPrevious = null;
 
 			this._dataFormat.unrealizedTodayNegative = false;
 
@@ -1074,6 +1120,14 @@ module.exports = (() => {
 			calculatePriceData(this, null, true);
 		}
 
+		refreshMarketPercent() {
+			calculateMarketPercent(this, true);
+		}
+
+		registerMarketPercentChangeHandler(handler) {
+			this._marketPercentChangeEvent.register(handler);
+		}
+
 		toString() {
 			return '[PositionGroup]';
 		}
@@ -1115,29 +1169,29 @@ module.exports = (() => {
 			updates.basis = updates.basis.add(item.data.basis);
 			updates.realized = updates.realized.add(item.data.realized);
 			updates.income = updates.income.add(item.data.income);
-			updates.summaryOneTotal = updates.summaryOneTotal.add(item.data.summaryOneTotal);
-			updates.summaryTwoTotal = updates.summaryTwoTotal.add(item.data.summaryTwoTotal);
+			updates.summaryTotalCurrent = updates.summaryTotalCurrent.add(item.data.summaryTotalCurrent);
+			updates.summaryTotalPrevious = updates.summaryTotalPrevious.add(item.data.summaryTotalPrevious);
 
 			return updates;
 		}, {
 			basis: Decimal.ZERO,
 			realized: Decimal.ZERO,
 			income: Decimal.ZERO,
-			summaryOneTotal: Decimal.ZERO,
-			summaryTwoTotal: Decimal.ZERO
+			summaryTotalCurrent: Decimal.ZERO,
+			summaryTotalPrevious: Decimal.ZERO
 		});
 
 		actual.basis = updates.basis;
 		actual.realized = updates.realized;
 		actual.income = updates.income;
-		actual.summaryOneTotal = updates.summaryOneTotal;
-		actual.summaryTwoTotal = updates.summaryTwoTotal;
+		actual.summaryTotalCurrent = updates.summaryTotalCurrent;
+		actual.summaryTotalPrevious = updates.summaryTotalPrevious;
 
 		format.basis = formatCurrency(actual.basis, currency);
 		format.realized = formatCurrency(actual.basis, currency);
 		format.income = formatCurrency(actual.income, currency);
-		format.summaryOneTotal = formatCurrency(updates.summaryOneTotal, currency);
-		format.summaryTwoTotal = formatCurrency(updates.summaryTwoTotal, currency);
+		format.summaryTotalCurrent = formatCurrency(updates.summaryTotalCurrent, currency);
+		format.summaryTotalPrevious = formatCurrency(updates.summaryTotalPrevious, currency);
 	}
 
 	function calculatePriceData(group, item, forceRefresh) {
@@ -1191,12 +1245,11 @@ module.exports = (() => {
 		}
 
 		actual.market = updates.market;
-		actual.marketPercent = updates.marketPercent;
 		actual.unrealizedToday = updates.unrealizedToday;
 		actual.total = updates.unrealizedToday.add(actual.realized).add(actual.income);
+		
 		format.market = formatCurrency(actual.market, currency);
-		format.marketPercent = formatPercent(actual.marketPercent, 2);
-
+		
 		if (updates.marketDirection.up || updates.marketDirection.down) {
 			format.marketDirection = unchanged;
 			setTimeout(() => format.marketDirection = updates.marketDirection, 0);
@@ -1206,10 +1259,41 @@ module.exports = (() => {
 		format.unrealizedTodayNegative = actual.unrealizedToday.getIsNegative();
 		format.total = formatCurrency(actual.total, currency);
 		format.totalNegative = actual.total.getIsNegative();
+		
+		calculateMarketPercent(group, false);
 	}
 
-	function calculatePercent() {
+	function calculateMarketPercent(group, silent) {
+		if (group.suspended) {
+			return;
+		}
+
+		const parent = group._parent;
+
+		const actual = group._dataActual;
+		const format = group._dataFormat;
+		
+		let marketPercent;
+		
+		if (parent !== null) {
+			const parentData = parent._dataActual;
+
+			if (parentData.market !== null && !parentData.market.getIsZero()) {
+				marketPercent = actual.market.divide(parentData.market);
+			} else {
+				marketPercent = null;
+			}
+		} else {
+			marketPercent = null;
+		}
 
+		actual.marketPercent = marketPercent;
+		
+		format.marketPercent = formatPercent(actual.marketPercent, 2);
+		
+		if (!silent) {
+			group._marketPercentChangeEvent.fire(group);
+		}
 	}
 
 	const unchanged = { up: false, down: false };
@@ -1217,7 +1301,7 @@ module.exports = (() => {
 	return PositionGroup;
 })();
 
-},{"@barchart/common-js/lang/Currency":11,"@barchart/common-js/lang/Decimal":13,"@barchart/common-js/lang/assert":17,"@barchart/common-js/lang/formatter":18,"@barchart/common-js/lang/is":19}],6:[function(require,module,exports){
+},{"@barchart/common-js/lang/Currency":11,"@barchart/common-js/lang/Decimal":13,"@barchart/common-js/lang/assert":17,"@barchart/common-js/lang/formatter":18,"@barchart/common-js/lang/is":19,"@barchart/common-js/messaging/Event":20}],6:[function(require,module,exports){
 const assert = require('@barchart/common-js/lang/assert'),
 	is = require('@barchart/common-js/lang/is');
 
@@ -1268,7 +1352,8 @@ module.exports = (() => {
 })();
 
 },{"@barchart/common-js/lang/assert":17,"@barchart/common-js/lang/is":19}],7:[function(require,module,exports){
-const assert = require('@barchart/common-js/lang/assert'),
+const array = require('@barchart/common-js/lang/array'),
+	assert = require('@barchart/common-js/lang/assert'),
 	Decimal = require('@barchart/common-js/lang/Decimal'),
 	Event = require('@barchart/common-js/messaging/Event'),
 	is = require('@barchart/common-js/lang/is');
@@ -1282,10 +1367,12 @@ module.exports = (() => {
 	 * @public
 	 */
 	class PositionItem {
-		constructor(portfolio, position, summaries) {
+		constructor(portfolio, position, currentSummary, previousSummaries) {
 			this._portfolio = portfolio;
 			this._position = position;
-			this._summaries = summaries || [ ];
+			
+			this._currentSummary = currentSummary || null;
+			this._previousSummaries = previousSummaries || [ ];
 
 			this._data = { };
 
@@ -1302,6 +1389,9 @@ module.exports = (() => {
 
 			this._data.realized = null;
 			this._data.income = null;
+			
+			this._data.summaryTotalCurrent = null;
+			this._data.summaryTotalPrevious = null;
 
 			this._excluded = false;
 
@@ -1320,8 +1410,12 @@ module.exports = (() => {
 			return this._position;
 		}
 
-		get summaries() {
-			return this._summaries;
+		get currentSummary() {
+			return this._currentSummary;
+		}
+		
+		get previousSummaries() {
+			return this._previousSummaries;
 		}
 
 		get data() {
@@ -1366,7 +1460,7 @@ module.exports = (() => {
 	function calculateStaticData(item) {
 		const position = item.position;
 		const snapshot = item.position.snapshot;
-		const summaries = item.summaries;
+		const previousSummaries = item.previousSummaries;
 
 		const data = item._data;
 
@@ -1385,22 +1479,8 @@ module.exports = (() => {
 		data.realized = snapshot.gain;
 		data.income = snapshot.income;
 
-		const getSummaryTotal = (index) => {
-			let summaryTotal;
-
-			if (summaries.length > index && summaries[index] !== null) {
-				const period = summaries[index].period;
-
-				summaryTotal = period.realized.add(period.unrealized).add(period.income);
-			} else {
-				summaryTotal = Decimal.ZERO;
-			}
-
-			return summaryTotal;
-		};
-
-		data.summaryOneTotal = getSummaryTotal(0);
-		data.summaryTwoTotal = getSummaryTotal(1);
+		data.summaryTotalCurrent = calculateSummaryTotal(item.currentSummary);
+		data.summaryTotalPrevious = calculateSummaryTotal(array.last(previousSummaries));
 	}
 
 	function calculatePriceData(item, price) {
@@ -1453,11 +1533,25 @@ module.exports = (() => {
 		data.unrealizedToday = unrealizedToday;
 		data.unrealizedTodayChange = unrealizedTodayChange;
 	}
+	
+	function calculateSummaryTotal(summary) {
+		let returnRef;
+		
+		if (summary) {
+			const period = summary.period;
+
+			returnRef = period.realized.add(period.unrealized).add(period.income);
+		} else {
+			returnRef = Decimal.ZERO;
+		}
+		
+		return returnRef;
+	}
 
 	return PositionItem;
 })();
 
-},{"./../data/InstrumentType":1,"@barchart/common-js/lang/Decimal":13,"@barchart/common-js/lang/assert":17,"@barchart/common-js/lang/is":19,"@barchart/common-js/messaging/Event":20}],8:[function(require,module,exports){
+},{"./../data/InstrumentType":1,"@barchart/common-js/lang/Decimal":13,"@barchart/common-js/lang/array":16,"@barchart/common-js/lang/assert":17,"@barchart/common-js/lang/is":19,"@barchart/common-js/messaging/Event":20}],8:[function(require,module,exports){
 'use strict';
 
 var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
@@ -5871,10 +5965,10 @@ describe('When a position container data is gathered', () => {
 				income: new Decimal(0),
 				gain: new Decimal(0)
 			}
-		}
+		};
 	}
 
-	describe('for two portfolios, each with the same position, and the second portfolio with an additonal position', () => {
+	describe('for two portfolios, each with the same position, and the second portfolio with an addition position', () => {
 		let portfolios;
 		let positions;
 		let summaries;

package/test/specs/processing/PositionContainerSpec.js

@@ -29,10 +29,10 @@ describe('When a position container data is gathered', () => {
 				income: new Decimal(0),
 				gain: new Decimal(0)
 			}
-		}
+		};
 	}
 
-	describe('for two portfolios, each with the same position, and the second portfolio with an additonal position', () => {
+	describe('for two portfolios, each with the same position, and the second portfolio with an addition position', () => {
 		let portfolios;
 		let positions;
 		let summaries;