Class LocationCategory

A LocationCategory groups one or more LocationProfile. These allow similar locations to be sorted in a logical fashion. For example a mall may group locations into Food Court, Footwear and Women's Fashion. They can be accessed using the MapData.getByType method as shown below.

const categories = mapData.getByType('location-category');

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 with mik_), use EnterpriseCategory instead.

See

EnterpriseCategory for the CMS/Enterprise equivalent.

Hierarchy

  • default
    • LocationCategory

Implements

  • Omit<MVFCategory, "parent">

Properties

icon id name

Accessors

children locationProfiles parent

Methods

toJSON is

Properties

icon

icon: string

The category's icon

Format

uri

id

id: string

The identity of the map metadata.

name

name: string

Accessors

children

locationProfiles

parent

Methods

toJSON

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

    Returns { __type: string; id: string; name: string }

Staticis

  • is(instance: object): instance is LocationCategory

    Checks if the provided instance is of type EnterpriseLocation.

    Parameters

    • instance: object

      The instance to check.

    Returns instance is LocationCategory

    True if the instance is a EnterpriseLocation, false otherwise.

Settings

Member Visibility

On This Page

Properties
Accessors
Methods