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

Create Legend

PreviousConstruct MatrixNextDeconstruct Matrix

Last updated 1 year ago

-

Create a custom legend for any set of data or range. Creating a legend with this component allows for a bit more flexibility than what can be achieved by working with the legends automatically output from different studies.

Inputs

  • values [Required]

A list of numerical values or data collections that the legend refers to. This can also be the minimum and maximum numerical values of the data. The legend's maximum and minimum values will be set by the max and min of the data set.

  • base_plane

An optional plane or point to set the location of the legend. (Default: Rhino origin - (0, 0, 0))

  • title

A text string representing a legend title. Legends are usually titled with the units of the data.

  • legend_par

Optional legend parameters from the "LB Legend Parameters" component.

  • 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.

Outputs

  • mesh

A colored mesh for the legend colors.

  • title_obj

A text object for the legend title.

  • label_objs

An array of text objects for the label text.

  • label_text

An array of text strings for the label text.

  • colors

An array of colors that align with the input _values. This can be used to color geometry that aligns with the values.

[source code]