@barchart/portfolio-api-common 1.2.79 → 1.2.83

package/lib/processing/PositionContainer.js

@@ -276,7 +276,7 @@ module.exports = (() => {
 
 			const existingBarchartSymbols = this.getPositionSymbols(false);
 
-			removePositionItem.call(this, this._items.find((item) => item.position.position === position.position));
+			removePositionItem.call(this, this._items.find(item => item.position.position === position.position));
 
 			summaries.forEach((summary) => {
 				addSummaryCurrent(this._summariesCurrent, summary, this._currentSummaryFrame, this._currentSummaryRange);
@@ -336,7 +336,7 @@ module.exports = (() => {
 			assert.argumentIsRequired(position, 'position', Object);
 			assert.argumentIsRequired(position.position, 'position.position', String);
 
-			removePositionItem.call(this, this._items.find((item) => item.position.position === position.position));
+			removePositionItem.call(this, this._items.find(item => item.position.position === position.position));
 
 			recalculatePercentages.call(this);
 		}
@@ -371,21 +371,41 @@ module.exports = (() => {
 			return array.unique(symbols);
 		}
 
+		/**
+		 * Causes a position to be flagged as locked (for editing).
+		 *
+		 * @public
+		 * @param {Object} position
+		 */
 		setPositionLock(position) {
 			if (position) {
 				assert.argumentIsRequired(position, 'position', Object);
 				assert.argumentIsRequired(position.position, 'position.position', String);
 
-				const item = this._items.find((i) => i.position.position === position.position);
+				const item = this._items.find(i => i.position.position === position.position);
 
 				if (item) {
-					const locked = is.object(position.system) && is.boolean(position.system.locked) && position.system.locked;
-
-					item.setPositionLock(locked);
+					item.setPositionLock(position);
 				}
 			}
 		}
 
+		/**
+		 * Returns a position's lock status.
+		 *
+		 * @public
+		 * @param {Object} position
+		 * @return {Boolean}
+		 */
+		getPositionLock(portfolio, position) {
+			assert.argumentIsRequired(position, 'position', Object);
+			assert.argumentIsRequired(position.position, 'position.position', String);
+
+			const item = this._items.find(i => i.position.position === position.position);
+
+			return is.object(item) && item.locked;
+		}
+
 		/**
 		 * Performs a batch update of both position quotes and forex quotes,
 		 * triggering updates to position(s) and data aggregation(s).

package/lib/processing/PositionItem.js

@@ -70,7 +70,7 @@ module.exports = (() => {
 
 			this._data.newsExists = false;
 			this._data.fundamental = { };
-			this._data.locked = is.object(position.system) && is.boolean(position.system.locked) && position.system.locked;
+			this._data.locked = getIsLocked(position);
 
 			calculateStaticData(this);
 			calculatePriceData(this, null);
@@ -242,18 +242,20 @@ module.exports = (() => {
 		}
 
 		/**
-		 * Sets position lock status.
+		 * Sets a position's lock status.
 		 *
 		 * @public
-		 * @param {Boolean} value
+		 * @param {Object} position
 		 */
-		setPositionLock(value) {
-			assert.argumentIsRequired(value, 'value', Boolean);
+		setPositionLock(position) {
+			assert.argumentIsRequired(position, 'position');
 
 			if (this.getIsDisposed()) {
 				return;
 			}
 
+			const value = getIsLocked(position);
+
 			if (this._data.locked !== value) {
 				this._lockChangedEvent.fire(this._data.locked = value);
 			}
@@ -525,5 +527,11 @@ module.exports = (() => {
 		return summary;
 	}
 
+	function getIsLocked(position) {
+		assert.argumentIsRequired(position, 'position');
+
+		return is.object(position.system) && is.boolean(position.system.locked) && position.system.locked;
+	}
+
 	return PositionItem;
 })();

package/package.json

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

package/test/SpecRunner.js

@@ -1655,7 +1655,7 @@ module.exports = (() => {
 
 			const existingBarchartSymbols = this.getPositionSymbols(false);
 
-			removePositionItem.call(this, this._items.find((item) => item.position.position === position.position));
+			removePositionItem.call(this, this._items.find(item => item.position.position === position.position));
 
 			summaries.forEach((summary) => {
 				addSummaryCurrent(this._summariesCurrent, summary, this._currentSummaryFrame, this._currentSummaryRange);
@@ -1715,7 +1715,7 @@ module.exports = (() => {
 			assert.argumentIsRequired(position, 'position', Object);
 			assert.argumentIsRequired(position.position, 'position.position', String);
 
-			removePositionItem.call(this, this._items.find((item) => item.position.position === position.position));
+			removePositionItem.call(this, this._items.find(item => item.position.position === position.position));
 
 			recalculatePercentages.call(this);
 		}
@@ -1750,21 +1750,41 @@ module.exports = (() => {
 			return array.unique(symbols);
 		}
 
+		/**
+		 * Causes a position to be flagged as locked (for editing).
+		 *
+		 * @public
+		 * @param {Object} position
+		 */
 		setPositionLock(position) {
 			if (position) {
 				assert.argumentIsRequired(position, 'position', Object);
 				assert.argumentIsRequired(position.position, 'position.position', String);
 
-				const item = this._items.find((i) => i.position.position === position.position);
+				const item = this._items.find(i => i.position.position === position.position);
 
 				if (item) {
-					const locked = is.object(position.system) && is.boolean(position.system.locked) && position.system.locked;
-
-					item.setPositionLock(locked);
+					item.setPositionLock(position);
 				}
 			}
 		}
 
+		/**
+		 * Returns a position's lock status.
+		 *
+		 * @public
+		 * @param {Object} position
+		 * @return {Boolean}
+		 */
+		getPositionLock(portfolio, position) {
+			assert.argumentIsRequired(position, 'position', Object);
+			assert.argumentIsRequired(position.position, 'position.position', String);
+
+			const item = this._items.find(i => i.position.position === position.position);
+
+			return is.object(item) && item.locked;
+		}
+
 		/**
 		 * Performs a batch update of both position quotes and forex quotes,
 		 * triggering updates to position(s) and data aggregation(s).
@@ -3278,7 +3298,7 @@ module.exports = (() => {
 
 			this._data.newsExists = false;
 			this._data.fundamental = { };
-			this._data.locked = is.object(position.system) && is.boolean(position.system.locked) && position.system.locked;
+			this._data.locked = getIsLocked(position);
 
 			calculateStaticData(this);
 			calculatePriceData(this, null);
@@ -3450,18 +3470,20 @@ module.exports = (() => {
 		}
 
 		/**
-		 * Sets position lock status.
+		 * Sets a position's lock status.
 		 *
 		 * @public
-		 * @param {Boolean} value
+		 * @param {Object} position
 		 */
-		setPositionLock(value) {
-			assert.argumentIsRequired(value, 'value', Boolean);
+		setPositionLock(position) {
+			assert.argumentIsRequired(position, 'position');
 
 			if (this.getIsDisposed()) {
 				return;
 			}
 
+			const value = getIsLocked(position);
+
 			if (this._data.locked !== value) {
 				this._lockChangedEvent.fire(this._data.locked = value);
 			}
@@ -3733,6 +3755,12 @@ module.exports = (() => {
 		return summary;
 	}
 
+	function getIsLocked(position) {
+		assert.argumentIsRequired(position, 'position');
+
+		return is.object(position.system) && is.boolean(position.system.locked) && position.system.locked;
+	}
+
 	return PositionItem;
 })();