Mappedin JS - v6.14.0
    Preparing search index...

    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.

    Data Source: Enterprise - This class is only available when using CMS/Enterprise credentials (clientId/clientSecret or API keys that do NOT start with mik_). When using Maker credentials (keys starting with mik_), use LocationCategory instead.

    LocationCategory for the Maker equivalent.

    Hierarchy

    • default
      • EnterpriseCategory

    Implements

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

    Properties

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

    Accessors

    children locations

    Methods

    toJSON is

    Properties

    color?: string

    The color of the category.

    externalId: string = ''

    The external ID of the category.

    extra?: Record<string, unknown>

    Extra properties of the category.

    icon?: string

    A URL to the icon of the category.

    iconFromDefaultList?: string | null

    The icon from the default list of icons.

    id: string

    The identity of the map metadata.

    name: string = ''

    The name of the category.

    picture?: string

    A URL to the picture of the category.

    sortOrder: number = -1

    The sort order of the category.

    Accessors

    • get children(): EnterpriseCategory[]

      The child categories of the category.

      Returns EnterpriseCategory[]

      Data Source: Enterprise - This property is only available when using CMS/Enterprise credentials.

    Methods

    • Serializes the EnterpriseCategory data to JSON.

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

      An object representing the 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