bruce-cesium 2.6.4 → 2.6.6

package/dist/bruce-cesium.umd.js

@@ -1713,7 +1713,7 @@
     }
     function getName(api, entity) {
         return __awaiter(this, void 0, void 0, function () {
-            var typeId, type, name_1, e_1;
+            var typeId, type, name_1, e_1, hideError, error, code;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -1740,7 +1740,18 @@
                         return [3 /*break*/, 4];
                     case 3:
                         e_1 = _a.sent();
-                        console.error(e_1);
+                        hideError = false;
+                        // TODO: we need a util for extracting code + message rather than writing all this every time.
+                        if (e_1 && typeof e_1 == "object" && e_1.ERROR) {
+                            error = e_1.ERROR;
+                            code = error && typeof error == "object" ? error.Code : "";
+                            // Avoiding logging a common error.
+                            // This happens when rendering entities that don't have records.
+                            hideError = String(code).toLowerCase() == "notfound";
+                        }
+                        if (!hideError) {
+                            console.error(e_1);
+                        }
                         return [3 /*break*/, 4];
                     case 4: return [2 /*return*/, "Unknown entity"];
                 }
@@ -5738,17 +5749,20 @@
     (function (EntitiesLoadedRenderManager) {
         var Manager = /** @class */ (function () {
             function Manager(params) {
+                var _a;
                 this.getter = null;
                 this.getterSub = null;
                 this.disposed = false;
                 this.renderedEntities = {};
-                this.updatedEntities = {};
                 var viewer = params.viewer, apiGetter = params.apiGetter, monitor = params.monitor, item = params.item, visualsManager = params.register;
                 this.viewer = viewer;
                 this.apiGetter = apiGetter;
                 this.monitor = monitor;
                 this.item = item;
                 this.visualsManager = visualsManager;
+                if (!((_a = this.item.BruceEntity) === null || _a === void 0 ? void 0 : _a.Entities)) {
+                    this.item.BruceEntity = __assign(__assign({}, this.item.BruceEntity), { Entities: [] });
+                }
             }
             Object.defineProperty(Manager.prototype, "Disposed", {
                 get: function () {
@@ -5757,8 +5771,75 @@
                 enumerable: false,
                 configurable: true
             });
-            Manager.prototype.Init = function () {
+            /**
+             * Adds entities to menu item and queues the render for them.
+             * If the entity already exists in the menu item, it will be removed and redrawn.
+             * @param params
+             */
+            Manager.prototype.AddEntities = function (params) {
+                var _this = this;
+                if (this.disposed) {
+                    throw (new Error("This item is disposed."));
+                }
+                var entities = params.entities;
+                entities.forEach(function (x) {
+                    var _a;
+                    // If already in the menu item we'll first remove it.
+                    // That way we're using the latest provided data.
+                    var entityId = (_a = x.Bruce) === null || _a === void 0 ? void 0 : _a.ID;
+                    var index = _this.item.BruceEntity.Entities.findIndex(function (y) { var _a; return ((_a = y === null || y === void 0 ? void 0 : y.Bruce) === null || _a === void 0 ? void 0 : _a.ID) == entityId; });
+                    if (index > -1) {
+                        _this.item.BruceEntity.Entities.splice(index, 1);
+                    }
+                    _this.item.BruceEntity.Entities.push(x);
+                });
+                this.ReRender({
+                    entities: entities,
+                    entityIds: entities.map(function (x) { var _a; return (_a = x.Bruce) === null || _a === void 0 ? void 0 : _a.ID; }),
+                    force: true
+                });
+                this.recreateGetter();
+            };
+            /**
+             * Removes entities from the menu item that match provided IDs.
+             * Any visuals will be removed as well.
+             * @param params
+             */
+            Manager.prototype.RemoveEntities = function (params) {
                 var _this = this;
+                if (this.disposed) {
+                    throw (new Error("This item is disposed."));
+                }
+                var entityIds = params.entityIds;
+                entityIds.forEach(function (x) {
+                    var index = _this.item.BruceEntity.Entities.findIndex(function (y) { var _a; return ((_a = y === null || y === void 0 ? void 0 : y.Bruce) === null || _a === void 0 ? void 0 : _a.ID) == x; });
+                    if (index > -1) {
+                        _this.item.BruceEntity.Entities.splice(index, 1);
+                    }
+                    _this.visualsManager.RemoveRegos({
+                        entityId: x,
+                        menuItemId: _this.item.id
+                    });
+                    _this.renderedEntities[x] = false;
+                });
+                this.recreateGetter();
+            };
+            /**
+             * Clears all entities from the menu item.
+             * Any visuals will be removed as well.
+             */
+            Manager.prototype.ClearEntities = function () {
+                if (this.disposed) {
+                    throw (new Error("This item is disposed."));
+                }
+                this.item.BruceEntity.Entities = [];
+                this.visualsManager.RemoveRegos({
+                    menuItemId: this.item.id
+                });
+                this.renderedEntities = {};
+                this.recreateGetter();
+            };
+            Manager.prototype.Init = function () {
                 var _a;
                 if (this.disposed) {
                     throw (new Error("This item is disposed."));
@@ -5775,6 +5856,17 @@
                         }
                     ];
                 }
+                this.recreateGetter();
+            };
+            /**
+             * Recreates the getter for the entities.
+             * This is used when the entities within the menu item are updated.
+             * @todo: this causes a bad side-effect where all menu item entities are queued for a re-render.
+             */
+            Manager.prototype.recreateGetter = function () {
+                var _this = this;
+                var _a;
+                (_a = this.getterSub) === null || _a === void 0 ? void 0 : _a.call(this);
                 this.getter = new bruceModels.BatchedDataGetter.Getter(this.item.BruceEntity.Entities, this.monitor, BATCH_SIZE$1);
                 this.getterSub = this.getter.OnUpdate.Subscribe(function (entities) {
                     var _a;
@@ -5821,10 +5913,6 @@
                         }
                         if (entities === null || entities === void 0 ? void 0 : entities.length) {
                             entities = [].concat(entities).filter(function (x) { var _a; return entityIds.includes((_a = x.Bruce) === null || _a === void 0 ? void 0 : _a.ID); });
-                            entities.forEach(function (x) {
-                                var _a;
-                                _this.updatedEntities[(_a = x.Bruce) === null || _a === void 0 ? void 0 : _a.ID] = x;
-                            });
                         }
                         this.visualsManager.MarkStale({
                             entityIds: entityIds,
@@ -5875,7 +5963,6 @@
                                 if (!(ids.length > 0)) return [3 /*break*/, 4];
                                 checkBatch = function () { return __awaiter(_this, void 0, void 0, function () {
                                     var entityIds, entities;
-                                    var _this = this;
                                     return __generator(this, function (_a) {
                                         switch (_a.label) {
                                             case 0:
@@ -5889,10 +5976,6 @@
                                                 if (this.disposed) {
                                                     return [2 /*return*/];
                                                 }
-                                                entities.forEach(function (x) {
-                                                    var _a;
-                                                    _this.updatedEntities[(_a = x.Bruce) === null || _a === void 0 ? void 0 : _a.ID] = x;
-                                                });
                                                 this.onGetterUpdate(entities, force);
                                                 return [2 /*return*/];
                                         }
@@ -5919,7 +6002,8 @@
                 var _a;
                 if (force === void 0) { force = false; }
                 return __awaiter(this, void 0, void 0, function () {
-                    var cEntities, i, entity, id, cEntity, visual, e_2;
+                    var isEntityInItem_1, cEntities, i, entity, id, cEntity, visual, e_2;
+                    var _this = this;
                     return __generator(this, function (_b) {
                         switch (_b.label) {
                             case 0:
@@ -5927,6 +6011,16 @@
                                 if (this.disposed || this.viewer.isDestroyed()) {
                                     return [2 /*return*/];
                                 }
+                                isEntityInItem_1 = function (entityId) {
+                                    var _a, _b;
+                                    return (_b = (_a = _this.item.BruceEntity) === null || _a === void 0 ? void 0 : _a.Entities) === null || _b === void 0 ? void 0 : _b.find(function (y) { var _a; return ((_a = y === null || y === void 0 ? void 0 : y.Bruce) === null || _a === void 0 ? void 0 : _a.ID) == entityId; });
+                                };
+                                // Filter out entities that aren't in the menu item.
+                                // This can happen if the menu item is updated while the getter is running.
+                                entities = entities.filter(function (x) {
+                                    var _a;
+                                    return isEntityInItem_1((_a = x === null || x === void 0 ? void 0 : x.Bruce) === null || _a === void 0 ? void 0 : _a.ID);
+                                });
                                 return [4 /*yield*/, exports.EntityRenderEngine.Render({
                                         viewer: this.viewer,
                                         apiGetter: this.apiGetter,
@@ -5943,7 +6037,7 @@
                                     id = entity.Bruce.ID;
                                     cEntity = cEntities[id];
                                     this.renderedEntities[id] = !!cEntity;
-                                    if (cEntity) {
+                                    if (cEntity && isEntityInItem_1(id)) {
                                         visual = (_a = this.visualsManager.GetRego({
                                             entityId: id,
                                             menuItemId: this.item.id
@@ -15022,7 +15116,7 @@
         ViewerUtils.CreateWidgets = CreateWidgets;
     })(exports.ViewerUtils || (exports.ViewerUtils = {}));
 
-    var VERSION$1 = "2.6.4";
+    var VERSION$1 = "2.6.6";
 
     exports.VERSION = VERSION$1;
     exports.CesiumViewMonitor = CesiumViewMonitor;