@datagrok/peptides 0.4.2 → 0.6.1

package/src/utils/cell-renderer.ts

@@ -3,13 +3,22 @@ import * as DG from 'datagrok-api/dg';
 
 const cp = new ChemPalette('grok');
 
-export function expandColumn(col:DG.Column,
-  grid:DG.Grid,
-  cellRenderSize: (celVal:string)=>number,
-  textSizeMult = 10,
-  minSize = 30,
-  maxSize = 650,
-  timeout = 500) {
+/**
+ * A function to expand column size based on its contents.
+ *
+ * @export
+ * @param {DG.Column} col Column to expand.
+ * @param {DG.Grid} grid Grid containing colum for expansion.
+ * @param {(cellVal: string) => number} cellRenderSize An anonymous function that calculates cell value length.
+ * @param {number} [textSizeMult=10] Text size muliplier.
+ * @param {number} [minSize=30] Minimal column width.
+ * @param {number} [maxSize=650] Maximum column width.
+ * @param {number} [timeout=500] Timeout value.
+ */
+export function expandColumn(
+  col: DG.Column, grid: DG.Grid, cellRenderSize: (cellVal: string) => number,
+  textSizeMult = 10, minSize = 30, maxSize = 650, timeout = 500,
+) {
   let maxLen = 0;
   col.categories.forEach((ent: string) => {
     const len = cellRenderSize(ent);
@@ -23,6 +32,14 @@ export function expandColumn(col:DG.Column,
   timeout);
 }
 
+/**
+ * A function that sets amino acid residue to the specified column.
+ *
+ * @export
+ * @param {DG.Column} col Column to set renderer for.
+ * @param {(DG.Grid | null)} [grid=null] Grid that contains the col column.
+ * @param {boolean} [grouping=false] Is grouping enabled.
+ */
 export function setAARRenderer(col: DG.Column, grid: DG.Grid | null = null, grouping = false) {
   col.semType = 'aminoAcids';
   col.setTag('cell.renderer', 'aminoAcids');
@@ -33,17 +50,39 @@ export function setAARRenderer(col: DG.Column, grid: DG.Grid | null = null, grou
     expandColumn(col, grid, (ent) => measureAAR(ent));
   }
 }
-
+/**
+ * A function to measure amino acid residue
+ *
+ * @export
+ * @param {string} s Amino acid residue string.
+ * @return {number} Amino acid residue size.
+ */
 export function measureAAR(s: string): number {
   const end = s.lastIndexOf(')');
   const beg = s.indexOf('(');
   return end == beg ? s.length : s.length - (end - beg) + 1;
 }
 
-function printLeftCentered(
+/**
+ * A function that prints a string aligned to left or centered.
+ *
+ * @param {number} x x coordinate.
+ * @param {number} y y coordinate.
+ * @param {number} w Width.
+ * @param {number} h Height.
+ * @param {CanvasRenderingContext2D} g Canvas rendering context.
+ * @param {string} s String to print.
+ * @param {string} [color=ChemPalette.undefinedColor] String color.
+ * @param {number} [pivot=0] Pirvot.
+ * @param {boolean} [left=false] Is left aligned.
+ * @param {boolean} [hideMod=false] Hide amino acid redidue modifications.
+ * @return {number} x coordinate to start printing at.
+ */
+function printLeftOrCentered(
   x: number, y: number, w: number, h: number,
   g: CanvasRenderingContext2D, s: string, color = ChemPalette.undefinedColor,
-  pivot: number = 0, left = false, hideMod = false) {
+  pivot: number = 0, left = false, hideMod = false,
+) {
   g.textAlign = 'start';
   let colorPart = pivot == -1 ? s.substring(0) : s.substring(0, pivot);
   if (colorPart.length == 1) {
@@ -100,23 +139,55 @@ function printLeftCentered(
   }
 }
 
-
+/**
+ * Amino acid residue cell renderer.
+ *
+ * @export
+ * @class AminoAcidsCellRenderer
+ * @extends {DG.GridCellRenderer}
+ */
 export class AminoAcidsCellRenderer extends DG.GridCellRenderer {
     chemPalette: ChemPalette | null;
 
+    /**
+     * Renderer name.
+     *
+     * @readonly
+     * @memberof AminoAcidsCellRenderer
+     */
     get name() {
       return 'aminoAcidsCR';
     }
 
+    /**
+     * Cell type.
+     *
+     * @readonly
+     * @memberof AminoAcidsCellRenderer
+     */
     get cellType() {
       return 'aminoAcids';
     }
 
+    /**
+     * Constructor.
+     */
     constructor() {
       super();
       this.chemPalette = null;
     }
 
+    /**
+     * Cell renderer function.
+     *
+     * @param {CanvasRenderingContext2D} g Canvas rendering context.
+     * @param {number} x x coordinate on the canvas.
+     * @param {number} y y coordinate on the canvas.
+     * @param {number} w width of the cell.
+     * @param {number} h height of the cell.
+     * @param {DG.GridCell} gridCell Grid cell.
+     * @param {DG.GridCellStyle} cellStyle Cell style.
+     */
     render(g: CanvasRenderingContext2D, x: number, y: number, w: number, h: number,
       gridCell: DG.GridCell, cellStyle: DG.GridCellStyle) {
       if (this.chemPalette === null) {
@@ -130,21 +201,51 @@ export class AminoAcidsCellRenderer extends DG.GridCellRenderer {
       g.textBaseline = 'top';
       const s: string = gridCell.cell.value ? gridCell.cell.value : '-';
       const [color, pivot] = cp.getColorPivot(s);
-      printLeftCentered(x, y, w, h, g, s, color, pivot, false, true);
+      printLeftOrCentered(x, y, w, h, g, s, color, pivot, false, true);
       g.restore();
     }
 }
 
-
+/**
+ * Aligned sequence cell renderer.
+ *
+ * @export
+ * @class AlignedSequenceCellRenderer
+ * @extends {DG.GridCellRenderer}
+ */
 export class AlignedSequenceCellRenderer extends DG.GridCellRenderer {
+  /**
+   * Renderer name.
+   *
+   * @readonly
+   * @memberof AlignedSequenceCellRenderer
+   */
   get name() {
     return 'alignedSequenceCR';
   }
 
+  /**
+   * Cell type.
+   *
+   * @readonly
+   * @memberof AlignedSequenceCellRenderer
+   */
   get cellType() {
     return 'alignedSequence';
   }
 
+  /**
+   * Cell renderer function.
+   *
+   * @param {CanvasRenderingContext2D} g Canvas rendering context.
+   * @param {number} x x coordinate on the canvas.
+   * @param {number} y y coordinate on the canvas.
+   * @param {number} w width of the cell.
+   * @param {number} h height of the cell.
+   * @param {DG.GridCell} gridCell Grid cell.
+   * @param {DG.GridCellStyle} cellStyle Cell style.
+   * @memberof AlignedSequenceCellRenderer
+   */
   render(g: CanvasRenderingContext2D, x: number, y: number, w: number, h: number,
     gridCell: DG.GridCell, cellStyle: DG.GridCellStyle ) {
     w = Math.min(gridCell.grid.canvas.width - x, w);
@@ -169,25 +270,31 @@ export class AlignedSequenceCellRenderer extends DG.GridCellRenderer {
         const gap = simplified?'':' ';
         amino += `${amino?'':'-'}${gap}`;
       }
-      x = printLeftCentered(x, y, w, h, g, amino, color, pivot, true);
+      x = printLeftOrCentered(x, y, w, h, g, amino, color, pivot, true);
     });
 
     g.restore();
   }
 }
 
-
-export function processSequence(subParts:string[]) : [string[], boolean] {
+/**
+ * Function for sequence processing.
+ *
+ * @export
+ * @param {string[]} subParts Sequence subparts.
+ * @return {[string[], boolean]}
+ */
+export function processSequence(subParts: string[]): [string[], boolean] {
   const simplified = !subParts.some((amino, index) =>
     amino.length > 1 &&
     index != 0 &&
     index != subParts.length - 1);
 
-  const text:string[] = [];
+  const text: string[] = [];
+  const gap = simplified ? '' : ' ';
   subParts.forEach((amino: string, index) => {
     if (index < subParts.length) {
-      const gap = simplified?'':' ';
-      amino += `${amino?'':'-'}${gap}`;
+      amino += `${amino ? '' : '-'}${gap}`;
     }
     text.push(amino);
   });