Skip to content

Commit 9ea99de

Browse files
stevemunkstevemunk
committed
Update drawing-requirements.md
1 parent 6d8261d commit 9ea99de

File tree

1 file changed

+72
-72
lines changed

1 file changed

+72
-72
lines changed

‎articles/azure-maps/drawing-requirements.md

Lines changed: 72 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
2-
title: Drawing package requirements in Microsoft Azure Maps Creator
2+
title: Drawing package requirements in Microsoft Azure Maps Creator
3+
titleSuffix: Microsoft Azure Maps Creator
34
description: Learn about the Drawing package requirements to convert your facility design files to map data
45
author: stevemunk
56
ms.author: v-munksteve
6-
ms.date: 07/02/2021
7+
ms.date: 03/18/2022
78
ms.topic: conceptual
89
ms.service: azure-maps
910
services: azure-maps
@@ -28,14 +29,14 @@ The [Azure Maps Conversion service](/rest/api/maps/v2/conversion) converts the D
2829

2930
For easy reference, here are some terms and definitions that are important as you read this article.
3031

31-
| Term | Definition |
32-
|:-------|:------------|
33-
| Layer | An AutoCAD DWG layer from the drawing file.|
34-
| Entity | An AutoCAD DWG entity from the drawing file. |
32+
| Term | Definition |
33+
|:------|:---------------------------------------------|
34+
| Layer | An AutoCAD DWG layer from the drawing file. |
35+
| Entity| An AutoCAD DWG entity from the drawing file. |
3536
| Xref | A file in AutoCAD DWG file format, attached to the primary drawing as an external reference. |
3637
| Level | An area of a building at a set elevation. For example, the floor of a building. |
37-
| Feature | An instance of an object produced from the Conversion service that combines a geometry with metadata information. |
38-
| Feature classes | A common blueprint for features. For example, a *unit* is a feature class, and an *office* is a feature. |
38+
|Feature| An instance of an object produced from the Conversion service that combines a geometry with metadata information. |
39+
|Feature classes| A common blueprint for features. For example, a *unit* is a feature class, and an *office* is a feature. |
3940

4041
## Drawing package structure
4142

@@ -51,21 +52,21 @@ The Drawing package must be zipped into a single archive file, with the .zip ext
5152
The [Azure Maps Conversion service](/rest/api/maps/v2/conversion) does the following on each DWG file:
5253

5354
- Extracts feature classes:
54-
- Levels
55-
- Units
56-
- Zones
57-
- Openings
58-
- Walls
59-
- Vertical penetrations
55+
- Levels
56+
- Units
57+
- Zones
58+
- Openings
59+
- Walls
60+
- Vertical penetrations
6061
- Produces a *Facility* feature.
6162
- Produces a minimal set of default Category features to be referenced by other features:
62-
- room
63-
- structure
64-
- wall
65-
- opening.door
66-
- zone
67-
- facility
68-
63+
- room
64+
- structure
65+
- wall
66+
- opening.door
67+
- zone
68+
- facility
69+
6970
## DWG file requirements
7071

7172
A single DWG file is required for each level of the facility. All data of a single level must be contained in a single DWG file. Any external references (_xrefs_) must be bound to the parent drawing. For example, a facility with three levels will have three DWG files in the Drawing package.
@@ -190,9 +191,8 @@ Although there are requirements when you use the manifest objects, not all objec
190191
>[!NOTE]
191192
> Unless otherwise specified, all properties with a string property type allow for one thousand characters.
192193
193-
194-
| Object | Required | Description |
195-
| :----- | :------- | :------- |
194+
| Object | Required | Description |
195+
| :-------- | :------- | :----------------------------------------------------------- |
196196
| `version` | true |Manifest schema version. Currently, only version 1.1 is supported.|
197197
| `directoryInfo` | true | Outlines the facility geographic and contact information. It can also be used to outline an occupant geographic and contact information. |
198198
| `buildingLevels` | true | Specifies the levels of the buildings and the files containing the design of the levels. |
@@ -207,66 +207,66 @@ The next sections detail the requirements for each object.
207207

