:py:mod:`pickax.pickax_config`
==============================

.. py:module:: pickax.pickax_config

.. autodoc2-docstring:: pickax.pickax_config
   :allowtitles:

Module Contents
---------------

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`PickAxConfig <pickax.pickax_config.PickAxConfig>`
     - .. autodoc2-docstring:: pickax.pickax_config.PickAxConfig
          :summary:

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`origin_mag_to_string <pickax.pickax_config.origin_mag_to_string>`
     - .. autodoc2-docstring:: pickax.pickax_config.origin_mag_to_string
          :summary:
   * - :py:obj:`default_titleFn <pickax.pickax_config.default_titleFn>`
     - .. autodoc2-docstring:: pickax.pickax_config.default_titleFn
          :summary:
   * - :py:obj:`defaultColorFn <pickax.pickax_config.defaultColorFn>`
     - .. autodoc2-docstring:: pickax.pickax_config.defaultColorFn
          :summary:
   * - :py:obj:`getuser <pickax.pickax_config.getuser>`
     - .. autodoc2-docstring:: pickax.pickax_config.getuser
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`DEFAULT_KEYMAP <pickax.pickax_config.DEFAULT_KEYMAP>`
     - .. autodoc2-docstring:: pickax.pickax_config.DEFAULT_KEYMAP
          :summary:
   * - :py:obj:`TRACE_AMP <pickax.pickax_config.TRACE_AMP>`
     - .. autodoc2-docstring:: pickax.pickax_config.TRACE_AMP
          :summary:
   * - :py:obj:`WINDOW_AMP <pickax.pickax_config.WINDOW_AMP>`
     - .. autodoc2-docstring:: pickax.pickax_config.WINDOW_AMP
          :summary:
   * - :py:obj:`GLOBAL_AMP <pickax.pickax_config.GLOBAL_AMP>`
     - .. autodoc2-docstring:: pickax.pickax_config.GLOBAL_AMP
          :summary:
   * - :py:obj:`RELATIVE_TIME <pickax.pickax_config.RELATIVE_TIME>`
     - .. autodoc2-docstring:: pickax.pickax_config.RELATIVE_TIME
          :summary:
   * - :py:obj:`ABSOLUTE_TIME <pickax.pickax_config.ABSOLUTE_TIME>`
     - .. autodoc2-docstring:: pickax.pickax_config.ABSOLUTE_TIME
          :summary:

API
~~~

.. py:data:: DEFAULT_KEYMAP
   :canonical: pickax.pickax_config.DEFAULT_KEYMAP
   :value: None

   .. autodoc2-docstring:: pickax.pickax_config.DEFAULT_KEYMAP

.. py:data:: TRACE_AMP
   :canonical: pickax.pickax_config.TRACE_AMP
   :value: 'TRACE_AMP'

   .. autodoc2-docstring:: pickax.pickax_config.TRACE_AMP

.. py:data:: WINDOW_AMP
   :canonical: pickax.pickax_config.WINDOW_AMP
   :value: 'WINDOW_AMP'

   .. autodoc2-docstring:: pickax.pickax_config.WINDOW_AMP

.. py:data:: GLOBAL_AMP
   :canonical: pickax.pickax_config.GLOBAL_AMP
   :value: 'GLOBAL_AMP'

   .. autodoc2-docstring:: pickax.pickax_config.GLOBAL_AMP

.. py:data:: RELATIVE_TIME
   :canonical: pickax.pickax_config.RELATIVE_TIME
   :value: 'REL_TIME'

   .. autodoc2-docstring:: pickax.pickax_config.RELATIVE_TIME

.. py:data:: ABSOLUTE_TIME
   :canonical: pickax.pickax_config.ABSOLUTE_TIME
   :value: 'ABS_TIME'

   .. autodoc2-docstring:: pickax.pickax_config.ABSOLUTE_TIME

.. py:class:: PickAxConfig()
   :canonical: pickax.pickax_config.PickAxConfig

   .. autodoc2-docstring:: pickax.pickax_config.PickAxConfig

   .. rubric:: Initialization

   .. autodoc2-docstring:: pickax.pickax_config.PickAxConfig.__init__

   .. py:property:: keymap
      :canonical: pickax.pickax_config.PickAxConfig.keymap

      .. autodoc2-docstring:: pickax.pickax_config.PickAxConfig.keymap

   .. py:property:: model
      :canonical: pickax.pickax_config.PickAxConfig.model

      .. autodoc2-docstring:: pickax.pickax_config.PickAxConfig.model

   .. py:method:: toggle_amplitude_mode()
      :canonical: pickax.pickax_config.PickAxConfig.toggle_amplitude_mode

      .. autodoc2-docstring:: pickax.pickax_config.PickAxConfig.toggle_amplitude_mode

   .. py:method:: toggle_time_mode()
      :canonical: pickax.pickax_config.PickAxConfig.toggle_time_mode

      .. autodoc2-docstring:: pickax.pickax_config.PickAxConfig.toggle_time_mode

.. py:function:: origin_mag_to_string(qmlevent=None)
   :canonical: pickax.pickax_config.origin_mag_to_string

   .. autodoc2-docstring:: pickax.pickax_config.origin_mag_to_string

.. py:function:: default_titleFn(stream=None, qmlevent=None, inventory=None)
   :canonical: pickax.pickax_config.default_titleFn

   .. autodoc2-docstring:: pickax.pickax_config.default_titleFn

.. py:function:: defaultColorFn(pick, arrival, author_colors)
   :canonical: pickax.pickax_config.defaultColorFn

   .. autodoc2-docstring:: pickax.pickax_config.defaultColorFn

.. py:function:: getuser()
   :canonical: pickax.pickax_config.getuser

   .. autodoc2-docstring:: pickax.pickax_config.getuser