Skip to content

DiGi.GIS.WebAPI.UI.ViewModels

github-actions[bot] edited this page Aug 21, 2026 · 6 revisions

DiGi.GIS.WebAPI.UI.ViewModels Namespace

Classes

AdministrativeAreal2DViewModel Class

Represents a view model for an administrative areal in 2D, providing access to its references and associated data.

public class AdministrativeAreal2DViewModel

Inheritance System.Object → AdministrativeAreal2DViewModel

Constructors

AdministrativeAreal2DViewModel() Constructor

Initializes a new instance of the AdministrativeAreal2DViewModel class.

public AdministrativeAreal2DViewModel();

AdministrativeAreal2DViewModel(AdministrativeAreal2DReference, AdministrativeAreal2D, AdministrativeAreal2DReferencePath, IEnumerable<AdministrativeAreal2DReference>) Constructor

Initializes a new instance of the AdministrativeAreal2DViewModel class with specified administrative areal data and references.

public AdministrativeAreal2DViewModel(DiGi.GIS.PostgreSQL.Classes.AdministrativeAreal2DReference? administrativeAreal2DReference, DiGi.GIS.Classes.AdministrativeAreal2D? administrativeAreal2D, DiGi.GIS.PostgreSQL.Classes.AdministrativeAreal2DReferencePath? administrativeAreal2DReferencePath, System.Collections.Generic.IEnumerable<DiGi.GIS.PostgreSQL.Classes.AdministrativeAreal2DReference>? administrativeAreal2DReferences);

Parameters

administrativeAreal2DReference DiGi.GIS.PostgreSQL.Classes.AdministrativeAreal2DReference

The reference to the administrative areal 2D.

administrativeAreal2D DiGi.GIS.Classes.AdministrativeAreal2D

The administrative areal 2D object.

administrativeAreal2DReferencePath DiGi.GIS.PostgreSQL.Classes.AdministrativeAreal2DReferencePath

The path reference for the administrative areal 2D.

administrativeAreal2DReferences System.Collections.Generic.IEnumerable<DiGi.GIS.PostgreSQL.Classes.AdministrativeAreal2DReference>

A collection of references to administrative areals 2D.

Properties

AdministrativeAreal2DViewModel.AdministrativeAreal2D Property

Gets the administrative areal 2D object.

public DiGi.GIS.Classes.AdministrativeAreal2D? AdministrativeAreal2D { get; }

Property Value

DiGi.GIS.Classes.AdministrativeAreal2D

AdministrativeAreal2DViewModel.AdministrativeAreal2DReference Property

Gets the reference to the administrative areal 2D.

public DiGi.GIS.PostgreSQL.Classes.AdministrativeAreal2DReference? AdministrativeAreal2DReference { get; }

Property Value

DiGi.GIS.PostgreSQL.Classes.AdministrativeAreal2DReference

AdministrativeAreal2DViewModel.AdministrativeAreal2DReferencePath Property

Gets the path reference for the administrative areal 2D.

public DiGi.GIS.PostgreSQL.Classes.AdministrativeAreal2DReferencePath? AdministrativeAreal2DReferencePath { get; }

Property Value

DiGi.GIS.PostgreSQL.Classes.AdministrativeAreal2DReferencePath

AdministrativeAreal2DViewModel.AdministrativeAreal2DReferences Property

Gets a list of references to administrative areals 2D.

public System.Collections.Generic.List<DiGi.GIS.PostgreSQL.Classes.AdministrativeAreal2DReference>? AdministrativeAreal2DReferences { get; }

Property Value

System.Collections.Generic.List<DiGi.GIS.PostgreSQL.Classes.AdministrativeAreal2DReference>

Building2DOccupancyDataViewModel Class

Represents a view model that provides combined access to Building2DReference and DiGi.GIS.Interfaces.IOccupancyData.

public class Building2DOccupancyDataViewModel

Inheritance System.Object → Building2DOccupancyDataViewModel

Constructors

Building2DOccupancyDataViewModel() Constructor

Initializes a new instance of the Building2DOccupancyDataViewModel class.

public Building2DOccupancyDataViewModel();

