@isrd-isi-edu/ermrestjs 2.8.0 → 2.9.0

package/js/core.js

@@ -21,7 +21,7 @@ import HTTPService from '@isrd-isi-edu/ermrestjs/src/services/http';
 import $log from '@isrd-isi-edu/ermrestjs/src/services/logger';
 
 // utils
-import { isObjectAndNotNull, isEmptyArray, isStringAndNotEmpty, isValidColorRGBHex } from '@isrd-isi-edu/ermrestjs/src/utils/type-utils';
+import { isObjectAndNotNull, isEmptyArray, isStringAndNotEmpty, isValidColorRGBHex, isValidVisibleCellHeight } from '@isrd-isi-edu/ermrestjs/src/utils/type-utils';
 import { fixedEncodeURIComponent, escapeHTML, updateObject } from '@isrd-isi-edu/ermrestjs/src/utils/value-utils';
 import {
   _annotations,
@@ -3570,6 +3570,8 @@ import {
                     }
                 }
 
+                const visibleCellHeight = _getHierarchicalDisplayAnnotationValue(this, context, "visible_cell_height", false);
+
                 this._display[context] = {
                     "hideColumnHeader": annotation.hide_column_header || false, // only hide if the annotation value is true
                     "isPreformat": hasPreformat,
@@ -3582,7 +3584,8 @@ import {
                     "columnOrder": columnOrder,
                     "comment": _processModelComment(comment, commentRenderMarkdown, columnCommentDisplayMode),
                     "commentRenderMarkdown": commentRenderMarkdown,
-                    "commentDisplayMode": columnCommentDisplayMode
+                    "commentDisplayMode": columnCommentDisplayMode,
+                    "visibleCellHeight": isValidVisibleCellHeight(visibleCellHeight) ? visibleCellHeight : undefined
                 };
             }
             return this._display[context];
