Skip to content
WireVizDocsOpen editor
Editor

Connectors, cables and component properties

Define connector pinouts, cable conductors, gauge, length, colors and shields with guarded controls, reusable templates and component copy/paste.

Select a connector or cable to edit it in the right Design tab. The component's Name is its YAML designator, such as X1 or W1; Type describes the part. Renaming a source definition updates recognized connection references, manual BOM designators and structured Graphviz override keys.

Most compact fields commit on Enter or when you leave the field. Escape discards the current field draft. Structured fields have an explicit Apply button. Errors appear beside the control rather than silently accepting a failed edit.

Connector type and pinout

The Connector type picker searches the bundled library and offers a Custom type name. Selecting a library entry applies its pin IDs, available manufacturer and part number, and artwork. See the six current entries and artwork credits in the connector library.

The Positions control accepts whole counts from 1 to 512. When pins explicitly defines IDs, the count is derived from that list and the control reads Defined by pin IDs. Edit the list under Advanced or in YAML to change those IDs. A simple splice has one position.

Open Pinout to edit individual labels and colors. IDs stay visible beside each row; changing a label does not rename its pin ID. Custom IDs such as A1, B1, T, R and S are supported by WireViz.

Cable and bundle controls

A cable can represent a common jacketed cable or a Wire bundle. The inspector provides conductor count, gauge, length, colors, a shield toggle and shield color, plus wire labels.

Conductor counts are whole numbers from 1 to 512. Reducing a count is refused when existing labels, colors or bundle part lists would no longer fit. Change the affected lists or connections first.

The Colors picker offers WireViz color standards, Custom and No colors. Choosing a standard preserves the number of conductors. Editing one conductor's swatch converts the effective palette to a custom color list. WireViz codes such as RD, BK and GNYE describe red, black and green/yellow; the picker also accepts custom entries that the engine checks.

Quantities preserve their meaning

Length supports millimeters, centimeters, meters, inches and feet. Changing among these units converts the value. Gauge supports AWG and square millimeters, with presets and custom values. AWG conversion from square millimeters chooses the nearest whole AWG value and identifies it as an approximation.

Length must be finite and nonnegative. Ordinary numeric gauge values must be positive; numeric AWG values must be whole numbers. WireViz gauge spellings such as 4/0 AWG can be entered as custom values.

A Custom unit sets the entered amount and unit explicitly. It does not infer an unknown conversion. For unusual quantities, enter the intended converted value yourself or edit YAML.

Guarded edits and advanced properties

Typed component controls compile a candidate before applying it. A change is rejected if compilation fails or the resolved wiring would change. For example, changing a wired pin list must not silently redirect existing conductors. If an edit is refused, update the affected connections first.

Part information includes manufacturer, manufacturer part number, supplier, supplier part number, internal part number and notes. Advanced exposes remaining properties, including explicit pin lists, images and display options. Advanced and raw YAML edits use normal source compilation; they do not receive the typed controls' additional wiring-preservation check.

Templates, copy and removal

A generated instance displays its template and an Edit template action. Edit the source definition to change shared properties. Generated instances cannot be renamed or removed as independent definitions through the inspector. See YAML, aliases and templates.

Copy, paste and duplicate work on a single component, including its resolved definition properties. They create a fresh designator and an unwired component; they do not clone the surrounding harness connections. Paste normally offsets the position, while a canvas context-menu paste uses that location. Custom image attachments travel with a copied component when its image name matches the attachment. Bundled artwork loads from the library again. If the browser blocks system clipboard access, copying within the current editor can use an internal fallback.

Cut copies first, then opens the removal confirmation. Remove component can remove whole connection sets that reference it, including other connections in those sets. Read the confirmation and use Undo if needed. See shortcuts.