geckon01/PhpSpreadsheet
1
0
Fork 0
mirror of https://github.com/PHPOffice/PhpSpreadsheet.git synced 2026-09-17 21:46:37 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
fb55d1b6e4a19aaa505df0b9cfa9e1f4b893e7e9
PhpSpreadsheet/docs/references/features-cross-reference.md
T
oleibman fb55d1b6e4 Ods Writer Support Some Number Formats 
Redo of PR #4799 due to failed attempt to resolve merge conflict.

Fix #4798. Partially address #3961. Ods Reader supports very little related to styling. Ods Writer supports many styling details, but has not heretofore supported Number Formatting. 3961 addresses both issues; I created 4798 specifically for the Writer side.

Writing number formats to Excel is pretty simple - you just supply a string and that is used directly in the Xml. Ods is much more complicated - it requires Xml nodes that give a complete description of the styling. For that reason, it is difficult and painstaking to convert from the string that Excel (and PhpSpreadsheet) uses to what Ods requires.

This PR provides code to support almost all the styles defined as constants in Style/NumberFormat. It also allows the user to add code to handle otherwise unhandled styles. New Sample55_DefinedStyles demonstrates the use of all the constant styles, plus the addition of a couple of custom styles. I may be amenable to adding some unsupported styles to the built-in list, but the custom style option will always be around in case I am being slow or unreasonable.

This PR does not fully support Ods Reader handling of styles. However, based on the new Writer output, it will often be able to guess the true type of numeric items and assign an appropriate style for that type. So, for example, if it can identify the field as a date, it will assign a date style. It will not always match the style in the sheet being read, but it is a big advance from just formatting the data as a generic number.
2026-02-10 23:48:49 -08:00

86 KiB
Raw Blame History

Features cross reference

  • ✔ Supported
  • ● Partially supported
  • ✖ Not supported
  • N/A Cannot be supported

Readers

