[Table Visualization] format table cell and restore showTotal feature (…

…#2562) * format table cell to show Date and percent * restore showTotal feature: it allows table vis to show total, avg, min, max and count statics on count * fix some type errors Partically resolved: #2379 Signed-off-by: Anan Zhuang <[email protected]>
opensearch-project · Oct 14, 2022 · 177e76f · 177e76f
1 parent 7e969bc
commit 177e76f
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 11 deletions.
diff --git a/src/plugins/vis_type_table/public/components/table_vis_component.tsx b/src/plugins/vis_type_table/public/components/table_vis_component.tsx
@@ -3,8 +3,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import React, { useState, useCallback, useMemo, useRef, useEffect } from 'react';
-import { isEqual, orderBy } from 'lodash';
+import React, { useCallback, useMemo, useRef } from 'react';
+import { orderBy } from 'lodash';
 import { EuiDataGridProps, EuiDataGrid, EuiDataGridSorting } from '@elastic/eui';
 
 import { IInterpreterRenderHandlers } from 'src/plugins/expressions';
@@ -32,7 +32,7 @@ export const TableVisComponent = ({ table, visConfig, handlers }: TableVisCompon
   const currentColState = useRef<{
     columnsWidth: ColumnWidth[];
   }>({
-    columnsWidth: handlers.uiState.get('vis.columnsWidth'),
+    columnsWidth: handlers.uiState.get('vis.columnsWidth') || [],
   });
 
   const sortedRows = useMemo(() => {
@@ -44,9 +44,15 @@ export const TableVisComponent = ({ table, visConfig, handlers }: TableVisCompon
 
   const renderCellValue = useMemo(() => {
     return (({ rowIndex, columnId }) => {
-      return sortedRows.hasOwnProperty(rowIndex) ? sortedRows[rowIndex][columnId] || null : null;
+      const rawContent = sortedRows[rowIndex][columnId];
+      const colIndex = columns.findIndex((col) => col.id === columnId);
+      const column = columns[colIndex];
+      // use formatter to format raw content
+      // this can format date and percentage data
+      const formattedContent = column.formatter.convert(rawContent, 'text');
+      return sortedRows.hasOwnProperty(rowIndex) ? formattedContent || null : null;
     }) as EuiDataGridProps['renderCellValue'];
-  }, [sortedRows]);
+  }, [sortedRows, columns]);
 
   const dataGridColumns = getDataGridColumns(
     sortedRows,
@@ -57,7 +63,7 @@ export const TableVisComponent = ({ table, visConfig, handlers }: TableVisCompon
   );
 
   const sortedColumns = useMemo(() => {
-    const sort = handlers.uiState.get('vis.sortColumn');
+    const sort: SortColumn = handlers.uiState.get('vis.sortColumn') || {};
     return sort && sort.colIndex !== null && sort.direction
       ? [{ id: dataGridColumns[sort.colIndex]?.id, direction: sort.direction }]
       : [];
@@ -97,19 +103,39 @@ export const TableVisComponent = ({ table, visConfig, handlers }: TableVisCompon
     [columns, currentColState, handlers.uiState]
   );
 
+  const footerCellValue = visConfig.showTotal
+    ? // @ts-expect-error
+    ({ columnId }) => {
+      const colIndex = columns.findIndex((col) => col.id === columnId);
+      return columns[colIndex]?.formattedTotal || null;
+    }
+    : undefined;
+
   return (
     <EuiDataGrid
       aria-label="tableVis"
       columns={dataGridColumns}
       columnVisibility={{
         visibleColumns: columns.map(({ id }) => id),
-        setVisibleColumns: () => {},
+        setVisibleColumns: () => { },
       }}
       rowCount={rows.length}
       renderCellValue={renderCellValue}
       sorting={{ columns: sortedColumns, onSort }}
       onColumnResize={onColumnResize}
       pagination={pagination}
+      gridStyle={{
+        border: 'horizontal',
+        header: 'underline',
+      }}
+      minSizeForControls={1}
+      renderFooterCellValue={footerCellValue}
+      toolbarVisibility={{
+        showColumnSelector: false,
+        showSortSelector: false,
+        showFullScreenSelector: false,
+        showStyleSelector: false,
+      }}
     />
   );
 };
diff --git a/src/plugins/vis_type_table/public/types.ts b/src/plugins/vis_type_table/public/types.ts
@@ -58,7 +58,7 @@ export interface TableVisParams {
 export interface FormattedColumn {
   id: string;
   title: string;
-  formatter: IFieldFormat | undefined;
+  formatter: IFieldFormat;
   filterable: boolean;
   formattedTotal?: string | number;
   sumTotal?: number;

diff --git a/src/plugins/vis_type_table/public/utils/convert_to_formatted_data.ts b/src/plugins/vis_type_table/public/utils/convert_to_formatted_data.ts
@@ -80,6 +80,7 @@ export interface FormattedDataProps {
   formattedRows: OpenSearchDashboardsDatatableRow[];
   formattedColumns: FormattedColumn[];
 }
+
 export const convertToFormattedData = (
   table: Table,
   visConfig: TableVisConfig
@@ -95,7 +96,9 @@ export const convertToFormattedData = (
       const dimension =
         isBucket || isSplitColumn || metrics.find((metric) => metric.accessor === i);
 
-      const formatter = dimension ? getFormatService().deserialize(dimension.format) : undefined;
+      if (!dimension) return undefined;
+
+      const formatter = getFormatService().deserialize(dimension.format);
 
       const formattedColumn: FormattedColumn = {
         id: col.id,
@@ -157,15 +160,15 @@ export const convertToFormattedData = (
 
       return formattedColumn;
     })
-    .filter((column) => column);
+    .filter((column): column is FormattedColumn => !!column);
 
   if (visConfig.percentageCol) {
     const insertAtIndex = formattedColumns.findIndex(
       (col) => col.title === visConfig.percentageCol
     );
 
     // column to show percentage for was removed
-    if (insertAtIndex < 0) return;
+    if (insertAtIndex < 0) return { formattedRows, formattedColumns };
 
     const { cols, rows } = addPercentageCol(
       formattedColumns,