Skip to content

DiGi.GIS.WebAPI.UI.ViewModels

github-actions[bot] edited this page Sep 28, 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>

Building2DCentroidViewModel Class

One building dot of a 2D area view: the bounding-box centre of a building_2d row, keyed by the reference and the county part the row is filed under.

A building reference is unique only per county partition - a reference is stored once per county part it was imported under - so the county identifier travels with the reference for any caller-side join, such as the Typology area view's join with the solved typology assignment. X and Y are the centre of the row's bounding-box columns in the same coordinate reference system the point2dsbyreferences endpoint answers in (PL-1992, EPSG:2180, metres). Row order is not contractual.

A relay of DiGi.GIS.PostgreSQL.Classes.Building2DCentroid without its _type discriminator: the browser never spells a type name, and the discriminator alone is most of the upstream payload for a county-sized area.

public class Building2DCentroidViewModel

Inheritance System.Object → Building2DCentroidViewModel

Constructors

Building2DCentroidViewModel() Constructor

Initializes a new instance of the Building2DCentroidViewModel class.

public Building2DCentroidViewModel();

Building2DCentroidViewModel(string, int, double, double) Constructor

Initializes a new instance of the Building2DCentroidViewModel class.

public Building2DCentroidViewModel(string reference, int countyId, double x, double y);

Parameters

reference System.String

The building reference key.

countyId System.Int32

The county part identifier the building row is filed under.

x System.Double

The X coordinate of the bounding-box centre.

y System.Double

The Y coordinate of the bounding-box centre.

Properties

Building2DCentroidViewModel.CountyId Property

Gets the county part identifier the building row is filed under.

public int CountyId { get; set; }

Property Value

System.Int32

Building2DCentroidViewModel.Reference Property

Gets the building reference key, as addressed by the GIS Web API.

public string Reference { get; set; }

Property Value

System.String

Building2DCentroidViewModel.X Property

Gets the X coordinate of the bounding-box centre, in PL-1992 (EPSG:2180) metres.

public double X { get; set; }

Property Value

System.Double

Building2DCentroidViewModel.Y Property

Gets the Y coordinate of the bounding-box centre, in PL-1992 (EPSG:2180) metres.

public double Y { get; set; }

Property Value

