Skip to content

gi-nx


gi-nx / RawPoint

Properties

PropertyTypeDescription
geometry.coordinates[number, number]-
geometry.type"Point"-
properties.angleOfRepose?numberAngle of repose for cut and fill.
properties.arrowEnd?booleanArrow at end of line (lines only).
properties.arrowEndLength?numberLength of arrowhead in meters.
properties.arrowEndYawn?numberAngle of arrowhead in degrees.
properties.arrowStart?booleanArrow at start of line (lines only).
properties.arrowStartLength?numberLength of arrowhead in meters.
properties.arrowStartYawn?numberAngle of arrowhead in degrees.
properties.baseHeight?numberHeight of Bottom.
properties.bevel?numberBevel.
properties.bevelSegments?numberBevel segments.
properties.blockId?stringBlock Id
properties.blockPropagation?Record<string, "pass" | "force" | "stop">-
properties.buildingID?stringGive 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?stringLoft this shape.
properties.cornerRadius?numberCorner radius.
properties.corners?"fillet" | "chamfer"Corner radius.
properties.cutAndFill?booleanLot Number/ID for Precinct App.
properties.cutAndFillOffset?numberOffset cut and fill shape. Positive is outward, negative inward.
properties.dendrogram?DendroRoot-
properties.depth?numberBasement depth - only applies to basement type. Overrides floor to floor and levels
properties.doesStack?booleanMake this feature stack on other stackable features
properties.dwellingCount?NumberKeyValueListManually override the number of dwellings for this section.
properties.dwellingCountPerLevel?booleanAre dwelling counts per level, or total
properties.dwellingMix?NumberKeyValueListRatio/Mix of units. Must sum to 1.
properties.dwellingParkingRequired?NumberKeyValueListSpecify parking requirements per unit (overrides "Parking Required" which calculates by area).
properties.dwellingPrice?NumberKeyValueListSpecify sale price per unit
properties.dwellingResidents?NumberKeyValueListSpecify number of residents per unit.
properties.dwellingSize?NumberKeyValueListSize of units.
properties.efficiency?numberEfficiency for this building section to calculate net area. (will override usage if applied to a section).
properties.elevationDatum?numberElevation Datum (Base Height is relative. For 3D terrain mode)
properties.fillOpacity?numberFill opacity (0.0-1.0).
properties.floorToFloor?numberFloor to Floor height. Works in combination with the "levels" property. Only affects features with type "buildingSection" or "3d".
properties.flow?RawSectionFlowPropAttach 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?stringUpload a gltf file to display on the map. Set scale and rotate properties to adjust it.
properties.groupID?string-
properties.guidelineOffset?numberOffset / 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?numberHeight of top. Overrides floor to floor and levels
properties.hideFloors?booleanHide the floors on the map
properties.hideVerticals?booleanHide the floors on the map
properties.idstring-
properties.imageUrl?stringUpload a gltf file to display on the map. Set scale and rotate properties to adjust it.
properties.isDraped?booleanControl whether the feature drapes over terrain
properties.layerId?stringDrawing Layer.
properties.levels?numberNumber of floors. Works in combination with the "floorToFloor" property. Only affects features with type "buildingSection" or "3d".
properties.loft?booleanDrawing Layer.
properties.lotNumber?stringLot Number/ID for Precinct App.
properties.marker?MarkerAdd 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?booleanRotation for imported 3D Model / Block Instance
properties.noFacade?booleanSet this to skip facade cost and solar facade analysis. The feature will still cast a shadow.
properties.offset?numberOffset 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?numberParking bays provided per (100m² / 1000ft²).
properties.parkingRequired?numberParking bays required per (100m² / 1000ft²).
properties.pavementWidth?numberWidth 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?stringMirror 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.projectIdstring-
properties.radius?numberThe size of the point on the map - for appearance only.
properties.roadWidth?numberAre dwelling counts per level, or total
properties.rotation?numberScale 3D Model / Block Instance.
properties.scale?numberScale 3D Model / Block Instance.
properties.scenario?string[]Upload an image to display on the map.
properties.sellEfficiency?numberSell efficiency for this building section to calculate saleable/rentable area. (will override usage if applied to a section).
properties.shiny?booleanMain color.
properties.slabThickness?numberThickness of slab/floor
properties.sourceFeatureProperties?Record<string, any>Properties from the map feature that this object was created from.
properties.stackOrder?numberChange stack order of each section. Greater means higher.
properties.stroke?stringLine 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?numberLine opacity (0.0-1.0).
properties.strokeWidth?numberLine width. Only applies to 3D features when in "bold" view mode.
properties.topThickness?numberThickness of top slab/floor. For appearance only.
properties.type?SectionTypeFloor to Floor height. Works in combination with the "levels" property. Only affects features with type "buildingSection" or "3d".
properties.usage?string-
properties.visitorParkingRequired?numberExtra parking spots required - per section.
type"Feature"-
versionId?number-