:tocdepth: 3

:py:mod:`gws.base.legend`
=========================

.. py:module:: gws.base.legend


**Source code:** :source:`gws.base.legend<gws/base/legend/__init__.py>`


Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   core/index.rst



Package Contents
----------------



.. py:function:: combine_outputs(lros: list[gws.LegendRenderOutput], options: dict = None) -> Optional[gws.LegendRenderOutput]

.. py:class:: Config(*args, **kwargs)


   Bases: :py:obj:`gws.ConfigWithAccess`

   Layer legend confuguration.

   .. py:attribute:: cacheMaxAge
      :type:  gws.Duration
      :value: '1d'


      max cache age for remote legends

   .. py:attribute:: options
      :type:  Optional[dict]

      provider-dependent legend options


.. py:class:: Object


   Bases: :py:obj:`gws.Legend`

   Generic legend object.

   .. py:attribute:: cacheMaxAge
      :type:  int

   .. py:attribute:: options
      :type:  dict

   .. py:method:: configure()

      Configuration hook.



.. py:function:: output_to_bytes(lro: gws.LegendRenderOutput) -> Optional[bytes]

.. py:function:: output_to_image(lro: gws.LegendRenderOutput) -> Optional[gws.Image]

.. py:function:: output_to_image_path(lro: gws.LegendRenderOutput) -> Optional[str]

.. py:class:: Props(*args, **kwargs)


   Bases: :py:obj:`gws.Props`

   Object properties.

   .. py:attribute:: type
      :type:  str