ladybug_vtk.visualization_set module

A Model object to collect all other DisplayPolyData objcts.

class ladybug_vtk.visualization_set.VisualizationSet(datasets: Optional[Union[DisplayPolyData, List[DisplayPolyData]]] = None)[source]

Bases: object

add_datasets(datasets: Union[DisplayPolyData, List[DisplayPolyData]]) → None[source]
classmethod from_visualization_set(visualization_set: VisualizationSet) → VisualizationSet[source]

Create a VisualizationSet from a Ladybug Display VisualizationSet.

to_html(folder: str = '.', name: Optional[str] = None, open: bool = False) → str[source]

Translate the visualization set to an HTML file.

This HTML file is self .

Parameters

  • folder – A valid text string representing the location of folder where you’d want to write the HTML file. Defaults to current working directory.

  • name – Name for the HTML file. File name will be visualization_set.html if not provided.

  • open – A boolean to open the HTML file once created. Default is set to False.

Returns

A text string representing the file path to the vtkjs file.

to_vtkjs(folder: str = '.', name: Optional[str] = None) → str[source]

Translate the visualization set a vtkjs file.

Write the visualization set to a vtkjs file that you can open in Pollination Viewer.

Parameters

  • folder – A valid text string representing the location of folder where you’d want to write the vtkjs file. Defaults to current working directory.

  • name – Name for the vtkjs file. File name will be visualization_set.vtkjs if not provided.

Returns

A text string representing the file path to the vtkjs file.