Skip to main content

Type Alias: GetBoundingBoxPosition2d()

GetBoundingBoxPosition2d = (instanceId) => Promise<Nullable<BoxRect>>

Function

Retrieves the screen position and dimensions of a specific element in the scene.

This action calculates the exact pixel coordinates and size of an element's bounding box on the screen. It's like measuring where and how large something appears in the current view, which is essential for positioning overlays, tooltips, or information panels precisely.

Business value:

  • Enables accurate placement of interactive UI elements relative to product parts
  • Supports hotspot features that highlight specific product components
  • Allows dynamic information displays that track with product features
  • Powers advanced configurator interfaces that respond to what's visible

Parameters​

instanceId​

string

Unique identifier for the element to measure

Returns​

Promise<Nullable<BoxRect>>

Promise resolving to position and size information, or null if not found

Example​

// Position a tooltip next to a specific product component
window.mimeeqApp.actions.getBoundingBoxPosition2d('drawer-handle')
  .then(position => {
    if (position) {
      const tooltip = document.getElementById('feature-tooltip');
      tooltip.style.left = `${position.right + 10}px`;
      tooltip.style.top = `${position.top}px`;
      tooltip.style.display = 'block';
    }
  });