Ladybug logo
API docs by Redocly

Ladybug Visualization Schema (0.7.8)

Download OpenAPI specification:Download

Ladybug Tools: info@ladybug.tools URL: https://github.com/ladybug-tools/ladybug-display-core License: MIT

Documentation for Honeybee model schema

OpenAPI Specification with Inheritance

_OpenAPIGenBaseModel

type
string (Type)
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

{
  • "type": "InvalidType"
}

_VisualizationBase

type
string (Type) ^_VisualizationBase$
Default: "_VisualizationBase"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[.A-Za-z0-9_-]+$

Text string for a unique object ID. Must be less than 100 characters and not contain spaces or special characters.

display_name
string (Display Name)

Display name of the object with no character restrictions. This is typically used to set the layer of the object in the interface that renders the VisualizationSet. A :: in the display_name can be used to denote sub-layers following a convention of ParentLayer::SubLayer. If not set, the display_name will be equal to the object identifier.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

{
  • "type": "_VisualizationBase",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { }
}

AnalysisGeometry

type
string (Type) ^AnalysisGeometry$
Default: "AnalysisGeometry"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[.A-Za-z0-9_-]+$

Text string for a unique object ID. Must be less than 100 characters and not contain spaces or special characters.

display_name
string (Display Name)

Display name of the object with no character restrictions. This is typically used to set the layer of the object in the interface that renders the VisualizationSet. A :: in the display_name can be used to denote sub-layers following a convention of ParentLayer::SubLayer. If not set, the display_name will be equal to the object identifier.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
Array of Vector2D (object) or Point2D (object) or Ray2D (object) or LineSegment2D (object) or Polyline2D (object) or Arc2D (object) or Polygon2D (object) or Mesh2D (object) or Vector3D (object) or Point3D (object) or Ray3D (object) or Plane (object) or LineSegment3D (object) or Polyline3D (object) or Arc3D (object) or Face3D (object) or Mesh3D (object) or Polyface3D (object) or Sphere (object) or Cone (object) or Cylinder (object) (Geometry)

A list of ladybug-geometry objects that is aligned with the values in the input data_sets. The length of this list should usually be equal to the total number of values in each data_set, indicating that each geometry gets a single color. Alternatively, if all of the geometry objects are meshes, the number of values in the data can be equal to the total number of faces across the meshes or the total number of vertices across the meshes.

required
Array of objects (Data Sets) non-empty

An list of VisualizationData objects representing the data sets that are associated with the input geometry.

active_data
integer <int32> (Active Data)
Default: 0

An integer to denote which of the input data_sets should be displayed by default.

display_mode
string (DisplayModes)
Default: "Surface"
Enum: "Surface" "SurfaceWithEdges" "Wireframe" "Points"

Text to indicate the display mode (surface, wireframe, etc.). The DisplayModes enumeration contains all acceptable types.

hidden
boolean (Hidden)
Default: false

A boolean to note whether the geometry is hidden by default and must be un-hidden to be visible in the 3D scene.

{
  • "type": "AnalysisGeometry",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "geometry": [
    ],
  • "data_sets": [
    ],
  • "active_data": 0,
  • "display_mode": "Surface",
  • "hidden": false
}

Arc2D

type
string (Type) ^Arc2D$
Default: "Arc2D"

A base class to use when there is no baseclass available to fall on.

c
required
Array of numbers <double> (C) = 2 items [ items <double > ]

Center of the arc as 2 (x, y) values.

r
required
number <double> (R)

A number representing the radius of the arc.

a1
number <double> (A1) [ 0 .. 6.283185307179586 ]
Default: 0

A number between 0 and 2 * pi for the start angle of the arc.

a2
number <double> (A2) [ 0 .. 6.283185307179586 ]
Default: 6.283185307179586

A number between 0 and 2 * pi for the end angle of the arc.

{
  • "type": "Arc2D",
  • "c": [
    ],
  • "r": 0,
  • "a1": 0,
  • "a2": 6.283185307179586
}

Arc3D

type
string (Type) ^Arc3D$
Default: "Arc3D"

A base class to use when there is no baseclass available to fall on.

required
object (Plane)

A Plane in which the arc lies with an origin representing the center of the circle for the arc.

radius
required
number <double> (Radius)

A number representing the radius of the arc.

a1
number <double> (A1) [ 0 .. 6.283185307179586 ]
Default: 0

A number between 0 and 2 * pi for the start angle of the arc.

a2
number <double> (A2) [ 0 .. 6.283185307179586 ]
Default: 6.283185307179586

A number between 0 and 2 * pi for the end angle of the arc.

{
  • "type": "Arc3D",
  • "plane": {
    },
  • "radius": 0,
  • "a1": 0,
  • "a2": 6.283185307179586
}

Color

type
string (Type) ^Color$
Default: "Color"

A base class to use when there is no baseclass available to fall on.

r
required
integer <int32> (R) [ 0 .. 255 ]

Value for red channel.

g
required
integer <int32> (G) [ 0 .. 255 ]

Value for green channel.

b
required
integer <int32> (B) [ 0 .. 255 ]

Value for blue channel.

a
integer <int32> (A) [ 0 .. 255 ]
Default: 255

Value for the alpha channel, which defines the opacity as a number between 0 (fully transparent) and 255 (fully opaque).

{
  • "type": "Color",
  • "r": 255,
  • "g": 255,
  • "b": 255,
  • "a": 255
}

Cone

type
string (Type) ^Cone$
Default: "Cone"

A base class to use when there is no baseclass available to fall on.

vertex
required
Array of numbers <double> (Vertex) = 3 items [ items <double > ]

The point at the tip of the cone as 3 (x, y, z) values.

axis
required
Array of numbers <double> (Axis) = 3 items [ items <double > ]

The vector representing the direction of the cone as 3 (x, y, z) values. The vector extends from the vertex to the center of the base.

angle
required
number <double> (Angle) ( 0 .. 1.5707963267948966 )

An angle in radians representing the half angle between the axis and the surface.

{
  • "type": "Cone",
  • "vertex": [
    ],
  • "axis": [
    ],
  • "angle": 0
}

ContextGeometry

type
string (Type) ^ContextGeometry$
Default: "ContextGeometry"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[.A-Za-z0-9_-]+$

Text string for a unique object ID. Must be less than 100 characters and not contain spaces or special characters.

display_name
string (Display Name)

