Campus

Loading a campus performs all download requests needed to display a plan, so that calls to viewer.loadPlan can immediately start the rendering process.

Loading a campus

locatrix.plans.loadCampus(viewerToken[, options])

Returns a promise that will resolve with the loaded campus. The promise will reject if there are network errors while loading the campus.

In order to use the downloaded data when loading a plan of the campus, the same viewerToken must be provided to loadPlan.

The viewerToken can be for a campus or client. If the viewerToken is not for a campus, the campusCode must be provided.

If prepare is true, the plans in the campus will be prepared for use in the viewer and with world paths, before the promise resolves.

Campuses must be manually unloaded with locatrix.plans.unload() when they are no longer needed.

locatrix.plans.unload(campus)

Unloads the given campus.

Querying campus data

campus.getClientCode()

Returns the client code associated with this campus.

campus.getCampusCode()

Returns the campus code associated with this campus.

campus.getSitePlanCode()

Returns the site plan code associated with this campus.

campus.getBuildingCodes()

Returns the building codes associated with this campus.

campus.getBuildingPlanCodes(buildingCode)

Returns the plan codes associated with this building.

campus.getPlanCodes()

Returns an array of all plan codes contained within this campus; including site plan code.

campus.getLoadedPlan(planCode)

Returns the loaded plan for the plan code. The plan must be part of the campus, which can be checked with getPlanCodes().

If loadCampus() wasn’t called with prepare as true, then the plan will now be prepared.

campus.getHierarchy()

Returns the hierarchy for this campus.