Mappedin Venue Format (MVF) User Attributes

Fixed Schema

The user attributes for this format come from the schema; they are visible in the Feature Type > User Attributes tab, but you cannot modify them.

Feature types and their corresponding user attributes are listed below.

Not every feature type is required in an MVF dataset, and not every attribute is required for every feature type. Refer to the Mappedin Venue Format Specification for the required properties for each extension.

Attribute data types may be string, int, float, or boolean.

Attribute names containing {} represent FME list attributes. For example, floors{0} will write a single floor value to the floors{} list.

Dot notation is used to represent JSON objects in the form of parent.child elements. So details.name represents the name property within the details object.

Feature Types

annotation
area
connection
entrance
floor
floor_image
floor_stack
hallway
location
location_category
location_instance
manifest
object
poi
room
style
unknown
wall
window

annotation

Attribute

Value

Required/Optional

Usage

id

string

Optional

Identifies the annotation. If not supplied, the writer generates an ID.

mvf_floor_id

string

Required

Identifies the floor containing the annotation. The value must reference a floor feature written to the same MVF bundle by id.

geometryId

string

Required

Required, but does not need to be supplied when the reference is populated from the annotation feature’s geometry. Identifies the Geometry extension feature referenced by the annotation.

externalId

string

Optional

Specifies an extension identifier for the annotation.

symbolKey

string

Required

Identifies the annotation symbol used by the annotation.

url

string

Required

Specifies the URL associated with the annotation symbol.

name

string

Required

Specifies the name associated with the annotation symbol.

area

Attribute

Value

Required/Optional

Usage
id string

Optional

 Identifies the geometry. If not supplied, the writer generates an ID.
mvf_floor_id string

Required

 Identifies the floor containing the geometry. The value must reference a floor feature written to the same MVF bundle by id.
details.name string

Optional

 Specifies the display name.
details.shortName string

Optional

 Specifies the abbreviated display name.
details.description string

Optional

 Specifies a description.
details.externalId string

Optional

 Specifies an identifier for the geometry in an external system.
details.icon string

Optional

 Specifies an icon associated with the geometry.
mvf_walkable boolean

Optional

 When true, includes the geometry as a walkable geometry in the Traversability extension.
mvf_nonwalkable boolean

Optional

 When true, includes the geometry as a non-walkable geometry in the Traversability extension.
mvf_style_token string

Optional

 Specifies a default style to the geometry. The value must match the mvf_style_token of a style feature written to the bundle.
mvf_floor_stack_id string

Optional

 Associates the geometry with a floor stack in the Facade extension. The value must reference a floor_stack feature written to the bundle by id.

connection

Attribute

Value

Required/Optional

Usage

id

string

Optional

Identifies the connection. If not supplied, the writer generates an ID.

type

string

Required

Specifies the connection type. Refer to the MVF Specification for the set of allowed types.

entrances{}.geometryId

string

Optional

Identifies a Geometry extension feature by ID used as an entrance to the connection.

Does not need to be supplied when the reference is populated from the connection feature’s geometry (see Reference Geometry for details).

entrances{}.floorId

string

Optional

Identifies the floor containing the corresponding entrance geometry by ID.

Does not need to be supplied when the reference is populated from the connection feature’s geometry (see Reference Geometry for details). Otherwise the value must reference a floor feature by id written to the same MVF bundle.

exits{}.geometryId

string

Optional

Identifies a Geometry extension feature by ID used as an exit to the connection.

Does not need to be supplied when the reference is populated from the annotation feature’s geometry, see Reference Geometry for details.

exits{}.floorId

string

Optional

Identifies the floor containing the corresponding exit geometry by ID.

Does not need to be supplied when the reference is populated from the connection feature’s geometry (see Reference Geometry for details). Otherwise the value must reference a floor feature by id written to the same MVF bundle.

entryCost

int

Required

Specifies the entry cost value for the connection.

floorCostMultiplier

int

Required

Specifies the floor cost multiplier value for the connection.

details.name

string

Optional

Specifies the display name.

details.shortName

string

Optional

Specifies the abbreviated display name.

details.description

string

Optional

Specifies a description.

details.externalId

string

Optional

Specifies an identifier for the connection in an external system.

details.icon

string

Optional

Specifies an icon associated with the connection.

entrance