Display name of the object with no character restrictions. This is typically used to set the layer of the object in the interface that renders the VisualizationSet. A :: in the display_name can be used to denote sub-layers following a convention of ParentLayer::SubLayer. If not set, the display_name will be equal to the object identifier.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
Array of DisplayVector2D (object) or DisplayPoint2D (object) or DisplayRay2D (object) or DisplayLineSegment2D (object) or DisplayPolyline2D (object) or DisplayArc2D (object) or DisplayPolygon2D (object) or DisplayMesh2D (object) or DisplayVector3D (object) or DisplayPoint3D (object) or DisplayRay3D (object) or DisplayPlane (object) or DisplayLineSegment3D (object) or DisplayPolyline3D (object) or DisplayArc3D (object) or DisplayFace3D (object) or DisplayMesh3D (object) or DisplayPolyface3D (object) or DisplaySphere (object) or DisplayCone (object) or DisplayCylinder (object) or DisplayText3D (object) (Geometry)

A list of ladybug-geometry or ladybug-display objects that gives context to analysis geometry or other aspects of the visualization. Typically, these will display in wireframe around the geometry, though the properties of display geometry can be used to customize the visualization.

hidden
boolean (Hidden)
Default: false

A boolean to note whether the geometry is hidden by default and must be un-hidden to be visible in the 3D scene.

{
  • "type": "ContextGeometry",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "geometry": [
    ],
  • "hidden": false
}

Cylinder

type
string (Type) ^Cylinder$
Default: "Cylinder"

A base class to use when there is no baseclass available to fall on.

center
required
Array of numbers <double> (Center) = 3 items [ items <double > ]

The center of the bottom base of the cylinder as 3 (x, y, z) values.

axis
required
Array of numbers <double> (Axis) = 3 items [ items <double > ]

The vector representing the direction of the cylinder as 3 (x, y, z) values. The vector extends from the bottom base center to the top base center.

radius
required
number <double> (Radius) > 0

A number representing the radius of the cylinder.

{
  • "type": "Cylinder",
  • "center": [
    ],
  • "axis": [
    ],
  • "radius": 0
}

DataType

type
string (Type) ^DataType$
Default: "DataType"

A base class to use when there is no baseclass available to fall on.

data_type
required
string (DataTypes)
Enum: "ActivityLevel" "AerosolOpticalDepth" "AirSpeed" "AirTemperature" "AirTemperatureDelta" "Albedo" "Angle" "Area" "AtmosphericStationPressure" "CeilingHeight" "ClothingInsulation" "ConvectionCoefficient" "CoolingDegreeTime" "Current" "DewPointTemperature" "DiffuseHorizontalIlluminance" "DiffuseHorizontalIrradiance" "DiffuseHorizontalRadiation" "DirectHorizontalIrradiance" "DirectHorizontalRadiation" "DirectNormalIlluminance" "DirectNormalIrradiance" "DirectNormalRadiation" "DiscomfortReason" "Distance" "DryBulbTemperature" "EffectiveRadiantField" "Energy" "EnergyFlux" "EnergyIntensity" "Enthalpy" "ExtraterrestrialDirectNormalRadiation" "ExtraterrestrialHorizontalRadiation" "Fraction" "GlobalHorizontalIlluminance" "GlobalHorizontalIrradiance" "GlobalHorizontalRadiation" "GroundTemperature" "HeatingDegreeTime" "HorizontalInfraredRadiationIntensity" "HumidityRatio" "Illuminance" "Irradiance" "LiquidPrecipitationDepth" "LiquidPrecipitationQuantity" "Luminance" "Mass" "MassFlowRate" "MeanRadiantTemperature" "MetabolicRate" "OpaqueSkyCover" "OperativeTemperature" "OperativeTemperatureDelta" "PercentagePeopleDissatisfied" "Power" "PrecipitableWater" "PredictedMeanVote" "Pressure" "PrevailingOutdoorTemperature" "RValue" "RadiantCoefficient" "RadiantTemperature" "RadiantTemperatureDelta" "Radiation" "RelativeHumidity" "SkyTemperature" "SnowDepth" "SpecificEnergy" "Speed" "StandardEffectiveTemperature" "Temperature" "TemperatureDelta" "TemperatureTime" "ThermalComfort" "ThermalCondition" "ThermalConditionElevenPoint" "ThermalConditionFivePoint" "ThermalConditionNinePoint" "ThermalConditionSevenPoint" "Time" "TotalSkyCover" "UTCICategory" "UValue" "UniversalThermalClimateIndex" "Visibility" "Voltage" "Volume" "VolumeFlowRate" "VolumeFlowRateIntensity" "WetBulbTemperature" "WindDirection" "WindSpeed" "ZenithLuminance"

Text to indicate the type of data. This governs the behavior of the data type and the acceptable units. The DataTypes enumeration contains all acceptable types.

name
required
string (Name)

Text to indicate how the data type displays. This can be more specific than the data_type.

{
  • "type": "DataType",
  • "data_type": "ActivityLevel",
  • "name": "string"
}

DataTypes

string (DataTypes)
Enum: "ActivityLevel" "AerosolOpticalDepth" "AirSpeed" "AirTemperature" "AirTemperatureDelta" "Albedo" "Angle" "Area" "AtmosphericStationPressure" "CeilingHeight" "ClothingInsulation" "ConvectionCoefficient" "CoolingDegreeTime" "Current" "DewPointTemperature" "DiffuseHorizontalIlluminance" "DiffuseHorizontalIrradiance" "DiffuseHorizontalRadiation" "DirectHorizontalIrradiance" "DirectHorizontalRadiation" "DirectNormalIlluminance" "DirectNormalIrradiance" "DirectNormalRadiation" "DiscomfortReason" "Distance" "DryBulbTemperature" "EffectiveRadiantField" "Energy" "EnergyFlux" "EnergyIntensity" "Enthalpy" "ExtraterrestrialDirectNormalRadiation" "ExtraterrestrialHorizontalRadiation" "Fraction" "GlobalHorizontalIlluminance" "GlobalHorizontalIrradiance" "GlobalHorizontalRadiation" "GroundTemperature" "HeatingDegreeTime" "HorizontalInfraredRadiationIntensity" "HumidityRatio" "Illuminance" "Irradiance" "LiquidPrecipitationDepth" "LiquidPrecipitationQuantity" "Luminance" "Mass" "MassFlowRate" "MeanRadiantTemperature" "MetabolicRate" "OpaqueSkyCover" "OperativeTemperature" "OperativeTemperatureDelta" "PercentagePeopleDissatisfied" "Power" "PrecipitableWater" "PredictedMeanVote" "Pressure" "PrevailingOutdoorTemperature" "RValue" "RadiantCoefficient" "RadiantTemperature" "RadiantTemperatureDelta" "Radiation" "RelativeHumidity" "SkyTemperature" "SnowDepth" "SpecificEnergy" "Speed" "StandardEffectiveTemperature" "Temperature" "TemperatureDelta" "TemperatureTime" "ThermalComfort" "ThermalCondition" "ThermalConditionElevenPoint" "ThermalConditionFivePoint" "ThermalConditionNinePoint" "ThermalConditionSevenPoint" "Time" "TotalSkyCover" "UTCICategory" "UValue" "UniversalThermalClimateIndex" "Visibility" "Voltage" "Volume" "VolumeFlowRate" "VolumeFlowRateIntensity" "WetBulbTemperature" "WindDirection" "WindSpeed" "ZenithLuminance"

