LadybugDisplaySchema - the C# library for the Ladybug Visualization Schema

Documentation for Ladybug visualization schema

This C# SDK is automatically generated by the OpenAPI Generator project:

• API version: 0.7.7
• SDK version: 0.7.7
• Build package: org.openapitools.codegen.languages.CSharpClientCodegen For more information, please visit https://github.com/ladybug-tools/ladybug-display-core

Frameworks supported

• .NET Core >=1.0
• .NET Framework >=4.5

Dependencies

• RestSharp - 105.1.0 or later
• Json.NET - 7.0.0 or later
• JsonSubTypes - 1.2.0 or later

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742

Installation

Run the following command to generate the DLL

• [Mac/Linux] /bin/sh build.sh
• [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using LadybugDisplaySchema.Api;
using LadybugDisplaySchema.Client;
using LadybugDisplaySchema.Model;

Packaging

A .nuspec is included with the project. You can follow the Nuget quickstart to create and publish packages.

This .nuspec uses placeholders from the .csproj, so build the .csproj directly:

nuget pack -Build -OutputDirectory out LadybugDisplaySchema.csproj

Then, publish to a local feed or other host and consume the new package via Nuget as usual.

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using LadybugDisplaySchema.Api;
using LadybugDisplaySchema.Client;
using LadybugDisplaySchema.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

        }
    }
}

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description

Documentation for Models

• Model.AnalysisGeometry
• Model.AnalysisGeometryAllOf
• Model.Arc2D
• Model.Arc2DAllOf
• Model.Arc3D
• Model.Arc3DAllOf
• Model.Color
• Model.ColorAllOf
• Model.Cone
• Model.ConeAllOf
• Model.ContextGeometry
• Model.ContextGeometryAllOf
• Model.Cylinder
• Model.CylinderAllOf
• Model.DataType
• Model.DataTypeAllOf
• Model.DataTypes
• Model.Default
• Model.DefaultAllOf
• Model.DisplayArc2D
• Model.DisplayArc2DAllOf
• Model.DisplayArc3D
• Model.DisplayArc3DAllOf
• Model.DisplayBaseModel
• Model.DisplayBaseModelAllOf
• Model.DisplayCone
• Model.DisplayConeAllOf
• Model.DisplayCylinder
• Model.DisplayCylinderAllOf
• Model.DisplayFace3D
• Model.DisplayFace3DAllOf
• Model.DisplayLineSegment2D
• Model.DisplayLineSegment2DAllOf
• Model.DisplayLineSegment3D
• Model.DisplayLineSegment3DAllOf
• Model.DisplayMesh2D
• Model.DisplayMesh2DAllOf
• Model.DisplayMesh3D
• Model.DisplayMesh3DAllOf
• Model.DisplayModes
• Model.DisplayPlane
• Model.DisplayPlaneAllOf
• Model.DisplayPoint2D
• Model.DisplayPoint2DAllOf
• Model.DisplayPoint3D
• Model.DisplayPoint3DAllOf
• Model.DisplayPolyface3D
• Model.DisplayPolyface3DAllOf
• Model.DisplayPolygon2D
• Model.DisplayPolygon2DAllOf
• Model.DisplayPolyline2D
• Model.DisplayPolyline2DAllOf
• Model.DisplayPolyline3D
• Model.DisplayPolyline3DAllOf
• Model.DisplayRay2D
• Model.DisplayRay2DAllOf
• Model.DisplayRay3D
• Model.DisplayRay3DAllOf
• Model.DisplaySphere
• Model.DisplaySphereAllOf
• Model.DisplayText3D
• Model.DisplayText3DAllOf
• Model.DisplayVector2D
• Model.DisplayVector2DAllOf
• Model.DisplayVector3D
• Model.DisplayVector3DAllOf
• Model.Face3D
• Model.Face3DAllOf
• Model.GenericDataType
• Model.GenericDataTypeAllOf
• Model.HorizontalAlignments
• Model.Legend2DParameters
• Model.Legend2DParametersAllOf
• Model.Legend3DParameters
• Model.Legend3DParametersAllOf
• Model.LegendParameters
• Model.LegendParametersAllOf
• Model.LineCurveBase
• Model.LineCurveBaseAllOf
• Model.LineSegment2D
• Model.LineSegment2DAllOf
• Model.LineSegment3D
• Model.LineSegment3DAllOf
• Model.LineTypes
• Model.Mesh2D
• Model.Mesh2DAllOf
• Model.Mesh3D
• Model.Mesh3DAllOf
• Model.OpenAPIGenBaseModel
• Model.Plane
• Model.PlaneAllOf
• Model.Point2D
• Model.Point2DAllOf
• Model.Point3D
• Model.Point3DAllOf
• Model.Polyface3D
• Model.Polyface3DAllOf
• Model.PolyfaceEdgeInfo
• Model.PolyfaceEdgeInfoAllOf
• Model.Polygon2D
• Model.Polygon2DAllOf
• Model.Polyline2D
• Model.Polyline2DAllOf
• Model.Polyline3D
• Model.Polyline3DAllOf
• Model.Ray2D
• Model.Ray2DAllOf
• Model.Ray3D
• Model.Ray3DAllOf
• Model.SingleColorBase
• Model.SingleColorBaseAllOf
• Model.Sphere
• Model.SphereAllOf
• Model.Units
• Model.Vector2D
• Model.Vector2DAllOf
• Model.Vector3D
• Model.Vector3DAllOf
• Model.VerticalAlignments
• Model.VisualizationBase
• Model.VisualizationBaseAllOf
• Model.VisualizationData
• Model.VisualizationDataAllOf
• Model.VisualizationMetaData
• Model.VisualizationMetaDataAllOf
• Model.VisualizationSet
• Model.VisualizationSetAllOf

Documentation for Authorization

All endpoints do not require authorization.