Metadata-Version: 2.1
Name: odoo-addon-report_positioned_image
Version: 18.0.1.0.0.3
Requires-Python: >=3.10
Requires-Dist: odoo-addon-report_qweb_element_page_visibility==18.0.*
Requires-Dist: odoo==18.0.*
Summary: Add positioned images to PDF reports.
Home-page: https://github.com/OCA/reporting-engine
License: AGPL-3
Author: Quartile, Odoo Community Association (OCA)
Author-email: support@odoo-community.org
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 18.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Description-Content-Type: text/x-rst

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

=======================
Report Positioned Image
=======================

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

.. |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%2Freporting--engine-lightgray.png?logo=github
    :target: https://github.com/OCA/reporting-engine/tree/18.0/report_positioned_image
    :alt: OCA/reporting-engine
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/reporting-engine-18-0/reporting-engine-18-0-report_positioned_image
    :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/reporting-engine&target_branch=18.0
    :alt: Try me on Runboat

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

This module allows you to add positioned images (such as watermarks,
logos, or stamps) to PDF reports. Images can be precisely positioned
using millimeter coordinates (top, left) and you can control whether
they appear on all pages or only the first page.

The module supports two types of images:

- *Company-level Images*: Define images at the company level that can be
  included in reports by enabling the *Include Company Images* option
- *Report-specific Images*: Configure specific images for individual
  reports, filtered by company context and always shown when configured

Images can be assigned to a specific company or left as shared records
(without company assignment) for use across multiple companies

**Table of contents**

.. contents::
   :local:

Configuration
=============

To configure company-level images:

1. Go to *Settings / Companies*
2. Open your company record
3. Navigate to the *Report Images* tab
4. Add images with position settings:

   - Upload an image - width defaults to 50mm and height is
     automatically calculated to maintain the original aspect ratio
   - *Top (mm)*: Distance from the top of the page
   - *Left (mm)*: Distance from the left edge of the page
   - *Width (mm)*: Width of the image (changing this auto-adjusts
     height)
   - *Height (mm)*: Height of the image (changing this auto-adjusts
     width)
   - *Respect Image Ratio*: When enabled (default), changing width or
     height automatically adjusts the other dimension to maintain aspect
     ratio. Uncheck for manual control of both dimensions.
   - *First Page Only*: Check to show only on the first page
   - *Company*: Automatically set to the current company when creating
     from the company form. To create shared images, leave empty.

To configure report-specific images:

1. Go to *Settings / Technical / Actions / Reports*
2. Open the report you want to customize
3. Navigate to the *Report Images* tab
4. Check *Include Company Images* if you want to show company-level
   images in addition to report-specific images
5. Add report-specific images in the list with the same position
   settings as above

**Note**: By default, images maintain their aspect ratio. When you
upload an image, it's automatically sized to 50mm width with
proportional height. You can then adjust either dimension and the other
will update automatically to prevent distortion.

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

Bugs are tracked on `GitHub Issues <https://github.com/OCA/reporting-engine/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/reporting-engine/issues/new?body=module:%20report_positioned_image%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
-------

* Quartile

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

- Quartile <https://www.quartile.co>

  - Tatsuki Kanda
  - Aung Ko Ko Lin

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.

This module is part of the `OCA/reporting-engine <https://github.com/OCA/reporting-engine/tree/18.0/report_positioned_image>`_ project on GitHub.

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