An enumeration.

"ActivityLevel"

Default

type
string (Type) ^Default$
Default: "Default"

A base class to use when there is no baseclass available to fall on.

{
  • "type": "Default"
}

DisplayArc2D

type
string (Type) ^DisplayArc2D$
Default: "DisplayArc2D"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
object (Color)

Color for the geometry.

required
object (Geometry)

Arc2D for the geometry.

Default (object) or Line Width (number) (Line Width)
Default: {"type":"Default"}

Number for line width in pixels (for the screen) or millimeters (in print). Set to zero to hide the geometry.

line_type
string (LineTypes)
Default: "Continuous"
Enum: "Continuous" "Dashed" "Dotted" "DashDot"

Text to indicate the type of line to display (dashed, dotted, etc.). The LineTypes enumeration contains all acceptable types.

{
  • "type": "DisplayArc2D",
  • "user_data": { },
  • "color": {
    },
  • "geometry": {
    },
  • "line_width": {
    },
  • "line_type": "Continuous"
}

DisplayArc3D

type
string (Type) ^DisplayArc3D$
Default: "DisplayArc3D"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
object (Color)

Color for the geometry.

required
object (Geometry)

Arc3D for the geometry.

Default (object) or Line Width (number) (Line Width)
Default: {"type":"Default"}

Number for line width in pixels (for the screen) or millimeters (in print). Set to zero to hide the geometry.

line_type
string (LineTypes)
Default: "Continuous"
Enum: "Continuous" "Dashed" "Dotted" "DashDot"

Text to indicate the type of line to display (dashed, dotted, etc.). The LineTypes enumeration contains all acceptable types.

{
  • "type": "DisplayArc3D",
  • "user_data": { },
  • "color": {
    },
  • "geometry": {
    },
  • "line_width": {
    },
  • "line_type": "Continuous"
}

DisplayBaseModel

type
string (Type) ^DisplayBaseModel$
Default: "DisplayBaseModel"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

{
  • "type": "DisplayBaseModel",
  • "user_data": { }
}

DisplayCone

type
string (Type) ^DisplayCone$
Default: "DisplayCone"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
object (Color)

Color for the geometry.

required
object (Geometry)

Cone for the geometry.

display_mode
string (DisplayModes)
Default: "Surface"
Enum: "Surface" "SurfaceWithEdges" "Wireframe" "Points"

Text to indicate the display mode (surface, wireframe, etc.). The DisplayModes enumeration contains all acceptable types.

{
  • "type": "DisplayCone",
  • "user_data": { },
  • "color": {
    },
  • "geometry": {
    },
  • "display_mode": "Surface"
}

DisplayCylinder

type
string (Type) ^DisplayCylinder$
Default: "DisplayCylinder"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
object (Color)

Color for the geometry.

required
object (Geometry)

Cylinder for the geometry.

display_mode
string (DisplayModes)
Default: "Surface"
Enum: "Surface" "SurfaceWithEdges" "Wireframe" "Points"

Text to indicate the display mode (surface, wireframe, etc.). The DisplayModes enumeration contains all acceptable types.

{
  • "type": "DisplayCylinder",
  • "user_data": { },
  • "color": {
    },
  • "geometry": {
    },
  • "display_mode": "Surface"
}

DisplayFace3D

type
string (Type) ^DisplayFace3D$
Default: "DisplayFace3D"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
object (Color)

Color for the geometry.

required
object (Geometry)

Face3D for the geometry.

display_mode
string (DisplayModes)
Default: "Surface"
Enum: "Surface" "SurfaceWithEdges" "Wireframe" "Points"

Text to indicate the display mode (surface, wireframe, etc.). The DisplayModes enumeration contains all acceptable types.

{
  • "type": "DisplayFace3D",
  • "user_data": { },
  • "color": {
    },
  • "geometry": {
    },
  • "display_mode": "Surface"
}

DisplayLineSegment2D

type
string (Type) ^DisplayLineSegment2D$
Default: "DisplayLineSegment2D"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
object (Color)

Color for the geometry.

required
object (Geometry)

LineSegment2D for the geometry.

Default (object) or Line Width (number) (Line Width)
Default: {"type":"Default"}

Number for line width in pixels (for the screen) or millimeters (in print). Set to zero to hide the geometry.

line_type
string (LineTypes)
Default: "Continuous"
Enum: "Continuous" "Dashed" "Dotted" "DashDot"

Text to indicate the type of line to display (dashed, dotted, etc.). The LineTypes enumeration contains all acceptable types.

{
  • "type": "DisplayLineSegment2D",
  • "user_data": { },
  • "color": {
    },
  • "geometry": {
    },
  • "line_width": {
    },
  • "line_type": "Continuous"
}

DisplayLineSegment3D

type
string (Type) ^DisplayLineSegment3D$
Default: "DisplayLineSegment3D"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
object (Color)

Color for the geometry.

required
object (Geometry)

LineSegment3D for the geometry.

Default (object) or Line Width (number) (Line Width)
Default: {"type":"Default"}

Number for line width in pixels (for the screen) or millimeters (in print). Set to zero to hide the geometry.

line_type
string (LineTypes)
Default: "Continuous"
Enum: "Continuous" "Dashed" "Dotted" "DashDot"

Text to indicate the type of line to display (dashed, dotted, etc.). The LineTypes enumeration contains all acceptable types.

{
  • "type": "DisplayLineSegment3D",
  • "user_data": { },
  • "color": {
    },
  • "geometry": {
    },
  • "line_width": {
    },
  • "line_type": "Continuous"
}

DisplayMesh2D

type
string (Type) ^DisplayMesh2D$
Default: "DisplayMesh2D"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
object (Color)