Building2DOccupancyDataViewModel(Building2DReference, IOccupancyData) Constructor

Initializes a new instance of the Building2DOccupancyDataViewModel class.

public Building2DOccupancyDataViewModel(DiGi.GIS.PostgreSQL.Classes.Building2DReference? building2DReference, DiGi.GIS.Interfaces.IOccupancyData? occupancyData);

Parameters

building2DReference DiGi.GIS.PostgreSQL.Classes.Building2DReference

The DiGi.GIS.PostgreSQL.Classes.Building2DReference reference to the 2D building, or null.

occupancyData DiGi.GIS.Interfaces.IOccupancyData

The DiGi.GIS.Interfaces.IOccupancyData containing occupancy data, or null.

Properties

Building2DOccupancyDataViewModel.Building2DReference Property

Gets the reference to the 2D building associated with this occupancy data view.

public DiGi.GIS.PostgreSQL.Classes.Building2DReference? Building2DReference { get; }

Property Value

DiGi.GIS.PostgreSQL.Classes.Building2DReference

Building2DOccupancyDataViewModel.OccupancyData Property

Gets the occupancy data associated with this building 2D occupancy data view.

public DiGi.GIS.Interfaces.IOccupancyData? OccupancyData { get; }

Property Value

DiGi.GIS.Interfaces.IOccupancyData

Building2DReferencesViewModel Class

Represents a view model containing a collection of 2D building references.

public class Building2DReferencesViewModel

Inheritance System.Object → Building2DReferencesViewModel

Constructors

Building2DReferencesViewModel() Constructor

Initializes a new instance of the Building2DReferencesViewModel class.

public Building2DReferencesViewModel();

Building2DReferencesViewModel(IEnumerable<Building2DReference>) Constructor

Initializes a new instance of the Building2DReferencesViewModel class with a specified collection of 2D building references.

public Building2DReferencesViewModel(System.Collections.Generic.IEnumerable<DiGi.GIS.PostgreSQL.Classes.Building2DReference>? building2DReferences);

Parameters

building2DReferences System.Collections.Generic.IEnumerable<DiGi.GIS.PostgreSQL.Classes.Building2DReference>

The collection of DiGi.GIS.PostgreSQL.Classes.Building2DReference objects to initialize the view model with.

Properties

Building2DReferencesViewModel.Building2DReferences Property

Gets the list of 2D building references associated with this view.

public System.Collections.Generic.List<DiGi.GIS.PostgreSQL.Classes.Building2DReference>? Building2DReferences { get; }

Property Value

System.Collections.Generic.List<DiGi.GIS.PostgreSQL.Classes.Building2DReference>

Building2DViewModel Class

Represents a 2D view model of a building, providing access to its reference, spatial data, and administrative areal path.

public class Building2DViewModel

Inheritance System.Object → Building2DViewModel

Constructors

Building2DViewModel() Constructor

Initializes a new instance of the Building2DViewModel class.

public Building2DViewModel();

Building2DViewModel(Building2DReference, Building2D, AdministrativeAreal2DReferencePath) Constructor

Initializes a new instance of the Building2DViewModel class.

public Building2DViewModel(DiGi.GIS.PostgreSQL.Classes.Building2DReference? building2DReference, DiGi.GIS.Classes.Building2D? building2D, DiGi.GIS.PostgreSQL.Classes.AdministrativeAreal2DReferencePath? administrativeAreal2DReferencePath);

Parameters

building2DReference DiGi.GIS.PostgreSQL.Classes.Building2DReference

The DiGi.GIS.PostgreSQL.Classes.Building2DReference for the building.

building2D DiGi.GIS.Classes.Building2D

The Building2D associated with this view model.

administrativeAreal2DReferencePath DiGi.GIS.PostgreSQL.Classes.AdministrativeAreal2DReferencePath

The DiGi.GIS.PostgreSQL.Classes.AdministrativeAreal2DReferencePath for the building.

Properties

Building2DViewModel.AdministrativeAreal2DReferencePath Property

Gets the collection of administrative 2D area references for this building view.

public DiGi.GIS.PostgreSQL.Classes.AdministrativeAreal2DReferencePath? AdministrativeAreal2DReferencePath { get; }

