Class Door

A class representing door data within the map.

Doors are hidden by default. Doors can be made visible by setting their visible property to true.

//Make interior doors visible and brown.
mapView.updateState(DOORS.Interior, {
	visible: true,
	color: '#5C4033',
	opacity: 0.6,
});

//Make exterior doors visible and black.
mapView.updateState(DOORS.Exterior, {
	visible: true,
	color: 'black',
	opacity: 0.6,
});

Doors can also be made visible on an individual basis by passing in a Door object to MapView.updateState.

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

Door appearance can be customized by changing the color or adding a texture to the top or sides of a door. Refer to the Textures & Colors Guide for more information and interactive examples.

Hierarchy

  • default<EntranceCollection["features"][number]>
    • Door

Implements

Properties

id

Accessors

center description externalId floor geoJSON geoJSONBoundingBox images isExterior links locationProfiles name

Methods

toJSON is

Properties

Readonlyid

id: string

The identity of the map data.

Accessors

center

description

  • get description(): string

  • Gets the description of the map feature.

    Returns string

    The description of the map feature, or an empty string if no description exists.

externalId

  • get externalId(): string

  • Gets the external identifier of the map feature.

    Returns string

    The external ID of the map feature, or an empty string if no external ID exists.

floor

  • get floor(): Floor

  • Gets the Floor object associated with the door.

    Returns Floor

    The floor object.

    Throws

    Will throw an error if the floor is not found.

geoJSON

  • get geoJSON(): { geometry: LineString; properties: null; type: "Feature" }

  • Gets the underlying GeoJSON Feature representation of this Door.

    Returns { geometry: LineString; properties: null; type: "Feature" }

geoJSONBoundingBox

  • get geoJSONBoundingBox(): {}

  • Gets the bounding box of the geoJSON geometry.

    Returns {}

    The bounding box of the geoJSON geometry

images

  • get images(): ImageData[]

  • Gets the array of Images associated with this map feature.

    Returns ImageData[]

    An array of Image objects, or an empty array if no images exist.

isExterior

  • get isExterior(): boolean

  • Gets whether this door is an exterior door.

    Returns boolean

links

  • Gets the array of Hyperlinks associated with this map feature.

    Returns Hyperlink[]

    An array of Hyperlink objects, or an empty array if no links exist.

locationProfiles

name

  • get name(): string

  • Gets the name of the map feature.

    Returns string

    The name of the map feature.

Methods

toJSON

  • toJSON(): {
        center: {
            floor: undefined
            | string;
            latitude: number;
            longitude: number;
            verticalOffset: number;
        };
        floor: string;
        id: string;
        name: string;
    }

  • Converts the door information to a JSON object.

    Returns {
        center: {
            floor: undefined | string;
            latitude: number;
            longitude: number;
            verticalOffset: number;
        };
        floor: string;
        id: string;
        name: string;
    }

    An object representing the door.

Staticis

  • is(instance: object): instance is Door

  • Checks if the provided instance is of type Door.

    Parameters

    • instance: object

      The instance to check.

    Returns instance is Door

    True if the instance is a Door, false otherwise.

Settings

Member Visibility

On This Page

Properties
Accessors
Methods
MMNEPVFCICPMFPCPTTAAATR