.. image:: https://odoo-community.org/readme-banner-image
   :target: https://odoo-community.org/get-involved?utm_source=readme
   :alt: Odoo Community Association

==========================
Web Pivot Computed Measure
==========================

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:ab3cd4b5fcebcf88ffc1c122a3d7d2708d6e1d2ffad1cd33c62b9e688733a5d0
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
    :target: https://odoo-community.org/page/development-status
    :alt: Beta
.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png
    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
    :alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github
    :target: https://github.com/OCA/web/tree/18.0/web_pivot_computed_measure
    :alt: OCA/web
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/web-18-0/web-18-0-web_pivot_computed_measure
    :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
    :target: https://runboat.odoo-community.org/builds?repo=OCA/web&target_branch=18.0
    :alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

Adds support for computed measures on the pivot view.

**Table of contents**

.. contents::
   :local:

Usage
=====

Go to pivot view and click on the "Measures" menu, you will see a new
option called 'Computed Measure'.

You have the follow options to create a 'computed measure':

- Measure 1: Used in 'operation formula' as 'm1'

- Measure 2: Used in 'operation formula' as 'm2'

- Operation: The formula

  - Sum: m1 + m2
  - Sub: m1 - m2
  - Mult: m1 \* m2
  - Div: m1 / m2 (Format: Float)
  - Perc m1 / m2 (Format: Percentage)
  - Custom: Special option only visible in debug mode to write a custom
    formula.

- Name: The name of the new measure (emtpy = auto-generated)

- Format: How will the value be printed

  - Integer
  - Float
  - Percentage (value \* 100)

- | Formula\*: Custom operation formula
  | These formula is evaluated using 'PY.eval'

These computed measures can be mixed (You can reuse it to make new
computed measures) and saved as favorites.

Notice that "measures/computed measures" involved in an active 'computed
measure' can't be deactivated until you have deactivate the 'computed
measure'.

Known issues / Roadmap
======================

1. Add support to define a style for a computed measure (ex. colored)
2. Use t-model to data-binding instead of jquery selectors

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/web/issues/new?body=module:%20web_pivot_computed_measure%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
-------

* Tecnativa

Contributors
------------

- `Tecnativa <https://www.tecnativa.com/>`__:

  - Alexandre D. Díaz
  - Pedro M. Baeza
  - Ernesto Tejeda
  - Carlos Roca

Maintainers
-----------

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
   :alt: Odoo Community Association
   :target: https://odoo-community.org

OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.

.. |maintainer-CarlosRoca13| image:: https://github.com/CarlosRoca13.png?size=40px
    :target: https://github.com/CarlosRoca13
    :alt: CarlosRoca13

Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-CarlosRoca13| 

This module is part of the `OCA/web <https://github.com/OCA/web/tree/18.0/web_pivot_computed_measure>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
