Welcome to ladybug-display’s documentation!¶
A library that assigns basic display attributes to ladybug-geometry objects (color, line weight, line type, etc).
Installation¶
pip install ladybug-display
DisplayArc2D
DisplayArc2D.ToString()
DisplayArc2D.duplicate()
DisplayArc2D.from_dict()
DisplayArc2D.move()
DisplayArc2D.reflect()
DisplayArc2D.rotate()
DisplayArc2D.scale()
DisplayArc2D.to_dict()
DisplayArc2D.c
DisplayArc2D.color
DisplayArc2D.geometry
DisplayArc2D.is_circle
DisplayArc2D.length
DisplayArc2D.line_type
DisplayArc2D.line_width
DisplayArc2D.p1
DisplayArc2D.p2
DisplayArc2D.r
DisplayArc2D.user_data
DisplayLineSegment2D
DisplayLineSegment2D.ToString()
DisplayLineSegment2D.duplicate()
DisplayLineSegment2D.from_dict()
DisplayLineSegment2D.move()
DisplayLineSegment2D.reflect()
DisplayLineSegment2D.rotate()
DisplayLineSegment2D.scale()
DisplayLineSegment2D.to_dict()
DisplayLineSegment2D.color
DisplayLineSegment2D.geometry
DisplayLineSegment2D.length
DisplayLineSegment2D.line_type
DisplayLineSegment2D.line_width
DisplayLineSegment2D.p
DisplayLineSegment2D.p1
DisplayLineSegment2D.p2
DisplayLineSegment2D.user_data
DisplayLineSegment2D.v
DisplayMesh2D
DisplayMesh2D.ToString()
DisplayMesh2D.duplicate()
DisplayMesh2D.from_dict()
DisplayMesh2D.move()
DisplayMesh2D.reflect()
DisplayMesh2D.rotate()
DisplayMesh2D.scale()
DisplayMesh2D.to_dict()
DisplayMesh2D.area
DisplayMesh2D.center
DisplayMesh2D.color
DisplayMesh2D.display_mode
DisplayMesh2D.face_areas
DisplayMesh2D.face_centroids
DisplayMesh2D.faces
DisplayMesh2D.geometry
DisplayMesh2D.max
DisplayMesh2D.min
DisplayMesh2D.user_data
DisplayMesh2D.vertices
DisplayPoint2D
DisplayPoint2D.ToString()
DisplayPoint2D.distance_to_point()
DisplayPoint2D.duplicate()
DisplayPoint2D.from_dict()
DisplayPoint2D.move()
DisplayPoint2D.reflect()
DisplayPoint2D.rotate()
DisplayPoint2D.scale()
DisplayPoint2D.to_dict()
DisplayPoint2D.color
DisplayPoint2D.geometry
DisplayPoint2D.radius
DisplayPoint2D.user_data
DisplayPoint2D.x
DisplayPoint2D.y
DisplayPolygon2D
DisplayPolygon2D.ToString()
DisplayPolygon2D.duplicate()
DisplayPolygon2D.from_dict()
DisplayPolygon2D.move()
DisplayPolygon2D.reflect()
DisplayPolygon2D.rotate()
DisplayPolygon2D.scale()
DisplayPolygon2D.to_dict()
DisplayPolygon2D.area
DisplayPolygon2D.center
DisplayPolygon2D.color
DisplayPolygon2D.geometry
DisplayPolygon2D.is_clockwise
DisplayPolygon2D.is_convex
DisplayPolygon2D.is_self_intersecting
DisplayPolygon2D.line_type
DisplayPolygon2D.line_width
DisplayPolygon2D.max
DisplayPolygon2D.min
DisplayPolygon2D.perimeter
DisplayPolygon2D.segments
DisplayPolygon2D.user_data
DisplayPolygon2D.vertices
DisplayPolyline2D
DisplayPolyline2D.ToString()
DisplayPolyline2D.duplicate()
DisplayPolyline2D.from_dict()
DisplayPolyline2D.move()
DisplayPolyline2D.reflect()
DisplayPolyline2D.rotate()
DisplayPolyline2D.scale()
DisplayPolyline2D.to_dict()
DisplayPolyline2D.color
DisplayPolyline2D.geometry
DisplayPolyline2D.interpolated
DisplayPolyline2D.length
DisplayPolyline2D.line_type
DisplayPolyline2D.line_width
DisplayPolyline2D.max
DisplayPolyline2D.min
DisplayPolyline2D.p1
DisplayPolyline2D.p2
DisplayPolyline2D.segments
DisplayPolyline2D.user_data
DisplayPolyline2D.vertices
DisplayVector2D
DisplayVector2D.ToString()
DisplayVector2D.angle()
DisplayVector2D.dot()
DisplayVector2D.duplicate()
DisplayVector2D.from_dict()
DisplayVector2D.normalize()
DisplayVector2D.reflect()
DisplayVector2D.reverse()
DisplayVector2D.rotate()
DisplayVector2D.to_dict()
DisplayVector2D.color
DisplayVector2D.geometry
DisplayVector2D.magnitude
DisplayVector2D.user_data
DisplayVector2D.x
DisplayVector2D.y
DisplayArc3D
DisplayArc3D.ToString()
DisplayArc3D.duplicate()
DisplayArc3D.from_dict()
DisplayArc3D.move()
DisplayArc3D.reflect()
DisplayArc3D.rotate()
DisplayArc3D.rotate_xy()
DisplayArc3D.scale()
DisplayArc3D.to_dict()
DisplayArc3D.angle
DisplayArc3D.c
DisplayArc3D.color
DisplayArc3D.geometry
DisplayArc3D.is_circle
DisplayArc3D.length
DisplayArc3D.line_type
DisplayArc3D.line_width
DisplayArc3D.p1
DisplayArc3D.p2
DisplayArc3D.plane
DisplayArc3D.radius
DisplayArc3D.user_data
DisplayCone
DisplayCone.ToString()
DisplayCone.duplicate()
DisplayCone.from_dict()
DisplayCone.move()
DisplayCone.reflect()
DisplayCone.rotate()
DisplayCone.rotate_xy()
DisplayCone.scale()
DisplayCone.to_dict()
DisplayCone.area
DisplayCone.axis
DisplayCone.color
DisplayCone.display_mode
DisplayCone.geometry
DisplayCone.height
DisplayCone.radius
DisplayCone.user_data
DisplayCone.vertex
DisplayCone.volume
DisplayCylinder
DisplayCylinder.ToString()
DisplayCylinder.duplicate()
DisplayCylinder.from_dict()
DisplayCylinder.move()
DisplayCylinder.reflect()
DisplayCylinder.rotate()
DisplayCylinder.rotate_xy()
DisplayCylinder.scale()
DisplayCylinder.to_dict()
DisplayCylinder.area
DisplayCylinder.axis
DisplayCylinder.center
DisplayCylinder.color
DisplayCylinder.display_mode
DisplayCylinder.geometry
DisplayCylinder.height
DisplayCylinder.radius
DisplayCylinder.user_data
DisplayCylinder.volume
DisplayFace3D
DisplayFace3D.ToString()
DisplayFace3D.duplicate()
DisplayFace3D.from_dict()
DisplayFace3D.move()
DisplayFace3D.reflect()
DisplayFace3D.rotate()
DisplayFace3D.rotate_xy()
DisplayFace3D.scale()
DisplayFace3D.to_dict()
DisplayFace3D.altitude
DisplayFace3D.area
DisplayFace3D.azimuth
DisplayFace3D.center
DisplayFace3D.color
DisplayFace3D.display_mode
DisplayFace3D.geometry
DisplayFace3D.max
DisplayFace3D.min
DisplayFace3D.normal
DisplayFace3D.perimeter
DisplayFace3D.user_data
DisplayFace3D.vertices
DisplayLineSegment3D
DisplayLineSegment3D.ToString()
DisplayLineSegment3D.duplicate()
DisplayLineSegment3D.from_dict()
DisplayLineSegment3D.move()
DisplayLineSegment3D.reflect()
DisplayLineSegment3D.rotate()
DisplayLineSegment3D.rotate_xy()
DisplayLineSegment3D.scale()
DisplayLineSegment3D.to_dict()
DisplayLineSegment3D.color
DisplayLineSegment3D.geometry
DisplayLineSegment3D.length
DisplayLineSegment3D.line_type
DisplayLineSegment3D.line_width
DisplayLineSegment3D.p
DisplayLineSegment3D.p1
DisplayLineSegment3D.p2
DisplayLineSegment3D.user_data
DisplayLineSegment3D.v
DisplayMesh3D
DisplayMesh3D.ToString()
DisplayMesh3D.duplicate()
DisplayMesh3D.from_dict()
DisplayMesh3D.move()
DisplayMesh3D.reflect()
DisplayMesh3D.rotate()
DisplayMesh3D.rotate_xy()
DisplayMesh3D.scale()
DisplayMesh3D.to_dict()
DisplayMesh3D.area
DisplayMesh3D.center
DisplayMesh3D.color
DisplayMesh3D.display_mode
DisplayMesh3D.face_areas
DisplayMesh3D.face_centroids
DisplayMesh3D.face_normals
DisplayMesh3D.faces
DisplayMesh3D.geometry
DisplayMesh3D.max
DisplayMesh3D.min
DisplayMesh3D.user_data
DisplayMesh3D.vertex_normals
DisplayMesh3D.vertices
DisplayPlane
DisplayPlane.ToString()
DisplayPlane.duplicate()
DisplayPlane.from_dict()
DisplayPlane.move()
DisplayPlane.reflect()
DisplayPlane.rotate()
DisplayPlane.rotate_xy()
DisplayPlane.scale()
DisplayPlane.to_dict()
DisplayPlane.color
DisplayPlane.geometry
DisplayPlane.k
DisplayPlane.n
DisplayPlane.o
DisplayPlane.show_axes
DisplayPlane.show_grid
DisplayPlane.user_data
DisplayPlane.x
DisplayPlane.y
DisplayPoint3D
DisplayPoint3D.ToString()
DisplayPoint3D.distance_to_point()
DisplayPoint3D.duplicate()
DisplayPoint3D.from_dict()
DisplayPoint3D.move()
DisplayPoint3D.reflect()
DisplayPoint3D.rotate()
DisplayPoint3D.rotate_xy()
DisplayPoint3D.scale()
DisplayPoint3D.to_dict()
DisplayPoint3D.color
DisplayPoint3D.geometry
DisplayPoint3D.radius
DisplayPoint3D.user_data
DisplayPoint3D.x
DisplayPoint3D.y
DisplayPoint3D.z
DisplayPolyface3D
DisplayPolyface3D.ToString()
DisplayPolyface3D.duplicate()
DisplayPolyface3D.from_dict()
DisplayPolyface3D.move()
DisplayPolyface3D.reflect()
DisplayPolyface3D.rotate()
DisplayPolyface3D.rotate_xy()
DisplayPolyface3D.scale()
DisplayPolyface3D.to_dict()
DisplayPolyface3D.area
DisplayPolyface3D.center
DisplayPolyface3D.color
DisplayPolyface3D.display_mode
DisplayPolyface3D.edge_indices
DisplayPolyface3D.edge_types
DisplayPolyface3D.edges
DisplayPolyface3D.face_indices
DisplayPolyface3D.faces
DisplayPolyface3D.geometry
DisplayPolyface3D.internal_edges
DisplayPolyface3D.is_solid
DisplayPolyface3D.max
DisplayPolyface3D.min
DisplayPolyface3D.naked_edges
DisplayPolyface3D.non_manifold_edges
DisplayPolyface3D.user_data
DisplayPolyface3D.vertices
DisplayPolyface3D.volume
DisplayPolyline3D
DisplayPolyline3D.ToString()
DisplayPolyline3D.duplicate()
DisplayPolyline3D.from_dict()
DisplayPolyline3D.move()
DisplayPolyline3D.reflect()
DisplayPolyline3D.rotate()
DisplayPolyline3D.rotate_xy()
DisplayPolyline3D.scale()
DisplayPolyline3D.to_dict()
DisplayPolyline3D.color
DisplayPolyline3D.geometry
DisplayPolyline3D.interpolated
DisplayPolyline3D.length
DisplayPolyline3D.line_type
DisplayPolyline3D.line_width
DisplayPolyline3D.max
DisplayPolyline3D.min
DisplayPolyline3D.p1
DisplayPolyline3D.p2
DisplayPolyline3D.segments
DisplayPolyline3D.user_data
DisplayPolyline3D.vertices
DisplayRay3D
DisplayRay3D.ToString()
DisplayRay3D.duplicate()
DisplayRay3D.from_dict()
DisplayRay3D.move()
DisplayRay3D.reflect()
DisplayRay3D.reverse()
DisplayRay3D.rotate()
DisplayRay3D.rotate_xy()
DisplayRay3D.scale()
DisplayRay3D.to_dict()
DisplayRay3D.color
DisplayRay3D.geometry
DisplayRay3D.p
DisplayRay3D.user_data
DisplayRay3D.v
DisplaySphere
DisplaySphere.ToString()
DisplaySphere.duplicate()
DisplaySphere.from_dict()
DisplaySphere.move()
DisplaySphere.reflect()
DisplaySphere.rotate()
DisplaySphere.rotate_xy()
DisplaySphere.scale()
DisplaySphere.to_dict()
DisplaySphere.area
DisplaySphere.center
DisplaySphere.circumference
DisplaySphere.color
DisplaySphere.diameter
DisplaySphere.display_mode
DisplaySphere.geometry
DisplaySphere.max
DisplaySphere.min
DisplaySphere.radius
DisplaySphere.user_data
DisplaySphere.volume
DisplayText3D
DisplayText3D.ToString()
DisplayText3D.duplicate()
DisplayText3D.from_dict()
DisplayText3D.move()
DisplayText3D.reflect()
DisplayText3D.rotate()
DisplayText3D.rotate_xy()
DisplayText3D.scale()
DisplayText3D.to_dict()
DisplayText3D.HORIZONTAL_ALIGN
DisplayText3D.VERTICAL_ALIGN
DisplayText3D.color
DisplayText3D.font
DisplayText3D.geometry
DisplayText3D.height
DisplayText3D.horizontal_alignment
DisplayText3D.max
DisplayText3D.min
DisplayText3D.plane
DisplayText3D.text
DisplayText3D.user_data
DisplayText3D.vertical_alignment
DisplayVector3D
DisplayVector3D.ToString()
DisplayVector3D.angle()
DisplayVector3D.cross()
DisplayVector3D.dot()
DisplayVector3D.duplicate()
DisplayVector3D.from_dict()
DisplayVector3D.normalize()
DisplayVector3D.reflect()
DisplayVector3D.reverse()
DisplayVector3D.rotate()
DisplayVector3D.rotate_xy()
DisplayVector3D.to_dict()
DisplayVector3D.color
DisplayVector3D.geometry
DisplayVector3D.magnitude
DisplayVector3D.user_data
DisplayVector3D.x
DisplayVector3D.y
DisplayVector3D.z
AnalysisGeometry
AnalysisGeometry.ToString()
AnalysisGeometry.add_data_set()
AnalysisGeometry.duplicate()
AnalysisGeometry.from_dict()
AnalysisGeometry.graphic_container()
AnalysisGeometry.move()
AnalysisGeometry.remove_data_set()
AnalysisGeometry.rotate_xy()
AnalysisGeometry.scale()
AnalysisGeometry.to_dict()
AnalysisGeometry.T_FORMABLE_2D
AnalysisGeometry.active_data
AnalysisGeometry.data_sets
AnalysisGeometry.display_mode
AnalysisGeometry.display_name
AnalysisGeometry.full_id
AnalysisGeometry.geometry
AnalysisGeometry.hidden
AnalysisGeometry.identifier
AnalysisGeometry.matching_method
AnalysisGeometry.max_point
AnalysisGeometry.min_point
AnalysisGeometry.user_data
ContextGeometry
ContextGeometry.ToString()
ContextGeometry.duplicate()
ContextGeometry.from_dict()
ContextGeometry.geometry_to_wireframe()
ContextGeometry.move()
ContextGeometry.rotate_xy()
ContextGeometry.scale()
ContextGeometry.to_dict()
ContextGeometry.WIREFRAME_MAP
ContextGeometry.display_name
ContextGeometry.full_id
ContextGeometry.geometry
ContextGeometry.hidden
ContextGeometry.identifier
ContextGeometry.max_point
ContextGeometry.min_point
ContextGeometry.user_data
VisualizationData
VisualizationData.ToString()
VisualizationData.duplicate()
VisualizationData.from_dict()
VisualizationData.graphic_container()
VisualizationData.to_dict()
VisualizationData.data_type
VisualizationData.legend
VisualizationData.legend_parameters
VisualizationData.unit
VisualizationData.user_data
VisualizationData.value_colors
VisualizationData.values
VisualizationMetaData
VisualizationSet
VisualizationSet.ToString()
VisualizationSet.add_geometry()
VisualizationSet.add_vis_set()
VisualizationSet.check_duplicate_identifiers()
VisualizationSet.convert_to_units()
VisualizationSet.duplicate()
VisualizationSet.from_dict()
VisualizationSet.from_file()
VisualizationSet.from_json()
VisualizationSet.from_pkl()
VisualizationSet.from_single_analysis_geo()
VisualizationSet.graphic_container()
VisualizationSet.move()
VisualizationSet.remove_geometry()
VisualizationSet.rotate_xy()
VisualizationSet.scale()
VisualizationSet.to_dict()
VisualizationSet.to_json()
VisualizationSet.to_pkl()
VisualizationSet.UNITS
VisualizationSet.display_name
VisualizationSet.full_id
VisualizationSet.geometry
VisualizationSet.identifier
VisualizationSet.max_point
VisualizationSet.min_point
VisualizationSet.units
VisualizationSet.user_data
A library that assigns basic display attributes to ladybug-geometry objects (color, line weight, line type, etc).
pip install ladybug-display