Property Value

DiGi.GIS.PostgreSQL.Classes.AdministrativeAreal2DReferencePath

Building2DViewModel.Building2D Property

Gets the 2D building associated with this view.

public DiGi.GIS.Classes.Building2D? Building2D { get; }

Property Value

DiGi.GIS.Classes.Building2D

Building2DViewModel.Building2DReference Property

Gets the reference to the 2D building associated with this view.

public DiGi.GIS.PostgreSQL.Classes.Building2DReference? Building2DReference { get; }

Property Value

DiGi.GIS.PostgreSQL.Classes.Building2DReference

CommunicationSceneViewModel Class

Represents a view model for the communication 3D scene view: the buildings of the analyzed circular area (streamed as a binary glTF payload) plus the input parameters required to send the communication calculation request back to the server.

public class CommunicationSceneViewModel

Inheritance System.Object → CommunicationSceneViewModel

Constructors

CommunicationSceneViewModel(string, string, double, double, double) Constructor

Initializes a new instance of the CommunicationSceneViewModel class.

public CommunicationSceneViewModel(string? title, string? gLBUrl, double centerX, double centerY, double radius);

Parameters

title System.String

The title displayed above the viewer.

gLBUrl System.String

The application relative URL of the binary glTF (.glb) endpoint.

centerX System.Double

The X coordinate of the center of the analyzed circular area.

centerY System.Double

The Y coordinate of the center of the analyzed circular area.

radius System.Double

The radius of the analyzed circular area in meters.

Properties

CommunicationSceneViewModel.CenterX Property

Gets the X coordinate of the center of the analyzed circular area.

public double CenterX { get; }

Property Value

System.Double

CommunicationSceneViewModel.CenterY Property

Gets the Y coordinate of the center of the analyzed circular area.

public double CenterY { get; }

Property Value

System.Double

CommunicationSceneViewModel.GLBUrl Property

Gets the application relative URL of the binary glTF (.glb) endpoint.

public string? GLBUrl { get; }

Property Value

System.String

CommunicationSceneViewModel.Radius Property

Gets the radius of the analyzed circular area in meters.

public double Radius { get; }

Property Value

System.Double

CommunicationSceneViewModel.Title Property

Gets the title displayed above the viewer.

public string? Title { get; }

Property Value

System.String

EPWFileViewModel Class

Represents a view model for an EPW file, providing access to the underlying weather data and structure.

public class EPWFileViewModel

Inheritance System.Object → EPWFileViewModel

Constructors

EPWFileViewModel() Constructor

Initializes a new instance of the EPWFileViewModel class.

public EPWFileViewModel();

EPWFileViewModel(EPWFile) Constructor

Initializes a new instance of the EPWFileViewModel class.

public EPWFileViewModel(DiGi.EPW.Classes.EPWFile? epwFile);

Parameters

epwFile DiGi.EPW.Classes.EPWFile

The EPW file to be associated with this view model.

Properties

EPWFileViewModel.EPWFile Property

Gets the EPW file associated with the EPW file view.

public DiGi.EPW.Classes.EPWFile? EPWFile { get; }

Property Value

DiGi.EPW.Classes.EPWFile

GLTFSceneViewModel Class

Represents a view model for rendering a GLTFScene in the 3D glTF viewer.

Two delivery modes are supported: streamed (the view carries only GLBUrl and the viewer fetches the binary glTF payload, whose scene extras are fully self-describing) and embedded (the scene JSON and the base64 encoded payload are inlined in the page).

public class GLTFSceneViewModel

Inheritance System.Object → GLTFSceneViewModel

Constructors

GLTFSceneViewModel() Constructor

Initializes a new instance of the GLTFSceneViewModel class.

public GLTFSceneViewModel();

GLTFSceneViewModel(GLTFScene, string, string, string) Constructor

Initializes a new instance of the GLTFSceneViewModel class for embedded delivery.

public GLTFSceneViewModel(DiGi.GLTF.Classes.GLTFScene? gLTFScene, string? gLTFSceneJson, string? gLBBase64, string? title);

Parameters

