attributes#
Utilities for clearing attributes on diagrams (nodes, endpoints, diagram-level).
These helpers work both on a single diagram and on collections (list, set, tuple) of diagrams. Attribute selection can be a single string or an iterable of strings.
Functions
Clear all attributes (nodes, endpoints, diagram-level). |
|
|
Clear diagram-level attributes. |
|
Clear endpoint attributes. |
|
Clear node attributes. |
Clear all temporary attributes (keys starting with '_') at all levels. |
|
|
Clear temporary diagram-level attributes (keys starting with '_'). |
|
Clear temporary endpoint attributes (keys starting with '_'). |
|
Clear temporary node attributes (keys starting with '_'). |
- clear_node_attributes(k, attr=None)#
Clear node attributes.
- Parameters:
k (PlanarDiagram | OrientedPlanarDiagram | list[PlanarDiagram | OrientedPlanarDiagram] | set[PlanarDiagram | OrientedPlanarDiagram] | tuple[PlanarDiagram | OrientedPlanarDiagram, ...]) – A diagram or a collection of diagrams.
attr (str | list[str] | set[str] | tuple[str, ...] | None) – Attribute name or iterable of names to remove. If None, clear all node attrs.
- Raises:
TypeError – If any element is not a PlanarDiagram/OrientedPlanarDiagram.
- Return type:
None
- clear_endpoint_attributes(k, attr=None)#
Clear endpoint attributes.
- Parameters:
k (PlanarDiagram | OrientedPlanarDiagram | list[PlanarDiagram | OrientedPlanarDiagram] | set[PlanarDiagram | OrientedPlanarDiagram] | tuple[PlanarDiagram | OrientedPlanarDiagram, ...]) – A diagram or a collection of diagrams.
attr (str | list[str] | set[str] | tuple[str, ...] | None) – Attribute name or iterable of names to remove. If None, clear all endpoint attrs.
- Return type:
None
- clear_diagram_attributes(k, attr=None)#
Clear diagram-level attributes.
- Parameters:
k (PlanarDiagram | OrientedPlanarDiagram | list[PlanarDiagram | OrientedPlanarDiagram] | set[PlanarDiagram | OrientedPlanarDiagram] | tuple[PlanarDiagram | OrientedPlanarDiagram, ...]) – A diagram or a collection of diagrams.
attr (str | list[str] | set[str] | tuple[str, ...] | None) – Attribute name or iterable of names to remove. If None, clear all diagram attrs.
- Return type:
None
- clear_attributes(k)#
Clear all attributes (nodes, endpoints, diagram-level).
- Parameters:
k (PlanarDiagram | OrientedPlanarDiagram | list[PlanarDiagram | OrientedPlanarDiagram] | set[PlanarDiagram | OrientedPlanarDiagram] | tuple[PlanarDiagram | OrientedPlanarDiagram, ...])
- Return type:
None
- clear_temporary_node_attributes(k, attr=None)#
Clear temporary node attributes (keys starting with ‘_’).
- Parameters:
k (PlanarDiagram | OrientedPlanarDiagram | list[PlanarDiagram | OrientedPlanarDiagram] | set[PlanarDiagram | OrientedPlanarDiagram] | tuple[PlanarDiagram | OrientedPlanarDiagram, ...]) – A diagram or a collection of diagrams.
attr (str | list[str] | set[str] | tuple[str, ...] | None) – Optional specific temporary key(s) to remove (must start with ‘_’). If None, remove all temporary node keys.
- Return type:
None
- clear_temporary_endpoint_attributes(k, attr=None)#
Clear temporary endpoint attributes (keys starting with ‘_’).
- Parameters:
k (PlanarDiagram | OrientedPlanarDiagram | list[PlanarDiagram | OrientedPlanarDiagram] | set[PlanarDiagram | OrientedPlanarDiagram] | tuple[PlanarDiagram | OrientedPlanarDiagram, ...])
attr (str | list[str] | set[str] | tuple[str, ...] | None)
- Return type:
None
- clear_temporary_diagram_attributes(k, attr=None)#
Clear temporary diagram-level attributes (keys starting with ‘_’).
- Parameters:
k (PlanarDiagram | OrientedPlanarDiagram | list[PlanarDiagram | OrientedPlanarDiagram] | set[PlanarDiagram | OrientedPlanarDiagram] | tuple[PlanarDiagram | OrientedPlanarDiagram, ...])
attr (str | list[str] | set[str] | tuple[str, ...] | None)
- Return type:
None
- clear_temporary_attributes(k)#
Clear all temporary attributes (keys starting with ‘_’) at all levels.
- Parameters:
k (PlanarDiagram | OrientedPlanarDiagram | list[PlanarDiagram | OrientedPlanarDiagram] | set[PlanarDiagram | OrientedPlanarDiagram] | tuple[PlanarDiagram | OrientedPlanarDiagram, ...])
- Return type:
None