ladybug_display.extension.hourlyplot module

Method to draw an HourlyPlot as a VisualizationSet.

ladybug_display.extension.hourlyplot.hourly_plot_to_vis_set(hourly_plot, z=0, custom_hours=(0, 3, 6, 9, 12, 15, 18, 21, 24), include_title=True)[source]

Get a Ladybug HourlyPlot represented as a VisualizationSet.

Parameters

  • hourly_plot – A Ladybug HourlyPlot object.

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

  • custom_hours – A tuple of integers from 0 to 24 to indicate which hours of the day should appear in the Hour_Axis of the visualization. The default is (0, 3, 6, 9, 12, 15, 18, 21, 24).

  • include_title – Boolean to note whether the title should be included in the output visualization. (Default: True).

Returns

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

  • Hour_Axis – A ContextGeometry with lines and text for the hour-of-the-day

    axis of the hourly plot.

  • Month_Axis – A ContextGeometry with lines and text for the month-of-the-year

    axis of the hourly plot.

  • Title – A ContextGeometry with text for the title of the hourly plot.

    This layer will be excluded if include_title is False.

  • Analysis_Data – An AnalysisGeometry for the data on the hourly plot.