Links

Construct Data Type

- [source code]
Construct a Ladybug DataType to be used in the header of a ladybug DataCollection.

Inputs

  • name [Required]
A name for the data type as a string.
  • unit [Required]
A unit for the data type as a string.
  • cumulative
Boolean to tell whether the data type can be cumulative when it is represented over time (True) or it can only be averaged over time to be meaningful (False).
  • categories
An optional list of text for categories to be associated with the data type. These categories will show up in the legend whenever data with this data type is visualized. The input should be text strings with a category number (integer) and name separated by a colon. For example: . -1: Cold . 0: Neutral . 1: Hot

Outputs

  • type
A Ladybug DataType object that can be assigned to the header of a Ladybug DataCollection.