Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

hide wiring information #212

Open
wlgrd opened this issue Jan 11, 2021 · 7 comments
Open

hide wiring information #212

wlgrd opened this issue Jan 11, 2021 · 7 comments

Comments

@wlgrd
Copy link

wlgrd commented Jan 11, 2021

Is it possible to leave out the wire information, and just have the connections visible in the output?

@kvid
Copy link
Collaborator

kvid commented Jan 11, 2021

Is it possible to leave out the wire information, and just have the connections visible in the output?

Currently, it's possible to make it a bundle and hide the cable name and wire count:

Click to expand YAML input
connectors:
  X1:
    pincount: 4
  X2:
    pincount: 4

cables:
  W1:
    category: bundle
    wirecount: 4
    color_code: IEC
    show_name: False
    show_wirecount: False

connections:
  - - X1: [1-4]
    - W1: [1-4]
    - X2: [1-4]

issue212

  1. Do you want to hide the whole Cable/bundle box including all contents, leaving just the wire splines between connectors?
  2. Do you want to specify such a thing per cable, or for all cables in the harness?

If your answer to question 1 is yes, then I guess you might want something like this:
issue212 gv
(I had to manually edit the .gv file and execute dot -O -Tpng issue212.gv to obtain the image above.)

@wlgrd
Copy link
Author

wlgrd commented Jan 11, 2021

image
This is exactly what I'm thinking of. I haven't dived too deep into this module yet, could you elaborate on the .gv file?

@formatc1702
Copy link
Collaborator

formatc1702 commented Jan 14, 2021

I never thought of this as a use-case, but I think it makes sense for simpler diagrams.. An additional attribute for the cable would be necessary, and the GraphViz rendering would need to take this into account... I would welcome a PR for this matter!

@kvid
Copy link
Collaborator

kvid commented Jan 16, 2021

This is exactly what I'm thinking of. I haven't dived too deep into this module yet, could you elaborate on the .gv file?

The .gv file is an intermediate file generated by WireWiz that is input to Graphviz for creating the diagram. Manually editing this file is time consuming for a large harness, and not recommended as a final solution.

When I get the time, I can try creating a PR supporting such a feature. It might fit well together with a couple of other changes I have in mind.

@formatc1702
Copy link
Collaborator

Sounds good, I'm curious to hear about your other ideas.

@kvid
Copy link
Collaborator

kvid commented Feb 4, 2022

@wlgrd asked how to hide the wire information more than a year ago. If you (or other visitors) still need this feature, see my work-around suggestion below.

When I get the time, I can try creating a PR supporting such a feature. It might fit well together with a couple of other changes I have in mind.

I'm sorry that I haven't had the time for this, but I still have my notes with ideas that could both resolve this and enhance the loops feature, but at the moment I should probably wait for the merging of PR #251 to avoid major conflicts in the code to generate the GV HTML.

The .gv file is an intermediate file generated by WireWiz that is input to Graphviz for creating the diagram. Manually editing this file is time consuming for a large harness, and not recommended as a final solution.

The tweak work-around suggested in #174 (comment) was added in v0.3 and that can help this old issue. Inspired by the #270 (comment), I found a work-around for this issue as well. Append the following to my one year old YAML input suggestion above:

tweak:
  override:
    graph:
      ranksep: "0.5"  # Reduce the horizontal spacing (default 2)
    W1:
      shape: none  # Hide the surrounding frame
      fontsize: "12"  # Reduce the space needed for text
      fontcolor: white  # Same as background to hide the text

This should then be the result, and is close to what you aimed for:
issue212-tweak12

@martinrieder
Copy link
Contributor

martinrieder commented May 21, 2024

Note that I found this would only work for simple examples. If shape=none does not bring the expected effect, then use style=invis. The Graphviz ranking might still need an additional constraint=false defined, as I have mentioned in #352 (comment)

EDIT : I created #376 that extends this idea.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants