From dbccb77b082091cb08c6a10a44464e5be7e8d5ce Mon Sep 17 00:00:00 2001
From: KV <kvid@users.noreply.github.com>
Date: Tue, 16 Feb 2021 22:27:15 +0100
Subject: [PATCH] Add bgcolor attribute to connectors and cables

This solves the #210 suggestion to render the title row of
the graph nodes with this bgcolor.
---
 docs/syntax.md             |  2 ++
 src/wireviz/DataClasses.py |  2 ++
 src/wireviz/Harness.py     |  8 ++++----
 src/wireviz/wv_gv_html.py  | 10 ++++++++--
 4 files changed, 16 insertions(+), 6 deletions(-)

diff --git a/docs/syntax.md b/docs/syntax.md
index b50014a..0d6f6b8 100644
--- a/docs/syntax.md
+++ b/docs/syntax.md
@@ -121,6 +121,7 @@ tweak:  # optional tweaking of .gv output
                      # no color marks will be added to remaining pins
 
   # rendering information (all optional)
+  bgcolor: <color>       # Background color of diagram connector box
   style: <style>         # may be set to simple for single pin connectors
   show_name: <bool>      # defaults to true for regular connectors,
                          # false for simple connectors
@@ -198,6 +199,7 @@ Since the auto-incremented and auto-assigned designator is not known to the user
   wirelabels: <List>  # optional; one label for each wire
 
   # rendering information (all optional)
+  bgcolor: <color>          # Background color of diagram cable box
   show_name: <bool>         # defaults to true
   show_wirecount: <bool>    # defaults to true
   show_wirenumbers: <bool>  # defaults to true for cables; false for bundles
diff --git a/src/wireviz/DataClasses.py b/src/wireviz/DataClasses.py
index 44c063c..addc2b3 100644
--- a/src/wireviz/DataClasses.py
+++ b/src/wireviz/DataClasses.py
@@ -122,6 +122,7 @@ class AdditionalComponent:
 @dataclass
 class Connector:
     name: Designator
+    bgcolor: Optional[Color] = None
     manufacturer: Optional[MultilineHypertext] = None
     mpn: Optional[MultilineHypertext] = None
     supplier: Optional[MultilineHypertext] = None
@@ -206,6 +207,7 @@ class Connector:
 @dataclass
 class Cable:
     name: Designator
+    bgcolor: Optional[Color] = None
     manufacturer: Union[MultilineHypertext, List[MultilineHypertext], None] = None
     mpn: Union[MultilineHypertext, List[MultilineHypertext], None] = None
     supplier: Union[MultilineHypertext, List[MultilineHypertext], None] = None
diff --git a/src/wireviz/Harness.py b/src/wireviz/Harness.py
index edd8046..91c8a30 100644
--- a/src/wireviz/Harness.py
+++ b/src/wireviz/Harness.py
@@ -12,8 +12,8 @@ import re
 from wireviz import wv_colors, __version__, APP_NAME, APP_URL
 from wireviz.DataClasses import Metadata, Options, Tweak, Connector, Cable
 from wireviz.wv_colors import get_color_hex, translate_color
-from wireviz.wv_gv_html import nested_html_table, html_colorbar, html_image, \
-    html_caption, remove_links, html_line_breaks
+from wireviz.wv_gv_html import nested_html_table, html_bgcolor, html_colorbar, \
+    html_image, html_caption, remove_links, html_line_breaks
 from wireviz.wv_bom import pn_info_string, component_table_entry, \
     get_additional_component_table, bom_list, generate_bom, \
     HEADER_PN, HEADER_MPN, HEADER_SPN
@@ -125,7 +125,7 @@ class Harness:
 
             html = []
 
-            rows = [[remove_links(connector.name) if connector.show_name else None],
+            rows = [[f'{html_bgcolor(connector.bgcolor)}{remove_links(connector.name)}' if connector.show_name else None],
                     [pn_info_string(HEADER_PN, None, remove_links(connector.pn)),
                      html_line_breaks(pn_info_string(HEADER_MPN, connector.manufacturer, connector.mpn)),
                      html_line_breaks(pn_info_string(HEADER_SPN, connector.supplier, connector.spn))],
@@ -209,7 +209,7 @@ class Harness:
                 elif cable.gauge_unit.upper() == 'AWG':
                     awg_fmt = f' ({mm2_equiv(cable.gauge)} mm\u00B2)'
 
-            rows = [[remove_links(cable.name) if cable.show_name else None],
+            rows = [[f'{html_bgcolor(cable.bgcolor)}{remove_links(cable.name)}' if cable.show_name else None],
                     [pn_info_string(HEADER_PN, None,
                         remove_links(cable.pn)) if not isinstance(cable.pn, list) else None,
                      html_line_breaks(pn_info_string(HEADER_MPN,
diff --git a/src/wireviz/wv_gv_html.py b/src/wireviz/wv_gv_html.py
index ee5b2e2..0be2360 100644
--- a/src/wireviz/wv_gv_html.py
+++ b/src/wireviz/wv_gv_html.py
@@ -4,6 +4,7 @@
 from typing import List, Union
 import re
 
+from wireviz.DataClasses import Color
 from wireviz.wv_colors import translate_color
 from wireviz.wv_helper import remove_links
 
@@ -32,8 +33,13 @@ def nested_html_table(rows):
     html.append('</table>')
     return html
 
-def html_colorbar(color):
-    return f'<tdX bgcolor="{translate_color(color, "HEX")}" width="4">' if color else None
+def html_bgcolor(color: Color, _extra_attr: str = '') -> str:
+    """Return <td> attributes prefix for bgcolor or '' if no color."""
+    return f'<tdX bgcolor="{translate_color(color, "HEX")}"{_extra_attr}>' if color else ''
+
+def html_colorbar(color: Color) -> str:
+    """Return <tdX> attributes prefix for bgcolor and minimum width or None if no color."""
+    return html_bgcolor(color, ' width="4"') if color else None
 
 def html_image(image):
     from wireviz.DataClasses import Image