Color for the geometry.

required
object (Geometry)

Mesh2D for the geometry.

display_mode
string (DisplayModes)
Default: "Surface"
Enum: "Surface" "SurfaceWithEdges" "Wireframe" "Points"

Text to indicate the display mode (surface, wireframe, etc.). The DisplayModes enumeration contains all acceptable types.

{
  • "type": "DisplayMesh2D",
  • "user_data": { },
  • "color": {
    },
  • "geometry": {
    },
  • "display_mode": "Surface"
}

DisplayMesh3D

type
string (Type) ^DisplayMesh3D$
Default: "DisplayMesh3D"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
object (Color)

Color for the geometry.

required
object (Geometry)

Mesh3D for the geometry.

display_mode
string (DisplayModes)
Default: "Surface"
Enum: "Surface" "SurfaceWithEdges" "Wireframe" "Points"

Text to indicate the display mode (surface, wireframe, etc.). The DisplayModes enumeration contains all acceptable types.

{
  • "type": "DisplayMesh3D",
  • "user_data": { },
  • "color": {
    },
  • "geometry": {
    },
  • "display_mode": "Surface"
}

DisplayModes

string (DisplayModes)
Enum: "Surface" "SurfaceWithEdges" "Wireframe" "Points"

An enumeration.

"Surface"

DisplayPlane

type
string (Type) ^DisplayPlane$
Default: "DisplayPlane"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
object (Color)

Color for the geometry.

required
object (Geometry)

Plane for the geometry.

show_axes
boolean (Show Axes)
Default: false

A boolean to note whether the plane should be displayed with XY axes instead of just an origin point and a normal vector.

show_grid
boolean (Show Grid)
Default: false

A boolean to note whether the plane should be displayed with a grid.

{
  • "type": "DisplayPlane",
  • "user_data": { },
  • "color": {
    },
  • "geometry": {
    },
  • "show_axes": false,
  • "show_grid": false
}

DisplayPoint2D

type
string (Type) ^DisplayPoint2D$
Default: "DisplayPoint2D"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
object (Color)

Color for the geometry.

required
object (Geometry)

Point2D for the geometry.

Default (object) or Radius (number) (Radius)
Default: {"type":"Default"}

Number for the radius with which the point should be displayed in pixels (for the screen) or millimeters (in print).

{
  • "type": "DisplayPoint2D",
  • "user_data": { },
  • "color": {
    },
  • "geometry": {
    },
  • "radius": {
    }
}

DisplayPoint3D

type
string (Type) ^DisplayPoint3D$
Default: "DisplayPoint3D"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
object (Color)

Color for the geometry.

required
object (Geometry)

Point3D for the geometry.

Default (object) or Radius (number) (Radius)
Default: {"type":"Default"}

Number for the radius with which the point should be displayed in pixels (for the screen) or millimeters (in print).

{
  • "type": "DisplayPoint3D",
  • "user_data": { },
  • "color": {
    },
  • "geometry": {
    },
  • "radius": {
    }
}

DisplayPolyface3D

type
string (Type) ^DisplayPolyface3D$
Default: "DisplayPolyface3D"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
object (Color)

Color for the geometry.

required
object (Geometry)

Polyface3D for the geometry.

display_mode
string (DisplayModes)
Default: "Surface"
Enum: "Surface" "SurfaceWithEdges" "Wireframe" "Points"

Text to indicate the display mode (surface, wireframe, etc.). The DisplayModes enumeration contains all acceptable types.

{
  • "type": "DisplayPolyface3D",
  • "user_data": { },
  • "color": {
    },
  • "geometry": {
    },
  • "display_mode": "Surface"
}

DisplayPolygon2D

type
string (Type) ^DisplayPolygon2D$
Default: "DisplayPolygon2D"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
object (Color)

Color for the geometry.

required
object (Geometry)

Polygon2D for the geometry.

Default (object) or Line Width (number) (Line Width)
Default: {"type":"Default"}

Number for line width in pixels (for the screen) or millimeters (in print). Set to zero to hide the geometry.

line_type
string (LineTypes)
Default: "Continuous"
Enum: "Continuous" "Dashed" "Dotted" "DashDot"

Text to indicate the type of line to display (dashed, dotted, etc.). The LineTypes enumeration contains all acceptable types.

{
  • "type": "DisplayPolygon2D",
  • "user_data": { },
  • "color": {
    },
  • "geometry": {
    },
  • "line_width": {
    },
  • "line_type": "Continuous"
}

DisplayPolyline2D

type
string (Type) ^DisplayPolyline2D$
Default: "DisplayPolyline2D"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
object (Color)

Color for the geometry.

required
object (Geometry)

Polyline2D for the geometry.

Default (object) or Line Width (number) (Line Width)
Default: {"type":"Default"}

Number for line width in pixels (for the screen) or millimeters (in print). Set to zero to hide the geometry.

line_type
string (LineTypes)
Default: "Continuous"
Enum: "Continuous" "Dashed" "Dotted" "DashDot"

Text to indicate the type of line to display (dashed, dotted, etc.). The LineTypes enumeration contains all acceptable types.

{
  • "type": "DisplayPolyline2D",
  • "user_data": { },
  • "color": {
    },
  • "geometry": {
    },
  • "line_width": {
    },
  • "line_type": "Continuous"
}

DisplayPolyline3D

type
string (Type) ^DisplayPolyline3D$
Default: "DisplayPolyline3D"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
object (Color)

Color for the geometry.

required
object (Geometry)

Polyline3D for the geometry.

Default (object) or Line Width (number) (Line Width)
Default: {"type":"Default"}

Number for line width in pixels (for the screen) or millimeters (in print). Set to zero to hide the geometry.

line_type
string (LineTypes)
Default: "Continuous"
Enum: "Continuous" "Dashed" "Dotted" "DashDot"

Text to indicate the type of line to display (dashed, dotted, etc.). The LineTypes enumeration contains all acceptable types.

{
  • "type": "DisplayPolyline3D",
  • "user_data": { },
  • "color": {
    },
  • "geometry": {
    },
  • "line_width": {
    },
  • "line_type": "Continuous"
}

DisplayRay2D

type
string (Type) ^DisplayRay2D$
Default: "DisplayRay2D"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
object (Color)

Color for the geometry.

required
object (Geometry)

Ray2D for the geometry.

{
  • "type": "DisplayRay2D",
  • "user_data": { },
  • "color": {
    },
  • "geometry": {
    }
}

DisplayRay3D

type
string (Type) ^DisplayRay3D$
Default: "DisplayRay3D"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
object (Color)