208208
| Property | Type | Required | Description |
209209
|-----------|------|----------|-------------|
210-
| `name` | string | true | Name of building. |
211-
| `streetAddress`| string | false | Address of building. |
212-
|`unit` | string | false | Unit in building. |
213-
| `locality` | string | false | Name of a city, town, area, neighborhood, or region.|
214-
| `adminDivisions` | JSON array of strings | false | An array containing address designations. For example: (Country, State) Use ISO 3166 country codes and ISO 3166-2 state/territory codes. |
215-
| `postalCode` | string | false | The mail sorting code. |
216-
| `hoursOfOperation` | string | false | Adheres to the [OSM Opening Hours](https://wiki.openstreetmap.org/wiki/Key:opening_hours/specification) format. |
217-
| `phone` | string | false | Phone number associated with the building. |
218-
| `website` | string | false | Website associated with the building. |
219-
| `nonPublic` | bool | false | Flag specifying if the building is open to the public. |
220-
| `anchorLatitude` | numeric | false | Latitude of a facility anchor (pushpin). |
221-
| `anchorLongitude` | numeric | false | Longitude of a facility anchor (pushpin). |
222-
| `anchorHeightAboveSeaLevel` | numeric | false | Height of the facility's ground floor above sea level, in meters. |
223-
| `defaultLevelVerticalExtent` | numeric | false | Default height (thickness) of a level of this facility to use when a level's `verticalExtent` is undefined. |
210+
| `name` |string| true | Name of building. |
211+
| `streetAddress`|string|false| Address of building. |
212+
|`unit` |string| false | Unit in building. |
213+
|`locality` |string | false | Name of a city, town, area, neighborhood, or region.|
214+
|`adminDivisions`|JSON array of strings | false| An array containing address designations. For example: (Country, State) Use ISO 3166 country codes and ISO 3166-2 state/territory codes. |
215+
|`postalCode`|string| false | The mail sorting code. |
216+
|`hoursOfOperation` |string|false| Adheres to the [OSM Opening Hours](https://wiki.openstreetmap.org/wiki/Key:opening_hours/specification) format. |
217+
|`phone` |string| false | Phone number associated with the building. |
218+
|`website` |string| false | Website associated with the building. |
219+
|`nonPublic`|bool| false | Flag specifying if the building is open to the public. |
220+
|`anchorLatitude`|numeric|false | Latitude of a facility anchor (pushpin). |
221+
|`anchorLongitude`|numeric |false | Longitude of a facility anchor (pushpin). |
222+
|`anchorHeightAboveSeaLevel`| numeric | false | Height of the facility's ground floor above sea level, in meters. |
223+
|`defaultLevelVerticalExtent` numeric | false | Default height (thickness) of a level of this facility to use when a level's `verticalExtent` is undefined. |
224224

225225
### `buildingLevels`
226226

227227
The `buildingLevels` object contains a JSON array of buildings levels.
228228

229-
| Property | Type | Required | Description |
230-
|-----------|------|----------|-------------|
231-
|`levelName` |string |true | Descriptive level name. For example: Floor 1, Lobby, Blue Parking, or Basement.|
232-
|`ordinal` | integer | true | Determines the vertical order of levels. Every facility must have a level with ordinal 0. |
233-
|`heightAboveFacilityAnchor` | numeric | false | Level height above the anchor in meters. |
234-
| `verticalExtent` | numeric | false | Floor-to-ceiling height (thickness) of the level in meters. |
235-
|`filename` | string | true | File system path of the CAD drawing for a building level. It must be relative to the root of the building's zip file. |
229+
| Property | Type | Required | Description |
230+
|-----------|-------|----------|-------------|
231+
|`levelName`|string |true |Descriptive level name. For example: Floor 1, Lobby, Blue Parking, or Basement.|
232+
|`ordinal` |integer|true | Determines the vertical order of levels. Every facility must have a level with ordinal 0. |
233+
|`heightAboveFacilityAnchor`| numeric | false |Level height above the anchor in meters. |
234+
|`verticalExtent`|numeric|false| Floor-to-ceiling height (thickness) of the level in meters. |
235+
|`filename` |string |true |File system path of the CAD drawing for a building level. It must be relative to the root of the building's zip file. |
236236

237237
### `georeference`
238238

239239
| Property | Type | Required | Description |
240240
|-----------|------|----------|-------------|
241-
|`lat` | numeric | true | Decimal representation of degrees latitude at the facility drawing's origin. The origin coordinates must be in WGS84 Web Mercator (`EPSG:3857`).|
242-
|`lon` |numeric| true| Decimal representation of degrees longitude at the facility drawing's origin. The origin coordinates must be in WGS84 Web Mercator (`EPSG:3857`). |
243-
|`angle`| numeric| true| The clockwise angle, in degrees, between true north and the drawing's vertical (Y) axis. |
241+
|`lat`|numeric|true|Decimal representation of degrees latitude at the facility drawing's origin. The origin coordinates must be in WGS84 Web Mercator (`EPSG:3857`).|
242+
|`lon`|numeric|true|Decimal representation of degrees longitude at the facility drawing's origin. The origin coordinates must be in WGS84 Web Mercator (`EPSG:3857`).|
243+
|`angle`|numeric|true|The clockwise angle, in degrees, between true north and the drawing's vertical (Y) axis.|
244244

245245
### `dwgLayers`
246246

247-
| Property | Type | Required | Description |
248-
|-----------|------|----------|-------------|
249-
|`exterior` |array of strings| true| Names of layers that define the exterior building profile.|
250-
|`unit`| array of strings| true| Names of layers that define units.|
251-
|`wall`| array of strings |false| Names of layers that define walls.|
252-
|`door` |array of strings| false | Names of layers that define doors.|
253-
|`unitLabel` |array of strings| false |Names of layers that define names of units.|
254-
|`zone` | array of strings | false | Names of layers that define zones.|
255-
|`zoneLabel` | array of strings | false | Names of layers that define names of zones.|
247+
| Property | Type | Required | Description |
248+
|-----------|------|----------|---------------------------------------------------------------|
249+
|`exterior` |array of strings|true |Names of layers that define the exterior building profile.|
250+
|`unit` |array of strings|false|Names of layers that define units. |
251+
|`wall` |array of strings|false|Names of layers that define walls. |
252+
|`door` |array of strings|false|Names of layers that define doors. |
253+
|`unitLabel`|array of strings|false|Names of layers that define names of units. |
254+
|`zone` |array of strings|false|Names of layers that define zones. |
255+
|`zoneLabel`|array of strings|false|Names of layers that define names of zones. |
256256

257257
### `unitProperties`
258258

259259
The `unitProperties` object contains a JSON array of unit properties.
260260

261261
| Property | Type | Required | Description |
262262
|-----------|------|----------|-------------|
263-
|`unitName` |string |true |Name of unit to associate with this `unitProperty` record. This record is only valid when a label matching `unitName` is found in the `unitLabel` layers. |
264-
|`categoryName`| string| false |Purpose of the unit. A list of values that the provided rendering styles can make use of is available [here](https://atlas.microsoft.com/sdk/javascript/indoor/0.1/categories.json). |
265-
|`occupants` |array of directoryInfo objects |false |List of occupants for the unit. |
266-
|`nameAlt`| string| false| Alternate name of the unit. |
267-
|`nameSubtitle`| string |false| Subtitle of the unit. |
268-
|`addressRoomNumber`| string| false| Room, unit, apartment, or suite number of the unit.|
269-
|`verticalPenetrationCategory`| string| false| When this property is defined, the resulting feature is a vertical penetration (VRT) rather than a unit. You can use vertical penetrations to go to other vertical penetration features in the levels above or below it. Vertical penetration is a [Category](https://aka.ms/pa-indoor-spacecategories) name. If this property is defined, the `categoryName` property is overridden with `verticalPenetrationCategory`. |
263+
|`unitName`|string|true|Name of unit to associate with this `unitProperty` record. This record is only valid when a label matching `unitName` is found in the `unitLabel` layers. |
264+
|`categoryName`|string|false|Purpose of the unit. A list of values that the provided rendering styles can make use of is available [here](https://atlas.microsoft.com/sdk/javascript/indoor/0.1/categories.json).|
265+
|`occupants`|array of directoryInfo objects |false |List of occupants for the unit. |
266+
|`nameAlt`|string|false|Alternate name of the unit. |
267+
|`nameSubtitle`|string|false|Subtitle of the unit. |
268+
|`addressRoomNumber`|string|false|Room, unit, apartment, or suite number of the unit.|
269+
|`verticalPenetrationCategory`|string|false| When this property is defined, the resulting feature is a vertical penetration (VRT) rather than a unit. You can use vertical penetrations to go to other vertical penetration features in the levels above or below it. Vertical penetration is a [Category](https://aka.ms/pa-indoor-spacecategories) name. If this property is defined, the `categoryName` property is overridden with `verticalPenetrationCategory`. |
270270
|`verticalPenetrationDirection`| string| false |If `verticalPenetrationCategory` is defined, optionally define the valid direction of travel. The permitted values are: `lowToHigh`, `highToLow`, `both`, and `closed`. The default value is `both`. The value is case-sensitive.|
271271
| `nonPublic` | bool | false | Indicates if the unit is open to the public. |
272272
| `isRoutable` | bool | false | When this property is set to `false`, you can't go to or through the unit. The default value is `true`. |
@@ -278,15 +278,15 @@ The `zoneProperties` object contains a JSON array of zone properties.
278278

279279
| Property | Type | Required | Description |
280280
|-----------|------|----------|-------------|
281-
|zoneName |string |true |Name of zone to associate with `zoneProperty` record. This record is only valid when a label matching `zoneName` is found in the `zoneLabel` layer of the zone. |
282-
|categoryName| string| false |Purpose of the zone. A list of values that the provided rendering styles can make use of is available [here](https://atlas.microsoft.com/sdk/javascript/indoor/0.1/categories.json).|
283-
|zoneNameAlt| string| false |Alternate name of the zone. |
284-
|zoneNameSubtitle| string | false |Subtitle of the zone. |
285-
|zoneSetId| string | false | Set ID to establish a relationship among multiple zones so that they can be queried or selected as a group. For example, zones that span multiple levels. |
281+
|zoneName |string |true |Name of zone to associate with `zoneProperty` record. This record is only valid when a label matching `zoneName` is found in the `zoneLabel` layer of the zone. |
282+
|categoryName| string| false |Purpose of the zone. A list of values that the provided rendering styles can make use of is available [here](https://atlas.microsoft.com/sdk/javascript/indoor/0.1/categories.json).|
283+
|zoneNameAlt| string| false |Alternate name of the zone. |
284+
|zoneNameSubtitle| string | false |Subtitle of the zone. |
285+
|zoneSetId| string | false | Set ID to establish a relationship among multiple zones so that they can be queried or selected as a group. For example, zones that span multiple levels. |
286286

287287
### Sample Drawing package manifest
288288

289-
Below is the manifest file for the sample Drawing package. To download the entire package, see [sample Drawing package](https://github.com/Azure-Samples/am-creator-indoor-data-examples).
289+
Below is the manifest file for the sample Drawing package. Go to the [Sample Drawing package for Azure Maps Creator](https://github.com/Azure-Samples/am-creator-indoor-data-examples) on GitHub to download the entire package.
290290

291291
#### Manifest file
292292

@@ -429,10 +429,10 @@ When your Drawing package meets the requirements, you can use the [Azure Maps Co
429429
> [Drawing Package Guide](drawing-package-guide.md)
430430
431431
> [!div class="nextstepaction"]
432-
>[Creator for indoor maps](creator-indoor-maps.md)
432+
> [Creator for indoor maps](creator-indoor-maps.md)
433433
434434
> [!div class="nextstepaction"]
435435
> [Tutorial: Creating a Creator indoor map](tutorial-creator-indoor-maps.md)
436436
437437
> [!div class="nextstepaction"]
438-
> [Indoor maps dynamic styling](indoor-map-dynamic-styling.md)
438+
> [Indoor maps dynamic styling](indoor-map-dynamic-styling.md)

0 commit comments

Comments
 (0)