Project

The project aims to develop a comprehensive floorplan management system using JSON format. It allows users to create, visualize, and edit architectural floor plans effortlessly. The system supports metric and imperial units, grid display, and drop shadows. Users can customize object appearance, including structural colors and light visibility. The system offers options for 2D and 3D export and features intuitive labeling and dimensioning. The design includes a user-friendly interface and accommodates public or private project settings. With seamless integration of background images, it facilitates clear visualization of floor layouts. The project empowers architects and designers to collaborate effectively while ensuring data privacy and security.

{
  'id': Integer,
  'name': String,
  'description': Text,
  'public': Boolean,
  'settings': Settings,
  'floors': Floor[]
}

Properties

Name	Type	Description	Default
id	Integer	This property contains an integer value, which can be used as a unique identifier for the object
name	String	This property can be used to give the floorplan a name
description	Text	This property can be used to give the floorplan a description
public	Boolean	Toggling true/false in this property will make the project publicly accessible or not	false
settings	Object	This property contains the object of project settings
floors	Array	This property contains an array of objects of type Floor, which represents the different floors of a building or similar structure

Settings

The "settings" part of the floorplan project JSON structure contains a set of configurable parameters that enable users to customize the appearance and behavior of the floorplan visualization. Users can control various aspects of the floorplan, such as wall height, thickness, and outer thickness. The system offers the flexibility to switch between metric and imperial units, catering to users' measurement preferences.

Visual enhancements include grid display, drop shadows, and customizable object colors. Users can toggle the visibility of lights, structural colors, and object colors, tailoring the floorplan to their specific needs. The system also provides options for 3D section viewing and exporting, enhancing the understanding of spatial relationships.

To ensure clear communication, the project supports dimension lines and labels, with horizontal dimension line labels as an option. Users can further customize the appearance with arrowhead types and north arrow rotation. The system supports 2D and 3D export functionalities, allowing users to present their floorplan designs in various formats.

With intuitive labeling and text display, the project enhances readability and comprehension. Additionally, users can define public or private project settings to control accessibility. The system ensures data privacy and security while facilitating effective collaboration among architects and designers. Incorporation of background images enables users to overlay the floorplan design on a visual context, enhancing clarity and visualization during the design process.

{
  'wallHeight': Float;
  'wallSectionHeight': Float;
  'wallThickness': Float;
  'wallOuterThickness': Float;
  'useMetric': Boolean;
  'showGrid': Boolean;
  'showDims': Boolean;
  'showShortDims': Boolean;
  'showAreaDims': Boolean;
  'generateOuterDimension': Boolean;
  'showDropShadows': Boolean;
  'showObjects': Boolean;
  'showFixtures': Boolean;
  'showItemOutline': Boolean;
  'showObjectColour': Boolean;
  'showStructuralColour': Boolean;
  'showFloorsBelow': Boolean;
  'showObjects3d': Boolean;
  'showObjectMono': Boolean;
  'showLights': Boolean;
  'useSection3D': Boolean;
  'showLabels': Boolean;
  'areaLabelOutline': Boolean;
  'areaLabelLetterSpacing': Float;
  'dimLineLabelHorizontal': Boolean;
  'exportLabels3D': Boolean;
  'showShadows3D': Boolean;
  'exportOrtho3D': Boolean;
  'visuals': "ALL" | "BW" | "BWC";
  'showTexts': Boolean;
  'arrowHeadType': "arrow-stop" | "stop" | "reverse-arrow-stop" | "arrow";
  'northArrowRotation': Float;
  'northArrowKind': Integer;
  'blueprintMode': Boolean;
  'dimLineFont': String;
  'hideItemsAboveHeight': Float;
  'hideItemsAbove': Boolean;
}

Properties

Name	Type	Description	Default
wallHeight	Float	Default height of the wall	280
wallSectionHeight	Float	The height of the wall when section is enabled	280
wallThickness	Float	The thickness of the wall	15
wallOuterThickness	Float	The outer wall thickness, inner wall thickness will not change	30
useMetric	Boolean	Use the metric system if set to true, uses imperial system if set to false	true
showGrid	Boolean	Toggle grid on and off	true
showDims	Boolean	Show dimensions	true
showShortDims	Boolean	Show dimensions	true
showAreaDims	Boolean	Show dimensions	true
generateOuterDimension	Boolean	Generate dimensions outside the floorplan	true
showDropShadows	Boolean	Show drop shadows on objects	true
showObjects	Boolean	Show or hide objects	true
showFixtures	Boolean	Show or hide fixtures	true
showItemOutline	Boolean	Show outline around objects	true
showObjectColour	Boolean	Show colour in objects	true
showStructuralColour	Boolean	Show colour in structurals items	true
showFloorsBelow	Boolean	Show the floors below	true
showObjects3d	Boolean	Show objects in 3D mode	true
showObjectMono	Boolean	Show object in black/white visual mode	true
showLights	Boolean	Show or hide lights	true
useSection3D	Boolean	Show section cut off in 3D mode	true
showLabels	Boolean	Show or hide labels	true
areaLabelOutline	Boolean	Show outline on area labels	true
areaLabelLetterSpacing	Float	Letter spacing in area labels	1.0
dimLineLabelHorizontal	Boolean	Show dimension line label in horizontal lines	true
exportLabels3D	Boolean	Show labels in 3D exports	false
showShadows3D	Boolean	Show shadows in 3D	true
exportOrtho3D	Boolean	Export orthographically in 3D	false
visuals	String	Style to display 2D floorplan, ALL: Fully coloured, BW: Black & White, BWC: Black & White products and other floors, walls and structurals coloured	ALL
northArrowRotation	Float	Rotation of the north arrow marker	0.0
northArrowKind	Integer	Type of north arrow marker 1, 2, 3 or 4	1
blueprintMode	Boolean	Show blueprint instead of grid, combine with visuals: BW to make it look like a blueprint	false
dimLineFont	String	The font face of a dimension line	arial
hideItemsAboveHeight	Float	Hide items above a certain height	122
hideItemsAbove	Boolean	Hide items above the height	false