Type Alias TMultiFloorViewOptions

TMultiFloorViewOptions: {
    __EXPERIMENTAL_darkenSpacesExposedToAbove?: boolean;
    __EXPERIMENTAL_disableGapFilling?: boolean;
    __EXPERIMENTAL_excludeSpaceIdsInAutoHeightCalculation?: readonly string[];
    enabled?: boolean;
    floorGap?: number | "auto";
    floorGapFallback?: number;
    floorGapMultiplier?: number;
    footprintColor?: string | Partial<Record<Floor["id"], string>>;
    footprintOpacity?: number;
    footprintOutline?: boolean;
    footprintsHidden?: boolean;
    spacesOpenToBelowEnabled?: boolean;
    updateCameraElevationOnFloorChange?: boolean;
}

Options for controlling multi-floor view. When enabled, displays all floors in a building stacked vertically below the active floor, allowing users to see the building's vertical structure and navigate between floors. The active floor is fully rendered while lower floors appear as semi-transparent footprints.

Type declaration

  • Optional Experimental__EXPERIMENTAL_darkenSpacesExposedToAbove?: boolean

    Whether to darken spaces that are exposed to the floor above. Only applies when spacesOpenToBelowEnabled is true.

    Default

    true
    @experimental
  • Optional Experimental__EXPERIMENTAL_disableGapFilling?: boolean

    When true, disables the automatic gap-filling footprints that are created between floors with missing elevations. This prevents the SDK from building gapFootprint geometry in FloorObject, which can be useful when the venue data does not have reliable elevation gaps or when gap filling is not desired.

    Default

    false
    @experimental
  • Optional Experimental__EXPERIMENTAL_excludeSpaceIdsInAutoHeightCalculation?: readonly string[]

    Space IDs to exclude when computing the automatic floor height (geometryMaxHeight). Useful for ignoring tall outlier spaces (e.g. atriums, voids) that would otherwise inflate the floor gap in 'auto' mode.

    Default

    []
    @experimental
  • Optionalenabled?: boolean

    Enable multi-floor view to show floors stacked vertically below the active floor.

    Default

    true
  • OptionalfloorGap?: number | "auto"

    The vertical spacing between floors in meters (before floorGapMultiplier).

    • number — base gap in meters × floorGapMultiplier, applied uniformly to all floors.
    • 'auto' — each floor's gap is derived from its data:
      1. maxHeight from venue data × floorGapMultiplier
      2. Computed geometry height as a guard (prevents tall geometry from poking through)
      3. floorGapFallback × floorGapMultiplier if provided
      4. Internal default (3m × floorGapMultiplier)

    Default

    'auto'
  • OptionalfloorGapFallback?: number

    Fallback floor height in meters, used when floorGap is 'auto' and a floor has no maxHeight in the venue data. This value is multiplied by floorGapMultiplier.

    When not provided, DEFAULT_FLOOR_HEIGHT × floorGapMultiplier (3m × 1 = 3m) is used.

    Example

    // 4-meter base gap for floors without maxHeight data (× floorGapMultiplier)
    multiFloorView: { floorGap: 'auto', floorGapFallback: 4 }
  • OptionalfloorGapMultiplier?: number

    Multiplier applied to all floor height sources: maxHeight, floorGap (number), floorGapFallback, and the internal default height (3m).

    Default

    1 (heights are used as-is)

    Example

    // Double all floor heights for wider separation
    multiFloorView: { floorGapMultiplier: 2 }

    // Works with explicit floorGap too: 5m × 2 = 10m per floor
    multiFloorView: { floorGap: 5, floorGapMultiplier: 2 }
  • OptionalfootprintColor?: string | Partial<Record<Floor["id"], string>>

    The color of the floor footprints when in multi-floor view. Accepts either:

    • A CSS color string (hex, rgb, rgba, named colors) applied to all floors
    • An object mapping floor IDs to color strings for per-floor coloring

    When using an object, floors without a specified color will use the internal default ('#ffffff').

    Example

    // Single color for all floors
    footprintColor: '#ff0000'

    Example

    // Per-floor colors
    footprintColor: {
      'floor-1': '#ff0000',
      'floor-2': '#00ff00',
      'floor-3': '#0000ff'
    }

    Default

    '#ffffff'
  • OptionalfootprintOpacity?: number

    The opacity of the floor footprints when in multi-floor view.

    Default

    1
  • OptionalfootprintOutline?: boolean

    The outline of the floor footprints when in multi-floor view.

    Default

    true
  • OptionalfootprintsHidden?: boolean

    When true, footprints remain hidden and ignore all state updates. This prevents footprint geometry from interfering with raycasting.

    Default

    false
  • Optional ExperimentalspacesOpenToBelowEnabled?: boolean

    Whether to enable spaces open to below (ceiling cutouts that expose lower floors).

    When this is enabled, and spaces that have kind "void" or "otb" will be cut out of the ceiling exposing the floor below. Any holes in the footprint will also be cut out but will have walls built around them.

    Default

    false
    @experimental
  • OptionalupdateCameraElevationOnFloorChange?: boolean

    Automatically adjust the camera elevation when switching floors to match the floor's altitude.

    Default

    true

Settings

Member Visibility