Module indoor-properties

Package com.here.mom.feature.indoor.indoor-properties

Parts

DisplayLabel

part DisplayLabel

Module indoor-properties

Property Type Modifier Description
text LanguageProperty list

LanguageProperty

part LanguageProperty

Module indoor-properties

This is mainly used by properties originating from Micello. e.g. description of a site is language dependent

Property Type Modifier Description
languageCode string 3-letter language code (all-caps), following the same standard (ISO-639) as languageCode of the Name class
propertyValue string

RenderProperties

part RenderProperties

Module indoor-properties

Property Type Modifier Description
displayText DisplayLabel optional Label is computed based on different rules and configurations

also this is language dependent
isCustomLabelArea boolean optional when set to true - one can define custom rectangle for rendering the displayText/icon, otherwise auto computed
labelArea Polygon optional labelArea is the largest rectangle that can be inscribed in a geometry, and suggests that the icon or displayText

must be rendered within the boundary, so it will avoid label overlapping. No arbitrary polygons are accepted.

At the same time when the isCustomLabelArea = true, it exposes option to define the area in which icon or

text should be rendered.

Site, Structure, Level and Space have it; if isCustomLabelArea = false, this will be auto computed

for spaces labelArea must be present
styleProperties StyleProperties optional style for the geometry stroke and fill
textLabelStyleProperties StyleProperties optional style for the label text
displayTextOverride boolean optional displayTextOverride is auto computed value, it is set to true when displayText value saved is not equal to

the auto-computed value of displayText

we have not yet defined/enabled labelTextPreference for Site, Structure and Level, so for now this will be

meaningful only for Space

StyleProperties

part StyleProperties

Module indoor-properties

Property Type Modifier Description
stroke CrgbHex optional pen color for lines and outlines
strokeWidth double optional abstract pen width; 0 = invisible, 1 = maximum width
strokeOpacity double optional 0 = transparent, 1 = opaque
fill CrgbHex optional
fillOpacity double optional 0 = transparent, 1 = opaque
font Font optional
Constraint Expression Description
strokeWidthMin0_0 (non-empty(.strokeWidth) -> (head(.strokeWidth) >= 0.0))
strokeOpacityMin0_0 (non-empty(.strokeOpacity) -> (head(.strokeOpacity) >= 0.0))
strokeOpacityMax1_0 (non-empty(.strokeOpacity) -> (head(.strokeOpacity) <= 1.0))
fillOpacityMin0_0 (non-empty(.fillOpacity) -> (head(.fillOpacity) >= 0.0))
fillOpacityMax1_0 (non-empty(.fillOpacity) -> (head(.fillOpacity) <= 1.0))

Url

part Url

Module indoor-properties

Property Type Modifier Description
alias string

VenueFeatureProperties

part VenueFeatureProperties extends Common

Module indoor-properties

Subtypes EntranceProperties, LevelConnectorProperties, LevelProperties, OccupantProperties, SiteProperties, SpaceGroupProperties, SpaceProperties, StructureProperties

Base class for venue object properties.

Property Type Modifier Description
@ns:com:here:mom:meta Metadata optional
@ns:com:here:mom:rmob string optional Currently not specified - may be specified by each Feature individually in future
featureType FeatureType optional Deprecated. This property is redundant to MomFeature.momType and should not be used.

MOM clients before 2.6 release had this deprecated property set to required, so

if data needs to be JSON schema validated by clients before 2.6 this property must be

set by the writer.
isoCountryCode Country optional Deprecated. This indicates which country a Feature is in, with a couple caveats.

- It may be unknown ("NONE" is a valid value, in addition to "UNDEFINED" like all MOM enums) simply because the

writer has not tried to figure it out or has otherwise not had the means to do so.

- It may be outright incorrect or a simplification of reality, specifically when a Feature is close to a country

border or in a disputed area (e.g., two or more countries claim the same area).

In all cases, writers and readers of this data should understand that the semantics of this property must be

agreed upon (if it is used at all). The preferred method of relating a Feature to a Country is through a

(direct or transitive) Reference from the Feature to an Admin.
@ns:com:here:mom:delta Branch optional
@ns:com:here:mom:mapcreator MapCreator optional
@ns:com:here:xyz Xyz optional Generic Data Hub namespace
extensionOSM MomOsm optional Optional extension for OSM (Open Street Map) metadata,

in case the object came from OSM
@ns:com:here:groundTruth GroundTruth optional Ground truth namespace
confidence ConfidenceData optional Confidence of a feature, optional only for the features

that are not participating in Quality Index.
venueId string optional Deprecated. Id of the venue. Venue Id is generated outside of MOM, and is used by the different components/services of venues.

There is no venue object, hence this is not a reference to any object,

but conceptually venue is a collection of objects of momType "indoor.{Site, Structure, Level, Space, Occupant}".

This id is linking every object to the venue.

It may have the same value as the Site object, but it doesn't have to have.

Each feature could be considered to be identifiable by a 2-level id: the venueId + feature id.

The feature id is also unique by itself.
indoorMapId string Id of the indoor map. The id is generated outside of MOM, and is used by the different components/services

of the indoor map.

Indoor map is a collection of objects of momType "indoor.{Site, Structure, Level, Space, Occupant, ...}".

This id is linking every object to the specific indoor map.

It may have the same value as the Site object, but it doesn't have to have.

Each feature could be considered to be identifiable by a 2-level id: the indoor map id + feature id.

The feature id is also unique by itself.
renderProperties RenderProperties optional optional object, will appear only for following objects Site, Structure, Level, Space (Vectors)

results matching ""

    No results matching ""