@@ -4078,10 +4081,8 @@ import {
 
                 columnOrder = _processColumnOrderList(annotation.column_order, this.table);
                 showKeyLink = annotation.show_key_link;
-                if (typeof showFKLink !== "boolean") {
-                    showKeyLink = _getHierarchicalDisplayAnnotationValue(
-                        self, context, "show_key_link"
-                    );
+                if (typeof showKeyLink !== "boolean") {
+                    showKeyLink = _getHierarchicalDisplayAnnotationValue(self, context, "show_key_link", false);
 
                     // default:
                     //   compact/select: false
@@ -4108,24 +4109,27 @@ import {
                     comment = annotComment;
                 }
 
-                var displayProps = _getHierarchicalDisplayAnnotationValue(this, context, "comment_display", false);
-                var commentDisplay = _commentDisplayModes.tooltip, commentRenderMarkdown;
-                if (isObjectAndNotNull(displayProps)) {
-                    if (_isValidModelCommentDisplay(displayProps.column_comment_display)) {
-                        commentDisplay = displayProps.column_comment_display;
+                const commentProps = _getHierarchicalDisplayAnnotationValue(this, context, "comment_display", false);
+                let commentDisplay = _commentDisplayModes.tooltip, commentRenderMarkdown;
+                if (isObjectAndNotNull(commentProps)) {
+                    if (_isValidModelCommentDisplay(commentProps.column_comment_display)) {
+                        commentDisplay = commentProps.column_comment_display;
                     }
-                    if (typeof displayProps.comment_render_markdown === 'boolean') {
-                        commentRenderMarkdown = displayProps.comment_render_markdown;
+                    if (typeof commentProps.comment_render_markdown === 'boolean') {
+                        commentRenderMarkdown = commentProps.comment_render_markdown;
                     }
                 }
 
+                const visibleCellHeight = _getHierarchicalDisplayAnnotationValue(this, context, "visible_cell_height", false);
+
                 this._display[context] = {
                     "columnOrder": columnOrder,
                     "isMarkdownPattern": (typeof annotation.markdown_pattern === 'string'),
                     "templateEngine": annotation.template_engine,
                     "markdownPattern": annotation.markdown_pattern,
                     "showKeyLink": showKeyLink,
-                    "comment": _processModelComment(comment, commentRenderMarkdown, commentDisplay)
+                    "comment": _processModelComment(comment, commentRenderMarkdown, commentDisplay),
+                    "visibleCellHeight": isValidVisibleCellHeight(visibleCellHeight) ? visibleCellHeight : undefined
                 };
             }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@isrd-isi-edu/ermrestjs",
   "description": "ERMrest client library in JavaScript",
-  "version": "2.8.0",
+  "version": "2.9.0",
   "license": "Apache-2.0",
   "engines": {
     "node": ">= 20.0.0",

package/src/models/reference-column/foreign-key-pseudo-column.ts

@@ -10,7 +10,12 @@ import { Tuple } from '@isrd-isi-edu/ermrestjs/src/models/reference';
 import $log from '@isrd-isi-edu/ermrestjs/src/services/logger';
 
 // utils
-import { isObjectAndNotNull, isStringAndNotEmpty, isObjectAndKeyExists } from '@isrd-isi-edu/ermrestjs/src/utils/type-utils';
+import {
+  isObjectAndNotNull,
+  isStringAndNotEmpty,
+  isObjectAndKeyExists,
+  isValidVisibleCellHeight,
+} from '@isrd-isi-edu/ermrestjs/src/utils/type-utils';
 import { fixedEncodeURIComponent } from '@isrd-isi-edu/ermrestjs/src/utils/value-utils';
 import { renderMarkdown } from '@isrd-isi-edu/ermrestjs/src/utils/markdown-utils';
 import { _annotations, _foreignKeyInputModes } from '@isrd-isi-edu/ermrestjs/src/utils/constants';
@@ -580,6 +585,10 @@ export class ForeignKeyPseudoColumn extends ReferenceColumn {
         sourceDisplay.hideColumnHeader = this.sourceObject.hide_column_header;
       }
 
+      if (this.sourceObject && isValidVisibleCellHeight(this.sourceObject.visible_cell_height)) {
+        sourceDisplay.visibleCellHeight = this.sourceObject.visible_cell_height;
+      }
+
       Object.assign(res, fkDisplay, sourceDisplay);
       this._display_cached = res;
     }

package/src/models/reference-column/key-pseudo-column.ts

@@ -7,7 +7,7 @@ import { Reference, Tuple } from '@isrd-isi-edu/ermrestjs/src/models/reference';
 
 // utils
 import { renderMarkdown } from '@isrd-isi-edu/ermrestjs/src/utils/markdown-utils';
-import { isStringAndNotEmpty } from '@isrd-isi-edu/ermrestjs/src/utils/type-utils';
+import { isValidVisibleCellHeight, isStringAndNotEmpty } from '@isrd-isi-edu/ermrestjs/src/utils/type-utils';
 import { buildSelfTemplateVariables } from '@isrd-isi-edu/ermrestjs/src/utils/template-utils';
 
 // legacy
@@ -227,6 +227,10 @@ export class KeyPseudoColumn extends ReferenceColumn {
         sourceDisplay.hideColumnHeader = this.sourceObject.hide_column_header;
       }
 
+      if (this.sourceObject && isValidVisibleCellHeight(this.sourceObject.visible_cell_height)) {
+        sourceDisplay.visibleCellHeight = this.sourceObject.visible_cell_height;
+      }
+
       Object.assign(res, keyDisplay, sourceDisplay);
       this._display_cached = res;
     }

package/src/models/reference-column/reference-column.ts

@@ -12,7 +12,12 @@ import $log from '@isrd-isi-edu/ermrestjs/src/services/logger';
 
 // utils
 import { renderMarkdown } from '@isrd-isi-edu/ermrestjs/src/utils/markdown-utils';
-import { isObjectAndKeyExists, isObjectAndNotNull, isStringAndNotEmpty } from '@isrd-isi-edu/ermrestjs/src/utils/type-utils';
+import {
+  isValidVisibleCellHeight,
+  isObjectAndKeyExists,
+  isObjectAndNotNull,
+  isStringAndNotEmpty,
+} from '@isrd-isi-edu/ermrestjs/src/utils/type-utils';
 import { _annotations, _contexts } from '@isrd-isi-edu/ermrestjs/src/utils/constants';
 import { buildSelfTemplateVariables } from '@isrd-isi-edu/ermrestjs/src/utils/template-utils';
 import ActiveListCondition from '@isrd-isi-edu/ermrestjs/src/models/active-list-condition';
@@ -385,6 +390,10 @@ export class ReferenceColumn {
         sourceDisplay.hideColumnHeader = this.sourceObject.hide_column_header;
       }
 
+      if (this.sourceObject && isValidVisibleCellHeight(this.sourceObject.visible_cell_height)) {
+        sourceDisplay.visibleCellHeight = this.sourceObject.visible_cell_height;
+      }
+
       // Using assign to avoid changing the original colDisplay
       Object.assign(res, colDisplay, sourceDisplay);
       this._display_cached = res;

package/src/utils/type-utils.ts

@@ -87,3 +87,10 @@ export function verify(test: any, message: string) {
     throw new InvalidInputError(message);
   }
 }
+
+/**
+ * check if the value is a valid visible cell height (i.e. a positive number or false)
+ */
+export function isValidVisibleCellHeight(value: unknown) {
+  return (typeof value === 'number' && value > 0) || value === false;
+}