gi-nx

---

gi-nx / RawPolygon

Properties

Property	Type	Description
geometry.coordinates	[number, number][][]	-
geometry.type	"Polygon"	-
properties.angleOfRepose?	number	Angle of repose for cut and fill.
properties.arrowEnd?	boolean	Arrow at end of line (lines only).
properties.arrowEndLength?	number	Length of arrowhead in meters.
properties.arrowEndYawn?	number	Angle of arrowhead in degrees.
properties.arrowStart?	boolean	Arrow at start of line (lines only).
properties.arrowStartLength?	number	Length of arrowhead in meters.
properties.arrowStartYawn?	number	Angle of arrowhead in degrees.
properties.baseHeight?	number	Height of Bottom.
properties.bevel?	number	Bevel.
properties.bevelSegments?	number	Bevel segments.
properties.blockId?	string	Block Id
properties.blockPropagation?	Record<string, "pass" | "force" | "stop">	-
properties.buildingID?	string	Give a name to a stack of building sections. Sections get their building ID from sections below them.
properties.childFeatures?	Feature<LineString | Polygon, { [name: string]: any; }>[]	-
properties.color?	string	Loft this shape.
properties.cornerRadius?	number	Corner radius.
properties.corners?	"fillet" | "chamfer"	Corner radius.
properties.cutAndFill?	boolean	Lot Number/ID for Precinct App.
properties.cutAndFillOffset?	number	Offset cut and fill shape. Positive is outward, negative inward.
properties.dendrogram?	DendroRoot	-
properties.depth?	number	Basement depth - only applies to basement type. Overrides floor to floor and levels
properties.doesStack?	boolean	Make this feature stack on other stackable features
properties.dwellingCount?	NumberKeyValueList	Manually override the number of dwellings for this section.
properties.dwellingCountPerLevel?	boolean	Are dwelling counts per level, or total
properties.dwellingMix?	NumberKeyValueList	Ratio/Mix of units. Must sum to 1.
properties.dwellingParkingRequired?	NumberKeyValueList	Specify parking requirements per unit (overrides "Parking Required" which calculates by area).
properties.dwellingPrice?	NumberKeyValueList	Specify sale price per unit
properties.dwellingResidents?	NumberKeyValueList	Specify number of residents per unit.
properties.dwellingSize?	NumberKeyValueList	Size of units.
properties.efficiency?	number	Efficiency for this building section to calculate net area. (will override usage if applied to a section).
properties.elevationDatum?	number	Elevation Datum (Base Height is relative. For 3D terrain mode)
properties.fillOpacity?	number	Fill opacity (0.0-1.0).
properties.floorToFloor?	number	Floor to Floor height. Works in combination with the "levels" property. Only affects features with type "buildingSection" or "3d".
properties.flow?	RawSectionFlowProp	Attach a flow to this feature. Must be a nested object with id referencing the flow UUID, NOT the name of the flow. Example section.properties.flow = { id: 'cd1e8657-c978-49ce-bb56-c68c6c5fdd95', inputs: { "radius": 1.14 } }; // Correct // NOT: section.properties.flow = 'cd1e8657-...'; // Wrong - must be an object
properties.fromLayer?	string	-
properties.gltf?	string	Upload a gltf file to display on the map. Set scale and rotate properties to adjust it.
properties.groupID?	string	-
properties.guidelineOffset?	number	Offset / buffered guide-line. Will show a dashed line around the shapes with this usage. Can be used for snap or to create new shapes from.
properties.height?	number	Height of top. Overrides floor to floor and levels
properties.hideFloors?	boolean	Hide the floors on the map
properties.hideVerticals?	boolean	Hide the floors on the map
properties.id	string	-
properties.imageUrl?	string	Upload a gltf file to display on the map. Set scale and rotate properties to adjust it.
properties.isDraped?	boolean	Control whether the feature drapes over terrain
properties.layerId?	string	Drawing Layer.
properties.levels?	number	Number of floors. Works in combination with the "floorToFloor" property. Only affects features with type "buildingSection" or "3d".
properties.loft?	boolean	Drawing Layer.
properties.lotNumber?	string	Lot Number/ID for Precinct App.
properties.marker?	Marker	Add a map marker to this feature. Markers can be text labels, icons, or simple labels. Example section.properties.marker = { "kind": "label", "value": { "scale": 0.75, "onTop": true, "renderMode": "screen", "text": "label", "textSize": 25, "textColor": "#151515", "stick": false, "stickHeight": 0, "anchor": "bottom" } };
properties.mirror?	boolean	Rotation for imported 3D Model / Block Instance
properties.noFacade?	boolean	Set this to skip facade cost and solar facade analysis. The feature will still cast a shadow.
properties.offset?	number	Offset this shape. Positive is outward, negative inward.
properties.offsetSide?	"right" | "left" | "both"	Choose whether a line offsets to the left, right or both sides.
properties.parkingProvided?	number	Parking bays provided per (100m² / 1000ft²).
properties.parkingRequired?	number	Parking bays required per (100m² / 1000ft²).
properties.pavementWidth?	number	Width of pavement on either side of road.
properties.popup?	Record<string, any>	Add a rich-text popup to this feature. The content field uses a ProseMirror-style document structure. Example section.properties.popup = { "content": { "type": "doc", "content": [ { "type": "paragraph", "attrs": { "textAlign": "left", "indent": 0 }, "content": [ { "type": "text", "text": "haha" } ] } ] }, "padding": 8, "borderColor": "#000000ff", "borderWidth": 2, "contentSize": 12, "borderRadius": 5, "backgroundColor": "#ffffffff" }
properties.primitive?	string	Mirror imported 3D Model / Block Instance
properties.primitiveParams?	Record<string, any>	Shape parameters for the primitive. Box: width, height, depth. Sphere: radius, segments. Cylinder: radius, radiusTop, radiusBottom, height, segments. Cone: radius, height, segments.
properties.projectId	string	-
properties.radius?	number	The size of the point on the map - for appearance only.
properties.roadWidth?	number	Are dwelling counts per level, or total
properties.rotation?	number	Scale 3D Model / Block Instance.
properties.scale?	number	Scale 3D Model / Block Instance.
properties.scenario?	string[]	Upload an image to display on the map.
properties.sellEfficiency?	number	Sell efficiency for this building section to calculate saleable/rentable area. (will override usage if applied to a section).
properties.shiny?	boolean	Main color.
properties.slabThickness?	number	Thickness of slab/floor
properties.sourceFeatureProperties?	Record<string, any>	Properties from the map feature that this object was created from.
properties.stackOrder?	number	Change stack order of each section. Greater means higher.
properties.stroke?	string	Line color.
properties.strokeDasharray?	number[]	Add a dash pattern to lines. Can be a comma separated list for more complicated dash patterns. See SVG spec for stroke-dasharray.
properties.strokeLinecap?	"butt" | "round" | "square"	Control the appearance of the end of a line.
properties.strokeLinejoin?	"bevel" | "round" | "miter"	Control the joins of line segments.
properties.strokeOpacity?	number	Line opacity (0.0-1.0).
properties.strokeWidth?	number	Line width. Only applies to 3D features when in "bold" view mode.
properties.topThickness?	number	Thickness of top slab/floor. For appearance only.
properties.type?	SectionType	Floor to Floor height. Works in combination with the "levels" property. Only affects features with type "buildingSection" or "3d".
properties.usage?	string	-
properties.visitorParkingRequired?	number	Extra parking spots required - per section.
type	"Feature"	-
versionId?	number	-