Attribute

Value

Required/Optional

Usage

id

string

Optional

Identifies the entrance aesthetic. If not supplied, the writer generates an ID.

mvf_floor_id

string

Required

Identifies the floor with the entrance aesthetic. The value must reference a floor feature written to the same MVF bundle by id.

geometryId

string

Required

Required, but does not need to be supplied when the reference is populated from the entrance feature’s geometry. Identifies the Geometry extension feature referenced by the entrance aesthetic.

kind

string

Required

Specifies the kind of entrance.

Refer to the MVF Specification for the set of allowed kinds.

swing

string

Optional

Specifies the entrance swing direction.

Refer to the MVF Specification for the set of allowed swing directions.

swingOrigin

int

Optional

Specifies the swing origin of the entrance.

details.name

string

Optional

Specifies the display name.

details.shortName

string

Optional

Specifies the abbreviated display name.

details.description

string

Optional

Specifies a description.

details.externalId

string

Optional

Specifies an identifier for the entrance aesthetic in an external system.

details.icon

string

Optional

Specifies an icon associated with the entrance aesthetic.

floor

Attribute

Value

Required/Optional

Usage

id

string

Optional

Identifies the floor. If not supplied, the writer generates an ID.

elevation

int

Required

Specifies the elevation of the floor.

maxHeight

float

Optional

Specifies the maximum height of the floor.

subtitle

string

Optional

Specifies the subtitle of the floor.

details.name

string

Optional

Specifies the display name.

details.shortName

string

Optional

Specifies the abbreviated display name.

details.description

string

Optional

Specifies a description.

details.externalId

string

Optional

Specifies an identifier for the floor in an external system.

details.icon

string

Optional

Specifies an icon associated with the floor.

mvf_outdoor

boolean

Optional

When true, includes the floor in the set of outdoor floors in the Outdoors extension.

floor_image

Attribute

Value

Required/Optional

Usage

path

string

Required

The remote URL for the image.

width

float

Required

Specifies the image width.

height

float

Required

Specifies the image height.

rotation

float

Required

Specifies the image rotation.

geometryId

string

Required

Required when a floor image should be anchored to a geometry. Identifies an existing Geometry extension feature by ID used to anchor the floor image.

The referenced geometry ID must be provided explicitly and is not populated from a floor image feature’s geometry.

verticalOffset

float

Required

Required when a floor image is floating and not anchored to a geometry. Specifies the vertical offset of the floor image.

mvf_floor_id

string

Required

Identifies the floor containing the floor image.

The value must reference a floor feature written to the same MVF bundle by id.

floor_stack

Attribute

Value

Required/Optional

Usage

id

string

Optional

Identifies the floor stack. If not supplied, the writer generates an ID.

defaultFloor

string

Optional

Identifies the default floor in the floor stack. If supplied, the value must reference a floor feature written to the same MVF bundle by id.

details.name

string

Optional

Specifies the display name.

details.shortName

string

Optional

Specifies the abbreviated display name.

details.description

string

Optional

Specifies a description.

details.externalId

string

Optional

Specifies an identifier for the floor stack in an external system.

details.icon

string

Optional

Specifies an icon associated with the floor stack.

floors{}

string

Optional

Identifies floors belonging to the floor stack. Each value supplied must reference a floor feature written to the same MVF bundle by id.

hallway

Attribute

 Value

Required/Optional

Usage

id

string

Optional

Identifies the geometry. If not supplied, the writer generates an ID.

mvf_floor_id

string

Required

Identifies the floor containing the geometry. The value must reference a floor feature written to the same MVF bundle by id.

details.name

string

Optional

Specifies the display name.

details.shortName

string

Optional

Specifies the abbreviated display name.

details.description

string

Optional

Specifies a description.

details.externalId

string

Optional

Specifies an identifier for the geometry in an external system.

details.icon

string

Optional

Specifies an icon associated with the geometry.

mvf_walkable

boolean

Optional

When true, includes the geometry as a walkable geometry in the Traversability extension.

mvf_nonwalkable

boolean

Optional

When true, includes the geometry as a non-walkable geometry in the Traversability extension.

mvf_style_token

string

Optional

Specifies a default style to the geometry. The value must match the mvf_style_token of a style feature written to the bundle.

mvf_floor_stack_id