Color for the geometry.

required
object (Geometry)

Ray3D for the geometry.

{
  • "type": "DisplayRay3D",
  • "user_data": { },
  • "color": {
    },
  • "geometry": {
    }
}

DisplaySphere

type
string (Type) ^DisplaySphere$
Default: "DisplaySphere"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
object (Color)

Color for the geometry.

required
object (Geometry)

Sphere for the geometry.

display_mode
string (DisplayModes)
Default: "Surface"
Enum: "Surface" "SurfaceWithEdges" "Wireframe" "Points"

Text to indicate the display mode (surface, wireframe, etc.). The DisplayModes enumeration contains all acceptable types.

{
  • "type": "DisplaySphere",
  • "user_data": { },
  • "color": {
    },
  • "geometry": {
    },
  • "display_mode": "Surface"
}

DisplayText3D

type
string (Type) ^DisplayText3D$
Default: "DisplayText3D"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
object (Color)

Color for the geometry.

text
required
string (Text)

A text string to be displayed in the 3D scene.

required
object (Plane)

A ladybug-geometry Plane object to locate and orient the text in the 3D scene.

height
required
number <double> (Height) > 0

A number for the height of the text in the 3D scene.

font
string (Font)
Default: "Arial"

A text string for the font in which to draw the text. Note that this field may not be interpreted the same on all machines and in all interfaces, particularly when a machine lacks a given font.

horizontal_alignment
string (HorizontalAlignments)
Default: "Left"
Enum: "Left" "Center" "Right"

String to specify the horizontal alignment of the text.

vertical_alignment
string (VerticalAlignments)
Default: "Bottom"
Enum: "Top" "Middle" "Bottom"

String to specify the vertical alignment of the text.

{
  • "type": "DisplayText3D",
  • "user_data": { },
  • "color": {
    },
  • "text": "string",
  • "plane": {
    },
  • "height": 0,
  • "font": "Arial",
  • "horizontal_alignment": "Left",
  • "vertical_alignment": "Bottom"
}

DisplayVector2D

type
string (Type) ^DisplayVector2D$
Default: "DisplayVector2D"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
object (Color)

Color for the geometry.

required
object (Geometry)

Vector2D for the geometry.

{
  • "type": "DisplayVector2D",
  • "user_data": { },
  • "color": {
    },
  • "geometry": {
    }
}

DisplayVector3D

type
string (Type) ^DisplayVector3D$
Default: "DisplayVector3D"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
object (Color)

Color for the geometry.

required
object (Geometry)

Vector3D for the geometry.

{
  • "type": "DisplayVector3D",
  • "user_data": { },
  • "color": {
    },
  • "geometry": {
    }
}

Face3D

type
string (Type) ^Face3D$
Default: "Face3D"

A base class to use when there is no baseclass available to fall on.

boundary
required
Array of numbers (Boundary) >= 3 items [ items <double > = 3 items [ items <double > ] ]

A list of points representing the outer boundary vertices of the face. The list should include at least 3 points and each point should be a list of 3 (x, y, z) values.

holes
Array of numbers (Holes) [ items >= 3 items [ items <double > = 3 items [ items <double > ] ] ]

Optional list of lists with one list for each hole in the face.Each hole should be a list of at least 3 points and each point a list of 3 (x, y, z) values. If None, it will be assumed that there are no holes in the face.

object (Plane)

Optional Plane indicating the plane in which the face exists.If None, the plane will usually be derived from the boundary points.

{
  • "type": "Face3D",
  • "boundary": [
    ],
  • "holes": [
    ],
  • "plane": {
    }
}

GenericDataType

type
string (Type) ^GenericDataType$
Default: "GenericDataType"

A base class to use when there is no baseclass available to fall on.

name
required
string (Name)

Text to indicate how the data type displays. This can be more specific than the data_type.

base_unit
required
string (Base Unit)

Text string for the base unit of the data type, which should be standard SI units where possible.

data_type
string (Data Type) ^GenericType$
Default: "GenericType"
Default (object) or Min (number) (Min)
Default: {"type":"Default"}

Optional lower limit for the data type, values below which should be physically or mathematically impossible. (Default: -inf)

Default (object) or Max (number) (Max)
Default: {"type":"Default"}

Optional upper limit for the data type, values above which should be physically or mathematically impossible. (Default: +inf)

abbreviation
string (Abbreviation)
Default: ""

An optional abbreviation for the data type as text.

unit_descr
object (Unit Descr)

An optional dictionary describing categories that the numerical values of the units relate to. For example: {-1: "Cold", 0: "Neutral", +1: "Hot"}; {0: "False", 1: "True"}.

point_in_time
boolean (Point In Time)
Default: true

Boolean to note whether the data type represents conditions at a single instant in time (True) as opposed to being an average or accumulation over time (False) when it is found in hourly lists of data.

cumulative
boolean (Cumulative)
Default: false

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). Note that cumulative cannot be True when point_in_time is also True.

{
  • "type": "GenericDataType",
  • "name": "string",
  • "base_unit": "string",
  • "data_type": "GenericType",
  • "min": {
    },
  • "max": {
    },
  • "abbreviation": "",
  • "unit_descr": { },
  • "point_in_time": true,
  • "cumulative": false
}

HorizontalAlignments

string (HorizontalAlignments)
Enum: "Left" "Center" "Right"

An enumeration.

"Left"

Legend2DParameters

type
string (Type) ^Legend2DParameters$
Default: "Legend2DParameters"

A base class to use when there is no baseclass available to fall on.

Default (object) or Origin X (string) (Origin X)
Default: {"type":"Default"}

A text string to note the X coordinate of the base point from where the legend will be generated (assuming an origin in the upper-left corner of the viewport with higher positive values of X moving to the right). Text must be formatted as an integer followed by either "px" (to denote the number of viewport pixels) or "%" (to denote the percentage of the viewport width). Examples include 10px, 5%. The default is set to make the legend clearly visible on the viewport (usually 10px).

Default (object) or Origin Y (string) (Origin Y)
Default: {"type":"Default"}

A text string to note the Y coordinate of the base point from where the legend will be generated (assuming an origin in the upper-left corner of the viewport with higher positive values of Y moving downward). Text must be formatted as an integer followed by either "px" (to denote the number of viewport pixels) or "%" (to denote the percentage of the viewport height). Examples include 10px, 5%. The default is set to make the legend clearly visible on the viewport (usually 50px).

Default (object) or Segment Height (string) (Segment Height)
Default: {"type":"Default"}

