WaferDie interface/type update

change/@ni-nimble-components-95871031-15d3-48ad-952f-7c70831fb3d0.json

@@ -0,0 +1,7 @@
+{
+  "type": "patch",
+  "comment": "Updated the WaferDie Interface to add an extra \"tooltip\" field",
+  "packageName": "@ni/nimble-components",
+  "email": "35329597+DStavilaNI@users.noreply.github.com",
+  "dependentChangeType": "patch"
+}

packages/nimble-components/src/wafer-map/tests/computations.spec.ts

@@ -2,7 +2,7 @@ import { Computations } from '../modules/computations';
 import { Margin, WaferMapQuadrant } from '../types';
 import { getWaferMapDies } from './utilities';
 
-describe('Computations module', () => {
+describe('Wafermap Computations module', () => {
     let computationsModule: Computations;
 
     describe('with 100 square canvas', () => {

packages/nimble-components/src/wafer-map/tests/data-generator.ts

@@ -19,6 +19,19 @@ const generateStringValue = (
     return valueToString(value);
 };
 
+export const generateDieContent = (
+    x: number,
+    y: number,
+    value: string
+): WaferMapDie => {
+    return {
+        x,
+        y,
+        value,
+        metadata: `Placeholder metadata value for Die x: ${x} y: ${y}`
+    };
+};
+
 export const generateWaferData = (
     numDies: number,
     valueGenerator?: IValueGenerator
@@ -43,7 +56,7 @@ export const generateWaferData = (
                 j--
             ) {
                 stringValue = generateStringValue(i, j, valueGenerator);
-                diesSet.push({ x: i, y: j, value: stringValue });
+                diesSet.push(generateDieContent(i, j, stringValue));
             }
             // generate points right of centerX
             for (
@@ -53,7 +66,7 @@ export const generateWaferData = (
                 j++
             ) {
                 stringValue = generateStringValue(i, j, valueGenerator);
-                diesSet.push({ x: i, y: j, value: stringValue });
+                diesSet.push(generateDieContent(i, j, stringValue));
             }
         }
     }

packages/nimble-components/src/wafer-map/tests/data-manager.spec.ts

@@ -6,7 +6,7 @@ import {
     getWaferMapDies
 } from './utilities';
 
-describe('Data manager', () => {
+describe('Wafermap Data manager', () => {
     let dataManagerModule: DataManager;
     const axisLocation: WaferMapQuadrant = WaferMapQuadrant.topLeft;
     const canvasDimensions = { width: 100, height: 110 };

packages/nimble-components/src/wafer-map/tests/prerendering.coloring.spec.ts

@@ -2,7 +2,7 @@ import { Prerendering } from '../modules/prerendering';
 import { WaferMapColorScaleMode } from '../types';
 import { getLinearScale, getWaferMapDies } from './utilities';
 
-describe('Prerendering module', () => {
+describe('Wafermap Prerendering module', () => {
     let prerenderingModule: Prerendering;
     const emptyDieColor = 'rgba(218,223,236,1)';
     const nanDieColor = 'rgba(122,122,122,1)';
@@ -193,7 +193,13 @@ describe('Prerendering module', () => {
 
         beforeEach(() => {
             prerenderingModule = new Prerendering(
-                [{ x: 0, y: 0, value: 'NaN' }],
+                [
+                    {
+                        x: 0,
+                        y: 0,
+                        value: 'NaN'
+                    }
+                ],
                 { colors: [], values: [] },
                 highlightedValues,
                 getLinearScale([], []),
@@ -223,7 +229,13 @@ describe('Prerendering module', () => {
 
         beforeEach(() => {
             prerenderingModule = new Prerendering(
-                [{ x: 0, y: 0, value: undefined as unknown as string }],
+                [
+                    {
+                        x: 0,
+                        y: 0,
+                        value: undefined as unknown as string
+                    }
+                ],
                 { colors: [], values: [] },
                 highlightedValues,
                 getLinearScale([], []),

packages/nimble-components/src/wafer-map/tests/prerendering.labeling.spec.ts

@@ -7,7 +7,7 @@ import {
     getWaferMapDiesAsNaN
 } from './utilities';
 
-describe('Prerendering module', () => {
+describe('Wafermap Prerendering module', () => {
     let prerenderingModule: Prerendering;
 
     describe('with die input and small die height', () => {

packages/nimble-components/src/wafer-map/tests/prerendering.positioning.spec.ts

@@ -2,7 +2,7 @@ import { Prerendering } from '../modules/prerendering';
 import { WaferMapColorScaleMode } from '../types';
 import { getLinearScale, getWaferMapDies } from './utilities';
 
-describe('Prerendering module', () => {
+describe('Wafermap Prerendering module', () => {
     let prerenderingModule: Prerendering;
 
     describe('with die input and margin', () => {

packages/nimble-components/src/wafer-map/tests/sets.ts

@@ -9,40 +9,200 @@ export const highLightedValueSets = [
 
 export const wafermapDieSets: WaferMapDie[][] = [
     [
-        { x: 0, y: 0, value: '100' },
-        { x: 0, y: 1, value: '50' },
-        { x: 0, y: 2, value: '12' },
-        { x: 0, y: 3, value: '99' },
-        { x: 1, y: 0, value: '78' },
-        { x: 1, y: 1, value: '88' },
-        { x: 1, y: 2, value: '68' },
-        { x: 1, y: 3, value: '99' },
-        { x: 2, y: 0, value: '99' },
-        { x: 2, y: 1, value: '80' },
-        { x: 2, y: 2, value: '99' },
-        { x: 2, y: 3, value: '100' },
-        { x: 3, y: 0, value: '40' },
-        { x: 3, y: 1, value: '10' },
-        { x: 3, y: 2, value: '15' },
-        { x: 3, y: 3, value: '30' }
+        {
+            x: 0,
+            y: 0,
+            value: '100',
+            metadata: 'Placeholder metadata value for Die x: 0 y: 0'
+        },
+        {
+            x: 0,
+            y: 1,
+            value: '50',
+            metadata: 'Placeholder metadata value for Die x: 0 y: 1'
+        },
+        {
+            x: 0,
+            y: 2,
+            value: '12',
+            metadata: 'Placeholder metadata value for Die x: 0 y: 2'
+        },
+        {
+            x: 0,
+            y: 3,
+            value: '99',
+            metadata: 'Placeholder metadata value for Die x: 0 y: 3'
+        },
+        {
+            x: 1,
+            y: 0,
+            value: '78',
+            metadata: 'Placeholder metadata value for Die x: 1 y: 0'
+        },
+        {
+            x: 1,
+            y: 1,
+            value: '88',
+            metadata: 'Placeholder metadata value for Die x: 1 y: 1'
+        },
+        {
+            x: 1,
+            y: 2,
+            value: '68',
+            metadata: 'Placeholder metadata value for Die x: 1 y: 2'
+        },
+        {
+            x: 1,
+            y: 3,
+            value: '99',
+            metadata: 'Placeholder metadata value for Die x: 1 y: 3'
+        },
+        {
+            x: 2,
+            y: 0,
+            value: '99',
+            metadata: 'Placeholder metadata value for Die x: 2 y: 0'
+        },
+        {
+            x: 2,
+            y: 1,
+            value: '80',
+            metadata: 'Placeholder metadata value for Die x: 2 y: 1'
+        },
+        {
+            x: 2,
+            y: 2,
+            value: '99',
+            metadata: 'Placeholder metadata value for Die x: 2 y: 2'
+        },
+        {
+            x: 2,
+            y: 3,
+            value: '100',
+            metadata: 'Placeholder metadata value for Die x: 2 y: 3'
+        },
+        {
+            x: 3,
+            y: 0,
+            value: '40',
+            metadata: 'Placeholder metadata value for Die x: 3 y: 0'
+        },
+        {
+            x: 3,
+            y: 1,
+            value: '10',
+            metadata: 'Placeholder metadata value for Die x: 3 y: 1'
+        },
+        {
+            x: 3,
+            y: 2,
+            value: '15',
+            metadata: 'Placeholder metadata value for Die x: 3 y: 2'
+        },
+        {
+            x: 3,
+            y: 3,
+            value: '30',
+            metadata: 'Placeholder metadata value for Die x: 3 y: 3'
+        }
     ],
     [
-        { x: 0, y: 0, value: '16' },
-        { x: 0, y: 1, value: '50' },
-        { x: 0, y: 2, value: '13' },
-        { x: 0, y: 3, value: '65' },
-        { x: 1, y: 0, value: '78' },
-        { x: 1, y: 1, value: '88' },
-        { x: 1, y: 2, value: '99' },
-        { x: 1, y: 3, value: '99' },
-        { x: 2, y: 0, value: '99' },
-        { x: 2, y: 1, value: '80' },
-        { x: 2, y: 2, value: '99' },
-        { x: 2, y: 3, value: '100' },
-        { x: 3, y: 0, value: '70' },
-        { x: 3, y: 1, value: '75' },
-        { x: 3, y: 2, value: '70' },
-        { x: 3, y: 3, value: '72' }
+        {
+            x: 0,
+            y: 0,
+            value: '16',
+            metadata: 'Placeholder metadata value for Die x: 0 y: 0'
+        },
+        {
+            x: 0,
+            y: 1,
+            value: '50',
+            metadata: 'Placeholder metadata value for Die x: 0 y: 1'
+        },
+        {
+            x: 0,
+            y: 2,
+            value: '13',
+            metadata: 'Placeholder metadata value for Die x: 0 y: 2'
+        },
+        {
+            x: 0,
+            y: 3,
+            value: '65',
+            metadata: 'Placeholder metadata value for Die x: 0 y: 3'
+        },
+        {
+            x: 1,
+            y: 0,
+            value: '78',
+            metadata: 'Placeholder metadata value for Die x: 1 y: 0'
+        },
+        {
+            x: 1,
+            y: 1,
+            value: '88',
+            metadata: 'Placeholder metadata value for Die x: 1 y: 1'
+        },
+        {
+            x: 1,
+            y: 2,
+            value: '99',
+            metadata: 'Placeholder metadata value for Die x: 1 y: 2'
+        },
+        {
+            x: 1,
+            y: 3,
+            value: '99',
+            metadata: 'Placeholder metadata value for Die x: 1 y: 3'
+        },
+        {
+            x: 2,
+            y: 0,
+            value: '99',
+            metadata: 'Placeholder metadata value for Die x: 2 y: 0'
+        },
+        {
+            x: 2,
+            y: 1,
+            value: '80',
+            metadata: 'Placeholder metadata value for Die x: 2 y: 1'
+        },
+        {
+            x: 2,
+            y: 2,
+            value: '99',
+            metadata: 'Placeholder metadata value for Die x: 2 y: 2'
+        },
+        {
+            x: 2,
+            y: 3,
+            value: '100',
+            metadata: 'Placeholder metadata value for Die x: 2 y: 3'
+        },
+        {
+            x: 3,
+            y: 0,
+            value: '70',
+            metadata: 'Placeholder metadata value for Die x: 3 y: 0'
+        },
+        {
+            x: 3,
+            y: 1,
+            value: '75',
+            metadata: 'Placeholder metadata value for Die x: 3 y: 1'
+        },
+        {
+            x: 3,
+            y: 2,
+            value: '70',
+            metadata: 'Placeholder metadata value for Die x: 3 y: 2'
+        },
+        {
+            x: 3,
+            y: 3,
+            value: '72',
+            metadata: 'Placeholder metadata value for Die x: 3 y: 3'
+        }
     ]
 ];
 

packages/nimble-components/src/wafer-map/tests/types.spec.ts

@@ -1,6 +1,6 @@
 import type { WaferMapOrientation, WaferMapQuadrant } from '../types';
 
-describe('WaferMap type', () => {
+describe('Wafermap Types', () => {
     it('WaferMapQuadrant fails compile if assigning arbitrary string values', () => {
         // @ts-expect-error This expect will fail if the enum-like type is missing "as const"
         const value: WaferMapQuadrant = 'hello';

packages/nimble-components/src/wafer-map/types.ts

@@ -30,6 +30,8 @@ export interface WaferMapDie {
     value: string;
     x: number;
     y: number;
+    // The metadata field is not used by the wafer-map and is only for optionally storing arbitrary metadata.
+    metadata?: unknown;
 }
 
 export interface WaferMapColorScale {