RenderConfig

class hugr.hugr.render.RenderConfig(palette: ~hugr.hugr.render.Palette = <factory>, qualify_op_name: bool = False, display_metadata: bool = True, display_node_id: bool = False, display_link_label: bool = True, max_edge_label_length: int | None = 24, max_node_label_length: int | None = 24, max_metadata_length: int | None = 20, display_node_extension_version: bool = False, display_edge_extension_version: bool = False)

Bases: object

Configuration for rendering a HUGR to a graphviz dot file.

Methods

Attributes

display_edge_extension_version	If true, display the types extension version on edges.
display_link_label	If true display full type name on the edges.
display_metadata	If true display node metadata.
display_node_extension_version	If true, display the op extension version in node labels.
display_node_id	If true display node numbering.
max_edge_label_length	Max length for edge labels.
max_metadata_length	Max length for metadata display.
max_node_label_length	Max length for node labels.
qualify_op_name	If true prepend extension names to operation and type names.
palette	The palette to use for rendering.

display_edge_extension_version: bool = False

If true, display the types extension version on edges.

display_link_label: bool = True

If true display full type name on the edges.

display_metadata: bool = True

If true display node metadata.

display_node_extension_version: bool = False

If true, display the op extension version in node labels.

display_node_id: bool = False

If true display node numbering.

max_edge_label_length: int | None = 24

Max length for edge labels. None means no truncation.

max_metadata_length: int | None = 20

Max length for metadata display. None means no truncation.

max_node_label_length: int | None = 24

Max length for node labels. None means no truncation.

palette: Palette

The palette to use for rendering. See PALETTE for the included options.

qualify_op_name: bool = False

If true prepend extension names to operation and type names.