honeybee_display.attr module

Display attribute objects for creating visualization sets.

class honeybee_display.attr.FaceAttribute(name, attrs, color=True, text=False, legend_par=None, face_types=None, boundary_conditions=None)

Bases: RoomAttribute

A Face attribute object.

Parameters:

• name – A name for this Face Attribute.

• attrs – A list of text strings of attributes the Model Faces have, which will be used to construct a visualization of this attribute in the resulting VisualizationSet. This can also be a list of attribute strings and a separate VisualizationData will be added to the AnalysisGeometry that represents the attribute in the resulting VisualizationSet (or a separate ContextGeometry layer if color is True). Attributes input here can have ‘.’ that separates the nested attributes from one another. For example, ‘properties.energy.construction’ or ‘user_data.tag’

• color – A boolean to note whether the input room_attr should be expressed as a colored AnalysisGeometry. (Default: True)

• text – A boolean to note whether the input room_attr should be expressed as a a ContextGeometry as text labels. (Default: False)

• legend_par – An optional LegendParameter object to customize the display of the attribute. For text attribute only the text_height and font will be used to customize the text.

• face_types –

  List of face types to be included in the visualization set. By default all the faces will be exported to visualization set. Valid values are:

  • Wall

  • RoofCeiling

  • Floor

  • AirBoundary

  • Aperture

  • Shade

• boundary_conditions –

  List of face boundary conditions to be included in the visualization set. This condition will be applied as a secondary check for the face_types that are set using the face_types argument. Valid values are:

  • Outdoors

  • Surface

  • Ground

property attrs

property boundary_conditions

property color

property face_types

property legend_par

property name

property text

class honeybee_display.attr.RoomAttribute(name, attrs, color=True, text=False, legend_par=None)

Bases: object

A Room attribute object.

Parameters:

• name – A name for this Room Attribute.

• attrs – A list of text strings of attributes that the Model Rooms have, which will be used to construct a visualization of this attribute in the resulting VisualizationSet. This can also be a list of attribute strings and a separate VisualizationData will be added to the AnalysisGeometry that represents the attribute in the resulting VisualizationSet (or a separate ContextGeometry layer if color is True). Attributes input here can have ‘.’ that separates the nested attributes from one another. For example, ‘properties.energy.construction’ or ‘user_data.tag’

• color – A boolean to note whether the input room_attr should be expressed as a colored AnalysisGeometry. (Default: True)

• text – A boolean to note whether the input room_attr should be expressed as a a ContextGeometry as text labels. (Default: False)

• legend_par – An optional LegendParameter object to customize the display of the attribute. For text attribute only the text_height and font will be used to customize the text.

property attrs

property color

property legend_par

property name

property text