string

Optional

Associates the geometry with a floor stack in the Facade extension. The value must reference a floor_stack feature written to the bundle by id.

location

Attribute

Value

Required/Optional

Usage

id

string

Optional

Identifies the location. If not supplied, the writer generates an ID.

details.name

string

Required

Specifies the location name.

details.shortName

string

Optional

Specifies the abbreviated display name.

details.description

string

Optional

Specifies a description.

details.externalId

string

Optional

Specifies an identifier for the location in an external system.

details.icon

string

Optional

Specifies an icon associated with the location.

geometryAnchors{}.geometryId

string

Optional

Identifies a Geometry extension feature associated with the location.

Does not need to be supplied when the reference is populated from the location feature’s geometry, see Reference Geometry for details.

geometryAnchors{}.floorId

string

Optional

Identifies the floor containing the corresponding geometry by ID.

Does not need to be supplied when the reference is populated from the location feature’s geometry, see Reference Geometryfor details. Otherwise the value must reference a floor feature by id written to the same MVF bundle.

categories{}

string

Optional

Associates the location with one or more location categories.

Each supplied value must reference a location_category feature written to the same bundle by id.

social{}.name

string

Optional

Specifies the name of a social network the location has an account for.

social{}.url

string

Optional

Specifies the URL of the corresponding social media account of the location.

images{}.url

string

Optional

Specifies an image URL associated with the location.

links{}.label

string

Optional

Specifies the display label for a link.

links{}.url

string

Optional

Specifies the corresponding URL link.

logo

string

Optional

Specifies a logo associated with the location.

phone

string

Optional

Specifies the phone number of the location.

website.label

string

Optional

Specifies the display label for the location website.

website.url

string

Optional

Specifies the location website URL.

openingHours{}.@type

string

Optional

Specifies the type of the opening-hours entry.

openingHours{}.opens

string

Optional

Specifies the time the opening hours start.

openingHours{}.closes

string

Optional

Specifies the time the opening hours end.

openingHours{}.dayOfWeek{}

string

Optional

Specifies the days of the week the opening hours apply to.

openingHours{}.validFrom

string

Optional

Specifies the date the opening hours start.

openingHours{}.validThrough

string

Optional

Specifies the date the opening hours end.

location_category

Attribute

Value

Required/Optional

Usage

id

string

Optional

Identifies the location category. If not supplied, the writer generates an ID.

details.name

string

Required

Specifies the location category name.

details.shortName

string

Optional

Specifies the abbreviated display name.

details.description

string

Optional

Specifies a description.

details.externalId

string

Optional

Specifies an identifier for the location category in an external system.

details.icon

string

Optional

Specifies an icon associated with the location category.

parent

string

Optional

Identifies the parent location category. If supplied, the value must reference a location_category feature written to the same bundle by id.

location_instance

Attribute

Value

Required/Optional

Usage

id

string

Optional

Identifies the location category. If not supplied, the writer generates an ID.

parentId

string

Required

Identifies the location the location instance refers to.

The value must reference a location feature written to the same bundle by id.

details.name

string

Optional

Specifies the location instance name.

details.shortName

string

Optional

Specifies the abbreviated display name.

details.description

string

Optional

Specifies a description.

details.externalId

string

Optional

Specifies an identifier for the location instance in an external system.

details.icon

string

Optional

Specifies an icon associated with the location instance.

geometryAnchors{}.geometryId

string

Optional

Identifies a Geometry extension feature associated with the location instance.

Does not need to be supplied when the reference is populated from the location feature’s geometry, see Reference Geometry for details.

geometryAnchors{}.floorId

string

Optional

Identifies the floor containing the corresponding geometry by ID.

Does not need to be supplied when the reference is populated from the location_instance feature’s geometry, see Reference Geometry for details. Otherwise the value must reference a floor feature by id written to the same MVF bundle.

categories{}

string

Optional

Associates the location with one or more location categories. Each supplied value must reference a location_category feature written to the same bundle by id.

social{}.name

string

Optional

Specifies the name of a social network the location instance has an account for.

social{}.url

string

Optional

Specifies the URL of the corresponding social media account of the location instance.

images{}.url

string

Optional

Specifies an image URL associated with the location instance.

links{}.label

string

Optional

Specifies the display label for a link.