Readers
XLS XLSX Excel2003XML Ods Gnumeric CSV SYLK HTML
Reader Options ✔ ✔ ● ● ✔ N/A N/A ✔
Read Charts ✖ ✔ ✖ ✖ ✖ N/A N/A ✖
Read Data Only (no formatting) ✔ ✔ ✖ ✔ ✔ N/A N/A ✔
Read Only Specified Worksheets ✔ ✔ ✔ ✔ ✔ N/A N/A ✔
Read Only Specified Cells ✔ ✔ ✔ ✔ ✔ ✔ ✖ ✔
Read External Images ✖ ✔ 9 ✖ ✖ ✖ N/A N/A ✔ 9
Document Properties ● ✔ ✔ ✔ ✔ N/A N/A ✔
Standard Properties ✔ ✔ ✔ ✔ ✔ N/A N/A ✔
Creator ✔ ✔ ✔ ✔ ✔ N/A N/A ✔
Creation Date/Time ✔ ✔ ✔ ✔ ✔ N/A N/A ✔
Modifier ✔ ✔ ✔ N/A N/A N/A N/A ✔
Modified Date/Time ✔ ✔ ✔ ✔ N/A N/A N/A ✔
Title ✔ ✔ ✔ ✔ ✔ N/A N/A ✔
Description ✔ ✔ ✔ ✔ ✔ N/A N/A ✔
Subject ✔ ✔ ✔ ✔ ✔ N/A N/A ✔
Keywords ✔ ✔ ✔ ✔ ✔ N/A N/A ✔
Extended Properties ✔ ✔ ✔ N/A ✔ N/A N/A ✔
Category ✔ ✔ ✔ N/A ✔ N/A N/A ✔
Company ✔ ✔ ✔ N/A ✔ N/A N/A ✔
Manager ✔ ✔ ✔ N/A ✔ N/A N/A ✔
User-Defined (Custom) Properties ✖ ✔ ✔ ✔ N/A N/A N/A ✔
Text Properties ✖ ✔ ✔ ✔ N/A N/A N/A ✔
Number Properties ✖ ✔ ✔ ✔ N/A N/A N/A ✔
Date Properties ✖ ✔ ✔ ✔ N/A N/A N/A ✔
Yes/No (Boolean) Properties ✖ ✔ ✔ ✔ N/A N/A N/A ✔
Cell Data Types
Empty/NULL ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
Boolean ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
Integer ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
Floating Point ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
String ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
Error ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
Formula ✔ ✔ ✔ ✔ ✔ ✖ ✔ ✖
Array Formula ✖ ✔ ✔ ✔ ✔ N/A ✖ N/A
Rich Text ✔ ✔ ✔ ✔ ✔ ✖ ✖ ✖
Conditional Formatting ✔ ✔ ✖ ✖ ✖ N/A N/A ✖
Rows and Column Properties ✔ ✔ ✔ ✖ ✔ N/A N/A ✔
Row Height/Column Width ✔ ✔ ✔ ✔ ✔ N/A N/A ✔
Hidden ✔ ✔ ✔ ✖ ✔ N/A N/A ✔
Worksheet Properties ● ✔ ● ● ✖ N/A N/A ●
Frozen Panes ✔ ✔ ✔ ✖ ✖ N/A N/A N/A
Hidden Worksheets ✔ ✔ ✖ ✔ ✖ N/A N/A ●
Coloured Tabs ✖ ✔ ✖ ✖ ✖ N/A N/A N/A
Drawing hyperlink ✖ ✔ ✖ ✖ ✖ N/A N/A ✔
Cell Formatting ✔ ✔ ● ✖ ✔ N/A ● ● 7
Number Format Mask ✔ ✔ ✔ ● 6 ✔ N/A ✔ ✔
Alignment ✔ ✔ ✔ ✖ ✔ N/A ✖ ● 7
Horizontal ✔ ✔ ✔ ✖ ✔ N/A ✖ ✔
Vertical ✔ ✔ ✔ ✖ ✔ N/A ✖ ✔
Wrapping ✔ ✔ ✔ ✖ ✔ N/A ✖ ●
Shrink-to-Fit ✔ ✔ ✔ ✖ ✔ N/A ✖ ●
Indent ✔ ✔ ✖ ✖ ✔ N/A ✖ ✔
Background Colour ✔ ✔ ✔ ✖ ✔ N/A ✔ ● 7
Patterned ✔ ✔ ✔ ✖ ✔ N/A ✔ ✖
Font Attributes ✔ ✔ ✔ ✖ ✔ N/A ✔ ● 7
Font Face ✔ ✔ ✔ ✖ ✔ N/A ✔ ✔
Font Size ✔ ✔ ✔ ✖ ✔ N/A ✔ ✔
Bold ✔ ✔ ✔ ✖ ✔ N/A ✔ ✔
Italic ✔ ✔ ✔ ✖ ✔ N/A ✔ ✔
Strikethrough ✔ ✔ ✔ ✖ ✔ N/A ✔ ✔
Underline ✔ ✔ ✔ ✖ ✔ N/A ✔ ✔
Superscript ✔ ✔ ✔ ✖ ✔ N/A ✔ ✔
Subscript ✔ ✔ ✔ ✖ ✔ N/A ✔ ✔
Borders ✔ ✔ ✔ ✖ ✔ N/A ● ● 7
Line Style ✔ ✔ ✔ ✖ ✔ N/A ✔ ✔
Position ✔ ✔ ✔ ✖ ✔ N/A ✔ ✔
Diagonal ✔ ✔ ✔ ✖ ✔ N/A ✖ ✖
Hyperlinks ✔ ✔ ✔ ✔ ✔ ✖ ✖ ✔
http ✔ ✔ ✔ ✔ ✔ N/A ✖ ✔
Merged Cells ✔ ✔ ✔ ✔ ✔ N/A ✖ ✔
Cell Comments ● ● ● ● ● N/A ● ●
Rich Text ✖ 2 ✔ ✖ ✖ ● N/A N/A ✖
Alignment ✖ 3 ✔ ✖ ✖ ✖ N/A ✖ ✔
Background Image ✖ ✔ ✖ ✖ ✖ N/A ✖ ✖
Cell Validation ✔ ✔ ✖ ✖ ✖ N/A N/A N/A
AutoFilters ● ● ● ● ● N/A N/A N/A
AutoFilter Expressions ✔ ✔ ✔ ✔ ✔ N/A N/A N/A
Filter ✔ ✔ ✔ ✔ ✔ N/A N/A N/A
Custom Filter ✔ ✔ ✔ ✔ ✔ N/A N/A N/A
Date Filter ✔ ✔ ✔ ✔ ✔ N/A N/A N/A
Dynamic Filter ✔ ✔ ✔ ✔ ✔ N/A N/A N/A
Colour Filter ✖ ✖ ✖ ✖ ✖ N/A N/A N/A
Icon Filter ✖ ✖ ✖ ✖ ✖ N/A N/A N/A
Top 10 Filter ✖ ✔ ✖ ✖ ✖ N/A N/A N/A
Macros ✖ ● 5 ✖ ✖ ✖ ✖ ✖ ✖
Form Controls ✖ ● 4 ✖ ✖ ✖ ✖ ✖ ✖
Security ● ● ✖ ✖ ✖ ✖ ✖ ✖
Protection (prevent editing) ✔ ✔ ✖ ✖ ✖ ✖ ✖ ✖
Encryption (prevent viewing) ✖ ✖ ✖ ✖ ✖ ✖ ✖ ✖
XLS XLSX Excel2003XML Ods Gnumeric CSV SYLK HTML
Readers
  1. Only text contents
  2. Only BIFF8 files support Rich Text. Prior to that, comments could only be plain text
  3. Only BIFF8 files support alignment and rotation. Prior to that, comments could only be unformatted text
  4. Xlsx forms and controls can be read and written but not otherwise manipulated
  5. Xlsx macros can be read and written; their values can be retrieved and changed, but only in a binary form which is unlikely to be useful
  6. There is very limited support for reading styles from an Ods spreadsheet. Writing styles has much better support. Starting with release 5.5.0, Number Format Writer supports many common styles, and users may extend support to additional styles; Reader support is improved but still imperfect.
  7. In most cases, Html reader processes only inline styles; styles provided by Css classes may be ignored.
  8. Code must opt in to array output.
  9. Use with caution - allowing external images may can subject the caller to security exploits. Starting with release 4.5.0 (also earlier releases 3.9.3, 2.3.10, 2.1.11, and 1.29.12), code can allow or not external images. In those starting releases, and in earlier releases which do not offer an option, default is to allow it. In release 5+ (and earlier supported versions 1.30+, 2.1.12+, 2.4+, and 3.10+), the default is to not allow it.

