OptionaldescriptionOptionalexternalOptionalextraAdditional user defined data. The type is unknown, so it is recommended to validate the data before use.
Only available when loading MVFv3 data.
const mapData = await getMapData({
...
mvfVersion: '3.0.0',
});
const locationProfile = mapData.getById('location-profile', id);
if (typeof locationProfile?.extra?.myProperty === 'string') {
// Do something
}
OptionaliconThe location's icon to display. Will be either a logo, category, or image
The identity of the map metadata.
The location's pictures
Web links for the location
OptionallogoThe location's logo
Use the logoImage property instead
OptionallogoAn image representing the location's logo
OptionalphoneOptionalsearchAdditional keywords to match against when searching. These should not be used for display.
The location's social media links.
OptionalwebsiteThe location's website
Gets the LocationCategorys associated with the location.
The location categories array.
Gets the PointOfInterests associated with the location.
The points of interest array.
StaticisChecks if the provided instance is of type LocationProfile.
The instance to check.
True if the instance is a EnterpriseLocation, false otherwise.
A LocationProfile contains metadata about a location, such as its name, description, logo, phone number, social media links, hours of operation and more. They can be accessed using the MapData.getByType method as shown below.
Remarks
Data Source: Maker - This class is only available when using Maker credentials (API keys starting with
mik_). When using CMS/Enterprise credentials (clientId/clientSecret or keys that do NOT start withmik_), use EnterpriseLocation instead.See
EnterpriseLocation for the CMS/Enterprise equivalent.