Class Location

A class representing location data within the map.

A Location is something like a store, or a washroom on a map.

Hierarchy

  • default
    • Location

Implements

  • Omit<EnterpriseLocation, "polygons" | "nodes" | "links">

Properties

amenity? description? externalId extra? gallery? id links logo? name operationHours? phone? picture? shortName? showFloatingLabelWhenImagePresent? showLogo? siblingGroups? social? sortOrder states? tags? type

Accessors

coordinates nodes spaces

Methods

toJSON is

Properties

Optionalamenity

amenity?: string

The location's amenity type. Only set if the location is an amenity

Optionaldescription

description?: string

externalId

externalId: string = ''

Optionalextra

extra?: Record<string, unknown>

Optionalgallery

gallery?: {
    caption?: null | string;
    embeddedUrl?: null | string;
    image: string;
}[]

The location's image gallery

Readonlyid

id: string

identity of the map object

links

links: Hyperlink[] = []

Gets the links associated with this data type.

Returns

The links associated with this data type

Optionallogo

logo?: string

The location's logo

Format

uri

name

name: string = ''

OptionaloperationHours

operationHours?: OperationHours[]

Optionalphone

phone?: {
    extension?: string;
    number: string;
}

Optionalpicture

picture?: string

The picture of the location

Format

uri

OptionalshortName

shortName?: string

OptionalshowFloatingLabelWhenImagePresent

showFloatingLabelWhenImagePresent?: boolean

Whether to show the flat label when an image is present

OptionalshowLogo

showLogo?: boolean

Whether to show the logo of the location

OptionalsiblingGroups

siblingGroups?: SiblingGroup[]

Locations that are related to this location in some manner (described by the label)

Optionalsocial

social?: {
    facebook?: string;
    instagram?: string;
    twitter?: string;
    website?: string;
}

The location's social media links

sortOrder

sortOrder: number = -1

Optionalstates

states?: LocationState[]

The location's state. No more than one state should be active at a time, and all but at most one should have dates set

Optionaltags

tags?: string[]

type

type: string = ''

Accessors

coordinates

nodes

  • get nodes(): Node[]

  • Returns Node[]

spaces

Methods

toJSON

  • toJSON(): {
        id: string;
        name: string;
    }

  • Serializes the location data to JSON.

    Returns {
        id: string;
        name: string;
    }

    An object representing the location.

    • id: string
    • name: string

Staticis

  • is(instance): instance is Location

  • Checks if the provided instance is of type Location.

    Parameters

    • instance: object

      The instance to check.

    Returns instance is Location

    True if the instance is a Location, false otherwise.

Settings

Member Visibility

On This Page

amenitydescriptionexternalIdextragalleryidlinkslogonameoperationHoursphonepictureshortNameshowFloatingLabelWhenImagePresentshowLogosiblingGroupssocialsortOrderstatestagstypecoordinatesnodesspacestoJSONis