Writers

Writers
XLS XLSX Ods CSV HTML PDF
Document Properties
Standard Properties
Creator ✔ ✔ ✔ N/A ✔ ✔
Creation Date/Time ✔ ✔ ✔ N/A ✔ ✖
Modifier ✔ ✔ ✖ N/A ✔ ✖
Modified Date/Time ✔ ✔ ✖ N/A ✔ ✖
Title ✔ ✔ ✔ N/A ✔ ✔
Description ✔ ✔ ✔ N/A ✔ ✖
Subject ✔ ✔ ✔ N/A ✔ ✔
Keywords ✔ ✔ ✔ N/A ✔ ✔
Extended Properties
Category ✔ ✔ ✖ N/A ✔ ✖
Company ✖ ✔ ✖ N/A ✔ ✖
Manager ✖ ✔ ✖ N/A ✔ ✖
User-Defined (Custom) Properties ✖ ✔ ✔ N/A ✔ N/A
Rich Text ✔ ✔ ✖ N/A ✔ ✔
Conditional Formatting ✔ ✔ ✖ ✖ ✖ ✖
Array Formula8 ✖ ✔ ✔ ✔ ✔ ✔
Rows and Column Properties
Row Height/Column Width ✔ ✔ ✔ N/A ✔ ✔
Hidden ✔ ✔ ✖ N/A ✔ ✔
Worksheet Properties
Frozen Panes ● ✔ ✖ N/A ✔ ✖
Hidden Worksheets ● ✔ ✖ N/A ✔ ✖
Coloured Tabs ✖ ✔ ✖ N/A ✖ ✖
Drawing hyperlink ✖ ✔ ✖ N/A ✖ ✖
Cell Formatting
Number Format Mask ✔ ✔ ✔6 N/A ✔ ✔
Alignment ✔ ✔ ✔ N/A ✔ ✔
Horizontal ✔ ✔ ✔ N/A ✔ ✔
Vertical ✔ ✔ ✔ N/A ✔ ✔
Wrapping ✔ ✔ ✔ N/A ✔ ✔
Shrink-to-Fit ✔ ✔ ✔ N/A ✔ ✔
Indent ✔ ✔ ✔ N/A ✔ ✔
Background Colour ✔ ✔ ✔ N/A ✔ ✔
Patterned ✔ ✔ ✔ N/A ✔ ✔
Font Attributes
Font Face ✔ ✔ ✔ N/A ✔ ✔
Font Size ✔ ✔ ✔ N/A ✔ ✔
Bold ✔ ✔ ✔ N/A ✔ ✔
Italic ✔ ✔ ✔ N/A ✔ ✔
Strikethrough ✔ ✔ ✔ N/A ✔ ✔
Underline ✔ ✔ ✔ N/A ✔ ✔
Superscript ✔ ✔ ✔ N/A ✔ ✔
Subscript ✔ ✔ ✔ N/A ✔ ✔
Borders
Line Style ✔ ✔ ✔ N/A ✔ ✔
Position ✔ ✔ ✔ N/A ✔ ✔
Diagonal ✖ ✔ ✖ N/A ✖ ✖
Hyperlinks ✔ ✔ ✖ N/A ✔ ✖
http ✔ ✔ ✖ N/A ✔ ✖
Merged Cells ✔ ✔ ✔ N/A ✔ ✔
Cell Comments ✖ ● ● N/A ● 1 N/A
Rich Text ✖ ✔ ✖ N/A ✖ N/A
Alignment ✖ ✔ ✖ N/A ✔ N/A
Background Image ✖ ✔ ✖ ✖ ✖ ✖
Cell Validation ✔ ✔ ✖ N/A N/A N/A
AutoFilters
AutoFilter Expressions ✔ ✔ ✔ N/A N/A N/A
Filter ✔ ✔ ✔ N/A N/A N/A
Custom Filter ✔ ✔ ✔ N/A N/A N/A
DateGroup Filter ✔ ✔ ✔ N/A N/A N/A
Dynamic Filter ✔ ✔ ✔ N/A N/A N/A
Colour Filter ✖ ✖ ✖ N/A N/A N/A
Icon Filter ✖ ✖ ✖ N/A N/A N/A
Top 10 Filter ✖ ✔ ✖ N/A N/A N/A
Macros ✖ ● 5 ✖ N/A ✖ ✖
Form Controls ✖ ● 4 ✖ N/A ✖ ✖
Security
Protection (prevent editing) ✔ ✔ ✖ N/A ✖ ✖
Encryption (prevent viewing) ✖ ✖ ✖ N/A ✖ ✖
XLS XLSX Ods CSV HTML PDF
Writers

