Floor

A Floor represents a single level of a Unit Map®.

📘

Working with floors on a Unit Map®.

See the FloorSelection API on how to select and manipulate floors.

map.on("ready", function () {
  // Get the currently displayed floor:
  var floor = map.floor();

  console.log(floor.label, floor.shortLabel);
});

Floor.id

The unique identifier of the Floor.

Floor.label

The display label of the Floor — e.g. "Floor 1".

Floor.shortLabel

The abbreviated label of the Floor — e.g. "1".

Floor.show()

Display the Floor, hiding the other floors of the map. This method is chainable.

map.floors().find("1010").first().show();

Returns

The object chain.

Floor.markers()

Add or remove Marker instances on the Floor.

Returns

A new MarkerCollection instance.

Floor.data()

Get the Floor data as a JSON.

Returns

A JSON object.