MVFv3 API Documentation
    Preparing search index...

    Type Alias LocationsSchema

    Locations are user facing destinations on the map. Also called "Points of Interest" (PoI), though in MVF a Location may be attached to multiple geometries, and they do not have to be "point" type.

    The Locations extension adds three properties to the root of the MVF, locations, locationCategories, and locationInstances.

    locations is an array of Locations.

    locationCategories is an array of LocationCategorys.

    locationInstances is an array of LocationInstances.

    type LocationsSchema = {
        locationInstances?: (
            { id: `loci_${string}`; parentId: `loc_${string}` } & {
                categories?: `lcat_${string}`[];
                images?: { url: string }[];
                links?: { label: string; url: string }[];
                logo?: string;
                openingHours?: {
                    "@type"?: "OpeningHoursSpecification";
                    closes?: string;
                    dayOfWeek?:
                        | "Sunday"
                        | "Monday"
                        | "Tuesday"
                        | "Wednesday"
                        | "Thursday"
                        | "Friday"
                        | "Saturday"
                        | "PublicHolidays"
                        | ((...) | (...) | (...) | (...) | (...) | (...) | (...) | (...))[];
                    opens?: string;
                    validFrom?: string;
                    validThrough?: string;
                }[];
                phone?: string;
                social?: { name: string; url: string }[];
                website?: { label: string; url: string };
            } & {} & {
                geometryAnchors?: {
                    floorId: `f_${string}`;
                    geometryId: `g_${string}`;
                }[];
            } & { extra?: { [key: string]: unknown } } & {
                details?: {
                    description?: string;
                    externalId?: string;
                    icon?: string;
                    name?: string;
                    shortName?: string;
                };
            }
        )[];
        locations: (
            {
                categories: `lcat_${string}`[];
                id: `loc_${string}`;
                images: { url: string }[];
                links: { label: string; url: string }[];
                social: { name: string; url: string }[];
                logo?: string;
                openingHours?: {
                    "@type"?: "OpeningHoursSpecification";
                    closes?: string;
                    dayOfWeek?:
                        | "Sunday"
                        | "Monday"
                        | "Tuesday"
                        | "Wednesday"
                        | "Thursday"
                        | "Friday"
                        | "Saturday"
                        | "PublicHolidays"
                        | (
                            | "Sunday"
                            | "Monday"
                            | "Tuesday"
                            | "Wednesday"
                            | "Thursday"
                            | "Friday"
                            | "Saturday"
                            | "PublicHolidays"
                        )[];
                    opens?: string;
                    validFrom?: string;
                    validThrough?: string;
                }[];
                phone?: string;
                website?: { label: string; url: string };
            } & {
                details: { name: string } & {
                    description?: string;
                    externalId?: string;
                    icon?: string;
                    shortName?: string;
                };
            } & {
                geometryAnchors: { floorId: `f_${string}`; geometryId: `g_${string}` }[];
            } & { extra?: { [key: string]: unknown } }
        )[];
        locationCategories: (
            { id: `lcat_${string}`; parent?: `lcat_${string}` } & {
                details: { name: string } & {
                    description?: string;
                    externalId?: string;
                    icon?: string;
                    shortName?: string;
                };
            } & { extra?: { [key: string]: unknown } }
        )[];
    }
    Index

    Properties

    locationInstances? locations locationCategories

    Properties

    locationInstances?: (
        { id: `loci_${string}`; parentId: `loc_${string}` } & {
            categories?: `lcat_${string}`[];
            images?: { url: string }[];
            links?: { label: string; url: string }[];
            logo?: string;
            openingHours?: {
                "@type"?: "OpeningHoursSpecification";
                closes?: string;
                dayOfWeek?:
                    | "Sunday"
                    | "Monday"
                    | "Tuesday"
                    | "Wednesday"
                    | "Thursday"
                    | "Friday"
                    | "Saturday"
                    | "PublicHolidays"
                    | ((...) | (...) | (...) | (...) | (...) | (...) | (...) | (...))[];
                opens?: string;
                validFrom?: string;
                validThrough?: string;
            }[];
            phone?: string;
            social?: { name: string; url: string }[];
            website?: { label: string; url: string };
        } & {} & {
            geometryAnchors?: { floorId: `f_${string}`; geometryId: `g_${string}` }[];
        } & { extra?: { [key: string]: unknown } } & {
            details?: {
                description?: string;
                externalId?: string;
                icon?: string;
                name?: string;
                shortName?: string;
            };
        }
    )[]
    locations: (
        {
            categories: `lcat_${string}`[];
            id: `loc_${string}`;
            images: { url: string }[];
            links: { label: string; url: string }[];
            social: { name: string; url: string }[];
            logo?: string;
            openingHours?: {
                "@type"?: "OpeningHoursSpecification";
                closes?: string;
                dayOfWeek?:
                    | "Sunday"
                    | "Monday"
                    | "Tuesday"
                    | "Wednesday"
                    | "Thursday"
                    | "Friday"
                    | "Saturday"
                    | "PublicHolidays"
                    | (
                        | "Sunday"
                        | "Monday"
                        | "Tuesday"
                        | "Wednesday"
                        | "Thursday"
                        | "Friday"
                        | "Saturday"
                        | "PublicHolidays"
                    )[];
                opens?: string;
                validFrom?: string;
                validThrough?: string;
            }[];
            phone?: string;
            website?: { label: string; url: string };
        } & {
            details: { name: string } & {
                description?: string;
                externalId?: string;
                icon?: string;
                shortName?: string;
            };
        } & {
            geometryAnchors: { floorId: `f_${string}`; geometryId: `g_${string}` }[];
        } & { extra?: { [key: string]: unknown } }
    )[]
    locationCategories: (
        { id: `lcat_${string}`; parent?: `lcat_${string}` } & {
            details: { name: string } & {
                description?: string;
                externalId?: string;
                icon?: string;
                shortName?: string;
            };
        } & { extra?: { [key: string]: unknown } }
    )[]

    Settings

    Member Visibility

    On This Page

    Properties