Setters and Getters

Methods
Getters Setters
Reader Options
Read Data Only (no formatting) $reader->getReadDataOnly() $reader->setReadDataOnly()
Read Only Specified Worksheets $reader->getLoadSheetsOnly() $reader->setLoadSheetsOnly()
$reader->setLoadAllSheets()
Read Only Specified Cells $reader->getReadFilter() $reader->setReadFilter()
Document Properties
Standard Properties
Creator $spreadsheet->getProperties()->getCreator() $spreadsheet->getProperties()->setCreator()
Creation Date/Time $spreadsheet->getProperties()->getCreated() $spreadsheet->getProperties()->setCreated()
Modifier $spreadsheet->getProperties()->getLastModifiedBy() $spreadsheet->getProperties()->setLastModifiedBy()
Modified Date/Time $spreadsheet->getProperties()->getModified() $spreadsheet->getProperties()->setModified()
Title $spreadsheet->getProperties()->getTitle() $spreadsheet->getProperties()->setTitle()
Description $spreadsheet->getProperties()->getDescription() $spreadsheet->getProperties()->setDescription()
Subject $spreadsheet->getProperties()->getSubject() $spreadsheet->getProperties()->setSubject()
Keywords $spreadsheet->getProperties()->getKeywords() $spreadsheet->getProperties()->setKeywords()
Extended Properties
Category $spreadsheet->getProperties()->getCategory() $spreadsheet->getProperties()->setCategory()
Company $spreadsheet->getProperties()->getCompany() $spreadsheet->getProperties()->setCompany()
Manager $spreadsheet->getProperties()->getManager() $spreadsheet->getProperties()->setManager()
User-Defined (Custom) Properties $spreadsheet->getProperties()->getCustomProperties()
$spreadsheet->getProperties()->isCustomPropertySet()
$spreadsheet->getProperties()->getCustomPropertyValue()
$spreadsheet->getProperties()->getCustomPropertyType()		 $spreadsheet->getProperties()->setCustomProperty()
Drawing hyperlink $drawing->getHyperlink()->getUrl() $drawing->setHyperlink()->setUrl($url)
Hyperlinks $cell->getHyperlink()->getUrl($url) $cell->getHyperlink()->setUrl($url)
Cell Comments
Background Image $comment->getBackgroundImage() $comment->setBackgroundImage()
Cell Validation $cell->getDataValidation() $cell->setDataValidation()
AutoFilters $sheet->getAutoFilter() $sheet->setAutoFilter()
Macros $spreadsheet->getMacrosCode();5 $spreadsheet->setMacrosCode();5
Security
Protection (prevent editing) $sheet->getProtection() $sheet->getProtection()->setSheet(true)
Getters Setters
Methods
Reference in New Issue View Git Blame Copy Permalink