Introduction

This guide provides instructions on how to use the report_excel. It covers the basic usage examples, and advanced features. ------------ Usage ------------

The Library Name library provides a set of functions that you can use to format fields in your reports. Here are some examples of how to use these functions: 1. Field Date

• Example:

  • {{o_date(o.order_date, date_format='full', lang_code='en')}}

• Parameters:

  • date_format: one of “full”, “long”, “medium”, or “short”, or a custom date/time pattern
  • lang_code: a Locale object or a locale identifier

2. Field Datetime

   • Example:

     • {{o_datetime(o.create_date, date_format='long', tz='UTC', lang_code='en')}}

   • Parameters:

     • dt_format: one of “full”, “long”, “medium”, or “short”, or a custom date/time pattern
     • tz: the timezone to apply to the time for display
     • lang_code: a Locale object or a locale identifier

3. Field Monetary

   • Example:

     • {{o_monetary(o.amount_total, currency_obj=o.currency_id, digits=2, no_break_space=True)}}

   • Parameters:

     • currency_obj: object currency
     • digits: default currency_obj.decimal_places (optional)
     • no_break_space: default True (optional)

4. Field Selection

   • Example:

     • {{o_selection(o.state, field_name='state')}}

   • Parameters:

     • field_name: technology field name

5. Field Html

   • Example:

     • {{o_html(o.note)}}

6. Field Float

   • Example:

     • {{o_float(o.amount_total, digits=2)}}

   • Parameters:

     • digits: number of decimal places to display (optional)

7. Field Count

   • Example:

     • {{o_count(o.order_line)}}

   • Parameters:

     • None

Advanced Features

When you using type Excel, you can operate normally with fields and for functions like on Jinda2 template.

When you using type Excel (openpyxl) also provides advanced features that you can explore. Here are some examples:

1. Function static (static method)

   • Example:

     {# static, A1, attr, variant #}.....{# endStatic, A1 #}

   • Parameters:

     • type: static
     • code: locale cell (D6, D7, D8, ...)
     • attr: example o.order_line or method of model
     • variant: use in loop, example: {{line.name}}

2. Function forCol (loop column method)

   • Example:

     {#forCol, A1, o_count(o.order_line), line #}{{line[0]}}....{{line[1].name}} {#endCol, A1#}

   • Parameters:

     • type: forCol
     • code: locale cell (D6, D7, D8, ...)
     • attr: example o_count(o.order_line) or method of model
     • variant: use in loop, example: {{line[1].name}}

3. Function forRow (loop row method)

   • Example:

     {# forRow, A1, o.order_line, line #} {{line.name }} {# endRow, A1 #}

   • Parameters:

     • type: forRow
     • code: locale cell (D6, D7, D8, ...)
     • attr: example o_count(o.order_line) or method of model
     • variant: use in loop, example: {{line[1].name}}

5. Merge cells

   • If you want to merge cells, you only need to add the value "merge_cell" in the cell location.
   • If you want to merge columns, you only need to add the value "merge_col" in the cell location.
   • If you want to merge rows, you only need to add the value "merge_row" in the cell location.

For more detailed information, refer to the library's documentation.

Conclusion

This guide has provided an overview of the report_excel library and instructions on how to use it. By following these steps, you should be able to integrate the library into your project successfully.

For any further assistance, refer to the library's documentation or reach out to the library's support team.

Author & Maintainer

• This module is maintained by Lazydoo <luuthinh2705@gmail.com>