A text string to note the height for each of the legend segments. Text must be formatted as an integer followed by either "px" (to denote the number of viewport pixels) or "%" (to denote the percentage of the viewport height). Examples include 10px, 5%. The default is set to make most legends readable (25px for horizontal legends and 36px for vertical legends).

Default (object) or Segment Width (string) (Segment Width)
Default: {"type":"Default"}

A text string to set the width for each of the legend segments. Text must be formatted as an integer followed by either "px" (to denote the number of viewport pixels) or "%" (to denote the percentage of the viewport width). Examples include 10px, 5%. The default is set to make most legends readable (36px for horizontal legends and 25px for vertical legends).

Default (object) or Text Height (string) (Text Height)
Default: {"type":"Default"}

A text string to set the height for the legend text. Text must be formatted as an integer followed by either "px" (to denote the number of viewport pixels) or "%" (to denote the percentage of the viewport height). Examples include 10px, 5%. Default is 1/3 of the segment_height. Default is 12px.

{
  • "type": "Legend2DParameters",
  • "origin_x": {
    },
  • "origin_y": {
    },
  • "segment_height": {
    },
  • "segment_width": {
    },
  • "text_height": {
    }
}

Legend3DParameters

type
string (Type) ^Legend3DParameters$
Default: "Legend3DParameters"

A base class to use when there is no baseclass available to fall on.

object (Base Plane)

A Ladybug Plane object to note the starting position from where the legend will be generated. The default is the world XY plane at origin (0, 0, 0) unless the legend is assigned to a specific geometry, in which case the origin is in the lower right corner of the geometry bounding box for vertical legends and the upper right corner for horizontal legends.

Default (object) or Segment Height (number) (Segment Height)
Default: {"type":"Default"}

A number to set the height for each of the legend segments. The default is 1 unless the legend is assigned to a specific geometry, in which case it is automatically set to a value on an appropriate scale (some fraction of the bounding box around the geometry).

Default (object) or Segment Width (number) (Segment Width)
Default: {"type":"Default"}

A number to set the width for each of the legend segments. The default is 1 unless the legend is assigned to a specific geometry, in which case it is automatically set to a value on an appropriate scale (some fraction of the bounding box around the geometry).

Default (object) or Text Height (number) (Text Height)
Default: {"type":"Default"}

A number to set the height for the legend text. Default is 1/3 of the segment_height.

{
  • "type": "Legend3DParameters",
  • "base_plane": {
    },
  • "segment_height": {
    },
  • "segment_width": {
    },
  • "text_height": {
    }
}

LegendParameters

type
string (Type) ^LegendParameters$
Default: "LegendParameters"

A base class to use when there is no baseclass available to fall on.

Default (object) or Min (number) (Min)
Default: {"type":"Default"}

A number to set the lower boundary of the legend. If Default, the minimum of the values associated with the legend will be used.

Default (object) or Max (number) (Max)
Default: {"type":"Default"}

A number to set the upper boundary of the legend. If Default, the maximum of the values associated with the legend will be used.

Default (object) or Segment Count (integer) (Segment Count)
Default: {"type":"Default"}

An integer representing the number of steps between the high and low boundary of the legend. The default is set to 11 or it will be equal to the number of items in the ordinal_dictionary. Any custom values input in here should always be greater than or equal to 1.

Array of objects (Colors) >= 2 items

An list of color objects. Default is the Ladybug original colorset.

title
string (Title)
Default: ""

Text string for Legend title. Typically, the units of the data are used here but the type of data might also be used.

continuous_legend
boolean (Continuous Legend)
Default: false

Boolean noting whether legend is drawn as a gradient or discrete segments.

ordinal_dictionary
object (Ordinal Dictionary)

Optional dictionary that maps values to text categories. If None, numerical values will be used for the legend segments. If not, text categories will be used and the legend will be ordinal. Note that, if the number of items in the dictionary are less than the segment_count, some segments will not receive any label. Examples for possible dictionaries include: {-1: "Cold", 0: "Neutral", 1: "Hot"}, {0: "False", 1: "True"}

decimal_count
integer <int32> (Decimal Count) >= 0
Default: 2

An an integer for the number of decimal places in the legend text. Note that this input has no bearing on the resulting legend text when an ordinal_dictionary is present.

include_larger_smaller
boolean (Include Larger Smaller)
Default: false

Boolean noting whether > and < should be included in legend segment text.

vertical
boolean (Vertical)
Default: true

Boolean noting whether legend is vertical (True) or horizontal (False).

font
string (Font)
Default: "Arial"

Text string to set the font for the legend text. Examples include "Arial", "Times New Roman", "Courier". Note that this parameter may not have an effect on certain interfaces that have limited access to fonts.

object (Properties 3D)

A Legend3DParameters object to specify the dimensional properties of the legend when it is rendered in the 3D environment of the geometry scene.

object (Properties 2D)

A Legend2DParameters object to specify the dimensional properties of the legend when it is rendered in the 2D plane of a screen.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

{
  • "type": "LegendParameters",
  • "min": {
    },
  • "max": {
    },
  • "segment_count": {
    },
  • "colors": [
    ],
  • "title": "",
  • "continuous_legend": false,
  • "ordinal_dictionary": { },
  • "decimal_count": 2,
  • "include_larger_smaller": false,
  • "vertical": true,
  • "font": "Arial",
  • "properties_3d": {
    },
  • "properties_2d": {
    },
  • "user_data": { }
}

LineCurveBase

type
string (Type) ^LineCurveBase$
Default: "LineCurveBase"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
object (Color)

Color for the geometry.

Default (object) or Line Width (number) (Line Width)
Default: {"type":"Default"}

Number for line width in pixels (for the screen) or millimeters (in print). Set to zero to hide the geometry.

line_type
string (LineTypes)
Default: "Continuous"
Enum: "Continuous" "Dashed" "Dotted" "DashDot"

Text to indicate the type of line to display (dashed, dotted, etc.). The LineTypes enumeration contains all acceptable types.

{
  • "type": "LineCurveBase",
  • "user_data": { },
  • "color": {
    },
  • "line_width": {
    },
  • "line_type": "Continuous"
}

LineSegment2D

type
string (Type) ^LineSegment2D$
Default: "LineSegment2D"

A base class to use when there is no baseclass available to fall on.

p
required
Array of numbers <double> (P) = 2 items [ items <double > ]

Line segment base point as 2 (x, y) values.

v
required
Array of numbers <double> (V) = 2 items [ items <double > ]

