ladybug_display.extension.adaptivechart module¶
Method to draw an AdaptiveChart as a VisualizationSet.
- ladybug_display.extension.adaptivechart.adaptive_chart_to_vis_set(adaptive_chart, data=None, legend_parameters=None, z=0)[source]¶
Get a Ladybug AdaptiveChart represented as a VisualizationSet.
- Parameters
adaptive_chart – A Ladybug AdaptiveChart object.
data – An optional list of data collection objects, which are aligned with the prevailing and operative temperature values of the chart. and will generate additional colored AnalysisGeometries on the chart.
legend_parameters – An optional LegendParameter object or list of LegendParameter objects to customize the display of the data on the adaptive chart. Note that this relates only to the data supplied as input for this method and, to customize the display of the time/frequency mesh, the AdaptiveChart’s native legend_parameters should be edited. If a list is used here, this should align with the input data (one legend parameter per data collection).
z – A number for the Z-coordinate to be used in translation. (Default: 0).
- Returns
A VisualizationSet with the adaptive chart represented several ContextGeometries and an AnalysisGeometry. This includes these objects in the following order.
- Title – A ContextGeometry for the title and border around the
adaptive chart.
- Prevailing_Axis – A ContextGeometry with lines and text for the
Prevailing Outdoor Temperature (X) axis of the adaptive chart.
- Operative_Axis – A ContextGeometry with lines and text for the
Indoor Operative Temperature (Y) axis of the adaptive chart.
- Comfort_Polygon – A ContextGeometry with lines for the comfort polygon
and neutral temperature of the adaptive chart.
- Analysis_Data – An AnalysisGeometry for the data on the adaptive
chart. This will include multiple data sets if the data input is provided.