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 (View Summary)

DetailedMapData<EntranceFeature>
- Door

Implements

Index

Properties

Accessors

center description externalId floor geoJSON geoJSONBoundingBox icon images isExterior links locationProfiles name

Methods

toJSON is

Properties

`Readonly`id

id: string

The identity of the map data.

Accessors

center

get center(): Coordinate
Calculates and gets the center Coordinate of the door.

Returns Coordinate
The center coordinate.

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.

Inherited from DetailedMapData.description

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.

Inherited from DetailedMapData.externalId

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" }
Implementation of IGeoJSONData.geoJSON
Overrides DetailedMapData.geoJSON

geoJSONBoundingBox

get geoJSONBoundingBox(): BBox | undefined
Gets the bounding box of the geoJSON geometry.

Returns BBox | undefined
The bounding box of the geoJSON geometry

Inherited from DetailedMapData.geoJSONBoundingBox

icon

get icon(): ImageMetaData | undefined
Gets the URL of the icon for the map feature.

Returns ImageMetaData | undefined
The icon of the map feature.

Inherited from DetailedMapData.icon

images

get images(): ImageMetaData[]
Gets the array of ImageMetaDatas associated with this map feature.

Returns ImageMetaData[]
An array of Image objects, or an empty array if no images exist.

Inherited from DetailedMapData.images

isExterior

get isExterior(): boolean
Gets whether this door is an exterior door.

Returns boolean

locationProfiles

get locationProfiles(): LocationProfile[]
Gets the LocationProfiles attached to this feature.

Returns LocationProfile[]
An array of location profiles.

Remarks
Data Source: Maker - This property is only populated when using Maker credentials (API keys starting with mik_). Returns an empty array when using CMS/Enterprise credentials. For Enterprise data, use Space.enterpriseLocations or MapObject.enterpriseLocations instead.

Inherited from DetailedMapData.locationProfiles

name

get name(): string
Gets the name of the map feature.

Returns string
The name of the map feature.

Inherited from DetailedMapData.name

Methods

toJSON

toJSON(): {
    __type: string;
    center: {
        __type: string;
        floorId: string
        | undefined;
        latitude: number;
        longitude: number;
        verticalOffset: number;
    };
    floor: string;
    id: string;
    name: string;
}
Converts the door information to a JSON object.

Returns {
    __type: string;
    center: {
        __type: string;
        floorId: string | undefined;
        latitude: number;
        longitude: number;
        verticalOffset: number;
    };
    floor: string;
    id: string;
    name: string;
}
An object representing the door.

`Static`is

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.

Class Door

Hierarchy (View Summary)

Implements

Index

Properties

Accessors

Methods

Properties

Readonlyid

Accessors

center

Returns Coordinate

description

Returns string

externalId

Returns string

floor

Returns Floor

Throws

geoJSON

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

geoJSONBoundingBox

Returns BBox | undefined

icon

Returns ImageMetaData | undefined

images

Returns ImageMetaData[]

isExterior

Returns boolean

links

Returns Hyperlink[]

locationProfiles

Returns LocationProfile[]

Remarks

name

Returns string

Methods

toJSON

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

Staticis

Parameters

Returns instance is Door

Settings

On This Page

`Readonly`id

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

`Static`is