BH.oM.LadybugTools.HeatPlotCommand¶
Command that, when executed with the LadybugToolsAdapter, produces a heatmap from data in an epw file. Output is a string of either the path to the image (if OutputLocation is not set) or the base 64 string representation of it.
Class structure¶
Implemented interfaces and base types¶
The HeatPlotCommand is inheriting from the following base type(s) and implements the following interfaces:
- BH.oM.LadybugTools.ISimulationCommand
- BH.oM.Adapter.IExecuteCommand
- BH.oM.Base.IObject
Properties¶
Defining properties¶
The following properties are defined on the class
| Name | Type | Description | Quantity |
|---|---|---|---|
| EPWFile | FileSettings | The path to an EPW file. | - |
| EPWKey | EPWKey | Key representing an hourly continuous collection in the EPW file to plot. | - |
| ColourMap | string | A Matplotlib colour map. Corresponds to the 'cmap' parameter of plot methods. See https://matplotlib.org/stable/users/explain/colors/colormaps.html for examples of valid keys. Default of 'viridis'. | - |
| OutputLocation | string | Full file path (with file name) to save the plot to. Leave blank to output a base 64 string representation of the image instead. | - |
Code and Schema¶
C# implementation¶
C#
public class HeatPlotCommand : BH.oM.LadybugTools.ISimulationCommand, BH.oM.Adapter.IExecuteCommand, BH.oM.Base.IObject
Assembly: LadybugTools_oM.dll
The C# class definition is available on github:
All history and changes of the class can be found by inspection the history.
JSON Schema implementation¶
The object is defined as a JSON schema. You can validate a JSON instance against this schema by reference. To do this, use the schema reference below in a validator like this one.
JSON Schema
{
"$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/LadybugTools_oM/HeatPlotCommand.json"
}
The JSON Schema is available on github here: