Class: Institution

MapVX Institution object, is a custom object containing data of conglomerate of places (enterprise or subdivision). Represents a collection of related places that form a larger organizational unit.

Example

const institution = new Institution(institutionResponse)
console.log(institution.title) // "Shopping Mall"
console.log(institution.hasPlaces) // true

Constructors

Constructor

new Institution(rawInstitution): Institution;

Creates a new instance of an Institution object with the rawInstitution arguments.

Parameters

rawInstitution

InstitutionResponse

JSON configuration parameters for the institution from API response

Returns

Institution

A new instance of Institution

Example

const institutionResponse = await fetchInstitutionData(institutionId)
const institution = new Institution(institutionResponse)

Properties

category

category: string

Category or type of the institution

country

country: string

Country where the institution is located

description?

optional description: string;

Detailed description of the institution (optional)

hasPlaces

hasPlaces: boolean

Flag indicating if the institution contains places

icon?

optional icon: string;

URL of the institution’s icon or logo

mapvxId

mapvxId: string

Unique identifier for the institution in MapVX system

properties?

optional properties: Property[];

List of properties associated with the institution

See

Property for property structure

title

title: string

Title or name of the institution