Skip to main content
Ctrl+K
Logo image

COMPAS TNA

  • Introduction
  • Installation
  • Tutorial
  • API Reference
    • compas_tna
      • compas_tna.diagrams
      • compas_tna.equilibrium
      • compas_tna.loads
      • compas_tna.notebook
      • compas_tna.rhino
      • compas_tna.scene
  • License
  • Acknowledgements
COMPAS.dev
  • API Reference
  • Diagram
  • Diagram.face_attribute

Diagram.face_attribute

Diagram.face_attribute(key, name, value=None)

Get or set an attribute of a face.

Parameters:
keyint

The face identifier.

namestr

The name of the attribute.

valueobject, optional

The value of the attribute.

Returns:
object | None

The value of the attribute, or None when the function is used as a “setter”.

Raises:
KeyError

If the face does not exist.

See also

face_attributes(), faces_attribute(), faces_attributes()
unset_face_attribute()
edge_attribute()
vertex_attribute()
On this page
  • Diagram.face_attribute()

© Copyright Block Research Group - ETH Zurich.

Created using Sphinx 8.1.3.

Built with the PyData Sphinx Theme 0.13.3.