mbdlyb.colormap
===============

.. py:module:: mbdlyb.colormap

.. autoapi-nested-parse::

   Color mapping for visualization of MBD model elements.

   Provides color schemes for rendering nodes, networks, and relations in
   diagrams and graph exports.



Attributes
----------

.. autoapisummary::

   mbdlyb.colormap.DEFAULT_COLORMAP


Classes
-------

.. autoapisummary::

   mbdlyb.colormap.ColorMap


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

.. py:class:: ColorMap(colormap: Optional[Union[dict[Union[type, str], str], list[tuple[Union[type, str], str]]]] = None)

   Maps model element types to hex color codes for visualization.

   ColorMap provides a flexible way to assign colors to different types of
   MBD model elements. Colors can be specified by class type or by string
   class name. The ColorMap falls back to base class colors if a specific
   class is not found, and provides a default color for unmapped types.

   :ivar _map: Internal mapping from class names to hex color codes.

   :vartype _map: dict[str, str]


   .. py:method:: get_color(c: Any, default: str = '#AAAAAA') -> str

      Get the color for an element or class.

      Performs intelligent lookup:
      1. If c is a string in the colormap, returns that color
      2. If c is an instance, checks its class and base classes
      3. If c is a class, checks it and its base classes
      4. Returns default if no match found

      :param c: An element instance, class, or string class name to get color for.
      :type c: Any
      :param default: The hex color to return if no mapping is found. Default is '#AAAAAA'.
      :type default: str

      :returns: Hex color code (e.g., '#FFFFFF') for the element.
      :rtype: str



.. py:data:: DEFAULT_COLORMAP

   Default color mapping for MBD model elements.