Line segment direction vector as 2 (x, y) values.

{
  • "type": "LineSegment2D",
  • "p": [
    ],
  • "v": [
    ]
}

LineSegment3D

type
string (Type) ^LineSegment3D$
Default: "LineSegment3D"

A base class to use when there is no baseclass available to fall on.

p
required
Array of numbers <double> (P) = 3 items [ items <double > ]

Line segment base point as 3 (x, y, z) values.

v
required
Array of numbers <double> (V) = 3 items [ items <double > ]

Line segment direction vector as 3 (x, y, z) values.

{
  • "type": "LineSegment3D",
  • "p": [
    ],
  • "v": [
    ]
}

LineTypes

string (LineTypes)
Enum: "Continuous" "Dashed" "Dotted" "DashDot"

An enumeration.

"Continuous"

Mesh2D

type
string (Type) ^Mesh2D$
Default: "Mesh2D"

A base class to use when there is no baseclass available to fall on.

vertices
required
Array of numbers (Vertices) >= 3 items [ items <double > = 2 items [ items <double > ] ]

A list of points representing the vertices of the mesh. The list should include at least 3 points and each point should be a list of 2 (x, y) values.

faces
required
Array of integers (Faces) non-empty [ items <int32 > [ 3 .. 4 ] items [ items <int32 > >= 0 ] ]

A list of lists with each sub-list having either 3 or 4 integers. These integers correspond to indices within the list of vertices.

Array of objects (Colors)

An optional list of colors that correspond to either the faces of the mesh or the vertices of the mesh.

{
  • "type": "Mesh2D",
  • "vertices": [
    ],
  • "faces": [
    ],
  • "colors": [
    ]
}

Mesh3D

type
string (Type) ^Mesh3D$
Default: "Mesh3D"

A base class to use when there is no baseclass available to fall on.

vertices
required
Array of numbers (Vertices) >= 3 items [ items <double > = 3 items [ items <double > ] ]

A list of points representing the vertices of the mesh. The list should include at least 3 points and each point should be a list of 3 (x, y, z) values.

faces
required
Array of integers (Faces) non-empty [ items <int32 > [ 3 .. 4 ] items [ items <int32 > >= 0 ] ]

A list of lists with each sub-list having either 3 or 4 integers. These integers correspond to indices within the list of vertices.

Array of objects (Colors)

An optional list of colors that correspond to either the faces of the mesh or the vertices of the mesh.

{
  • "type": "Mesh3D",
  • "vertices": [
    ],
  • "faces": [
    ],
  • "colors": [
    ]
}

Plane

type
string (Type) ^Plane$
Default: "Plane"

A base class to use when there is no baseclass available to fall on.

n
required
Array of numbers <double> (N) = 3 items [ items <double > ]

Plane normal as 3 (x, y, z) values.

o
required
Array of numbers <double> (O) = 3 items [ items <double > ]

Plane origin as 3 (x, y, z) values

x
Array of numbers <double> (X) = 3 items [ items <double > ]

Plane x-axis as 3 (x, y, z) values. If None, it is autocalculated.

{
  • "type": "Plane",
  • "n": [
    ],
  • "o": [
    ],
  • "x": [
    ]
}

Point2D

type
string (Type) ^Point2D$
Default: "Point2D"

A base class to use when there is no baseclass available to fall on.

x
required
number <double> (X)

Number for X coordinate.

y
required
number <double> (Y)

Number for Y coordinate.

{
  • "type": "Point2D",
  • "x": 0,
  • "y": 0
}

Point3D

type
string (Type) ^Point3D$
Default: "Point3D"

A base class to use when there is no baseclass available to fall on.

x
required
number <double> (X)

Number for X coordinate.

y
required
number <double> (Y)

Number for Y coordinate.

z
required
number <double> (Z)

Number for Z coordinate.

{
  • "type": "Point3D",
  • "x": 0,
  • "y": 0,
  • "z": 0
}

Polyface3D

type
string (Type) ^Polyface3D$
Default: "Polyface3D"

A base class to use when there is no baseclass available to fall on.

vertices
required
Array of numbers (Vertices) >= 3 items [ items <double > = 3 items [ items <double > ] ]

A list of points representing the vertices of the polyface. The list should include at least 3 points and each point should be a list of 3 (x, y, z) values.

face_indices
required
Array of integers (Face Indices) non-empty [ items non-empty [ items <int32 > >= 3 items [ items <int32 > >= 0 ] ] ]

A list of lists with one list for each face of the polyface. Each face list must contain at least one sub-list of integers corresponding to indices within the vertices list. Additional sub-lists of integers may follow this one such that the first sub-list denotes the boundary of the face while each subsequent sub-list denotes a hole in the face.

object (Edge Information)

Optional edge information, which will speed up the creation of the Polyface object if it is available but should be left as None if it is unknown. If None, edge_information will be computed from the vertices and face_indices inputs.

{
  • "type": "Polyface3D",
  • "vertices": [
    ],
  • "face_indices": [
    ],
  • "edge_information": {
    }
}

PolyfaceEdgeInfo

type
string (Type) ^PolyfaceEdgeInfo$
Default: "PolyfaceEdgeInfo"

A base class to use when there is no baseclass available to fall on.

edge_indices
required
Array of integers (Edge Indices) >= 3 items [ items <int32 > = 2 items [ items <int32 > >= 0 ] ]

An array objects that each contain two integers. These integers correspond to indices within the vertices list and each tuple represents a line segment for an edge of the polyface.

edge_types
required
Array of integers <int32> (Edge Types) >= 3 items [ items <int32 > >= 0 ]

An array of integers for each edge that parallels the edge_indices list. An integer of 0 denotes a naked edge, an integer of 1 denotes an internal edge. Anything higher is a non-manifold edge.

{
  • "type": "PolyfaceEdgeInfo",
  • "edge_indices": [
    ],
  • "edge_types": [
    ]
}

Polygon2D

type
string (Type) ^Polygon2D$
Default: "Polygon2D"

A base class to use when there is no baseclass available to fall on.

vertices
required
Array of numbers (Vertices) >= 3 items [ items <double > = 2 items [ items <double > ] ]

A list of points representing the vertices of the polygon. The list should include at least 3 points and each point should be a list of 2 (x, y) values.

{
  • "type": "Polygon2D",
  • "vertices": [
    ]
}

Polyline2D

type
string (Type) ^Polyline2D$
Default: "Polyline2D"

A base class to use when there is no baseclass available to fall on.

