feat(tooltip): expose datum in the TooltipValue (#1082)

Adds the datum, when possible, to the TooltipValue object.
Currently available for cartesian, gauge/goal, heatmap.
Disabled for partition charts as we cannot represent a single datum for a partition chart
due to its aggregated and nested nature.

fix #1042

src/chart_types/goal_chart/state/selectors/tooltip.ts

@@ -53,6 +53,7 @@ export const getTooltipInfoSelector = createCachedSelector(
         },
         value: shape.actual,
         formattedValue: `${shape.actual}`,
+        datum: shape.actual,
       });
     });
 

src/chart_types/heatmap/state/selectors/tooltip.ts

@@ -60,6 +60,7 @@ export const getTooltipInfoSelector = createCachedSelector(
             },
             value: `${shape.datum.x}`,
             formattedValue: config.xAxisLabel.formatter(shape.datum.x),
+            datum: shape.datum,
           });
 
           // Y-axis value
@@ -74,6 +75,7 @@ export const getTooltipInfoSelector = createCachedSelector(
             },
             value: `${shape.datum.y}`,
             formattedValue: config.yAxisLabel.formatter(shape.datum.y),
+            datum: shape.datum,
           });
 
           // Cell value
@@ -88,6 +90,7 @@ export const getTooltipInfoSelector = createCachedSelector(
             },
             value: `${shape.value}`,
             formattedValue: `${shape.formatted}`,
+            datum: shape.datum,
           });
         });
     } else {
@@ -102,6 +105,7 @@ export const getTooltipInfoSelector = createCachedSelector(
         },
         value: `${pickedShapes.value}`,
         formattedValue: `${pickedShapes.value}`,
+        datum: pickedShapes.value,
       });
     }
 

src/chart_types/partition_chart/layout/viewmodel/tooltip_info.ts

@@ -37,7 +37,7 @@ export function getTooltipInfo(
   valueFormatter: ValueFormatter,
   percentFormatter: ValueFormatter,
   id: string,
-) {
+): TooltipInfo {
   if (!valueFormatter || !labelFormatters) {
     return EMPTY_TOOLTIP;
   }
@@ -65,6 +65,7 @@ export function getTooltipInfo(
       value,
       formattedValue: `${valueFormatter(value)} (${percentFormatter(percentValueGetter(shape))})`,
       valueAccessor: shape.depth,
+      // the datum is omitted ATM due to the aggregated and nested nature of a partition section
     });
   });
 

src/chart_types/xy_chart/tooltip/tooltip.ts

@@ -66,7 +66,7 @@ export function getHighligthedValues(
 
 /** @internal */
 export function formatTooltip(
-  { color, value: { x, y, mark, accessor }, seriesIdentifier }: IndexedGeometry,
+  { color, value: { x, y, mark, accessor, datum }, seriesIdentifier }: IndexedGeometry,
   spec: BasicSeriesSpec,
   isHeader: boolean,
   isHighlighted: boolean,
@@ -104,5 +104,6 @@ export function formatTooltip(
     color,
     isHighlighted: isHeader ? false : isHighlighted,
     isVisible,
+    datum,
   };
 }

src/index.ts

@@ -81,6 +81,9 @@ export {
   VerticalAlignment,
   HorizontalAlignment,
   RecursivePartial,
+  NonAny,
+  IsAny,
+  IsUnknown,
   ColorVariant,
   Color,
   LabelAccessor,

src/specs/settings.tsx

@@ -199,6 +199,12 @@ export interface TooltipValue {
    * The accessor linked to the current tooltip value
    */
   valueAccessor?: Accessor;
+
+  /**
+   * The datum associated with the current tooltip value
+   * Maybe not available
+   */
+  datum?: unknown;
 }
 
 /**

src/utils/common.ts

@@ -216,16 +216,25 @@ export type RecursivePartial<T> = {
     ? Set<RecursivePartial<V>>
     : T[P] extends Map<infer K, infer V> // checks for Maps
     ? Map<K, RecursivePartial<V>>
-    : T[P] extends NonAny // checks for primative values
+    : T[P] extends NonAny // checks for primitive values
     ? T[P]
-    : RecursivePartial<T[P]>; // recurse for all non-array and non-primative values
+    : IsUnknown<T[P], 1, 0> extends 1
+    ? T[P]
+    : RecursivePartial<T[P]>; // recurse for all non-array and non-primitive values
 };
-type NonAny = number | boolean | string | symbol | null;
+
+// return True if T is `any`, otherwise return False
+export type IsAny<T, True, False = never> = True | False extends (T extends never ? True : False) ? True : False;
+
+// return True if T is `unknown`, otherwise return False
+export type IsUnknown<T, True, False = never> = unknown extends T ? IsAny<T, False, True> : False;
+
+export type NonAny = number | boolean | string | symbol | null;
 
 export interface MergeOptions {
   /**
    * Includes all available keys of every provided partial at a given level.
-   * This is opposite to normal behavoir, which only uses keys from the base
+   * This is opposite to normal behavior, which only uses keys from the base
    * object to merge values.
    *
    * @defaultValue false
@@ -253,7 +262,7 @@ export function getPartialValue<T>(base: T, partial?: RecursivePartial<T>, parti
  * @internal
  */
 export function getAllKeys(object: any, objects: any[] = []): string[] {
-  const initalKeys = object instanceof Map ? [...object.keys()] : Object.keys(object);
+  const initialKeys = object instanceof Map ? [...object.keys()] : Object.keys(object);
 
   return objects.reduce((keys: any[], obj) => {
     if (obj && typeof obj === 'object') {
@@ -262,7 +271,7 @@ export function getAllKeys(object: any, objects: any[] = []): string[] {
     }
 
     return keys;
-  }, initalKeys);
+  }, initialKeys);
 }
 
 /** @internal */