/** * Copyright (c) 2020-present, Goldman Sachs * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import type { DefaultMenuItem, GetContextMenuItemsParams, GetMainMenuItemsParams, MenuItemDef, } from 'ag-grid-community'; import { DataCubeQuerySortDirection, DataCubeColumnPinPlacement, DEFAULT_COLUMN_MIN_WIDTH, DataCubeColumnKind, type DataCubeOperationValue, DataCubeQueryFilterOperator, isPivotResultColumnName, getPivotResultColumnBaseColumnName, DataCubeOperationAdvancedValueType, DataCubeOpenEditorSource, } from '../../core/DataCubeQueryEngine.js'; import { guaranteeIsNumber, guaranteeNonNullable, isNonNullable, UnsupportedOperationError, } from '@finos/legend-shared'; import type { DataCubeGridControllerState } from './DataCubeGridControllerState.js'; import { DataCubeGridClientExportFormat, INTERNAL__GRID_CLIENT_MISSING_VALUE, INTERNAL__GRID_CLIENT_TREE_COLUMN_ID, } from './DataCubeGridClientEngine.js'; import { PRIMITIVE_TYPE } from '@finos/legend-graph'; import type { DataCubeColumnConfiguration } from '../../core/model/DataCubeConfiguration.js'; import { DataCubeFilterEditorConditionTreeNode } from '../../core/filter/DataCubeQueryFilterEditorState.js'; import { DataCubeEditorTab } from '../editor/DataCubeEditorState.js'; import { _findCol } from '../../core/model/DataCubeColumn.js'; import { useGridMenuItem, type CustomMenuItemProps } from 'ag-grid-react'; import { FormBadge_WIP } from '../../../components/core/DataCubeFormUtils.js'; import { DataCubeEvent } from '../../../__lib__/DataCubeEvent.js'; import type { DataCubeDimensionalMetadata } from './DataCubeGridDimensionalTree.js'; export function WIP_GridMenuItem({ name, subMenu, checked, }: CustomMenuItemProps) { useGridMenuItem({ configureDefaults: () => true, }); return (
{name} {subMenu && }
); } function toFilterValue( value: unknown, columnConfiguration: DataCubeColumnConfiguration, ): { label: string; value: DataCubeOperationValue } { const label = `${columnConfiguration.type === PRIMITIVE_TYPE.STRING ? `'${value}'` : value}`; let val: unknown; switch (columnConfiguration.type) { case PRIMITIVE_TYPE.STRING: { val = value; break; } case PRIMITIVE_TYPE.NUMBER: case PRIMITIVE_TYPE.DECIMAL: case PRIMITIVE_TYPE.FLOAT: case PRIMITIVE_TYPE.INTEGER: { val = guaranteeIsNumber(Number(value)); break; } case PRIMITIVE_TYPE.DATE: case PRIMITIVE_TYPE.STRICTDATE: case PRIMITIVE_TYPE.DATETIME: { val = value; // TODO?: make sure this is a parsable date string break; } default: { throw new UnsupportedOperationError( `Can't filter on column with unsupported type '${columnConfiguration.type}'`, ); } } return { label, value: { type: columnConfiguration.type, value: val } }; } function getColumnFilterOperations( columnConfiguration: DataCubeColumnConfiguration, ): string[] { switch (columnConfiguration.type) { case PRIMITIVE_TYPE.STRING: { return [ DataCubeQueryFilterOperator.EQUAL, DataCubeQueryFilterOperator.NOT_EQUAL, DataCubeQueryFilterOperator.LESS_THAN, DataCubeQueryFilterOperator.LESS_THAN_OR_EQUAL, DataCubeQueryFilterOperator.GREATER_THAN, DataCubeQueryFilterOperator.GREATER_THAN_OR_EQUAL, DataCubeQueryFilterOperator.CONTAIN, DataCubeQueryFilterOperator.NOT_CONTAIN, DataCubeQueryFilterOperator.START_WITH, DataCubeQueryFilterOperator.NOT_START_WITH, DataCubeQueryFilterOperator.END_WITH, DataCubeQueryFilterOperator.NOT_END_WITH, ]; } case PRIMITIVE_TYPE.NUMBER: case PRIMITIVE_TYPE.DECIMAL: case PRIMITIVE_TYPE.FLOAT: case PRIMITIVE_TYPE.INTEGER: { return [ DataCubeQueryFilterOperator.EQUAL, DataCubeQueryFilterOperator.NOT_EQUAL, DataCubeQueryFilterOperator.LESS_THAN, DataCubeQueryFilterOperator.LESS_THAN_OR_EQUAL, DataCubeQueryFilterOperator.GREATER_THAN, DataCubeQueryFilterOperator.GREATER_THAN_OR_EQUAL, ]; } case PRIMITIVE_TYPE.DATE: case PRIMITIVE_TYPE.STRICTDATE: case PRIMITIVE_TYPE.DATETIME: { return [ DataCubeQueryFilterOperator.EQUAL, DataCubeQueryFilterOperator.NOT_EQUAL, DataCubeQueryFilterOperator.LESS_THAN, DataCubeQueryFilterOperator.LESS_THAN_OR_EQUAL, DataCubeQueryFilterOperator.GREATER_THAN, DataCubeQueryFilterOperator.GREATER_THAN_OR_EQUAL, ]; } default: { return []; } } } function buildNewFilterConditionMenuItem( columnConfiguration: DataCubeColumnConfiguration, operator: string, value: { label?: string | undefined; value: DataCubeOperationValue }, controller: DataCubeGridControllerState, ): MenuItemDef { const operation = controller.view.engine.getFilterOperation(operator); return { name: `Add Filter: ${columnConfiguration.name} ${operation.textLabel}${value.label ? ` ${value.label}` : ''}`, action: () => { controller.addNewFilterCondition( new DataCubeFilterEditorConditionTreeNode( controller.filterTree.root, { name: columnConfiguration.name, type: columnConfiguration.type, }, operation, value.value, undefined, ), ); }, }; } export function generateMenuBuilder( controller: DataCubeGridControllerState, ): ( params: GetContextMenuItemsParams | GetMainMenuItemsParams, fromHeader: boolean, ) => (DefaultMenuItem | MenuItemDef)[] { const view = controller.view; const dataCube = view.dataCube; // NOTE: we need to minimize the usage of these states // since the grid context-menu should be solely driven // by the grid controller const filter = view.filter; const editor = view.editor; const extend = view.extend; const logEmail = (format: string) => { view.dataCube.telemetryService.sendTelemetry(DataCubeEvent.EMAIL_DATACUBE, { ...view.engine.getDataFromSource(view.getInitialSource()), emailFormat: format, }); }; const logExport = (format: string) => { view.dataCube.telemetryService.sendTelemetry( DataCubeEvent.EXPORT_DATACUBE, { ...view.engine.getDataFromSource(view.getInitialSource()), exportFormat: format, }, ); }; const logOpeningPropertiesEditor = () => { view.dataCube.telemetryService.sendTelemetry( DataCubeEvent.OPEN_EDITOR_PROPERTIES, { ...view.engine.getDataFromSource(view.getInitialSource()), openedFrom: DataCubeOpenEditorSource.GRID_MENU, }, ); }; const logOpeningFilterEditor = () => { view.dataCube.telemetryService.sendTelemetry( DataCubeEvent.OPEN_EDITOR_FILTER, { ...view.engine.getDataFromSource(view.getInitialSource()), openedFrom: DataCubeOpenEditorSource.GRID_MENU, }, ); }; const logMenuItem = (menuName: string, subMenuName?: string) => { const menuItem = subMenuName === undefined ? { menuName: menuName } : { menuName: menuName, subMenuName: subMenuName }; view.dataCube.telemetryService.sendTelemetry( DataCubeEvent.SELECT_ITEM_GRIDMENU, { ...view.engine.getDataFromSource(view.getInitialSource()), ...menuItem, }, ); }; return ( params: GetContextMenuItemsParams | GetMainMenuItemsParams, fromHeader: boolean, ) => { const column = params.column ?? undefined; const columnName = column?.getColId(); const columnConfiguration = controller.getColumnConfiguration(columnName); const baseColumnConfiguration = columnName && isPivotResultColumnName(columnName) ? controller.getColumnConfiguration( getPivotResultColumnBaseColumnName(columnName), ) : undefined; const isExtendedColumn = columnName && _findCol( [...controller.leafExtendedColumns, ...controller.groupExtendedColumns], columnName, ); // NOTE: here we assume the value must be coming from the same column const value: unknown = 'value' in params ? params.value : undefined; const sortMenu = [ { name: 'Sort', subMenu: [ ...(column && columnName && controller.getSortableColumn(columnName) ? [ { name: 'Ascending', action: () => { controller.setSortByColumn( columnName, DataCubeQuerySortDirection.ASCENDING, ); logMenuItem('Sort', 'Ascending'); }, }, { name: 'Descending', action: () => { controller.setSortByColumn( columnName, DataCubeQuerySortDirection.DESCENDING, ); logMenuItem('Sort', 'Descending'); }, }, { name: 'Clear Sort', disabled: !_findCol(controller.sortColumns, columnName), action: () => { controller.clearSortByColumn(columnName); logMenuItem('Sort', 'Clear Sort'); }, }, 'separator', { name: 'Add Ascending', disabled: Boolean( controller.sortColumns.find( (col) => col.name === columnName && col.direction === DataCubeQuerySortDirection.ASCENDING, ), ), action: () => { controller.addSortByColumn( columnName, DataCubeQuerySortDirection.ASCENDING, ); logMenuItem('Sort', 'Add Ascending'); }, }, { name: 'Add Descending', disabled: Boolean( controller.sortColumns.find( (col) => col.name === columnName && col.direction === DataCubeQuerySortDirection.DESCENDING, ), ), action: () => { controller.addSortByColumn( columnName, DataCubeQuerySortDirection.DESCENDING, ); logMenuItem('Sort', 'Add Descending'); }, }, 'separator', ] : []), { name: 'Clear All Sorts', disabled: controller.sortColumns.length === 0, action: () => { controller.clearAllSorts(); logMenuItem('Clear All Sorts'); }, }, ], }, ] satisfies (DefaultMenuItem | MenuItemDef)[]; let newFilterMenu: MenuItemDef[] = []; if (column && value !== undefined) { let _columnConfiguration = columnConfiguration; if ( column.getColId() === INTERNAL__GRID_CLIENT_TREE_COLUMN_ID && controller.verticalPivotColumns.length && 'node' in params && params.node ) { const groupByColumn = controller.verticalPivotColumns[params.node.level]; _columnConfiguration = controller.getColumnConfiguration( groupByColumn?.name, ); } if (_columnConfiguration) { if (value !== INTERNAL__GRID_CLIENT_MISSING_VALUE) { const filterValue = toFilterValue(value, _columnConfiguration); const filterOperations = getColumnFilterOperations(_columnConfiguration); if ( filterOperations.length && filterOperations.includes(DataCubeQueryFilterOperator.EQUAL) ) { const moreFilterOperations = filterOperations.filter( (op) => op !== DataCubeQueryFilterOperator.EQUAL, ); newFilterMenu = [ buildNewFilterConditionMenuItem( _columnConfiguration, DataCubeQueryFilterOperator.EQUAL, filterValue, controller, ), moreFilterOperations.length ? { name: `More Filters on ${columnName}...`, subMenu: moreFilterOperations.map((operator) => buildNewFilterConditionMenuItem( _columnConfiguration, operator, filterValue, controller, ), ), } : undefined, ].filter(isNonNullable); } } else { newFilterMenu = [ buildNewFilterConditionMenuItem( _columnConfiguration, DataCubeQueryFilterOperator.IS_NULL, { value: { type: DataCubeOperationAdvancedValueType.VOID, }, }, controller, ), buildNewFilterConditionMenuItem( _columnConfiguration, DataCubeQueryFilterOperator.IS_NOT_NULL, { value: { type: DataCubeOperationAdvancedValueType.VOID, }, }, controller, ), ]; } } } return [ { name: 'Export', subMenu: [ { name: 'HTML', menuItem: WIP_GridMenuItem, cssClasses: ['!opacity-100'], disabled: true, }, { name: 'Plain Text', menuItem: WIP_GridMenuItem, cssClasses: ['!opacity-100'], disabled: true, }, { name: 'PDF', menuItem: WIP_GridMenuItem, cssClasses: ['!opacity-100'], disabled: true, }, { name: 'Excel', action: () => { view.grid.exportEngine.exportFile( DataCubeGridClientExportFormat.EXCEL, ); logExport(DataCubeGridClientExportFormat.EXCEL); }, }, { name: 'CSV', action: () => { view.grid.exportEngine.exportFile( DataCubeGridClientExportFormat.CSV, ); logExport(DataCubeGridClientExportFormat.CSV); }, }, 'separator', { name: 'DataCube Specification', menuItem: WIP_GridMenuItem, cssClasses: ['!opacity-100'], disabled: true, }, ], }, { name: 'Email', subMenu: [ { name: 'HTML', menuItem: WIP_GridMenuItem, cssClasses: ['!opacity-100'], disabled: true, }, { name: 'Plain Text', menuItem: WIP_GridMenuItem, cssClasses: ['!opacity-100'], disabled: true, }, 'separator', { name: 'HTML Attachment', menuItem: WIP_GridMenuItem, cssClasses: ['!opacity-100'], disabled: true, }, { name: 'Plain Text Attachment', menuItem: WIP_GridMenuItem, cssClasses: ['!opacity-100'], disabled: true, }, { name: 'PDF Attachment', menuItem: WIP_GridMenuItem, cssClasses: ['!opacity-100'], disabled: true, }, { name: 'Excel Attachment', action: () => { view.grid.exportEngine .exportEmail(DataCubeGridClientExportFormat.EXCEL) .catch((error) => dataCube.alertService.alertUnhandledError(error), ); logEmail(DataCubeGridClientExportFormat.EXCEL); }, }, { name: 'CSV Attachment', action: () => { view.grid.exportEngine .exportEmail(DataCubeGridClientExportFormat.CSV) .catch((error) => dataCube.alertService.alertUnhandledError(error), ); logEmail(DataCubeGridClientExportFormat.CSV); }, }, { name: 'DataCube Specification Attachment', menuItem: WIP_GridMenuItem, cssClasses: ['!opacity-100'], disabled: true, }, ], }, { name: 'Copy', menuItem: WIP_GridMenuItem, cssClasses: ['!opacity-100'], subMenu: [ { name: 'Plain Text', menuItem: WIP_GridMenuItem, cssClasses: ['!opacity-100'], disabled: true, }, { name: 'Selected Rows as Plain Text', menuItem: WIP_GridMenuItem, cssClasses: ['!opacity-100'], disabled: true, }, { name: 'Selected Column as Plain Text', menuItem: WIP_GridMenuItem, cssClasses: ['!opacity-100'], disabled: true, }, ], }, 'separator', ...sortMenu, { name: 'Filter', subMenu: [ ...newFilterMenu, newFilterMenu.length ? 'separator' : undefined, { name: 'Filters...', action: () => { filter.display.open(); logOpeningFilterEditor(); }, }, { name: 'Clear All Filters', action: () => { controller.clearFilters(); logMenuItem('Filter', 'Clear All Filters'); }, }, ].filter(isNonNullable), }, { name: 'Pivot', subMenu: [ ...(column && columnName && columnConfiguration?.kind === DataCubeColumnKind.DIMENSION && controller.getVerticalPivotableColumn(columnName) ? [ { name: `Vertical Pivot on ${columnName}`, action: () => { controller.setVerticalPivotOnColumn(columnName); logMenuItem('Pivot', 'Vertical Pivot'); }, }, { name: `Add Vertical Pivot on ${columnName}`, disabled: Boolean( _findCol(controller.verticalPivotColumns, columnName), ), action: () => { controller.addVerticalPivotOnColumn(columnName); logMenuItem('Pivot', 'Add Vertical Pivot'); }, }, { name: `Remove Vertical Pivot on ${columnName}`, disabled: !_findCol( controller.verticalPivotColumns, columnName, ), action: () => { controller.removeVerticalPivotOnColumn(columnName); logMenuItem('Pivot', 'Remove Vertical Pivot'); }, }, 'separator', ] : []), ...(column && columnName && columnConfiguration?.kind === DataCubeColumnKind.DIMENSION && controller.getHorizontalPivotableColumn(columnName) ? [ { name: `Horizontal Pivot on ${columnName}`, action: () => { controller.setHorizontalPivotOnColumn(columnName); logMenuItem('Pivot', 'Horizontal Pivot'); }, }, { name: `Add Horizontal Pivot on ${columnName}`, disabled: Boolean( _findCol(controller.horizontalPivotColumns, columnName), ), action: () => { controller.addHorizontalPivotOnColumn(columnName); logMenuItem('Pivot', 'Add Horizontal Pivot'); }, }, 'separator', ] : []), ...(column && columnName && baseColumnConfiguration?.kind === DataCubeColumnKind.MEASURE && !baseColumnConfiguration.excludedFromPivot && controller.horizontalPivotColumns.length !== 0 // pivot must be active ? [ { name: `Exclude Column ${baseColumnConfiguration.name} from Horizontal Pivot`, action: () => { controller.excludeColumnFromHorizontalPivot(columnName); logMenuItem( 'Pivot', 'Exclude Column From Horizontal Pivot', ); }, }, 'separator', ] : []), ...(column && columnName && columnConfiguration?.kind === DataCubeColumnKind.MEASURE && columnConfiguration.excludedFromPivot && controller.horizontalPivotColumns.length !== 0 // pivot must be active ? [ { name: `Include Column ${columnName} in Horizontal Pivot`, action: () => { controller.includeColumnInHorizontalPivot(columnName); logMenuItem('Pivot', 'Include Column in Horizontal Pivot'); }, }, 'separator', ] : []), { name: `Clear All Vertical Pivots`, disabled: controller.verticalPivotColumns.length === 0, action: () => { controller.clearAllVerticalPivots(); logMenuItem('Pivot', 'Clear All Vertical Pivots'); }, }, { name: `Clear All Horizontal Pivots`, disabled: controller.horizontalPivotColumns.length === 0, action: () => { controller.clearAllHorizontalPivots(); logMenuItem('Pivot', 'Clear All Horizontal Pivots'); }, }, ], }, { name: 'Extended Columns', subMenu: [ { name: `Add New Column...`, action: () => { extend .openNewColumnEditor() .catch((error) => dataCube.alertService.alertUnhandledError(error), ); logMenuItem('Extended Columns', 'Add New Column...'); }, }, ...(columnConfiguration && columnName ? [ { name: `Extend Column ${columnName}...`, action: () => { extend .openNewColumnEditor(columnConfiguration) .catch((error) => dataCube.alertService.alertUnhandledError(error), ); logMenuItem('Extended Columns', 'Extend Column'); }, }, ] : []), ...(isExtendedColumn ? [ 'separator', { name: `Edit Column ${columnName}...`, action: () => { extend .openExistingColumnEditor(columnName) .catch((error) => dataCube.alertService.alertUnhandledError(error), ); logMenuItem('Extended Columns', 'Edit Column'); }, }, { name: `Delete Column ${columnName}`, action: () => { extend .deleteColumn(columnName) .catch((error) => dataCube.alertService.alertUnhandledError(error), ); logMenuItem('Extended Columns', 'Delete Column'); }, }, ] : []), ], }, 'separator', { name: 'Resize', subMenu: [ { name: `Auto-size to Fit Content`, disabled: !column || !columnConfiguration || columnConfiguration.fixedWidth !== undefined, action: () => { params.api.autoSizeColumns( [column?.getColId()].filter(isNonNullable), ); logMenuItem('Resize', 'Auto-size to Fit Content'); }, }, { name: `Minimize Column`, disabled: !column || !columnConfiguration || columnConfiguration.fixedWidth !== undefined, action: () => { if (column && columnConfiguration) { params.api.setColumnWidths([ { key: columnConfiguration.name, newWidth: columnConfiguration.minWidth ?? DEFAULT_COLUMN_MIN_WIDTH, }, ]); } logMenuItem('Resize', 'Minimize Column'); }, }, 'separator', { name: `Auto-size All Columns`, action: () => { params.api.autoSizeColumns([ ...controller.configuration.columns .filter( (col) => col.fixedWidth === undefined && col.isSelected && !col.hideFromView, ) .map((col) => col.name), ...controller.horizontalPivotCastColumns .map((col) => { if (isPivotResultColumnName(col.name)) { const colConf = _findCol( controller.configuration.columns, getPivotResultColumnBaseColumnName(col.name), ); if ( colConf && colConf.fixedWidth === undefined && colConf.isSelected && !colConf.hideFromView ) { return col.name; } } return undefined; }) .filter(isNonNullable), ]); logMenuItem('Resize', 'Auto-size All Columns'); }, }, { name: `Minimize All Columns`, action: () => { params.api.setColumnWidths([ ...controller.configuration.columns .filter((col) => col.fixedWidth === undefined) .map((col) => ({ key: col.name, newWidth: columnConfiguration?.minWidth ?? DEFAULT_COLUMN_MIN_WIDTH, })), ...controller.horizontalPivotCastColumns .map((col) => { if (isPivotResultColumnName(col.name)) { const colConf = _findCol( controller.configuration.columns, getPivotResultColumnBaseColumnName(col.name), ); if ( colConf && colConf.fixedWidth === undefined && colConf.isSelected && !colConf.hideFromView ) { return { key: col.name, newWidth: colConf.minWidth ?? DEFAULT_COLUMN_MIN_WIDTH, }; } } return undefined; }) .filter(isNonNullable), ]); logMenuItem('Resize', 'Minimize All Columns'); }, }, { name: `Size Grid to Fit Screen`, action: () => { params.api.sizeColumnsToFit(); logMenuItem('Resize', 'Size Grid to Fit Screen'); }, }, ], }, { name: 'Pin', subMenu: [ ...(columnConfiguration ? [ { name: `Pin Left`, disabled: !column || column.isPinnedLeft(), checked: Boolean(column?.isPinnedLeft()), action: () => { controller.pinColumn( columnName, DataCubeColumnPinPlacement.LEFT, ); logMenuItem('Pin', 'Pin Left'); }, }, { name: `Pin Right`, disabled: !column || column.isPinnedRight(), checked: Boolean(column?.isPinnedRight()), action: () => { controller.pinColumn( columnName, DataCubeColumnPinPlacement.RIGHT, ); logMenuItem('Pin', 'Pin Right'); }, }, { name: `Unpin`, disabled: !column?.isPinned(), action: () => { controller.pinColumn(columnName, undefined); logMenuItem('Pin', 'Unpin'); }, }, 'separator', ] : []), { name: `Remove All Pinnings`, disabled: controller.configuration.columns.every( (col) => col.pinned === undefined, ), action: () => { controller.removeAllPins(); logMenuItem('Pin', 'Remove All Pinnings'); }, }, ], }, { name: 'Hide', disabled: !columnConfiguration, action: () => { controller.showColumn(columnName, false); logMenuItem('Hide'); }, }, ...((columnName === INTERNAL__GRID_CLIENT_TREE_COLUMN_ID ? [ 'separator', { name: 'Collapse All', action: () => { controller.collapseAllPaths(); }, }, ] : []) as (DefaultMenuItem | MenuItemDef)[]), 'separator', { name: 'Heatmap', menuItem: WIP_GridMenuItem, cssClasses: ['!opacity-100'], disabled: !column, subMenu: column ? [ { name: `Add to ${column.getColId()}`, menuItem: WIP_GridMenuItem, cssClasses: ['!opacity-100'], disabled: true, }, { name: `Remove from ${column.getColId()}`, menuItem: WIP_GridMenuItem, cssClasses: ['!opacity-100'], disabled: true, }, ] : [], }, { name: 'Show Plot...', menuItem: WIP_GridMenuItem, cssClasses: ['!opacity-100'], disabled: true, }, { name: 'Show TreeMap...', menuItem: WIP_GridMenuItem, cssClasses: ['!opacity-100'], disabled: true, }, 'separator', { name: 'Properties...', disabled: editor.display.isOpen, action: () => { // open the column property if (column && fromHeader) { editor.setCurrentTab(DataCubeEditorTab.COLUMN_PROPERTIES); editor.columnProperties.setSelectedColumnName( baseColumnConfiguration?.name ?? columnConfiguration?.name ?? columnName, ); } editor.display.open(); logOpeningPropertiesEditor(); }, }, ] satisfies (DefaultMenuItem | MenuItemDef)[]; }; } export function generateDimensionalMenuBuilder( controller: DataCubeGridControllerState, ): ( params: GetContextMenuItemsParams | GetMainMenuItemsParams, fromHeader: boolean, ) => (DefaultMenuItem | MenuItemDef)[] { const view = controller.view; const dataCube = view.dataCube; return ( params: GetContextMenuItemsParams | GetMainMenuItemsParams, fromHeader: boolean, ) => { const column = params.column ?? undefined; const columnName = column?.getColId(); const columnConfiguration = controller.getColumnConfiguration(columnName); //TODO: add more menu items like sort,filter... return [ { name: 'Zoom Out', action: (param) => { const data = param.node?.data.metadata as Map< string, DataCubeDimensionalMetadata >; view.grid .retrieveDrilloutData( data, guaranteeNonNullable(params.column?.getColId()), ) .catch((error) => dataCube.alertService.alertUnhandledError(error)); }, }, { name: 'Export', subMenu: [ { name: 'HTML', menuItem: WIP_GridMenuItem, cssClasses: ['!opacity-100'], disabled: true, }, { name: 'Plain Text', menuItem: WIP_GridMenuItem, cssClasses: ['!opacity-100'], disabled: true, }, { name: 'PDF', menuItem: WIP_GridMenuItem, cssClasses: ['!opacity-100'], disabled: true, }, { name: 'Excel', action: () => view.grid.exportEngine.exportFile( DataCubeGridClientExportFormat.EXCEL, ), }, { name: 'CSV', action: () => view.grid.exportEngine.exportFile( DataCubeGridClientExportFormat.CSV, ), }, 'separator', { name: 'DataCube Specification', menuItem: WIP_GridMenuItem, cssClasses: ['!opacity-100'], disabled: true, }, ], }, { name: 'Email', subMenu: [ { name: 'HTML', menuItem: WIP_GridMenuItem, cssClasses: ['!opacity-100'], disabled: true, }, { name: 'Plain Text', menuItem: WIP_GridMenuItem, cssClasses: ['!opacity-100'], disabled: true, }, 'separator', { name: 'HTML Attachment', menuItem: WIP_GridMenuItem, cssClasses: ['!opacity-100'], disabled: true, }, { name: 'Plain Text Attachment', menuItem: WIP_GridMenuItem, cssClasses: ['!opacity-100'], disabled: true, }, { name: 'PDF Attachment', menuItem: WIP_GridMenuItem, cssClasses: ['!opacity-100'], disabled: true, }, { name: 'Excel Attachment', action: () => { view.grid.exportEngine .exportEmail(DataCubeGridClientExportFormat.EXCEL) .catch((error) => dataCube.alertService.alertUnhandledError(error), ); }, }, { name: 'CSV Attachment', action: () => { view.grid.exportEngine .exportEmail(DataCubeGridClientExportFormat.CSV) .catch((error) => dataCube.alertService.alertUnhandledError(error), ); }, }, { name: 'DataCube Specification Attachment', menuItem: WIP_GridMenuItem, cssClasses: ['!opacity-100'], disabled: true, }, ], }, //TODO: add sort .extend, heatmap 'separator', { name: 'Resize', subMenu: [ { name: `Auto-size to Fit Content`, disabled: !column || !columnConfiguration || columnConfiguration.fixedWidth !== undefined, action: () => params.api.autoSizeColumns( [column?.getColId()].filter(isNonNullable), ), }, { name: `Minimize Column`, disabled: !column || !columnConfiguration || columnConfiguration.fixedWidth !== undefined, action: () => { if (column && columnConfiguration) { params.api.setColumnWidths([ { key: columnConfiguration.name, newWidth: columnConfiguration.minWidth ?? DEFAULT_COLUMN_MIN_WIDTH, }, ]); } }, }, 'separator', { name: `Auto-size All Columns`, action: () => params.api.autoSizeColumns([ ...controller.configuration.columns .filter( (col) => col.fixedWidth === undefined && col.isSelected && !col.hideFromView, ) .map((col) => col.name), ...controller.horizontalPivotCastColumns .map((col) => { if (isPivotResultColumnName(col.name)) { const colConf = _findCol( controller.configuration.columns, getPivotResultColumnBaseColumnName(col.name), ); if ( colConf && colConf.fixedWidth === undefined && colConf.isSelected && !colConf.hideFromView ) { return col.name; } } return undefined; }) .filter(isNonNullable), ]), }, { name: `Minimize All Columns`, action: () => { params.api.setColumnWidths([ ...controller.configuration.columns .filter((col) => col.fixedWidth === undefined) .map((col) => ({ key: col.name, newWidth: columnConfiguration?.minWidth ?? DEFAULT_COLUMN_MIN_WIDTH, })), ...controller.horizontalPivotCastColumns .map((col) => { if (isPivotResultColumnName(col.name)) { const colConf = _findCol( controller.configuration.columns, getPivotResultColumnBaseColumnName(col.name), ); if ( colConf && colConf.fixedWidth === undefined && colConf.isSelected && !colConf.hideFromView ) { return { key: col.name, newWidth: colConf.minWidth ?? DEFAULT_COLUMN_MIN_WIDTH, }; } } return undefined; }) .filter(isNonNullable), ]); }, }, { name: `Size Grid to Fit Screen`, action: () => params.api.sizeColumnsToFit(), }, ], }, ] satisfies (DefaultMenuItem | MenuItemDef)[]; }; }