Class: MVXPlace
MapVX place object, is a custom object containing data of a specific real place. Represents a physical location with all its associated metadata and properties.
Example
PlaceResponse
Constructors
Constructor
MVXPlace
Creates a new place instance with the parameters specified in the data.
Parameters
rawPlace
JSON configuration parameters for the place from API response
Returns
MVXPlace
A new instance of MVXPlace
Example
InnerFloor
Methods
inFloor()
undefined
Returns the floor in which the place exists as an InnerFloor object. If no matching available floor is found or if the place is not indoor, an undefined value will be returned.
Parameters
parentPlaceFloors
Array of existing parent place floors to search in
Returns
undefined | InnerFloor
The matching InnerFloor object or undefined if not found
Example
InnerFloor
toString()
string
Returns a string representation of the place
Returns
string
String in format “MVXPlace {mapvxId}“
Properties
address?
Physical address of the place in plain text (if provided)
banners
List of available banner images for the place
See
Banner for banner structure
category
Category identifier for the place
clientId?
Client-side identifier for the place (optional) Used for custom identification in client applications
description?
Detailed description text for the place (localized based on client language)
generalCategory
General purpose category string for the place (localized)
hidePlace
Flag to control visibility of the place in search results
images
List of available image URLs for the place
inFloors?
Specific floor identifiers where this place exists (for indoor locations)
innerFloors
Floors available in the parent place. If this exists, the place is indoor. Otherwise, the place is considered outdoor.
See
InnerFloor for floor structure
localizedCategory?
Localized category name for the place (based on client language)
logo?
URL of the place’s logo image
mapvxId
Unique identifier to reference the place in MapVX system
metadata?
Metadata of the place.
openingHours?
Business hours when the place is open
See
OpeningHours for schedule structure
parentId
Unique identifier of the parent place or object
parentInstitutionId
Unique identifier of the institution to which this place belongs
parentType
Type of the object being referenced by parentId
position
Central position coordinates for the place
See
LatLng for coordinate structure
properties?
List of properties connected to the place
See
Property for property structure
shortDescription?
Short description text for the place (localized based on client language)
tags
Tags associated with the place for categorization and filtering
title
Title text for the place (localized based on client language)
transportLine?
Transport services associated with this place
See
TransportLine for transport service structure
visibility
Visibility of the place