Rustpy-xlsxwriter

Added

- Added support for positioning or hiding Chart legends. See [`ChartLegend`].

[`ChartLegend`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/chart/struct.ChartLegend.html

Added

- Added support for Charts via the [`Chart`] struct and the
[`Worksheet::insert_chart()`] method. See also the [Chart Examples] in the user
guide.

- Added a generic [`Worksheet::write()`] method that writes string or number
types. This will be extended in an upcoming release to provide a single
`write()` method for all of the currently supported types.

It also allows the user to extend [`Worksheet::write()`] to handle user defined
types via the [`IntoExcelData`] trait. See also the [Writing Generic data]
example in the user guide.

[`Chart`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/chart/struct.Chart.html
[Chart Examples]: https://rustxlsxwriter.github.io/examples/simple_chart.html
[`IntoExcelData`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/worksheet/trait.IntoExcelData.html
[`Worksheet::write()`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/worksheet/struct.Worksheet.html#method.write
[Writing Generic data]: https://rustxlsxwriter.github.io/examples/generic_write.html
[`Worksheet::insert_chart()`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/worksheet/struct.Worksheet.html#method.insert_chart

Note: this version contains a major refactoring/renaming of some of the main
data writing functions and some of the enums and secondary structs. This will
require code changes from all current users but will allow more consistent
APIs in future releases. Nevertheless, I apologize for this level of change.


Changed

- The following worksheet functions have changed names to reflect their
frequency of usage.

| Previous name | New name |
| :----------------------------------- | :------------------------------------------ |
| `write_string_only()` | `write_string()` |
| `write_number_only()` | `write_number()` |
| `write_formula_only()` | `write_formula()` |
| `write_boolean_only()` | `write_boolean()` |
| `write_rich_string_only()` | `write_rich_string()` |
| `write_array_formula_only()` | `write_array_formula()` |
| `write_dynamic_array_formula_only()` | `write_dynamic_array_formula()` |
| | |
| `write_array_formula()` | `write_array_formula_with_format()` |
| `write_boolean()` | `write_boolean_with_format()` |
| `write_dynamic_array_formula()` | `write_dynamic_array_formula_with_format()` |
| `write_formula()` | `write_formula_with_format()` |
| `write_number()` | `write_number_with_format()` |
| `write_rich_string()` | `write_rich_string_with_format()` |
| `write_string()` | `write_string_with_format()` |


- The following enums and structs have changed to a more logical naming:

| Previous name | New name |
| :------------------------ | :--------------------- |
| `XlsxAlign` | `FormatAlign` |
| `XlsxBorder` | `FormatBorder` |
| `XlsxDiagonalBorder` | `FormatDiagonalBorder` |
| `XlsxPattern` | `FormatPattern` |
| `XlsxScript` | `FormatScript` |
| `XlsxUnderline` | `FormatUnderline` |
| | |
| `XlsxObjectMovement` | `ObjectMovement` |
| `XlsxImagePosition` | `HeaderImagePosition` |
| | |
| `ProtectWorksheetOptions` | `ProtectionOptions` |
| `Properties` | `DocProperties` |


- The `DocProperties::set_custom_property()` method replaces several type
specific methods with a single trait based generic method.

Added

- Added ability to filter columns in [`Worksheet::autofilter()`] ranges via
[`Worksheet::filter_column()`] and [`FilterCondition`].

The library automatically hides any rows that don't match the supplied
criteria. This is an additional feature that isn't available in the other
language ports of "xlsxwriter".

See also the [Working with Autofilters] section of the Users Guide.

[`FilterCondition`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/struct.FilterCondition.html
[Working with Autofilters]: https://rustxlsxwriter.github.io/formulas/autofilters.html
[`Worksheet::autofilter()`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/worksheet/struct.Worksheet.html#method.autofilter
[`Worksheet::filter_column()`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/worksheet/struct.Worksheet.html#method.filter_column

Added

- Added support for hiding rows and columns (to hide intermediate calculations)
via the [`Worksheet::set_column_hidden()`] and[`Worksheet::set_row_hidden()`]
method. This is also a required precursor to adding autofilter conditions.
- Added the [ObjectMovement] enum to control how a worksheet object, such a
an image, moves when the cells underneath it are moved, resized or deleted.

[ObjectMovement]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/enum.ObjectMovement.html
[`Worksheet::set_row_hidden()`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/worksheet/struct.Worksheet.html#method.set_row_hidden
[`Worksheet::set_column_hidden()`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/worksheet/struct.Worksheet.html#method.set_column_hidden

Added

Added more page setup methods.

- Added [`Worksheet::set_selection()`] method to select a cell or range of cells in a worksheet.
- Added [`Worksheet::set_top_left_cell()`] method to set the top and leftmost visible cell.
- Added [`Worksheet::set_page_breaks()`] method to add page breaks to a worksheet.

[`Worksheet::set_selection()`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/worksheet/struct.Worksheet.html#method.set_selection
[`Worksheet::set_page_breaks()`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/worksheet/struct.Worksheet.html#method.set_page_breaks
[`Worksheet::set_top_left_cell()`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/worksheet/struct.Worksheet.html#method.set_top_left_cell