Skip to main content

BuildingPart

Building parts represent parts of larger building features. They allow buildings to be modeled in rich detail suitable for creating realistic 3D models.

Every building part is associated with a parent Building feature via the building_id field. In addition, a building part has a footprint geometry and may include additional details such as its height, the number of floors, and the color and material of its facade and roof.

Building parts can float or be stacked on top of each other. The min_height, min_floor, height, and num_floors, fields can be used to arrange the parts correctly along the vertical dimension.

Fields

NameTypeDescription
bboxbbox (optional)An optional bounding box for the feature
building_idIdThe building to which this part belongs
References Building (belongs to)
facade_colorHexColor (optional)Facade color in #rgb or #rrggbb hex notation
facade_materialFacadeMaterial (optional)Outer surface material of the facade
geometrygeometryThe footprint or roofprint of the building part.
Allowed geometry types: MultiPolygon, Polygon
heightfloat64 (optional)Height of the building or part in meters.

This is the distance from the lowest point to the highest point.
> 0
idIdA feature ID. This may be an ID associated with the Global Entity Reference System (GERS) if—and-only-if the feature represents an entity that is part of GERS.
is_undergroundboolean (optional)Whether the entire building or part is completely below ground.

The underground flag is useful for display purposes. Buildings and building parts that are entirely below ground can be styled differently or omitted from the rendered image.

This flag is conceptually different from the level field, which indicates relative z-ordering and, notably, can be negative even if the building is entirely above-ground.
strict=True
levelLevel (optional)Z-order of the feature where 0 is visual level
min_floorint32 (optional)Start floor of this building or part.

If present, this value indicates that the building or part is "floating" and its bottom-most floor is above ground level, usually because it is part of a larger building in which some parts do reach down to ground level. An example is a building that has an entry road or driveway at ground level into an interior courtyard, where part of the building bridges above the entry road. This property may sometimes be populated when min_height is missing and in these cases can be used as a proxy for min_height.
> 0
min_heightfloat64 (optional)Altitude above ground where the bottom of the building or building part starts.

If present, this value indicates that the lowest part of the building or building part starts is above ground level.
num_floorsint32 (optional)Number of above-ground floors of the building or part.
> 0
num_floors_undergroundint32 (optional)Number of below-ground floors of the building or part.
> 0
roof_colorHexColor (optional)The roof color in #rgb or #rrggbb hex notation
roof_directionfloat64 (optional)Bearing of the roof ridge line in degrees
≥ 0
< 360
roof_heightfloat64 (optional)Height of the roof in meters.

This is the distance from the base of the roof to its highest point.
roof_materialRoofMaterial (optional)Outer surface material of the roof
roof_orientationRoofOrientation (optional)Orientation of the roof shape relative to the footprint shape
roof_shapeRoofShape (optional)Shape of the roof
theme"buildings"
type"building_part"
versionFeatureVersion

Examples

ColumnValue
id19412d64-51ac-3d6a-ac2f-8a8c8b91bb60
geometryPOLYGON ((-73.2462509 -39.8108937, -73.2462755 -39.8109047, -73.246291 -39.8109182, -73.2463022 -39....
themebuildings
typebuilding_part
version0
sources[0].property
sources[0].datasetOpenStreetMap
sources[0].record_idw223076787@2
sources[0].update_time2014-10-31T22:55:36.000Z
sources[0].confidencenull
sources[0].betweennull
building_idbd663bd4-1844-4d7d-a400-114de051cf49
namesnull
level3
heightnull
is_undergroundfalse
num_floorsnull
num_floors_undergroundnull
min_heightnull
min_floornull
facade_colornull
facade_materialnull
roof_materialnull
roof_shapenull
roof_directionnull
roof_orientationnull
roof_colornull
roof_heightnull