Merge pull request #4735 from oleibman/gridright

oleibman · web-flow · commit 954fb871d375 · 2025-12-05T02:59:36.000Z
Minor Improvements to TextGrid
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -31,6 +31,7 @@ and this project adheres to [Semantic Versioning](https://semver.org). Thia is a
 
 - Slightly better support for escaped characters in Xlsx Reader/Writer. [Discussion #4724](https://github.com/PHPOffice/PhpSpreadsheet/discussions/4724) [PR #4726](https://github.com/PHPOffice/PhpSpreadsheet/pull/4726)
 - CODE/UNICODE and CHAR/UNICHAR. [PR #4727](https://github.com/PHPOffice/PhpSpreadsheet/pull/4727)
+- Minor changes to TextGrid. [PR #4735](https://github.com/PHPOffice/PhpSpreadsheet/pull/4735)
 
 ## 2025-11-24 - 5.3.0
 
diff --git a/samples/Autofilter/10_Autofilter.php b/samples/Autofilter/10_Autofilter.php
@@ -86,7 +86,7 @@
     ['2011', 'Q4', 'Italy', 335],
 ];
 $spreadsheet->getActiveSheet()->fromArray($dataArray, null, 'A2');
-$helper->displayGrid($spreadsheet->getActiveSheet()->toArray(null, false, false, true));
+$helper->displayGrid($spreadsheet->getActiveSheet()->toArray(null, false, false, true), true);
 
 // Set title row bold
 $helper->log('Set title row bold');
diff --git a/samples/Autofilter/10_Autofilter_selection_1.php b/samples/Autofilter/10_Autofilter_selection_1.php
@@ -26,11 +26,11 @@
 // Create the worksheet
 $helper->log('Add data');
 $spreadsheet->setActiveSheetIndex(0);
-$spreadsheet->getActiveSheet()->setCellValue('A1', 'Financial Year')
-    ->setCellValue('B1', 'Financial Period')
+$spreadsheet->getActiveSheet()->setCellValue('A1', 'Year')
+    ->setCellValue('B1', 'Period')
     ->setCellValue('C1', 'Country')
     ->setCellValue('D1', 'Date')
-    ->setCellValue('E1', 'Sales Value')
+    ->setCellValue('E1', 'Sales')
     ->setCellValue('F1', 'Expenditure');
 $dateTime = new DateTime();
 $startYear = $endYear = $currentYear = (int) $dateTime->format('Y');
diff --git a/samples/Autofilter/10_Autofilter_selection_2.php b/samples/Autofilter/10_Autofilter_selection_2.php
@@ -26,11 +26,11 @@
 // Create the worksheet
 $helper->log('Add data');
 $spreadsheet->setActiveSheetIndex(0);
-$spreadsheet->getActiveSheet()->setCellValue('A1', 'Financial Year')
-    ->setCellValue('B1', 'Financial Period')
+$spreadsheet->getActiveSheet()->setCellValue('A1', 'Year')
+    ->setCellValue('B1', 'Period')
     ->setCellValue('C1', 'Country')
     ->setCellValue('D1', 'Date')
-    ->setCellValue('E1', 'Sales Value')
+    ->setCellValue('E1', 'Sales')
     ->setCellValue('F1', 'Expenditure');
 $dateTime = new DateTime();
 $startYear = $endYear = $currentYear = (int) $dateTime->format('Y');
diff --git a/samples/Autofilter/10_Autofilter_selection_display.php b/samples/Autofilter/10_Autofilter_selection_display.php
@@ -26,11 +26,11 @@
 // Create the worksheet
 $helper->log('Add data');
 $spreadsheet->setActiveSheetIndex(0);
-$spreadsheet->getActiveSheet()->setCellValue('A1', 'Financial Year')
-    ->setCellValue('B1', 'Financial Period')
+$spreadsheet->getActiveSheet()->setCellValue('A1', 'Year')
+    ->setCellValue('B1', 'Period')
     ->setCellValue('C1', 'Country')
     ->setCellValue('D1', 'Date')
-    ->setCellValue('E1', 'Sales Value')
+    ->setCellValue('E1', 'Sales')
     ->setCellValue('F1', 'Expenditure');
 $dateTime = new DateTime();
 $startYear = $endYear = $currentYear = (int) $dateTime->format('Y');
diff --git a/samples/Database/DAVERAGE.php b/samples/Database/DAVERAGE.php
@@ -36,11 +36,13 @@
 
 $worksheet->setCellValue('A13', 'The Average age of all Apple and Pear trees in the orchard');
 $worksheet->setCellValue('B13', '=DAVERAGE(A4:E10,3,A1:A3)');
+$worksheet->getStyle('E5:E10')->getNumberFormat()
+    ->setFormatCode('0.00');
 
 $helper->log('Database');
 
 $databaseData = $worksheet->rangeToArray('A4:E10', null, true, true, true);
-$helper->displayGrid($databaseData);
+$helper->displayGrid($databaseData, true);
 
 // Test the formulae
 $helper->log('Criteria');
diff --git a/samples/Database/DCOUNT.php b/samples/Database/DCOUNT.php
@@ -40,7 +40,7 @@
 $helper->log('Database');
 
 $databaseData = $worksheet->rangeToArray('A4:E10', null, true, true, true);
-$helper->displayGrid($databaseData);
+$helper->displayGrid($databaseData, true);
 
 // Test the formulae
 $helper->log('Criteria');
diff --git a/samples/Database/DCOUNTA.php b/samples/Database/DCOUNTA.php
@@ -40,7 +40,7 @@
 $helper->log('Database');
 
 $databaseData = $worksheet->rangeToArray('A4:E10', null, true, true, true);
-$helper->displayGrid($databaseData);
+$helper->displayGrid($databaseData, true);
 
 // Test the formulae
 $helper->log('Criteria');
diff --git a/samples/Database/DGET.php b/samples/Database/DGET.php
@@ -36,11 +36,13 @@
 
 $worksheet->setCellValue('A13', 'The height of the Apple tree (will return an Excel error, because there is more than one apple tree)');
 $worksheet->setCellValue('B13', '=DGET(A4:E10,"Height",A1:A2)');
+$worksheet->getStyle('E5:E10')->getNumberFormat()
+    ->setFormatCode('0.00');
 
 $helper->log('Database');
 
 $databaseData = $worksheet->rangeToArray('A4:E10', null, true, true, true);
-$helper->displayGrid($databaseData);
+$helper->displayGrid($databaseData, true);
 
 // Test the formulae
 $helper->log('Criteria');
diff --git a/samples/Database/DMAX.php b/samples/Database/DMAX.php
@@ -36,11 +36,13 @@
 
 $worksheet->setCellValue('A13', 'The Oldest apple tree in the orchard');
 $worksheet->setCellValue('B13', '=DMAX(A4:E10,3,A1:A2)');
+$worksheet->getStyle('E5:E10')->getNumberFormat()
+    ->setFormatCode('0.00');
 
 $helper->log('Database');
 
 $databaseData = $worksheet->rangeToArray('A4:E10', null, true, true, true);
-$helper->displayGrid($databaseData);
+$helper->displayGrid($databaseData, true);
 
 // Test the formulae
 $helper->log('Criteria');
diff --git a/samples/Database/DMIN.php b/samples/Database/DMIN.php
@@ -36,11 +36,13 @@
 
 $worksheet->setCellValue('A13', 'The Youngest apple tree in the orchard');
 $worksheet->setCellValue('B13', '=DMIN(A4:E10,3,A1:A2)');
+$worksheet->getStyle('E5:E10')->getNumberFormat()
+    ->setFormatCode('0.00');
 
 $helper->log('Database');
 
 $databaseData = $worksheet->rangeToArray('A4:E10', null, true, true, true);
-$helper->displayGrid($databaseData);
+$helper->displayGrid($databaseData, true);
 
 // Test the formulae
 $helper->log('Criteria');
diff --git a/samples/Database/DPRODUCT.php b/samples/Database/DPRODUCT.php
@@ -40,7 +40,7 @@
 $helper->log('Database');
 
 $databaseData = $worksheet->rangeToArray('A4:E10', null, true, true, true);
-$helper->displayGrid($databaseData);
+$helper->displayGrid($databaseData, true);
 
 // Test the formulae
 $helper->log('Criteria');
diff --git a/samples/Database/DSTDEV.php b/samples/Database/DSTDEV.php
@@ -36,11 +36,13 @@
 
 $worksheet->setCellValue('A13', 'The estimated standard deviation in height of Apple and Pear trees');
 $worksheet->setCellValue('B13', '=DSTDEV(A4:E10,2,A1:A3)');
+$worksheet->getStyle('E5:E10')->getNumberFormat()
+    ->setFormatCode('0.00');
 
 $helper->log('Database');
 
 $databaseData = $worksheet->rangeToArray('A4:E10', null, true, true, true);
-$helper->displayGrid($databaseData);
+$helper->displayGrid($databaseData, true);
 
 // Test the formulae
 $helper->log('Criteria');
diff --git a/samples/Database/DSTDEVP.php b/samples/Database/DSTDEVP.php
@@ -36,11 +36,13 @@
 
 $worksheet->setCellValue('A13', 'The standard deviation in height of Apple and Pear trees');
 $worksheet->setCellValue('B13', '=DSTDEVP(A4:E10,2,A1:A3)');
+$worksheet->getStyle('E5:E10')->getNumberFormat()
+    ->setFormatCode('0.00');
 
 $helper->log('Database');
 
 $databaseData = $worksheet->rangeToArray('A4:E10', null, true, true, true);
-$helper->displayGrid($databaseData);
+$helper->displayGrid($databaseData, true);
 
 // Test the formulae
 $helper->log('Criteria');
diff --git a/samples/Database/DSUM.php b/samples/Database/DSUM.php
@@ -36,11 +36,13 @@
 
 $worksheet->setCellValue('A13', 'Total profit from apple trees with a height between 10 and 16 feet, and all pear trees');
 $worksheet->setCellValue('B13', '=DSUM(A4:E10,"Profit",A1:F3)');
+$worksheet->getStyle('E5:E10')->getNumberFormat()
+    ->setFormatCode('0.00');
 
 $helper->log('Database');
 
 $databaseData = $worksheet->rangeToArray('A4:E10', null, true, true, true);
-$helper->displayGrid($databaseData);
+$helper->displayGrid($databaseData, true);
 
 // Test the formulae
 $helper->log('Criteria');
diff --git a/samples/Database/DVAR.php b/samples/Database/DVAR.php
@@ -36,11 +36,13 @@
 
 $worksheet->setCellValue('A13', 'The estimated variance in height of Apple and Pear trees');
 $worksheet->setCellValue('B13', '=DVAR(A4:E10,2,A1:A3)');
+$worksheet->getStyle('E5:E10')->getNumberFormat()
+    ->setFormatCode('0.00');
 
 $helper->log('Database');
 
 $databaseData = $worksheet->rangeToArray('A4:E10', null, true, true, true);
-$helper->displayGrid($databaseData);
+$helper->displayGrid($databaseData, true);
 
 // Test the formulae
 $helper->log('Criteria');
diff --git a/samples/Database/DVARP.php b/samples/Database/DVARP.php
@@ -36,11 +36,13 @@
 
 $worksheet->setCellValue('A13', 'The variance in height of Apple and Pear trees');
 $worksheet->setCellValue('B13', '=DVARP(A4:E10,2,A1:A3)');
+$worksheet->getStyle('E5:E10')->getNumberFormat()
+    ->setFormatCode('0.00');
 
 $helper->log('Database');
 
 $databaseData = $worksheet->rangeToArray('A4:E10', null, true, true, true);
-$helper->displayGrid($databaseData);
+$helper->displayGrid($databaseData, true);
 
 // Test the formulae
 $helper->log('Criteria');
diff --git a/samples/Reader/11_Reading_a_workbook_in_chunks_using_a_configurable_read_filter_(version_1).php b/samples/Reader/11_Reading_a_workbook_in_chunks_using_a_configurable_read_filter_(version_1).php
@@ -53,10 +53,13 @@ public function readCell(string $columnAddress, int $row, string $worksheetName
     $reader->setReadFilter($chunkFilter);
     // Load only the rows that match our filter from $inputFileName to a PhpSpreadsheet Object
     $spreadsheet = $reader->load($inputFileName);
+    $sheet = $spreadsheet->getActiveSheet();
 
     // Do some processing here
 
-    $activeRange = $spreadsheet->getActiveSheet()->calculateWorksheetDataDimension();
-    $sheetData = $spreadsheet->getActiveSheet()->rangeToArray($activeRange, null, true, true, true);
-    $helper->displayGrid($sheetData);
+    $activeRange = $sheet->calculateWorksheetDataDimension();
+    $sheet->getStyle($activeRange)->getNumberFormat()
+        ->setFormatCode('0.000');
+    $sheetData = $sheet->rangeToArray($activeRange, null, true, true, true);
+    $helper->displayGrid($sheetData, true);
 }
diff --git a/samples/Reader/12_Reading_a_workbook_in_chunks_using_a_configurable_read_filter_(version_2).php b/samples/Reader/12_Reading_a_workbook_in_chunks_using_a_configurable_read_filter_(version_2).php
@@ -56,10 +56,13 @@ public function readCell(string $columnAddress, int $row, string $worksheetName
     $chunkFilter->setRows($startRow, $chunkSize);
     // Load only the rows that match our filter from $inputFileName to a PhpSpreadsheet Object
     $spreadsheet = $reader->load($inputFileName);
+    $sheet = $spreadsheet->getActiveSheet();
 
     // Do some processing here
 
-    $activeRange = $spreadsheet->getActiveSheet()->calculateWorksheetDataDimension();
-    $sheetData = $spreadsheet->getActiveSheet()->rangeToArray($activeRange, null, true, true, true);
-    $helper->displayGrid($sheetData);
+    $activeRange = $sheet->calculateWorksheetDataDimension();
+    $sheet->getStyle($activeRange)->getNumberFormat()
+        ->setFormatCode('0.000');
+    $sheetData = $sheet->rangeToArray($activeRange, null, true, true, true);
+    $helper->displayGrid($sheetData, true);
 }
diff --git a/samples/Reader2/13_Simple_file_reader_for_multiple_CSV_files.php b/samples/Reader2/13_Simple_file_reader_for_multiple_CSV_files.php
@@ -23,8 +23,11 @@
 foreach ($loadedSheetNames as $sheetIndex => $loadedSheetName) {
     $helper->log('<b>Worksheet #' . $sheetIndex . ' -> ' . $loadedSheetName . '</b>');
     $spreadsheet->setActiveSheetIndexByName($loadedSheetName);
+    $sheet = $spreadsheet->getActiveSheet();
 
-    $activeRange = $spreadsheet->getActiveSheet()->calculateWorksheetDataDimension();
-    $sheetData = $spreadsheet->getActiveSheet()->rangeToArray($activeRange, null, true, true, true);
-    $helper->displayGrid($sheetData);
+    $activeRange = $sheet->calculateWorksheetDataDimension();
+    $sheet->getStyle($activeRange)->getNumberFormat()
+        ->setFormatCode('0.000');
+    $sheetData = $sheet->rangeToArray($activeRange, null, true, true, true);
+    $helper->displayGrid($sheetData, true);
 }
diff --git a/samples/Reader2/14_Reading_a_large_CSV_file_in_chunks_to_split_across_multiple_worksheets.php b/samples/Reader2/14_Reading_a_large_CSV_file_in_chunks_to_split_across_multiple_worksheets.php
@@ -77,8 +77,11 @@ public function readCell(string $columnAddress, int $row, string $worksheetName
 foreach ($loadedSheetNames as $sheetIndex => $loadedSheetName) {
     $helper->log('<b>Worksheet #' . $sheetIndex . ' -> ' . $loadedSheetName . '</b>');
     $spreadsheet->setActiveSheetIndexByName($loadedSheetName);
+    $sheet = $spreadsheet->getActiveSheet();
 
-    $activeRange = $spreadsheet->getActiveSheet()->calculateWorksheetDataDimension();
-    $sheetData = $spreadsheet->getActiveSheet()->rangeToArray($activeRange, null, true, true, true);
-    $helper->displayGrid($sheetData);
+    $activeRange = $sheet->calculateWorksheetDataDimension();
+    $sheet->getStyle($activeRange)->getNumberFormat()
+        ->setFormatCode('0.000');
+    $sheetData = $sheet->rangeToArray($activeRange, null, true, true, true);
+    $helper->displayGrid($sheetData, true);
 }
diff --git a/samples/Table/02_Table_Total.php b/samples/Table/02_Table_Total.php
@@ -76,7 +76,7 @@
 
 $helper->log('Calculate Structured References');
 
-$helper->displayGrid($spreadsheet->getActiveSheet()->toArray(null, true, true, true));
+$helper->displayGrid($spreadsheet->getActiveSheet()->toArray(null, true, true, true), true);
 
 // Save
 $helper->write($spreadsheet, __FILE__, ['Xlsx']);
diff --git a/samples/Table/04_Column_Formula_with_Totals.php b/samples/Table/04_Column_Formula_with_Totals.php
@@ -86,7 +86,7 @@
 
 $helper->log('Calculate Structured References');
 
-$helper->displayGrid($spreadsheet->getActiveSheet()->toArray(null, true, true, true));
+$helper->displayGrid($spreadsheet->getActiveSheet()->toArray(null, true, true, true), true);
 
 // Save
 $helper->write($spreadsheet, __FILE__, ['Xlsx']);
diff --git a/src/PhpSpreadsheet/Helper/Sample.php b/src/PhpSpreadsheet/Helper/Sample.php
@@ -242,9 +242,12 @@ public function titles(string $category, string $functionName, ?string $descript
     }
 
     /** @param mixed[][] $matrix */
-    public function displayGrid(array $matrix): void
+    public function displayGrid(array $matrix, ?bool $numbersRight = null): void
     {
         $renderer = new TextGrid($matrix, $this->isCli());
+        if ($numbersRight !== null) {
+            $renderer->setNumbersRight($numbersRight);
+        }
         echo $renderer->render();
     }
 
diff --git a/src/PhpSpreadsheet/Helper/TextGrid.php b/src/PhpSpreadsheet/Helper/TextGrid.php
diff --git a/tests/PhpSpreadsheetTests/Helper/TextGridExtended.php b/tests/PhpSpreadsheetTests/Helper/TextGridExtended.php
diff --git a/tests/PhpSpreadsheetTests/Helper/TextGridTest.php b/tests/PhpSpreadsheetTests/Helper/TextGridTest.php
