ladybug_display.extension.monthlychart module

Method to draw an MonthlyChart as a VisualizationSet.

ladybug_display.extension.monthlychart.monthly_chart_to_vis_set(monthly_chart, z=0, time_marks=False, global_title=None, y_axis_title=None)[source]

Get a Ladybug MonthlyChart represented as a VisualizationSet.

Parameters

  • monthly_chart – A Ladybug MonthlyChart object.

  • z – A number for the Z-coordinate to be used in translation. (Default: 0).

  • time_marks – Boolean to note whether the month labels should be replaced with marks for the time of day in each month. This is useful for displaying hourly data, particularly when the input data is only for a month and not the whole year.

  • global_title – A text string to label the entire entire chart. It will be displayed in the lower left of the output chart. If None, the default is to display the metadata of the chart data.

  • y_axis_title – A text string to label the Y-axis of the chart. This can also be a list of 2 Y-axis titles if there are two different types of data plotted on the chart and there are two axes labels on either side of the chart. The default will display the data type and units of the plotted data.

Returns

A VisualizationSet with the monthly chart represented several ContextGeometries (and an AnalysisGeometry). This includes these objects in the following order.

  • X_Axis – A ContextGeometry with lines and text for the X axis of

    the monthly chart.

  • Y_Axis – A ContextGeometry with lines and text for the Y axis of

    the monthly chart.

  • Y_Axis2 – A ContextGeometry with lines and text for the second Y axis

    of the monthly chart.

  • Title – A ContextGeometry with text for the title of the monthly chart.

  • Data_Outlines – A ContextGeometry with a list of polylines that outline

    the input data. These will represent the average or total at each hour whenever the input data is hourly or monthly-per-hour data.

  • Analysis_Data – An AnalysisGeometry for the data on the monthly chart.