System.Double

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" or "halfX;halfY" (DiGi coordinates; the latter lets the viewer fit the Z range to the buildings' elevation) 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" or "halfX;halfY" (DiGi coordinates; the latter lets the viewer fit the Z range to the buildings' elevation) 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

SolarJobViewModel Class

Represents the state of a background solar radiation job as the solar/jobs routes answer it and the solar radiation viewer polls it.

public class SolarJobViewModel

Inheritance System.Object → SolarJobViewModel

Constructors

SolarJobViewModel(string, string, Nullable<int>, double, int, string) Constructor

Initializes a new instance of the SolarJobViewModel class.

public SolarJobViewModel(string jobId, string status, System.Nullable<int> queuePosition, double elapsedSeconds, int receiverCount, string? error);

Parameters

jobId System.String

The unique identifier of the job.

status System.String

The state of the job, the name of an SolarJobStatus member.

queuePosition System.Nullable<System.Int32>

The place of the job in the queue (0 while it runs), or null once it has finished.

elapsedSeconds System.Double

The seconds spent in the current state: waiting while queued, calculating while running, and the calculation time once finished.

receiverCount System.Int32

The number of receiving surfaces (external walls and roofs) the job calculates.

error System.String

The error text of a failed job.

Properties

SolarJobViewModel.ElapsedSeconds Property

Gets the seconds spent in the current state: waiting while queued, calculating while running, and the calculation time once finished.

public double ElapsedSeconds { get; }

Property Value

System.Double

SolarJobViewModel.Error Property

Gets the error text of a failed job.

public string? Error { get; }

Property Value

System.String

SolarJobViewModel.JobId Property

Gets the unique identifier of the job.

public string JobId { get; }

Property Value

System.String

SolarJobViewModel.QueuePosition Property

Gets the place of the job in the queue (0 while it runs), or null once it has finished.

public System.Nullable<int> QueuePosition { get; }

Property Value

System.Nullable<System.Int32>

SolarJobViewModel.ReceiverCount Property

Gets the number of receiving surfaces (external walls and roofs) the job calculates.

public int ReceiverCount { get; }

Property Value

System.Int32

SolarJobViewModel.Status Property

Gets the state of the job, the name of an SolarJobStatus member; a name rather than the number the JSON serializer would write for the enum.

public string Status { get; }

Property Value

System.String

SolarSceneViewModel Class

Represents a view model for the solar radiation 3D scene view: the building and its neighbours, streamed as a binary glTF payload with the receiving surfaces coloured by their annual irradiation, plus what the legend states about the calculation.

public class SolarSceneViewModel

Inheritance System.Object → SolarSceneViewModel

Constructors

SolarSceneViewModel(string, string, string, string, double, string, string) Constructor

Initializes a new instance of the SolarSceneViewModel class.

public SolarSceneViewModel(string? title, string? gLBUrl, string? jobsUrl, string? jobQuery, double radius, string? stationName, string? stationUrl);

Parameters

title System.String

The title displayed above the viewer.

gLBUrl System.String

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

jobsUrl System.String

The application relative URL of the background job routes (solar/jobs), offered when the scene request is refused as too large.

jobQuery System.String

The query string (id, countyid, radius) a background job is posted with.

radius System.Double

The neighbour radius in metres, measured from the edge of the footprint.

stationName System.String

The name of the EPW weather station, or null when the file does not state it.

stationUrl System.String

The application relative URL of the EPW weather file page of the station.

Properties

SolarSceneViewModel.GLBUrl Property

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

public string? GLBUrl { get; }

Property Value

System.String

SolarSceneViewModel.JobQuery Property

Gets the query string (id, countyid, radius) a background job is posted with.

public string? JobQuery { get; }

Property Value

System.String

SolarSceneViewModel.JobsUrl Property

Gets the application relative URL of the background job routes (solar/jobs), offered when the scene request is refused as too large.

public string? JobsUrl { get; }

Property Value

System.String

SolarSceneViewModel.Radius Property

Gets the neighbour radius in metres, measured from the edge of the footprint.

public double Radius { get; }

Property Value

System.Double

SolarSceneViewModel.StationName Property

Gets the name of the EPW weather station, or null when the file does not state it.

public string? StationName { get; }

Property Value

System.String

SolarSceneViewModel.StationUrl Property

Gets the application relative URL of the EPW weather file page of the station.

public string? StationUrl { get; }

Property Value

System.String

SolarSceneViewModel.Title Property

Gets the title displayed above the viewer.

public string? Title { get; }

Property Value

System.String

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

TypologyAreaCountViewModel Class

The pre-flight answer of GET /typology/buildingcount: how many buildings a Typology solve of an area reads, known before the solve starts, so the area view can say what it is waiting for (DiGi.GIS.WebAPI.UI#29, B1).

public class TypologyAreaCountViewModel

Inheritance System.Object → TypologyAreaCountViewModel

Constructors

TypologyAreaCountViewModel() Constructor

Initializes a new instance of the TypologyAreaCountViewModel class.

public TypologyAreaCountViewModel();

TypologyAreaCountViewModel(Nullable<long>, int, int, bool) Constructor

Initializes a new instance of the TypologyAreaCountViewModel class.

public TypologyAreaCountViewModel(System.Nullable<long> count, int countyPartCount, int ceiling, bool clipped);

Parameters

count System.Nullable<System.Int64>

The number of buildings the solve reads, or null when it is not counted.

countyPartCount System.Int32

The number of county parts the solve reads.

ceiling System.Int32

The number of buildings above which a solve is refused.

clipped System.Boolean

A value indicating whether the solve clips its county parts to the area's polygon.

Properties

TypologyAreaCountViewModel.Ceiling Property

Gets the number of buildings above which a solve is refused with a 413 (BuildingSolveCeiling).

public int Ceiling { get; }

Property Value

System.Int32

TypologyAreaCountViewModel.Clipped Property

Gets a value indicating whether the area is a municipality or subdivision, whose county parts are clipped to its polygon after the read - so Count is an upper bound ("up to") rather than the area's count.

public bool Clipped { get; }

Property Value

System.Boolean

TypologyAreaCountViewModel.Count Property

Gets the number of buildings the solve reads: the sum over the area's county parts. For a clipped area it is the count of the county parts the area lies in, an upper bound of the area's own buildings. Null for a country, which is not counted - it is refused as above the ceiling outright.

public System.Nullable<long> Count { get; }

Property Value

System.Nullable<System.Int64>

TypologyAreaCountViewModel.CountyPartCount Property

Gets the number of county parts the solve reads.

public int CountyPartCount { get; }

Property Value

System.Int32

TypologyBuildingsViewModel Class

The response of POST /typology/buildings: the solved Typology tree and the flat building list the view renders as dots.

The Root is the recursive tree the view renders as the typology panel: each node carries its name, description, color and children. The Buildings is the flat list of building entries, one per reference the solve classified, each filed under the deepest node holding it - a leaf bucket, or the bucket whose next level dropped the row; the view joins each entry to its dot position by (Reference, CountyId) against the area-scoped centroid endpoint.

public class TypologyBuildingsViewModel

Inheritance System.Object → TypologyBuildingsViewModel

Constructors

TypologyBuildingsViewModel() Constructor

Initializes a new instance of the TypologyBuildingsViewModel class.

public TypologyBuildingsViewModel();

TypologyBuildingsViewModel(TypologyTreeNodeViewModel, List<TypologyBuildingViewModel>) Constructor

Initializes a new instance of the TypologyBuildingsViewModel class.

public TypologyBuildingsViewModel(DiGi.GIS.WebAPI.UI.ViewModels.TypologyTreeNodeViewModel? root, System.Collections.Generic.List<DiGi.GIS.WebAPI.UI.ViewModels.TypologyBuildingViewModel> buildings);

Parameters

root TypologyTreeNodeViewModel

The root of the solved typology tree, or null when the solve produced no nodes.

buildings System.Collections.Generic.List<TypologyBuildingViewModel>

The flat list of building entries, one per classified reference, filed under the deepest node holding it.

Properties

TypologyBuildingsViewModel.Buildings Property

Gets the flat list of building entries, one per classified reference, filed under the deepest node holding it, emitted in the sorted tree's order.

public System.Collections.Generic.List<DiGi.GIS.WebAPI.UI.ViewModels.TypologyBuildingViewModel> Buildings { get; set; }

Property Value

System.Collections.Generic.List<TypologyBuildingViewModel>

TypologyBuildingsViewModel.Root Property

Gets the root of the solved typology tree.

public DiGi.GIS.WebAPI.UI.ViewModels.TypologyTreeNodeViewModel? Root { get; set; }

Property Value

TypologyTreeNodeViewModel

TypologyBuildingViewModel Class

One building entry of the Typology area view: the reference that identifies it in the GIS Web API, the county part it was fetched from, and the path of the typology bucket it was solved into.

Coordinates are intentionally absent: the dot positions come from the area-scoped centroid endpoint in DiGi.GIS.WebAPI, joined in the view by (Reference, CountyId). The Path is the filing index chain of the deepest typology bucket holding the building, one integer per level - a leaf's path, or a bucket's own path for a row its next level dropped - which the view uses to locate the node in the tree for the centroid join, the dimming and the grid.

The Id is the building's database identifier, read from the building data table's Database Id column. It serves the links to the 2D details page and the 3D viewer, which address a building by that identifier - it takes no part in the centroid join.

public class TypologyBuildingViewModel

Inheritance System.Object → TypologyBuildingViewModel

Constructors

TypologyBuildingViewModel() Constructor

Initializes a new instance of the TypologyBuildingViewModel class.

public TypologyBuildingViewModel();

TypologyBuildingViewModel(string, long, int, List<int>) Constructor

Initializes a new instance of the TypologyBuildingViewModel class.

public TypologyBuildingViewModel(string reference, long id, int countyId, System.Collections.Generic.List<int> path);

Parameters

reference System.String

The building reference key.

id System.Int64

The building's database identifier, or 0 when unknown.

countyId System.Int32

The county part identifier the building was fetched from.

path System.Collections.Generic.List<System.Int32>

The typology path, one filing index per level.

Properties

TypologyBuildingViewModel.CountyId Property

Gets the county part identifier the building was fetched from.

public int CountyId { get; set; }

Property Value

System.Int32

TypologyBuildingViewModel.Id Property

Gets the building's database identifier - the Building2DReference.Id the 2D details and the 3D viewer routes address - or 0 when the column was not projected or the row carried none.

public long Id { get; set; }

Property Value

System.Int64

TypologyBuildingViewModel.Path Property

Gets the typology path, one filing index per level, identifying the deepest bucket the building was solved into.

public System.Collections.Generic.List<int> Path { get; set; }

Property Value

System.Collections.Generic.List<System.Int32>

TypologyBuildingViewModel.Reference Property

Gets the building reference key, as addressed by the GIS Web API.

public string Reference { get; set; }

Property Value

System.String

TypologyChildAreaViewModel Class

One area of GET /typology/childareas: an area one level below one too large for a Typology solve, which the area view offers to open instead (DiGi.GIS.WebAPI.UI#29, B2).

public class TypologyChildAreaViewModel

Inheritance System.Object → TypologyChildAreaViewModel

Constructors

TypologyChildAreaViewModel() Constructor

Initializes a new instance of the TypologyChildAreaViewModel class.

public TypologyChildAreaViewModel();

TypologyChildAreaViewModel(int, string, string, int, Nullable<long>) Constructor

Initializes a new instance of the TypologyChildAreaViewModel class.

public TypologyChildAreaViewModel(int id, string? code, string? name, int administrativeArealType, System.Nullable<long> count);

Parameters

id System.Int32

The identifier the area view opens the area with - the lowest of its polygon parts.

code System.String

The TERYT code of the area.

name System.String

The name of the area.

administrativeArealType System.Int32

The administrative level of the area, as the integer the area view carries.

count System.Nullable<System.Int64>

The number of buildings of the area, or null when it is not counted.

Properties

TypologyChildAreaViewModel.AdministrativeArealType Property

Gets the administrative level of the area, as the integer of AdministrativeArealType the area view carries in its query string.

public int AdministrativeArealType { get; }

Property Value

System.Int32

TypologyChildAreaViewModel.Code Property

Gets the TERYT code of the area.

public string? Code { get; }

Property Value

System.String

TypologyChildAreaViewModel.Count Property

Gets the number of buildings of the area: exact for a county (the sum over its parts), null for a voivodeship (not counted) or when the count could not be read.

public System.Nullable<long> Count { get; }

Property Value

System.Nullable<System.Int64>

TypologyChildAreaViewModel.Id Property

Gets the identifier the area view opens the area with: the lowest of its polygon parts, since a solve resolves every part from the code.

public int Id { get; }

Property Value

System.Int32

TypologyChildAreaViewModel.Name Property

Gets the name of the area.

public string? Name { get; }

Property Value

System.String

TypologyColumnViewModel Class

Represents a single building-data column available for typology grouping, as listed in the Available Columns section.

public class TypologyColumnViewModel

Inheritance System.Object → TypologyColumnViewModel

Constructors

TypologyColumnViewModel() Constructor

Initializes a new instance of the TypologyColumnViewModel class.

public TypologyColumnViewModel();

TypologyColumnViewModel(Column) Constructor

Initializes a new instance of the TypologyColumnViewModel class from a deployed GIS Web API DiGi.PostgreSQL.Table.Classes.Column.

public TypologyColumnViewModel(DiGi.PostgreSQL.Table.Classes.Column column);

Parameters

column DiGi.PostgreSQL.Table.Classes.Column

The source column.

Properties

TypologyColumnViewModel.Category Property

Gets the category grouping of the column.

public string? Category { get; }

Property Value

System.String

TypologyColumnViewModel.DataType Property

Gets the integer data type value (0 Undefined through 14 String).

public int DataType { get; }

Property Value

System.Int32

TypologyColumnViewModel.Description Property

Gets the description of the column.

public string? Description { get; }

Property Value

System.String

TypologyColumnViewModel.IsNumeric Property

Gets a value indicating whether the column is numeric and eligible for a Range rule.

public bool IsNumeric { get; }

Property Value

System.Boolean

TypologyColumnViewModel.Name Property

Gets the display name of the column.

public string? Name { get; }

Property Value

System.String

TypologyColumnViewModel.UniqueId Property

Gets the unique identifier (slug) of the column, as addressed by the deployed GIS Web API.

public string? UniqueId { get; }

Property Value

System.String

TypologyTreeNodeViewModel Class

One node of the solved Typology tree as rendered by the area view: the bucket name, description, color and children.

The Color is a CSS hex string (#rrggbb) read from the node's TypologyAppearance via Color(this TypologyAppearance), not a System.Drawing.Color — the view paints CSS, and a serialized color type would add a dependency the page does not need.

The Path is the filing index chain of this node, one integer per level from the root. The view uses it to locate the node in the tree for the centroid join with the building dot positions.

The Count is the number of buildings filed under this node (issue #24). A bucket node counts its own reference set - every row that matched it, including rows that resolved to no bucket at a lower level - so a parent's count can exceed the sum of its children's counts; the root, which the solver never files references on, counts the sum of its children. Every building the count includes is listed in the flat building list under this node or one below it, so the count always equals the buildings the view can show for the node.

public class TypologyTreeNodeViewModel

Inheritance System.Object → TypologyTreeNodeViewModel

Constructors

TypologyTreeNodeViewModel() Constructor

Initializes a new instance of the TypologyTreeNodeViewModel class.

public TypologyTreeNodeViewModel();

TypologyTreeNodeViewModel(string, string, string, List<int>, int, List<TypologyTreeNodeViewModel>) Constructor

Initializes a new instance of the TypologyTreeNodeViewModel class.

public TypologyTreeNodeViewModel(string? name, string? description, string? color, System.Collections.Generic.List<int> path, int count, System.Collections.Generic.List<DiGi.GIS.WebAPI.UI.ViewModels.TypologyTreeNodeViewModel>? children);

Parameters

name System.String

The bucket name, as the solver named it.

description System.String

The bucket description, or null when the column carries none.

color System.String

The bucket color as a CSS hex string, or null when the rule maps none for this bucket.

path System.Collections.Generic.List<System.Int32>

The typology path, one filing index per level from the root.

count System.Int32

The number of buildings filed under this node.

children System.Collections.Generic.List<TypologyTreeNodeViewModel>

The sub-typology nodes in ascending bucket value, or null when this node is a leaf.

Properties

TypologyTreeNodeViewModel.Children Property

Gets the sub-typology nodes in ascending bucket value - a range by its Min, a unique value by the value itself - or null when this node is a leaf.

public System.Collections.Generic.List<DiGi.GIS.WebAPI.UI.ViewModels.TypologyTreeNodeViewModel>? Children { get; set; }

Property Value

System.Collections.Generic.List<TypologyTreeNodeViewModel>

TypologyTreeNodeViewModel.Color Property

Gets the bucket color as a CSS hex string (#rrggbb), or null when the rule maps no appearance for this bucket.

public string? Color { get; set; }

Property Value

System.String

TypologyTreeNodeViewModel.Count Property

Gets the number of buildings filed under this node: a bucket's own reference set (every row that matched it, including rows dropped at a lower level, so a parent can exceed the sum of its children), or the sum of the children for the root.

public int Count { get; set; }

Property Value

System.Int32

TypologyTreeNodeViewModel.Description Property

Gets the bucket description, the column's description when the column carries one.

public string? Description { get; set; }

Property Value

System.String

TypologyTreeNodeViewModel.Name Property

Gets the bucket name, as the solver named it: the level's column name and the rule data's text.

public string? Name { get; set; }

Property Value

System.String

TypologyTreeNodeViewModel.Path Property

Gets the typology path, one filing index per level from the root.

public System.Collections.Generic.List<int> Path { get; set; }

Property Value

System.Collections.Generic.List<System.Int32>

TypologyViewViewModel Class

Represents the administrative-area context the Typology Load modal redirected with: the area the colour-coded building typology is solved for, shown in the Administrative Area card of the area view.

public class TypologyViewViewModel

Inheritance System.Object → TypologyViewViewModel

Constructors

TypologyViewViewModel() Constructor

Initializes a new instance of the TypologyViewViewModel class.

public TypologyViewViewModel();

TypologyViewViewModel(int, string, AdministrativeArealType, string) Constructor

Initializes a new instance of the TypologyViewViewModel class from the query context of the Load modal redirect.

public TypologyViewViewModel(int id, string? code, DiGi.GIS.PostgreSQL.Enums.AdministrativeArealType administrativeArealType, string? name);

Parameters

id System.Int32

The unique identifier of the administrative area.

code System.String

The code of the administrative area.

administrativeArealType DiGi.GIS.PostgreSQL.Enums.AdministrativeArealType

The type of the administrative area.

name System.String

The name of the administrative area, or null when it could not be read.

Properties

TypologyViewViewModel.AdministrativeArealType Property

Gets the type of the administrative area.

public DiGi.GIS.PostgreSQL.Enums.AdministrativeArealType AdministrativeArealType { get; }

Property Value

DiGi.GIS.PostgreSQL.Enums.AdministrativeArealType

TypologyViewViewModel.AdministrativeArealTypeName Property

Gets the display name of the administrative area type.

public string AdministrativeArealTypeName { get; }

Property Value

System.String

TypologyViewViewModel.Code Property

Gets the code of the administrative area.

public string? Code { get; }

Property Value

System.String

TypologyViewViewModel.Id Property

Gets the unique identifier of the administrative area.

public int Id { get; }

Property Value

System.Int32

TypologyViewViewModel.Name Property

Gets the name of the administrative area, read from the GIS Web API by the area identifier, or null when the lookup answered nothing - the page then shows the context it carries on the query alone.

public string? Name { get; }

Property Value

System.String

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