Skip to main content
Ctrl+K
Logo image

COMPAS AGS

  • Introduction
  • Installation
  • Examples
    • Basic example
    • Updating the form diagram
    • Optimise the load path
    • Fink Truss
  • API Reference
    • compas_ags
      • compas_ags.ags
      • compas_ags.diagrams
      • compas_ags.exceptions
  • Publications
    • Algebraic Graph Statics
    • Bi-directional Algebraic Graph Statics
    • Interactive Graphic Statics
    • Load-path optimisation of funicular networks
  • License
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.