links{}.url

string

Optional

Specifies the corresponding URL link.

logo

string

Optional

Specifies a logo associated with the location.

phone

string

Optional

Specifies the phone number of the location.

website.label

string

Optional

Specifies the display label for the location instance website.

website.url

string

Optional

Specifies the location instance website URL.

openingHours{}.@type

string

Optional

Specifies the type of the opening-hours entry.

openingHours{}.opens

string

Optional

Specifies the time the opening hours start.

openingHours{}.closes

string

Optional

Specifies the time the opening hours end.

openingHours{}.dayOfWeek{}

string

Optional

Specifies the days of the week the opening hours apply to.

openingHours{}.validFrom

string

Optional

Specifies the date the opening hours start.

openingHours{}.validThrough

string

Optional

Specifies the date the opening hours end.

manifest

Attribute

Value

Required/Optional

Usage

name

string

Optional

Specifies the name of the map. If not supplied, defaults to the output dataset name.

version

string

Optional

Specifies the MVF version. Defaults to the supported version.

time

string

Optional

Specifies the time. If not supplied, defaults to the current time.

defaultFloor

string

Optional

Specified the default floor of the map. If supplied, the value must reference a floor feature written to the same bundle by id.

orgId

string

Optional

Specifies the organization identifier.

mapId

string

Optional

Specifies the map identifier.

tzid

string

Optional

Specifies the venue time zone identifier.

naturalBearing

float

Optional

Specifies the natural bearing of the venue.

language

string

Optional

Specifies the venue language.

object

Attribute

Value

Required/Optional

Usage

id

string

Optional

Identifies the geometry. If not supplied, the writer generates an ID.

mvf_floor_id

string

Required

Identifies the floor containing the geometry. The value must reference a floor feature written to the same MVF bundle by id.

details.name

string

Optional

Specifies the display name.

details.shortName

string

Optional

Specifies the abbreviated display name.

details.description

string

Optional

Specifies a description.

details.externalId

string

Optional

Specifies an identifier for the geometry in an external system.

details.icon

string

Optional

Specifies an icon associated with the geometry.

mvf_walkable

boolean

Optional

When true, includes the geometry as a walkable geometry in the Traversability extension.

mvf_nonwalkable

boolean

Optional

When true, includes the geometry as a non-walkable geometry in the Traversability extension.

mvf_style_token

string

Optional

Specifies a default style to the geometry. The value must match the mvf_style_token of a style feature written to the bundle.

mvf_floor_stack_id

string

Optional

Associates the geometry with a floor stack in the Facade extension. The value must reference a floor_stack feature written to the bundle by id.

poi

Attribute

Value

Required/Optional

Usage

id

string

Optional

Identifies the geometry. If not supplied, the writer generates an ID.

mvf_floor_id

string

Required

Identifies the floor containing the geometry. The value must reference a floor feature written to the same MVF bundle by id.

details.name

string

Optional

Specifies the display name.

details.shortName

string

Optional

Specifies the abbreviated display name.

details.description

string

Optional

Specifies a description.

details.externalId

string

Optional

Specifies an identifier for the geometry in an external system.

details.icon

string

Optional

Specifies an icon associated with the geometry.

mvf_walkable

boolean

Optional

When true, includes the geometry as a walkable geometry in the Traversability extension.

mvf_nonwalkable

boolean

Optional

When true, includes the geometry as a non-walkable geometry in the Traversability extension.

mvf_style_token

string

Optional

Specifies a default style to the geometry. The value must match the mvf_style_token of a style feature written to the bundle.

mvf_floor_stack_id

string

Optional

Associates the geometry with a floor stack in the Facade extension. The value must reference a floor_stack feature written to the bundle by id.

room

Attribute

Value

Required/Optional

Usage

id

string

Optional

Identifies the geometry. If not supplied, the writer generates an ID.

mvf_floor_id

string

Required

Identifies the floor containing the geometry. The value must reference a floor feature written to the same MVF bundle by id.

details.name

string

Optional

Specifies the display name.

details.shortName

string

Optional

Specifies the abbreviated display name.

details.description

string

Optional

Specifies a description.

details.externalId

string

Optional

Specifies an identifier for the geometry in an external system.

details.icon

string

Optional

Specifies an icon associated with the geometry.

mvf_walkable

