MVFv3 API Documentation
    Preparing search index...

    Type Alias LocationInstance

    A location instance is a particular instance of an location that has some properties different from the parent. Eg, it may have different hours, or a slightly different name.

    A location instance:

    • MUST have a parentId, referring to a Location.
    • MUST have a unique ID, for localization to work.
    • SHOULD have AT LEAST ONE polygon or node to anchor it in space.
    • SHOULD have AT LEAST ONE other Location property set.

    It is otherwise a Partial

    NOTE: Unlike Location, details.name is optional.

    Usage examples:

    • A location instance for a location with a different externalId so a customer can identify them individually.
    • A location instance with different operationHours, that might indicate different hours for that particular entrance.
    type LocationInstance = {
        id: `loci_${string}`;
        parentId: `loc_${string}`;
        categories?: `lcat_${string}`[];
        logo?: string;
        phone?: string;
        social?: { name: string; url: string }[];
        images?: { url: string }[];
        links?: { label: string; url: string }[];
        website?: { label: string; url: 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;
        }[];
        geometryAnchors?: { floorId: `f_${string}`; geometryId: `g_${string}` }[];
        extra?: { [key: string]: unknown };
        details?: {
            description?: string;
            externalId?: string;
            icon?: string;
            name?: string;
            shortName?: string;
        };
    }
    Index

    Properties

    id parentId categories? logo? phone? social? images? links? website? openingHours? geometryAnchors? extra? details?

    Properties

    id: `loci_${string}`
    parentId: `loc_${string}`
    categories?: `lcat_${string}`[]

    The LocationCategorys of the location.

    logo?: string

    The logo for the location. Different from Details.icon, or images

    phone?: string

    The phone number of the location.

    social?: { name: string; url: string }[]

    The social media accounts of the location.

    images?: { url: string }[]

    Images for and usually of the location. Usually photos.

    links?: { label: string; url: string }[]

    Links to other information about the location.

    website?: { label: string; url: string }

    A link to the website of the location.

    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;
    }[]

    The opening hours of the location.

    Type declaration

    • Optional@type?: "OpeningHoursSpecification"

      The type of opening hours

      'OpeningHoursSpecification'
    • Optionalcloses?: string

      The time the opening hours end

    • OptionaldayOfWeek?:
          | "Sunday"
          | "Monday"
          | "Tuesday"
          | "Wednesday"
          | "Thursday"
          | "Friday"
          | "Saturday"
          | "PublicHolidays"
          | (
              | "Sunday"
              | "Monday"
              | "Tuesday"
              | "Wednesday"
              | "Thursday"
              | "Friday"
              | "Saturday"
              | "PublicHolidays"
          )[]

      The days of the week the opening hours apply to

    • Optionalopens?: string

      The time the opening hours start

    • OptionalvalidFrom?: string

      The date the opening hours start, in ISO 8601 format

      date-time

    • OptionalvalidThrough?: string

      The date the opening hours end, in ISO 8601 format

      date-time

    geometryAnchors?: { floorId: `f_${string}`; geometryId: `g_${string}` }[]

    Type declaration

    • floorId: `f_${string}`

      The floor ID of the geometry to reference.

      FloorId

    • geometryId: `g_${string}`

      The ID of the geometry to reference.

      GeometryId

    extra?: { [key: string]: unknown }

    {@inheritDoc utility-types/extra!Extra}

    Extra

    details?: {
        description?: string;
        externalId?: string;
        icon?: string;
        name?: string;
        shortName?: string;
    }

    {@inheritDoc utility-types/details!Details}

    Details

    Settings

    Member Visibility

    On This Page

    Properties