gLTFScene DiGi.GLTF.Classes.GLTFScene

The GLTFScene to be rendered.

gLTFSceneJson System.String

The JSON representation of the scene used by the viewer for lights, camera and reference point configuration.

gLBBase64 System.String

The base64 encoded binary glTF (.glb) payload rendered by the viewer.

title System.String

The title displayed above the viewer.

GLTFSceneViewModel(string, string, string) Constructor

Initializes a new instance of the GLTFSceneViewModel class for streamed delivery: the viewer fetches the binary glTF payload from gLBUrl and reads the scene configuration from its extras.

public GLTFSceneViewModel(string? title, string? gLBUrl, string? scopeBoxSize=null);

Parameters

title System.String

The title displayed above the viewer.

gLBUrl System.String

The application relative URL of the binary glTF (.glb) endpoint.

scopeBoxSize System.String

The default scope box preset in the form "halfX;halfY;zMin;zMax" (DiGi coordinates) passed to the viewer, or null for the bounds-fit default. This value can be null.

Properties

GLTFSceneViewModel.GLBBase64 Property

Gets the base64 encoded binary glTF (.glb) payload rendered by the viewer (embedded delivery only).

public string? GLBBase64 { get; }

Property Value

System.String

GLTFSceneViewModel.GLBUrl Property

Gets the application relative URL of the binary glTF (.glb) endpoint (streamed delivery only).

public string? GLBUrl { get; }

Property Value

System.String

GLTFSceneViewModel.GLTFScene Property

Gets the GLTFScene to be rendered (embedded delivery only).

public DiGi.GLTF.Classes.GLTFScene? GLTFScene { get; }

Property Value

DiGi.GLTF.Classes.GLTFScene

GLTFSceneViewModel.GLTFSceneJson Property

Gets the JSON representation of the scene used by the viewer for lights, camera and reference point configuration (embedded delivery only).

public string? GLTFSceneJson { get; }

Property Value

System.String

GLTFSceneViewModel.ScopeBoxSize Property

Gets the default scope box preset in the form "halfX;halfY;zMin;zMax" (DiGi coordinates) passed to the viewer, or null for the bounds-fit default.

public string? ScopeBoxSize { get; }

Property Value

System.String

GLTFSceneViewModel.Title Property

Gets the title displayed above the viewer.

public string? Title { get; }

Property Value

System.String

OrtoDatasViewModel Class

Represents a view model that combines orthographic data and a 2D building reference.

public class OrtoDatasViewModel

Inheritance System.Object → OrtoDatasViewModel

Constructors

OrtoDatasViewModel() Constructor

Initializes a new instance of the OrtoDatasViewModel class.

public OrtoDatasViewModel();

OrtoDatasViewModel(Building2DReference, OrtoDatas) Constructor

Initializes a new instance of the OrtoDatasViewModel class with the specified building reference and orthographic data.

public OrtoDatasViewModel(DiGi.GIS.PostgreSQL.Classes.Building2DReference? building2DReference, DiGi.GIS.Classes.OrtoDatas? ortoDatas);

Parameters

building2DReference DiGi.GIS.PostgreSQL.Classes.Building2DReference

The reference to the 2D building.

ortoDatas DiGi.GIS.Classes.OrtoDatas

The orthographic data associated with the view model.

Properties

OrtoDatasViewModel.Building2DReference Property

Gets the reference to the 2D building associated with this view.

public DiGi.GIS.PostgreSQL.Classes.Building2DReference? Building2DReference { get; }

Property Value

DiGi.GIS.PostgreSQL.Classes.Building2DReference

OrtoDatasViewModel.OrtoDatas Property

Gets the orthographic data associated with this view.

public DiGi.GIS.Classes.OrtoDatas? OrtoDatas { get; }

Property Value

DiGi.GIS.Classes.OrtoDatas

RegulatedHeatTransferCoefficientsViewModel Class

Represents a view model of the regulated heat transfer coefficients.

public class RegulatedHeatTransferCoefficientsViewModel

Inheritance System.Object → RegulatedHeatTransferCoefficientsViewModel

Constructors

RegulatedHeatTransferCoefficientsViewModel() Constructor

