Developer

Appearance

Minimap & Quality Controls

rooomSpaces Viewer API minimap and quality controls for virtual environments. Manage navigation aids, rendering quality, and performance optimization in 3D virtual spaces.

getMinimapSize ​

getMinimapSize([callback: Function])

Returns the current dimensions of the minimap display as width and height values. Use this to understand the current minimap configuration and adjust UI layouts accordingly.

Returns: Array with width and height [width: number, height: number] or undefined if minimap is not available

js
api.getMinimapSize(function(size) {
  if (size) {
    console.log('Minimap size:', size[0], 'x', size[1]);
  } else {
    console.log('Minimap not available');
  }
});

hideMinimap ​

hideMinimap([callback: Function])

Hides the minimap navigation aid to provide more screen space for the 3D environment or when navigation assistance is not needed.

js
api.hideMinimap(function() {
  console.log('Minimap hidden');
});

showMinimap ​

showMinimap([callback: Function])

Shows the minimap navigation aid to help users orient themselves and navigate within large virtual spaces.

js
api.showMinimap(function() {
  console.log('Minimap displayed');
});

setQuality ​

setQuality(type: QualityType, [callback: Function])

Sets the rendering quality level for the 3D viewer to balance visual fidelity with performance. Quality settings affect texture resolution, lighting complexity, and rendering effects.

Parameters:

  • type: QualityType - Quality level setting (3 = legendary, 2 = excellent, 1 = sharp, 0 = standard, -1 = eco, -2 = efficient, -3 = thumbnail)
js
api.setQuality(1, function() {
  console.log('Quality set to 1 (sharp)');
});