MVFv3 API Documentation
    Preparing search index...

    Type Alias Location

    A Location is a place of interest in the MVF that end users may want to know about.

    It will always have a Details property with at least a name. It will also have GeometryAnchors, which will have 0 or more Geometries this location is attached to.

    Many locations will only have one anchor, but it is common to have things like Washrooms be a single location with many different anchors. Also if a location is spread across floors it may have multiple anchors.

    Locations may also have LocationCategories, which are used to group locations together.

    In cases where locations are attached to multiple geometries, there may also be LocationInstances for that location, where the properties specific to that instance are noted. For example, a location instance may have different hours.

    type Location = {
        logo?: string;
        phone?: 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;
        }[];
        id: `loc_${string}`;
        categories: `lcat_${string}`[];
        social: { name: string; url: string }[];
        images: { url: string }[];
        links: { 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 };
    }
    Index

    Properties

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

    Properties

    logo?: string

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

    phone?: string

    The phone number of 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

    id: `loc_${string}`

    The ID of the location.

    categories: `lcat_${string}`[]

    The LocationCategorys 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.

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

    Type declaration

    • name: string

      The name of the entity.

    • Optionaldescription?: string

      A description of the entity.

    • OptionalexternalId?: string

      An identifier that can be used to link this entity to data outside of the MVF.

    • Optionalicon?: string

      A URL to an icon for the entity.

    • OptionalshortName?: string

      A short name for the entity. Usually a handful characters (eg; R303, F1, L, etc.) For display in places a full name would be too long or cumbersome.

    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

    Settings

    Member Visibility

    On This Page

    Properties