boolean

Optional

When true, includes the geometry as a walkable geometry in the Traversability extension.

mvf_nonwalkable

boolean

Optional

When true, includes the geometry as a non-walkable geometry in the Traversability extension.

mvf_style_token

string

Optional

Specifies a default style to the geometry. The value must match the mvf_style_token of a style feature written to the bundle.

mvf_floor_stack_id

string

Optional

Associates the geometry with a floor stack in the Facade extension. The value must reference a floor_stack feature written to the bundle by id.

style

Attribute

Value

Required/Optional

Usage

mvf_style_token

string

Required

Identifies the default style.

color

string

Required

Specifies the color associated with the default style.

altitude

float

Required

Specifies the offset above the floor objects with this default style.

height

float

Required

Specifies the height for objects associated with the default style.

opacity

float

Required

Specifies the opacity associated with the default style.

buffer

float

Required

Specifies the buffer associated with the default style.

hidden

boolean

Optional

Specifies if the objects with this style should be hidden from view.

unknown

Attribute

Value

Required/Optional

Usage

id

string

Optional

Identifies the geometry. If not supplied, the writer generates an ID.

mvf_floor_id

string

Required

Identifies the floor containing the geometry. The value must reference a floor feature written to the same MVF bundle by id.

details.name

string

Optional

Specifies the display name.

details.shortName

string

Optional

Specifies the abbreviated display name.

details.description

string

Optional

Specifies a description.

details.externalId

string

Optional

Specifies an identifier for the geometry in an external system.

details.icon

string

Optional

Specifies an icon associated with the geometry.

mvf_walkable

boolean

Optional

When true, includes the geometry as a walkable geometry in the Traversability extension.

mvf_nonwalkable

boolean

Optional

When true, includes the geometry as a non-walkable geometry in the Traversability extension.

mvf_style_token

string

Optional

Specifies a default style to the geometry. The value must match the mvf_style_token of a style feature written to the bundle.

mvf_floor_stack_id

string

Optional

Associates the geometry with a floor stack in the Facade extension. The value must reference a floor_stack feature written to the bundle by id.

wall

Attribute

 Value

Required/Optional

Usage

id

string

Optional

Identifies the geometry. If not supplied, the writer generates an ID.

mvf_floor_id

string

Required

Identifies the floor containing the geometry. The value must reference a floor feature written to the same MVF bundle by id.

details.name

string

Optional

Specifies the display name.

details.shortName

string

Optional

Specifies the abbreviated display name.

details.description

string

Optional

Specifies a description.

details.externalId

string

Optional

Specifies an identifier for the geometry in an external system.

details.icon

string

Optional

Specifies an icon associated with the geometry.

mvf_walkable

boolean

Optional

When true, includes the geometry as a walkable geometry in the Traversability extension.

mvf_nonwalkable

boolean

Optional

When true, includes the geometry as a non-walkable geometry in the Traversability extension.

mvf_style_token

string

Optional

Specifies a default style to the geometry. The value must match the mvf_style_token of a style feature written to the bundle.

mvf_floor_stack_id

string

Optional

Associates the geometry with a floor stack in the Facade extension. The value must reference a floor_stack feature written to the bundle by id.

window

Attribute

 Value

Required/Optional

Usage

id

string

Optional

Identifies the geometry. If not supplied, the writer generates an ID.

mvf_floor_id

string

Required

Identifies the floor containing the geometry. The value must reference a floor feature written to the same MVF bundle by id.

details.name

string

Optional

Specifies the display name.

details.shortName

string

Optional

Specifies the abbreviated display name.

details.description

string

Optional

Specifies a description.

details.externalId

string

Optional

Specifies an identifier for the geometry in an external system.

details.icon

string

Optional

Specifies an icon associated with the geometry.

mvf_walkable

boolean

Optional

When true, includes the geometry as a walkable geometry in the Traversability extension.

mvf_nonwalkable

boolean

Optional

When true, includes the geometry as a non-walkable geometry in the Traversability extension.

mvf_style_token

string

Optional

Specifies a default style to the geometry. The value must match the mvf_style_token of a style feature written to the bundle.

mvf_floor_stack_id

string

Optional

Associates the geometry with a floor stack in the Facade extension. The value must reference a floor_stack feature written to the bundle by id.