Skip to content

[Explore Vis] Fix table visualiztion issues #10754

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Oct 21, 2025
Merged

[Explore Vis] Fix table visualiztion issues #10754

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
ce11838
Fix fields order issue
lunalzm Oct 19, 2025
baf9b73
Changeset file for PR #10754 created/updated
opensearch-changeset-bot[bot] Oct 19, 2025
3a9c07d
Fix fields order issue
lunalzm Oct 20, 2025
23f1ebb
refactor(vis): table vis columns should also be sorted correctly for …
ruanyl Oct 21, 2025
f685e22
refactor(vis): change default table cell alignment to left
ruanyl Oct 21, 2025
55e1791
fix(vis): fix table vis pagination not working
ruanyl Oct 21, 2025
3a80e2d
fix(vis): remove console.log
ruanyl Oct 21, 2025
55fd811
Changeset file for PR #10754 created/updated
opensearch-changeset-bot[bot] Oct 21, 2025
9e01a75
refactor(vis): avoid sorting array in-place
ruanyl Oct 21, 2025
6f42a06
refactor: fix the root cause of the table column visibility issue
ruanyl Oct 21, 2025
ad6135e
fix: update table footer default alignment to left
ruanyl Oct 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions changelogs/fragments/10754.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
fix:
- Fix table vis fields order not the same as fields order in the query ([#10754](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/10754))
- Table vis pagination not working due to unnecessary rerendering ([#10754](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/10754))
- Change the default table column alignment to left ([#10754](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/10754))
26 changes: 15 additions & 11 deletions src/plugins/explore/public/components/visualizations/table/table_vis.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* SPDX-License-Identifier: Apache-2.0
*/

import React, { useCallback, useEffect, useMemo, useState } from 'react';
import React, { useCallback, useEffect, useMemo, useRef, useState } from 'react';
import { EuiDataGrid, EuiDataGridCellValueElementProps, EuiDataGridColumn } from '@elastic/eui';
import { VisColumn, VisFieldType } from '../types';
import { defaultTableChartStyles, CellTypeConfig, TableChartStyle } from './table_vis_config';
Expand All @@ -25,8 +25,12 @@ interface TableVisProps {

export const TableVis = React.memo(
({ rows, columns, styleOptions, pageSizeOptions, showStyleSelector }: TableVisProps) => {
const sortedColumns = useMemo(() => [...columns].sort((a, b) => a.id - b.id), [columns]);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: we can make the columns is ordered in props in parent component, that could reduce the change.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This component is used at different places, having the sorting here is to avoid having the same logic at multiple places

const [visibleColumns, setVisibleColumns] = useState(() =>
sortedColumns.map(({ column }) => column)
);

const pageSize = styleOptions?.pageSize ?? defaultTableChartStyles.pageSize;
const [visibleColumns, setVisibleColumns] = useState(() => columns.map(({ column }) => column));
const [pagination, setPagination] = useState({ pageIndex: 0, pageSize });
const [filters, setFilters] = useState<Record<string, FilterConfig>>({});
const [popoverOpenColumnId, setPopoverOpenColumnId] = useState<string | null>(null);
Expand All @@ -37,9 +41,9 @@ export const TableVis = React.memo(

const columnUniques = useMemo(() => {
const uniques: Record<string, Set<any>> = {};
columns.forEach((col) => (uniques[col.column] = new Set()));
sortedColumns.forEach((col) => (uniques[col.column] = new Set()));
rows.forEach((row) => {
columns.forEach((col) => {
sortedColumns.forEach((col) => {
const value = row[col.column];
if (row.hasOwnProperty(col.column) && value != null && value !== '') {
uniques[col.column].add(row[col.column]);
Expand All @@ -51,18 +55,18 @@ export const TableVis = React.memo(
.map(([key, set]) => [key, Array.from(set).sort()])
.filter(([, arr]) => arr.length > 0)
);
}, [columns, rows]);
}, [sortedColumns, rows]);

const columnTypes = useMemo(() => {
const types: Record<string, VisFieldType> = {};
columns.forEach((col) => {
sortedColumns.forEach((col) => {
types[col.column] = col.schema;
});
return types;
}, [columns]);
}, [sortedColumns]);

const dataGridColumns: EuiDataGridColumn[] = useMemo(() => {
return columns.map((col) => ({
return sortedColumns.map((col) => ({
id: col.column,
displayAsText: col.name,
display: (
Expand All @@ -78,7 +82,7 @@ export const TableVis = React.memo(
),
}));
}, [
columns,
sortedColumns,
styleOptions?.showColumnFilter,
popoverOpenColumnId,
filters,
Expand Down Expand Up @@ -117,7 +121,7 @@ export const TableVis = React.memo(
({ rowIndex, columnId, setCellProps }: EuiDataGridCellValueElementProps) => {
const cellTypes: CellTypeConfig[] = styleOptions?.cellTypes || [];
const columnCellType = cellTypes.find((ct) => ct.field === columnId)?.type || 'auto';
const alignment = styleOptions?.globalAlignment || 'auto';
const alignment = styleOptions?.globalAlignment || 'left';
const textAlign =
alignment === 'auto'
? columnTypes[columnId] === 'numerical'
Expand Down Expand Up @@ -172,7 +176,7 @@ export const TableVis = React.memo(

const renderFooterCellValue = useCallback(
({ columnId, setCellProps }: EuiDataGridCellValueElementProps) => {
const alignment = styleOptions?.globalAlignment || 'auto';
const alignment = styleOptions?.globalAlignment || 'left';
const textAlign =
alignment === 'auto'
? columnTypes[columnId] === 'numerical'
Expand Down
2 changes: 1 addition & 1 deletion src/plugins/explore/public/components/visualizations/table/table_vis_config.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ describe('table_vis_config', () => {

expect(defaults).toEqual({
pageSize: 10,
globalAlignment: 'auto',
globalAlignment: 'left',
showColumnFilter: false,
showFooter: false,
footerCalculations: [],
Expand Down
2 changes: 1 addition & 1 deletion src/plugins/explore/public/components/visualizations/table/table_vis_config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ export type TableChartStyle = Required<TableChartStyleOptions>;

export const defaultTableChartStyles: TableChartStyle = {
pageSize: 10,
globalAlignment: 'auto',
globalAlignment: 'left',
showColumnFilter: false,
showFooter: false,
footerCalculations: [],
Expand Down
4 changes: 2 additions & 2 deletions src/plugins/explore/public/components/visualizations/visualization_container.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ export interface UpdateVisualizationProps {
// }),
// };

export const VisualizationContainer = () => {
export const VisualizationContainer = React.memo(() => {
const { services } = useOpenSearchDashboards<ExploreServices>();
const { results } = useTabResults();
const searchContext = useSearchContext();
Expand Down Expand Up @@ -98,4 +98,4 @@ export const VisualizationContainer = () => {
</EuiPanel>
</div>
);
};
});
8 changes: 2 additions & 6 deletions src/plugins/explore/public/components/visualizations/visualization_render.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,17 +107,13 @@ export const VisualizationRender = ({
[onSelectTimeRange]
);

if (!visualizationData) {
if (!visualizationData || columns.length === 0) {
return null;
}

if (visConfig?.type === 'table') {
return (
<TableVis
styleOptions={visConfig.styles as TableChartStyle}
rows={visualizationData.transformedData ?? []}
columns={columns}
/>
<TableVis styleOptions={visConfig.styles as TableChartStyle} rows={rows} columns={columns} />
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed it to rows which is defined as this, should be the same

  const rows = useMemo(() => {
    return visualizationData?.transformedData ?? [];
  }, [visualizationData?.transformedData]);

);
}

Expand Down
Loading