Skip to content

Commit

Permalink
Fix @kvid's suggestions:
Browse files Browse the repository at this point in the history
- Rename image alignment to position
- Rename under to below
- Display the above positioned images right above the pins list

Fixes wireviz#418
  • Loading branch information
martonmiklos committed Sep 7, 2024
1 parent 00716d0 commit f19fafb
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 9 deletions.
4 changes: 2 additions & 2 deletions src/wireviz/DataClasses.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
PlainText # = Literal['wirecount', 'terminations', 'length', 'total_length']
)
ImageScale = PlainText # = Literal['false', 'true', 'width', 'height', 'both']
ImageAlignment = PlainText # = Literal['under', 'above', 'left', 'right']
ImagePosition = PlainText # = Literal['below', 'above', 'left', 'right']

# Type combinations
Pin = Union[int, PlainText] # Pin identifier
Expand Down Expand Up @@ -87,7 +87,7 @@ class Image:
height: Optional[int] = None
fixedsize: Optional[bool] = None
bgcolor: Optional[Color] = None
alignment: Optional[ImageAlignment] = None
position: Optional[ImagePosition] = None
# Contents of the text cell <td> just below the image cell:
caption: Optional[MultilineHypertext] = None
# See also HTML doc at https://graphviz.org/doc/info/shapes.html#html
Expand Down
15 changes: 8 additions & 7 deletions src/wireviz/Harness.py
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ def create_graph(self) -> Graph:
html = []

image_rows = []
if connector.image:
if connector.image and connector.image.position != 'above':
image_rows = [[html_image(connector.image)],
[html_caption(connector.image)]]

Expand All @@ -205,17 +205,17 @@ def create_graph(self) -> Graph:
html_line_breaks(pn_info_string(HEADER_SPN, connector.supplier, connector.spn))],
[html_line_breaks(connector.type),
html_line_breaks(connector.subtype),
f'{connector.pincount}-pin' if connector.show_pincount else None,
f'{connector.pincount}-pin' if connector.show_pincount else None],
[html_caption(connector.image) if connector.image and connector.image.position == 'above' else None,
html_image(connector.image) if connector.image and connector.image.position == 'above' else None,
translate_color(connector.color, self.options.color_mode) if connector.color else None,
html_colorbar(connector.color)],
'<!-- connector table -->' if connector.style != 'simple' else None]
# fmt: on
imagetable=''
if connector.image:
if connector.image.alignment == 'under' or connector.image.alignment is None:
if connector.image.position == 'below' or connector.image.position is None:
rows += image_rows
elif connector.image.alignment == 'above':
rows = image_rows + rows
else:
imagetable = ''.join(nested_html_table(image_rows, html_bgcolor_attr(connector.bgcolor)))

Expand Down Expand Up @@ -248,7 +248,7 @@ def create_graph(self) -> Graph:

pinhtml.append(" <tr>")

if firstpin and connector.image and connector.image.alignment == 'left':
if firstpin and connector.image and connector.image.position == 'left':
firstpin = False
pinhtml.append(f'<td rowspan="{pincount}">{imagetable}</td>')

Expand All @@ -272,7 +272,7 @@ def create_graph(self) -> Graph:
if connector.ports_right:
pinhtml.append(f' <td port="p{pinindex+1}r">{pinname}</td>')

if firstpin and connector.image and connector.image.alignment == 'right':
if firstpin and connector.image and connector.image.position == 'right':
firstpin = False
pinhtml.append(
f'<td rowspan="{pincount}">{imagetable}</td>')
Expand Down Expand Up @@ -741,3 +741,4 @@ def bom(self):
if not self._bom:
self._bom = generate_bom(self)
return self._bom

0 comments on commit f19fafb

Please sign in to comment.