vertices
required
Array of numbers (Vertices) >= 3 items [ items <double > = 2 items [ items <double > ] ]

A list of points representing the the vertices of the polyline. The list should include at least 3 points and each point should be a list of 2 (x, y) values.

interpolated
boolean (Interpolated)
Default: false

A boolean to note whether the polyline should be interpolated between the input vertices when it is translated to other interfaces.

{
  • "type": "Polyline2D",
  • "vertices": [
    ],
  • "interpolated": false
}

Polyline3D

type
string (Type) ^Polyline3D$
Default: "Polyline3D"

A base class to use when there is no baseclass available to fall on.

vertices
required
Array of numbers (Vertices) >= 3 items [ items <double > = 3 items [ items <double > ] ]

A list of points representing the the vertices of the polyline. The list should include at least 3 points and each point should be a list of 3 (x, y, z) values.

interpolated
boolean (Interpolated)
Default: false

A boolean to note whether the polyline should be interpolated between the input vertices when it is translated to other interfaces.

{
  • "type": "Polyline3D",
  • "vertices": [
    ],
  • "interpolated": false
}

Ray2D

type
string (Type) ^Ray2D$
Default: "Ray2D"

A base class to use when there is no baseclass available to fall on.

p
required
Array of numbers <double> (P) = 2 items [ items <double > ]

Ray base point as 2 (x, y) values.

v
required
Array of numbers <double> (V) = 2 items [ items <double > ]

Ray direction vector as 2 (x, y) values.

{
  • "type": "Ray2D",
  • "p": [
    ],
  • "v": [
    ]
}

Ray3D

type
string (Type) ^Ray3D$
Default: "Ray3D"

A base class to use when there is no baseclass available to fall on.

p
required
Array of numbers <double> (P) = 3 items [ items <double > ]

Ray base point as 3 (x, y, z) values.

v
required
Array of numbers <double> (V) = 3 items [ items <double > ]

Ray direction vector as 3 (x, y, z) values.

{
  • "type": "Ray3D",
  • "p": [
    ],
  • "v": [
    ]
}

SingleColorBase

type
string (Type) ^SingleColorBase$
Default: "SingleColorBase"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
object (Color)

Color for the geometry.

{
  • "type": "SingleColorBase",
  • "user_data": { },
  • "color": {
    }
}

Sphere

type
string (Type) ^Sphere$
Default: "Sphere"

A base class to use when there is no baseclass available to fall on.

center
required
Array of numbers <double> (Center) = 3 items [ items <double > ]

The center of the sphere as 3 (x, y, z) values.

radius
required
number <double> (Radius) > 0

A number representing the radius of the sphere.

{
  • "type": "Sphere",
  • "center": [
    ],
  • "radius": 0
}

Units

string (Units)
Enum: "Meters" "Millimeters" "Feet" "Inches" "Centimeters"

An enumeration.

"Meters"

Vector2D

type
string (Type) ^Vector2D$
Default: "Vector2D"

A base class to use when there is no baseclass available to fall on.

x
required
number <double> (X)

Number for X coordinate.

y
required
number <double> (Y)

Number for Y coordinate.

{
  • "type": "Vector2D",
  • "x": 0,
  • "y": 0
}

Vector3D

type
string (Type) ^Vector3D$
Default: "Vector3D"

A base class to use when there is no baseclass available to fall on.

x
required
number <double> (X)

Number for X coordinate.

y
required
number <double> (Y)

Number for Y coordinate.

z
required
number <double> (Z)

Number for Z coordinate.

{
  • "type": "Vector3D",
  • "x": 0,
  • "y": 0,
  • "z": 0
}

VerticalAlignments

string (VerticalAlignments)
Enum: "Top" "Middle" "Bottom"

An enumeration.

"Top"

VisualizationData

type
string (Type) ^VisualizationData$
Default: "VisualizationData"

A base class to use when there is no baseclass available to fall on.

values
required
Array of numbers <double> (Values) non-empty [ items <double > ]

A list of numerical values that will be used to generate the visualization colors.

object (Legend Parameters)

An Optional LegendParameters object to override default parameters of the legend. None indicates that default legend parameters will be used.

DataType (object) or GenericDataType (object) (Data Type)

Optional DataType from the ladybug datatype subpackage (ie. Temperature()) , which will be used to assign default legend properties. If None, the legend associated with this object will contain no units unless a unit below is specified.

unit
string (Unit)
Default: ""

Optional text string for the units of the values. (ie. "C"). If None, the default units of the data_type will be used.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

{
  • "type": "VisualizationData",
  • "values": [
    ],
  • "legend_parameters": {
    },
  • "data_type": {
    },
  • "unit": "",
  • "user_data": { }
}

VisualizationMetaData

type
string (Type) ^VisualizationMetaData$
Default: "VisualizationMetaData"

A base class to use when there is no baseclass available to fall on.

object (Legend Parameters)

An Optional LegendParameters object to override default parameters of the legend. None indicates that default legend parameters will be used.

DataType (object) or GenericDataType (object) (Data Type)

Optional DataType from the ladybug datatype subpackage (ie. Temperature()) , which will be used to assign default legend properties. If None, the legend associated with this object will contain no units unless a unit below is specified.

unit
string (Unit)
Default: ""

Optional text string for the units of the values. (ie. "C"). If None, the default units of the data_type will be used.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

{
  • "type": "VisualizationMetaData",
  • "legend_parameters": {
    },
  • "data_type": {
    },
  • "unit": "",
  • "user_data": { }
}

VisualizationSet

type
string (Type) ^VisualizationSet$
Default: "VisualizationSet"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[.A-Za-z0-9_-]+$

Text string for a unique object ID. Must be less than 100 characters and not contain spaces or special characters.

display_name
string (Display Name)

Display name of the object with no character restrictions. This is typically used to set the layer of the object in the interface that renders the VisualizationSet. A :: in the display_name can be used to denote sub-layers following a convention of ParentLayer::SubLayer. If not set, the display_name will be equal to the object identifier.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

Array of AnalysisGeometry (object) or ContextGeometry (object) (Geometry)

A list of AnalysisGeometry and ContextGeometry objects to display in the visualization. Each geometry object will typically be translated to its own layer within the interface that renders the VisualizationSet.

units
string (Units)
Enum: "Meters" "Millimeters" "Feet" "Inches" "Centimeters"

Text indicating the units in which the model geometry exists. If None, the geometry will always be assumed to be in the current units system of the display interface.

{
  • "type": "VisualizationSet",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "geometry": [
    ],
  • "units": "Meters"
}