|
| 1 | +# Building |
| 2 | + |
| 3 | +A building is a man-made structure with a roof that exists permanently in one |
| 4 | + place. |
| 5 | + |
| 6 | + Buildings are compatible with GeoJSON Polygon features. |
| 7 | + |
| 8 | +## Model Information |
| 9 | + |
| 10 | +**Module:** `overture.schema.buildings.building.models` |
| 11 | +**Class:** `Building` |
| 12 | + |
| 13 | +## Fields |
| 14 | + |
| 15 | +| Name | Type | Description | |
| 16 | +|------|------|-------------| |
| 17 | +| `height` | Number (optional) | Height of the building or part in meters. The height is the distance from the lowest point to the highest point. | |
| 18 | +| `is_underground` | Boolean (optional) | Whether the entire building or part is completely below ground. This is useful for rendering which typically omits these buildings or styles them differently because they are not visible above ground. This is different than the level column which is used to indicate z-ordering of elements and negative values may be above ground. | |
| 19 | +| `num_floors` | Integer (optional) | Number of above-ground floors of the building or part. | |
| 20 | +| `num_floors_underground` | Integer (optional) | Number of below-ground floors of the building or part. | |
| 21 | +| `min_height` | Number (optional) | The height of the bottom part of building in meters. Used if a building or part of building starts above the ground level. | |
| 22 | +| `min_floor` | Integer (optional) | The "start" floor of this building or part. 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. | |
| 23 | +| `facade_color` | String (optional) | The color (name or color triplet) of the facade of a building or building part in hexadecimal | |
| 24 | +| `facade_material` | FacadeMaterial (optional) | The outer surface material of building facade. | |
| 25 | +| `roof_material` | RoofMaterial (optional) | The outermost material of the roof. | |
| 26 | +| `roof_shape` | RoofShape (optional) | The shape of the roof | |
| 27 | +| `roof_direction` | Number (optional) | Bearing of the roof ridge line in degrees. | |
| 28 | +| `roof_orientation` | RoofOrientation (optional) | Orientation of the roof shape relative to the footprint shape. Either "along" or "across". | |
| 29 | +| `roof_color` | String (optional) | The color (name or color triplet) of the roof of a building or building part in hexadecimal | |
| 30 | +| `roof_height` | Number (optional) | The height of the building roof in meters. This represents the distance from the base of the roof to the highest point of the roof. | |
| 31 | +| `level` | Integer (optional) | | |
| 32 | +| `names.primary` | String | The most commonly used name. | |
| 33 | +| `names.common` | Map[String, String] (optional) | | |
| 34 | +| `names.rules[].side` | Side (optional) | | |
| 35 | +| `names.rules[].between` | Array[Number] (optional) | | |
| 36 | +| `names.rules[].value` | String | | |
| 37 | +| `names.rules[].variant` | NameVariant | | |
| 38 | +| `names.rules[].language` | String (optional) | | |
| 39 | +| `names.rules[].perspectives.mode` | PerspectiveMode | Whether the perspective holder accepts or disputes this name. | |
| 40 | +| `names.rules[].perspectives.countries` | list | Countries holding the given mode of perspective. | |
| 41 | +| `names.rules[].perspectives` | Perspectives (optional) | | |
| 42 | +| `names.rules[]` | Array[NameRule] (optional) | Rules for names that cannot be specified in the simple common names property. These rules can cover other name variants such as official, alternate, and short; and they can optionally include geometric scoping (linear referencing) and side-of-road scoping for complex cases. | |
| 43 | +| `names` | Names (optional) | | |
| 44 | +| `id` | String | | |
| 45 | +| `theme` | Literal | | |
| 46 | +| `type` | Literal | | |
| 47 | +| `geometry` | Geometry | The building's footprint or roofprint (if traced from aerial/satellite imagery). | |
| 48 | +| `version` | Integer | | |
| 49 | +| `sources[].between` | Array[Number] (optional) | | |
| 50 | +| `sources[].property` | String | | |
| 51 | +| `sources[].dataset` | String | | |
| 52 | +| `sources[].record_id` | String (optional) | Refers to the specific record within the dataset that was used. | |
| 53 | +| `sources[].update_time` | String (optional) | | |
| 54 | +| `sources[].confidence` | Number (optional) | | |
| 55 | +| `sources[]` | Array[SourcePropertyItem] (optional) | | |
| 56 | +| `subtype` | Subtype (optional) | | |
| 57 | +| `class_` | BuildingClass (optional) | | |
| 58 | +| `has_parts` | Boolean (optional) | Flag indicating whether the building has parts | |
0 commit comments