.. include:: ../../substitutions.rst

.. _printing:

Printing
========

.. contents::
   :depth: 3

Extent defined by the user on the fly in Lizmap
-----------------------------------------------

To add print capabilities in the online map, you have to create at least one
`print layout <https://docs.qgis.org/latest/en/docs/user_manual/print_composer/index.html>`_ without atlas enabled.
Then you will find the list of your layouts in the :guilabel:`Layouts` plugin tab.
They are enabled by default but you can disable it or set permissions for groups.

.. note:: Printing will respect the feature filters and selections.

Creating the layout
^^^^^^^^^^^^^^^^^^^

In your layout, you can add :

* A map, **without** an atlas enabled
* An image to North arrow
* An image for the logo of your organization
* A legend that will be fixed for all printing
* Labels
* A scale
    - Either :guilabel:`Numeric`
    - Or set :guilabel:`Fit segment width` with a correct reference anchor point to adjust the position of the scale bar
* A location map, a map for which you have enabled and configured one *Overview*
* Since |qgis_3|, you can use QGIS expressions, in your labels for instance. You can create automatic source label
  according to visible layers following this example on the
  `QGIS documentation <https://docs.qgis.org/latest/en/docs/user_manual/print_composer/composer_items/composer_label.html#id4>`_.

.. _dynamic_content:

Dynamic content
^^^^^^^^^^^^^^^

You can allow the user to modify the contents of certain labels (title, description, comment, etc).
To do this, you need to add an identifier to your label in the layout.

.. warning::
    Each identifier must be unique for the whole layout. Identifiers must be strings, **without** integers or spaces
    (e.g. it must be ``custom_title``, **nor** ``1`` neither ``custom title``).

..  image:: /images/interface-print-dynamic-label.jpg
   :align: center

Lizmap will automatically ask the user in the web-browser to fill each fields.

.. tip::
    * If your label is pre-populated in QGIS, the field will be pre-populated too in the web-browser.
    * If you check 'Render as HTML' for your label in QGIS, you will have a multiline label in Lizmap accepting HTML code.
      But you will need to ``<br>`` for line breaks.

The preview in Lizmap will be similar to this screenshot. The light rectangle is the area the user can define in
the web browser. The user can also set the map description and title.

.. image:: /images/print_user_params.jpg
   :align: center
   :width: 800

Scales
^^^^^^

The print function will be based on the map scales that you set in the plugin *Map* (:ref:`lizmap-config-map`).

Overview
^^^^^^^^

You can create a location map by creating a ``second map`` for which you create an overview with the ``first map`` as the ``Map frame``.
`QGIS documentation <https://docs.qgis.org/latest/en/docs/user_manual/print_composer/composer_items/composer_map.html#overviews>`_

Layout with an atlas when using a popup
---------------------------------------

Read in the popup chapter, :ref:`print-layout-atlas`

Adding your own images in a layout
----------------------------------

If you add some custom images in a layout, such as custom North arrow or your organization logo, the server needs to
access these images too.

* Either use an image with an URL ``http://`` so that your image is accessible on both your local computer and on the
  server.
* Or use QGIS expression to build a compatible path on both desktop and server
  (it should work out of the box, but in case it's not working, you can use an expression.) :

    1. Put your images in the :file:`media` directory (see :ref:`media`), this is not mandatory, you can put it next to
       your project file.
    2. Use an QGIS expression ``@project_home || '/media/organization_logo.png'``.
    3. Use slash even if you are on Windows.