Class EnterpriseCategory

An EnterpriseCategory groups one or more EnterpriseLocation. 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('enterprise-category');

Refer to the EnterpriseCategory Guide for more information and interactive examples.

Hierarchy

  • default
    • EnterpriseCategory

Implements

  • Omit<MVFEnterpriseCategory, "children" | "locations">

Properties

color? externalId extra? icon? iconFromDefaultList? id name picture? sortOrder

Accessors

children locations

Methods

toJSON is

Properties

Optionalcolor

color?: string

The color of the category.

externalId

externalId: string = ''

The external ID of the category.

Optionalextra

extra?: Record<string, unknown>

Extra properties of the category.

Optionalicon

icon?: string

A URL to the icon of the category.

OptionaliconFromDefaultList

iconFromDefaultList?: null | string

The icon from the default list of icons.

Readonlyid

id: string

The identity of the map metadata.

name

name: string = ''

The name of the category.

Optionalpicture

picture?: string

A URL to the picture of the category.

sortOrder

sortOrder: number = -1

The sort order of the category.

Accessors

children

locations

Methods

toJSON

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

    Serializes the EnterpriseCategory data to JSON.

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

    An object representing the EnterpriseCategory.

Staticis

  • is(instance: object): instance is EnterpriseCategory

    Checks if the provided instance is of type EnterpriseCategory.

    Parameters

    • instance: object

      The instance to check.

    Returns instance is EnterpriseCategory

    True if the instance is a EnterpriseCategory, false otherwise.

Settings

Member Visibility

On This Page

Properties
Accessors
Methods