Initializes a new instance of the RegulatedHeatTransferCoefficientsViewModel class.

public RegulatedHeatTransferCoefficientsViewModel();

RegulatedHeatTransferCoefficientsViewModel(short, IRegulatedHeatTransferCoefficients, Nullable<bool>) Constructor

Initializes a new instance of the RegulatedHeatTransferCoefficientsViewModel class.

public RegulatedHeatTransferCoefficientsViewModel(short year, DiGi.Analytical.Building.HVAC.Interfaces.IRegulatedHeatTransferCoefficients? regulatedHeatTransferCoefficients, System.Nullable<bool> isResidential);

Parameters

year System.Int16

The year associated with the regulated heat transfer coefficients.

regulatedHeatTransferCoefficients DiGi.Analytical.Building.HVAC.Interfaces.IRegulatedHeatTransferCoefficients

The regulated heat transfer coefficients.

isResidential System.Nullable<System.Boolean>

A value indicating whether the building is residential.

Properties

RegulatedHeatTransferCoefficientsViewModel.IsResidential Property

Gets a value indicating whether the building is residential.

public System.Nullable<bool> IsResidential { get; }

Property Value

System.Nullable<System.Boolean>

RegulatedHeatTransferCoefficientsViewModel.RegulatedHeatTransferCoefficients Property

Gets the regulated heat transfer coefficients.

public DiGi.Analytical.Building.HVAC.Interfaces.IRegulatedHeatTransferCoefficients? RegulatedHeatTransferCoefficients { get; }

Property Value

DiGi.Analytical.Building.HVAC.Interfaces.IRegulatedHeatTransferCoefficients

RegulatedHeatTransferCoefficientsViewModel.Year Property

Gets the year associated with the regulated heat transfer coefficients.

public short Year { get; }

Property Value

System.Int16

TableViewModel Class

Represents a view model for a PostgreSQL table, providing access to the underlying table data and structure.

public class TableViewModel

Inheritance System.Object → TableViewModel

Constructors

TableViewModel() Constructor

Initializes a new instance of the TableViewModel class.

public TableViewModel();

TableViewModel(Table) Constructor

Initializes a new instance of the TableViewModel class.

public TableViewModel(DiGi.PostgreSQL.Table.Classes.Table? table);

Parameters

table DiGi.PostgreSQL.Table.Classes.Table

The PostgreSQL table to be associated with this view model.

Properties

TableViewModel.Table Property

Gets the table associated with the table view.

public DiGi.PostgreSQL.Table.Classes.Table? Table { get; }

Property Value

DiGi.PostgreSQL.Table.Classes.Table

YearBuiltDataViewModel Class

Represents a view model that associates a 2D building reference with its corresponding year built data.

public class YearBuiltDataViewModel

Inheritance System.Object → YearBuiltDataViewModel

Constructors

YearBuiltDataViewModel() Constructor

Initializes a new instance of the YearBuiltDataViewModel class.

public YearBuiltDataViewModel();

YearBuiltDataViewModel(Building2DReference, IYearBuiltData) Constructor

Initializes a new instance of the YearBuiltDataViewModel class with specified building reference and year built data.

public YearBuiltDataViewModel(DiGi.GIS.PostgreSQL.Classes.Building2DReference? building2DReference, DiGi.GIS.Interfaces.IYearBuiltData? yearBuiltData);

Parameters

building2DReference DiGi.GIS.PostgreSQL.Classes.Building2DReference

The reference to the 2D building.

yearBuiltData DiGi.GIS.Interfaces.IYearBuiltData

The year built data associated with the building.

Properties

YearBuiltDataViewModel.Building2DReference Property

Gets the reference to the 2D building.

public DiGi.GIS.PostgreSQL.Classes.Building2DReference? Building2DReference { get; }

Property Value

DiGi.GIS.PostgreSQL.Classes.Building2DReference

YearBuiltDataViewModel.YearBuiltData Property

Gets the year built data associated with the building.

public DiGi.GIS.Interfaces.IYearBuiltData? YearBuiltData { get; }

Property Value

DiGi.GIS.Interfaces.IYearBuiltData

Clone this wiki locally