Ladybug Primer
Ladybug Tools for Grasshopper Documentation
  • Ladybug Primer
  • Components
    • 0 :: Import
      • Download Weather
      • EPWmap
      • Import EPW
      • Import Location
      • Construct Location
      • Deconstruct Location
      • Import DDY
      • Import STAT
      • Deconstruct Design Day
      • Import Design Day
      • EPW to DDY
    • 1 :: Analyze Data
      • Construct Data
      • Construct Data Type
      • Construct Header
      • Deconstruct Data
      • Analysis Period
      • Calculate HOY
      • Apply Analysis Period
      • Apply Conditional Statement
      • Arithmetic Operation
      • Time Interval Operation
      • Degree Days
      • Wind Speed
      • Adaptive Comfort
      • PET Comfort
      • PMV Comfort
      • UTCI Comfort
      • Indoor Solar MRT
      • Outdoor Solar MRT
      • Ankle Draft
      • Clothing by Temperature
      • Comfort Statistics
      • Convert to Timestep
      • Data DateTimes
      • Day Solar Information
      • Deconstruct Header
      • Directional Solar Irradiance
      • HOY to DateTime
      • Humidity Metrics
      • Mass Arithmetic Operation
      • Radiant Asymmetry
      • Relative Humidity from Dew Point
      • Solar MRT from Solar Components
      • Thermal Indices
    • 2 :: Visualize Data
      • Hourly Plot
      • Monthly Chart
      • Adaptive Chart
      • PMV Polygon
      • Psychrometric Chart
      • UTCI Polygon
      • Benefit Sky Matrix
      • Cumulative Sky Matrix
      • Sky Dome
      • SunPath
      • Radiation Dome
      • Radiation Rose
      • Wind Profile
      • Wind Rose
    • 3 :: Analyze Geometry
      • Direct Sun Hours
      • Incident Radiation
      • View Factors
      • View Percent
      • View Rose
      • Visibility Percent
      • Human to Sky Relation
      • Sky Mask
      • Solar Envelope
      • Surface Ray Tracing
      • Shade Benefit
      • Thermal Shade Benefit
      • Set Rhino Sun
      • View From Sun
      • Real Time Incident Radiation
    • 4 :: Extra
      • Color Range
      • FalseStartToggle
      • Generate Point Grid
      • ImageViewer
      • Legend Parameters
      • Mesh Threshold Selector
      • Preview VisualizationSet
      • Spatial Heatmap
      • Capture View
      • Legend 2D Parameters
      • Orient to Camera
      • Set View
      • To IP
      • To SI
      • To Unit
      • Unit Converter
      • Adaptive Comfort Parameters
      • PMV Comfort Parameters
      • Passive Strategies
      • Solar Body Parameters
      • Dump Data
      • Load Data
      • Open Directory
      • Open File
      • Compass
      • Magnetic to True North
      • Activities Met List
      • Area Aggregate
      • Area Normalize
      • Clothing List
      • Construct Matrix
      • Create Legend
      • Deconstruct Matrix
      • Deconstruct VisualizationSet
      • Dump VisualizationSet
      • Filter by Normal
      • Legend Parameters Categorized
      • Mesh to Hatch
      • PET Body Parameters
      • Passive Strategy Parameters
      • Screen Oriented Text
      • SortByLayers
      • Time Aggregate
      • Time Rate of Change
      • UTCI Comfort Parameters
    • 5 :: Version
      • Sync Grasshopper File
      • Versioner
      • Export UserObject
      • Legacy Updater
Powered by GitBook
On this page
  • Inputs
  • Outputs
Export as PDF
  1. Components
  2. 4 :: Extra

Preview VisualizationSet

PreviousMesh Threshold SelectorNextSpatial Heatmap

Last updated 1 year ago

-

Preview a VisualizationSet from any component with a vis_set output.

The VisualizationSet is often a much more detailed view of the geometry that the component typically generates and includes features like recommended line weights/types, display modes (eg. wireframe vs. shaded), transparency, and more.

Inputs

  • vis_set [Required]

VisualizationSet arguments from any Ladybug Tools component with a vis_set output. This can also be the path to a .vsf file that exists on this machine (these files are often written with the "LB Dump VisualizationSet" component). Lastly, this input can be a custom VisualizationSet that has been created with the Ladybug Tools SDK.

  • leg_par

Script variable VisSet

  • leg_par2d

Optional 2D LegendParameters from the "LB Legend Parameters 2D" component, which will be used to customize a legend in the plane of the screen so that it functions like a head-up display (HUD). If unspecified, the VisualizationSet will be rendered with 3D legends in the Rhino scene much like the other native Ladybug Tools components.

  • data_set

Optional text or an integer to select a specific data set from analysis geometries within the Visualization Set. Note that this input only has meaning for Visualization Sets that contain multiple data sets assigned to the same geometry. When using an integer, this will refer to the index of the data set to be visualized (starting with 0). When using text, this will refer to the name of the data type for the data set to be displayed.

Outputs

  • vs

A VisualizationSet object that can be baked into the Rhino document by running "Bake" on this component or written to a standalone file using the "LB Dump VisualizationSet" component.

[source code]